You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

734 lines
22 KiB

/*****************************************************************************
* speex.c: speex decoder/packetizer/encoder module making use of libspeex.
*****************************************************************************
* Copyright (C) 2003 VideoLAN
* $Id$
*
* Authors: Gildas Bazin <gbazin@videolan.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
*****************************************************************************/
/*****************************************************************************
* Preamble
*****************************************************************************/
#include <vlc/vlc.h>
#include <vlc/decoder.h>
#include <vlc/input.h>
#include <ogg/ogg.h>
#include <speex.h>
#include "speex_header.h"
#include "speex_stereo.h"
#include "speex_callbacks.h"
/*****************************************************************************
* decoder_sys_t : speex decoder descriptor
*****************************************************************************/
struct decoder_sys_t
{
/* Module mode */
vlc_bool_t b_packetizer;
/*
* Input properties
*/
int i_headers;
int i_frame_in_packet;
/*
* Speex properties
*/
SpeexBits bits;
SpeexHeader *p_header;
SpeexStereoState stereo;
void *p_state;
/*
* Common properties
*/
audio_date_t end_date;
};
static int pi_channels_maps[6] =
{
0,
AOUT_CHAN_CENTER, AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
AOUT_CHAN_CENTER | AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARLEFT
| AOUT_CHAN_REARRIGHT,
AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
| AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT
};
/****************************************************************************
* Local prototypes
****************************************************************************/
static int OpenDecoder ( vlc_object_t * );
static int OpenPacketizer( vlc_object_t * );
static void CloseDecoder ( vlc_object_t * );
static void *DecodeBlock ( decoder_t *, block_t ** );
static int ProcessHeader ( decoder_t *, ogg_packet * );
static void *ProcessPacket( decoder_t *, ogg_packet *, block_t ** );
static aout_buffer_t *DecodePacket( decoder_t *, ogg_packet * );
static block_t *SendPacket( decoder_t *, ogg_packet *, block_t * );
static void ParseSpeexComments( decoder_t *, ogg_packet * );
static int OpenEncoder ( vlc_object_t * );
static void CloseEncoder ( vlc_object_t * );
static block_t *Encode ( encoder_t *, aout_buffer_t * );
/*****************************************************************************
* Module descriptor
*****************************************************************************/
vlc_module_begin();
set_description( _("Speex audio decoder") );
set_capability( "decoder", 100 );
set_callbacks( OpenDecoder, CloseDecoder );
add_submodule();
set_description( _("Speex audio packetizer") );
set_capability( "packetizer", 100 );
set_callbacks( OpenPacketizer, CloseDecoder );
add_submodule();
set_description( _("Speex audio encoder") );
set_capability( "encoder", 100 );
set_callbacks( OpenEncoder, CloseEncoder );
vlc_module_end();
/*****************************************************************************
* OpenDecoder: probe the decoder and return score
*****************************************************************************/
static int OpenDecoder( vlc_object_t *p_this )
{
decoder_t *p_dec = (decoder_t*)p_this;
decoder_sys_t *p_sys = p_dec->p_sys;
if( p_dec->fmt_in.i_codec != VLC_FOURCC('s','p','x',' ') )
{
return VLC_EGENERIC;
}
/* Allocate the memory needed to store the decoder's structure */
if( ( p_dec->p_sys = p_sys =
(decoder_sys_t *)malloc(sizeof(decoder_sys_t)) ) == NULL )
{
msg_Err( p_dec, "out of memory" );
return VLC_EGENERIC;
}
p_dec->p_sys->b_packetizer = VLC_FALSE;
aout_DateSet( &p_sys->end_date, 0 );
/* Set output properties */
p_dec->fmt_out.i_cat = AUDIO_ES;
p_dec->fmt_out.i_codec = AOUT_FMT_S16_NE;
/* Set callbacks */
p_dec->pf_decode_audio = (aout_buffer_t *(*)(decoder_t *, block_t **))
DecodeBlock;
p_dec->pf_packetize = (block_t *(*)(decoder_t *, block_t **))
DecodeBlock;
p_sys->i_headers = 0;
p_sys->p_state = NULL;
p_sys->p_header = NULL;
p_sys->i_frame_in_packet = 0;
return VLC_SUCCESS;
}
static int OpenPacketizer( vlc_object_t *p_this )
{
decoder_t *p_dec = (decoder_t*)p_this;
int i_ret = OpenDecoder( p_this );
if( i_ret == VLC_SUCCESS )
{
p_dec->p_sys->b_packetizer = VLC_TRUE;
p_dec->fmt_out.i_codec = VLC_FOURCC('s','p','x',' ');
}
return i_ret;
}
/****************************************************************************
* DecodeBlock: the whole thing
****************************************************************************
* This function must be fed with ogg packets.
****************************************************************************/
static void *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
{
decoder_sys_t *p_sys = p_dec->p_sys;
ogg_packet oggpacket;
if( !pp_block ) return NULL;
if( *pp_block )
{
/* Block to Ogg packet */
oggpacket.packet = (*pp_block)->p_buffer;
oggpacket.bytes = (*pp_block)->i_buffer;
}
else
{
if( p_sys->b_packetizer ) return NULL;
/* Block to Ogg packet */
oggpacket.packet = NULL;
oggpacket.bytes = 0;
}
oggpacket.granulepos = -1;
oggpacket.b_o_s = 0;
oggpacket.e_o_s = 0;
oggpacket.packetno = 0;
if( p_sys->i_headers == 0 )
{
/* Take care of the initial Speex header */
if( ProcessHeader( p_dec, &oggpacket ) != VLC_SUCCESS )
{
msg_Err( p_dec, "initial Speex header is corrupted" );
block_Release( *pp_block );
return NULL;
}
p_sys->i_headers++;
return ProcessPacket( p_dec, &oggpacket, pp_block );
}
if( p_sys->i_headers == 1 )
{
/* The next packet in order is the comments header */
ParseSpeexComments( p_dec, &oggpacket );
p_sys->i_headers++;
return ProcessPacket( p_dec, &oggpacket, pp_block );
}
return ProcessPacket( p_dec, &oggpacket, pp_block );
}
/*****************************************************************************
* ProcessHeader: processes the inital Speex header packet.
*****************************************************************************/
static int ProcessHeader( decoder_t *p_dec, ogg_packet *p_oggpacket )
{
decoder_sys_t *p_sys = p_dec->p_sys;
void *p_state;
SpeexHeader *p_header;
const SpeexMode *p_mode;
SpeexCallback callback;
p_sys->p_header = p_header =
speex_packet_to_header( p_oggpacket->packet, p_oggpacket->bytes );
if( !p_header )
{
msg_Err( p_dec, "cannot read Speex header" );
return VLC_EGENERIC;
}
if( p_header->mode >= SPEEX_NB_MODES )
{
msg_Err( p_dec, "mode number %d does not (yet/any longer) exist in "
"this version of libspeex.", p_header->mode );
return VLC_EGENERIC;
}
p_mode = speex_mode_list[p_header->mode];
if( p_header->speex_version_id > 1 )
{
msg_Err( p_dec, "this file was encoded with Speex bit-stream "
"version %d, which I don't know how to decode.",
p_header->speex_version_id );
return VLC_EGENERIC;
}
if( p_mode->bitstream_version < p_header->mode_bitstream_version )
{
msg_Err( p_dec, "file encoded with a newer version of Speex." );
return VLC_EGENERIC;
}
if( p_mode->bitstream_version > p_header->mode_bitstream_version )
{
msg_Err( p_dec, "file encoded with an older version of Speex." );
return VLC_EGENERIC;
}
msg_Dbg( p_dec, "Speex %d Hz audio using %s mode %s%s",
p_header->rate, p_mode->modeName,
( p_header->nb_channels == 1 ) ? " (mono" : " (stereo",
p_header->vbr ? ", VBR)" : ")" );
/* Take care of speex decoder init */
speex_bits_init( &p_sys->bits );
p_sys->p_state = p_state = speex_decoder_init( p_mode );
if( !p_state )
{
msg_Err( p_dec, "decoder initialization failed" );
return VLC_EGENERIC;
}
if( p_header->nb_channels == 2 )
{
SpeexStereoState stereo = SPEEX_STEREO_STATE_INIT;
p_sys->stereo = stereo;
callback.callback_id = SPEEX_INBAND_STEREO;
callback.func = speex_std_stereo_request_handler;
callback.data = &p_sys->stereo;
speex_decoder_ctl( p_state, SPEEX_SET_HANDLER, &callback );
}
/* Setup the format */
p_dec->fmt_out.audio.i_physical_channels =
p_dec->fmt_out.audio.i_original_channels =
pi_channels_maps[p_header->nb_channels];
p_dec->fmt_out.audio.i_channels = p_header->nb_channels;
p_dec->fmt_out.audio.i_rate = p_header->rate;
aout_DateInit( &p_sys->end_date, p_header->rate );
return VLC_SUCCESS;
}
/*****************************************************************************
* ProcessPacket: processes a Speex packet.
*****************************************************************************/
static void *ProcessPacket( decoder_t *p_dec, ogg_packet *p_oggpacket,
block_t **pp_block )
{
decoder_sys_t *p_sys = p_dec->p_sys;
block_t *p_block = *pp_block;
/* Date management */
if( p_block && p_block->i_pts > 0 &&
p_block->i_pts != aout_DateGet( &p_sys->end_date ) )
{
aout_DateSet( &p_sys->end_date, p_block->i_pts );
}
if( !aout_DateGet( &p_sys->end_date ) )
{
/* We've just started the stream, wait for the first PTS. */
if( p_block ) block_Release( p_block );
return NULL;
}
*pp_block = NULL; /* To avoid being fed the same packet again */
if( p_sys->b_packetizer )
{
return SendPacket( p_dec, p_oggpacket, p_block );
}
else
{
aout_buffer_t *p_aout_buffer;
if( p_sys->i_headers >= p_sys->p_header->extra_headers + 2 )
p_aout_buffer = DecodePacket( p_dec, p_oggpacket );
else
p_aout_buffer = NULL; /* Skip headers */
if( p_block )
{
block_Release( p_block );
}
return p_aout_buffer;
}
}
/*****************************************************************************
* DecodePacket: decodes a Speex packet.
*****************************************************************************/
static aout_buffer_t *DecodePacket( decoder_t *p_dec, ogg_packet *p_oggpacket )
{
decoder_sys_t *p_sys = p_dec->p_sys;
if( p_oggpacket->bytes )
{
/* Copy Ogg packet to Speex bitstream */
speex_bits_read_from( &p_sys->bits, p_oggpacket->packet,
p_oggpacket->bytes );
p_sys->i_frame_in_packet = 0;
}
/* Decode one frame at a time */
if( p_sys->i_frame_in_packet < p_sys->p_header->frames_per_packet )
{
aout_buffer_t *p_aout_buffer;
int i_ret;
p_aout_buffer =
p_dec->pf_aout_buffer_new( p_dec, p_sys->p_header->frame_size );
if( !p_aout_buffer )
{
return NULL;
}
i_ret = speex_decode( p_sys->p_state, &p_sys->bits,
(int16_t *)p_aout_buffer->p_buffer );
if( i_ret == -1 )
{
/* End of stream */
return NULL;
}
if( i_ret== -2 )
{
msg_Warn( p_dec, "decoding error: corrupted stream?" );
return NULL;
}
if( speex_bits_remaining( &p_sys->bits ) < 0 )
{
msg_Warn( p_dec, "decoding overflow: corrupted stream?" );
}
if( p_sys->p_header->nb_channels == 2 )
speex_decode_stereo( (int16_t *)p_aout_buffer->p_buffer,
p_sys->p_header->frame_size, &p_sys->stereo );
/* Date management */
p_aout_buffer->start_date = aout_DateGet( &p_sys->end_date );
p_aout_buffer->end_date =
aout_DateIncrement( &p_sys->end_date, p_sys->p_header->frame_size);
p_sys->i_frame_in_packet++;
return p_aout_buffer;
}
else
{
return NULL;
}
}
/*****************************************************************************
* SendPacket: send an ogg packet to the stream output.
*****************************************************************************/
static block_t *SendPacket( decoder_t *p_dec, ogg_packet *p_oggpacket,
block_t *p_block )
{
decoder_sys_t *p_sys = p_dec->p_sys;
/* Date management */
p_block->i_dts = p_block->i_pts = aout_DateGet( &p_sys->end_date );
if( p_sys->i_headers >= p_sys->p_header->extra_headers + 2 )
p_block->i_length =
aout_DateIncrement( &p_sys->end_date,
p_sys->p_header->frame_size ) -
p_block->i_pts;
else
p_block->i_length = 0;
return p_block;
}
/*****************************************************************************
* ParseSpeexComments: FIXME should be done in demuxer
*****************************************************************************/
#define readint(buf, base) (((buf[base+3]<<24)&0xff000000)| \
((buf[base+2]<<16)&0xff0000)| \
((buf[base+1]<<8)&0xff00)| \
(buf[base]&0xff))
static void ParseSpeexComments( decoder_t *p_dec, ogg_packet *p_oggpacket )
{
input_thread_t *p_input = (input_thread_t *)p_dec->p_parent;
decoder_sys_t *p_sys = p_dec->p_sys;
char *p_buf = (char *)p_oggpacket->packet;
const SpeexMode *p_mode;
int i_len;
p_mode = speex_mode_list[p_sys->p_header->mode];
input_Control( p_input, INPUT_ADD_INFO, _("Speex comment"), _("Mode"),
"%s%s", p_mode->modeName,
p_sys->p_header->vbr ? " VBR" : "" );
if( p_oggpacket->bytes < 8 )
{
msg_Warn( p_dec, "invalid/corrupted comments" );
return;
}
i_len = readint( p_buf, 0 ); p_buf += 4;
if( i_len > p_oggpacket->bytes - 4 )
{
msg_Warn( p_dec, "invalid/corrupted comments" );
return;
}
input_Control( p_input, INPUT_ADD_INFO, _("Speex comment"), p_buf, "" );
/* TODO: finish comments parsing */
}
/*****************************************************************************
* CloseDecoder: speex decoder destruction
*****************************************************************************/
static void CloseDecoder( vlc_object_t *p_this )
{
decoder_t * p_dec = (decoder_t *)p_this;
decoder_sys_t *p_sys = p_dec->p_sys;
if( p_sys->p_state )
{
speex_decoder_destroy( p_sys->p_state );
speex_bits_destroy( &p_sys->bits );
}
if( p_sys->p_header ) free( p_sys->p_header );
free( p_sys );
}
/*****************************************************************************
* encoder_sys_t: encoder descriptor
*****************************************************************************/
#define MAX_FRAME_SIZE 2000
#define MAX_FRAME_BYTES 2000
struct encoder_sys_t
{
/*
* Input properties
*/
char *p_buffer;
char p_buffer_out[MAX_FRAME_BYTES];
/*
* Speex properties
*/
SpeexBits bits;
SpeexHeader header;
SpeexStereoState stereo;
void *p_state;
int i_frames_per_packet;
int i_frames_in_packet;
int i_frame_length;
int i_samples_delay;
int i_frame_size;
/*
* Common properties
*/
mtime_t i_pts;
};
/*****************************************************************************
* OpenEncoder: probe the encoder and return score
*****************************************************************************/
static int OpenEncoder( vlc_object_t *p_this )
{
encoder_t *p_enc = (encoder_t *)p_this;
encoder_sys_t *p_sys;
const SpeexMode *p_speex_mode = &speex_nb_mode;
int i_quality, i;
char *pp_header[2];
int pi_header[2];
uint8_t *p_extra;
if( p_enc->fmt_out.i_codec != VLC_FOURCC('s','p','x',' ') &&
!p_enc->b_force )
{
return VLC_EGENERIC;
}
/* Allocate the memory needed to store the decoder's structure */
if( ( p_sys = (encoder_sys_t *)malloc(sizeof(encoder_sys_t)) ) == NULL )
{
msg_Err( p_enc, "out of memory" );
return VLC_EGENERIC;
}
p_enc->p_sys = p_sys;
p_enc->pf_encode_audio = Encode;
p_enc->fmt_in.i_codec = AOUT_FMT_S16_NE;
p_enc->fmt_out.i_codec = VLC_FOURCC('s','p','x',' ');
speex_init_header( &p_sys->header, p_enc->fmt_in.audio.i_rate,
1, p_speex_mode );
p_sys->header.frames_per_packet = 1;
p_sys->header.vbr = 1;
p_sys->header.nb_channels = p_enc->fmt_in.audio.i_channels;
/* Create a new encoder state in narrowband mode */
p_sys->p_state = speex_encoder_init( p_speex_mode );
/* Set the quality to 8 (15 kbps) */
i_quality = 8;
speex_encoder_ctl( p_sys->p_state, SPEEX_SET_QUALITY, &i_quality );
/*Initialization of the structure that holds the bits*/
speex_bits_init( &p_sys->bits );
p_sys->i_frames_in_packet = 0;
p_sys->i_samples_delay = 0;
p_sys->i_pts = 0;
speex_encoder_ctl( p_sys->p_state, SPEEX_GET_FRAME_SIZE,
&p_sys->i_frame_length );
p_sys->i_frame_size = p_sys->i_frame_length *
sizeof(int16_t) * p_enc->fmt_in.audio.i_channels;
p_sys->p_buffer = malloc( p_sys->i_frame_size );
/* Create and store headers */
pp_header[0] = speex_header_to_packet( &p_sys->header, &pi_header[0] );
pp_header[1] = "ENCODER=VLC media player";
pi_header[1] = sizeof("ENCODER=VLC media player");
p_enc->fmt_out.i_extra = 1 + 3 * 2 + pi_header[0] + pi_header[1];
p_extra = p_enc->fmt_out.p_extra = malloc( p_enc->fmt_out.i_extra );
*(p_extra++) = 2; /* number of headers */
for( i = 0; i < 2; i++ )
{
*(p_extra++) = pi_header[i] >> 8;
*(p_extra++) = pi_header[i] & 0xFF;
memcpy( p_extra, pp_header[i], pi_header[i] );
p_extra += pi_header[i];
}
msg_Dbg( p_enc, "encoding: frame size:%d, channels:%d, samplerate:%d",
p_sys->i_frame_size, p_enc->fmt_in.audio.i_channels,
p_enc->fmt_in.audio.i_rate );
return VLC_SUCCESS;
}
/****************************************************************************
* Encode: the whole thing
****************************************************************************
* This function spits out ogg packets.
****************************************************************************/
static block_t *Encode( encoder_t *p_enc, aout_buffer_t *p_aout_buf )
{
encoder_sys_t *p_sys = p_enc->p_sys;
block_t *p_block, *p_chain = NULL;
char *p_buffer = p_aout_buf->p_buffer;
int i_samples = p_aout_buf->i_nb_samples;
int i_samples_delay = p_sys->i_samples_delay;
p_sys->i_pts = p_aout_buf->start_date -
(mtime_t)1000000 * (mtime_t)p_sys->i_samples_delay /
(mtime_t)p_enc->fmt_in.audio.i_rate;
p_sys->i_samples_delay += i_samples;
while( p_sys->i_samples_delay >= p_sys->i_frame_length )
{
int16_t *p_samples;
int i_out;
if( i_samples_delay )
{
/* Take care of the left-over from last time */
int i_delay_size = i_samples_delay * 2 *
p_enc->fmt_in.audio.i_channels;
int i_size = p_sys->i_frame_size - i_delay_size;
p_samples = (int16_t *)p_sys->p_buffer;
memcpy( p_sys->p_buffer + i_delay_size, p_buffer, i_size );
p_buffer -= i_delay_size;
i_samples += i_samples_delay;
i_samples_delay = 0;
}
else
{
p_samples = (int16_t *)p_buffer;
}
/* Encode current frame */
if( p_enc->fmt_in.audio.i_channels == 2 )
speex_encode_stereo( p_samples, p_sys->i_frame_length,
&p_sys->bits );
#if 0
if( p_sys->preprocess )
speex_preprocess( p_sys->preprocess, p_samples, NULL );
#endif
speex_encode( p_sys->p_state, p_samples, &p_sys->bits );
p_buffer += p_sys->i_frame_size;
p_sys->i_samples_delay -= p_sys->i_frame_length;
i_samples -= p_sys->i_frame_length;
p_sys->i_frames_in_packet++;
if( p_sys->i_frames_in_packet < p_sys->header.frames_per_packet )
continue;
p_sys->i_frames_in_packet = 0;
speex_bits_insert_terminator( &p_sys->bits );
i_out = speex_bits_write( &p_sys->bits, p_sys->p_buffer_out,
MAX_FRAME_BYTES );
speex_bits_reset( &p_sys->bits );
p_block = block_New( p_enc, i_out );
memcpy( p_block->p_buffer, p_sys->p_buffer_out, i_out );
p_block->i_length = (mtime_t)1000000 *
(mtime_t)p_sys->i_frame_length * p_sys->header.frames_per_packet /
(mtime_t)p_enc->fmt_in.audio.i_rate;
p_block->i_dts = p_block->i_pts = p_sys->i_pts;
/* Update pts */
p_sys->i_pts += p_block->i_length;
block_ChainAppend( &p_chain, p_block );
}
/* Backup the remaining raw samples */
if( i_samples )
{
memcpy( p_sys->p_buffer + i_samples_delay * 2 *
p_enc->fmt_in.audio.i_channels, p_buffer,
i_samples * 2 * p_enc->fmt_in.audio.i_channels );
}
return p_chain;
}
/*****************************************************************************
* CloseEncoder: encoder destruction
*****************************************************************************/
static void CloseEncoder( vlc_object_t *p_this )
{
encoder_t *p_enc = (encoder_t *)p_this;
encoder_sys_t *p_sys = p_enc->p_sys;
speex_encoder_destroy( p_sys->p_state );
speex_bits_destroy( &p_sys->bits );
if( p_sys->p_buffer ) free( p_sys->p_buffer );
free( p_sys );
}