/*****************************************************************************
- * speex.c: speex decoder/packetizer module making use of libspeex.
+ * speex.c: speex decoder/packetizer/encoder module making use of libspeex.
*****************************************************************************
- * Copyright (C) 1999-2001 VideoLAN
- * $Id: speex.c,v 1.4 2003/11/22 23:39:14 fenrir Exp $
+ * Copyright (C) 2003 VideoLAN
+ * $Id$
*
- * Authors: Gildas Bazin <gbazin@netcourrier.com>
+ * 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
*****************************************************************************/
#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"
+#include <speex/speex.h>
+#include <speex/speex_header.h>
+#include <speex/speex_stereo.h>
+#include <speex/speex_callbacks.h>
/*****************************************************************************
* decoder_sys_t : speex decoder descriptor
static void CloseDecoder ( vlc_object_t * );
static void *DecodeBlock ( decoder_t *, block_t ** );
-static int ProcessHeader ( decoder_t *, ogg_packet * );
+static int ProcessHeaders( decoder_t * );
+static int ProcessInitialHeader ( decoder_t *, ogg_packet * );
static void *ProcessPacket( decoder_t *, ogg_packet *, block_t ** );
static aout_buffer_t *DecodePacket( decoder_t *, ogg_packet * );
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_category( CAT_INPUT );
+ set_subcategory( SUBCAT_INPUT_ACODEC );
+
set_description( _("Speex audio decoder") );
set_capability( "decoder", 100 );
set_callbacks( OpenDecoder, CloseDecoder );
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();
/*****************************************************************************
oggpacket.e_o_s = 0;
oggpacket.packetno = 0;
- if( p_sys->i_headers == 0 )
+ /* Check for headers */
+ if( p_sys->i_headers == 0 && p_dec->fmt_in.i_extra )
+ {
+ /* Headers already available as extra data */
+ p_sys->i_headers = 2;
+ }
+ else if( oggpacket.bytes && p_sys->i_headers < 2 )
{
- /* Take care of the initial Speex header */
- if( ProcessHeader( p_dec, &oggpacket ) != VLC_SUCCESS )
+ /* Backup headers as extra data */
+ uint8_t *p_extra;
+
+ p_dec->fmt_in.p_extra =
+ realloc( p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra +
+ oggpacket.bytes + 2 );
+ p_extra = p_dec->fmt_in.p_extra + p_dec->fmt_in.i_extra;
+ *(p_extra++) = oggpacket.bytes >> 8;
+ *(p_extra++) = oggpacket.bytes & 0xFF;
+
+ memcpy( p_extra, oggpacket.packet, oggpacket.bytes );
+ p_dec->fmt_in.i_extra += oggpacket.bytes + 2;
+
+ block_Release( *pp_block );
+ p_sys->i_headers++;
+ return NULL;
+ }
+
+ if( p_sys->i_headers == 2 )
+ {
+ if( ProcessHeaders( p_dec ) != VLC_SUCCESS )
{
- msg_Err( p_dec, "Initial Speex header is corrupted" );
+ p_sys->i_headers = 0;
+ p_dec->fmt_in.i_extra = 0;
block_Release( *pp_block );
return NULL;
}
+ else p_sys->i_headers++;
+ }
- p_sys->i_headers++;
+ return ProcessPacket( p_dec, &oggpacket, pp_block );
+}
- return ProcessPacket( p_dec, &oggpacket, pp_block );
+/*****************************************************************************
+ * ProcessHeaders: process Speex headers.
+ *****************************************************************************/
+static int ProcessHeaders( decoder_t *p_dec )
+{
+ decoder_sys_t *p_sys = p_dec->p_sys;
+ ogg_packet oggpacket;
+ uint8_t *p_extra;
+ int i_extra;
+
+ if( !p_dec->fmt_in.i_extra ) return VLC_EGENERIC;
+
+ oggpacket.granulepos = -1;
+ oggpacket.b_o_s = 1; /* yes this actually is a b_o_s packet :) */
+ oggpacket.e_o_s = 0;
+ oggpacket.packetno = 0;
+ p_extra = p_dec->fmt_in.p_extra;
+ i_extra = p_dec->fmt_in.i_extra;
+
+ /* Take care of the initial Vorbis header */
+ oggpacket.bytes = *(p_extra++) << 8;
+ oggpacket.bytes |= (*(p_extra++) & 0xFF);
+ oggpacket.packet = p_extra;
+ p_extra += oggpacket.bytes;
+ i_extra -= (oggpacket.bytes + 2);
+ if( i_extra < 0 )
+ {
+ msg_Err( p_dec, "header data corrupted");
+ return VLC_EGENERIC;
}
- if( p_sys->i_headers == 1 )
+ /* Take care of the initial Speex header */
+ if( ProcessInitialHeader( p_dec, &oggpacket ) != VLC_SUCCESS )
{
- /* The next packet in order is the comments header */
- ParseSpeexComments( p_dec, &oggpacket );
- p_sys->i_headers++;
+ msg_Err( p_dec, "initial Speex header is corrupted" );
+ return VLC_EGENERIC;
+ }
- return ProcessPacket( p_dec, &oggpacket, pp_block );
+ /* The next packet in order is the comments header */
+ oggpacket.b_o_s = 0;
+ oggpacket.bytes = *(p_extra++) << 8;
+ oggpacket.bytes |= (*(p_extra++) & 0xFF);
+ oggpacket.packet = p_extra;
+ p_extra += oggpacket.bytes;
+ i_extra -= (oggpacket.bytes + 2);
+ if( i_extra < 0 )
+ {
+ msg_Err( p_dec, "header data corrupted");
+ return VLC_EGENERIC;
}
- return ProcessPacket( p_dec, &oggpacket, pp_block );
+ ParseSpeexComments( p_dec, &oggpacket );
+
+ if( p_sys->b_packetizer )
+ {
+ p_dec->fmt_out.i_extra = p_dec->fmt_in.i_extra;
+ p_dec->fmt_out.p_extra =
+ realloc( p_dec->fmt_out.p_extra, p_dec->fmt_out.i_extra );
+ memcpy( p_dec->fmt_out.p_extra,
+ p_dec->fmt_in.p_extra, p_dec->fmt_out.i_extra );
+ }
+
+ return VLC_SUCCESS;
}
/*****************************************************************************
- * ProcessHeader: processes the inital Speex header packet.
+ * ProcessInitialHeader: processes the inital Speex header packet.
*****************************************************************************/
-static int ProcessHeader( decoder_t *p_dec, ogg_packet *p_oggpacket )
+static int ProcessInitialHeader( decoder_t *p_dec, ogg_packet *p_oggpacket )
{
decoder_sys_t *p_sys = p_dec->p_sys;
void *p_state;
SpeexHeader *p_header;
- SpeexMode *p_mode;
+ 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" );
+ 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 );
+ msg_Err( p_dec, "mode number %d does not (yet/any longer) exist in "
+ "this version of libspeex.", p_header->mode );
return VLC_EGENERIC;
}
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",
+ 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" );
+ 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 )
+ if( p_mode->bitstream_version > p_header->mode_bitstream_version )
{
- msg_Err( p_dec, "File encoded with an older version of Speex" );
+ 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",
+
+ 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)" : ")" );
p_sys->p_state = p_state = speex_decoder_init( p_mode );
if( !p_state )
{
- msg_Err( p_dec, "Decoder initialization failed" );
+ msg_Err( p_dec, "decoder initialization failed" );
return VLC_EGENERIC;
}
else
p_aout_buffer = NULL; /* Skip headers */
- if( p_block )
- {
- block_Release( p_block );
- }
+ if( p_block ) block_Release( p_block );
return 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 ) return NULL; /* End of stream */
+ i_ret = speex_decode_int( 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?" );
+ 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?" );
+ 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 );
+ speex_decode_stereo_int( (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 );
input_thread_t *p_input = (input_thread_t *)p_dec->p_parent;
decoder_sys_t *p_sys = p_dec->p_sys;
- input_info_category_t *p_cat =
- input_InfoCategory( p_input, _("Speex Comment") );
-
char *p_buf = (char *)p_oggpacket->packet;
- SpeexMode *p_mode;
+ const SpeexMode *p_mode;
int i_len;
+ if( p_input->i_object_type != VLC_OBJECT_INPUT ) return;
+
p_mode = speex_mode_list[p_sys->p_header->mode];
- input_AddInfo( p_cat, _("Mode"), "%s%s",
- p_mode->modeName, p_sys->p_header->vbr ? " VBR" : "" );
+
+ 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" );
+ 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" );
+ msg_Warn( p_dec, "invalid/corrupted comments" );
return;
}
- input_AddInfo( p_cat, p_buf, "" );
+ input_Control( p_input, INPUT_ADD_INFO, _("Speex comment"), p_buf, "" );
/* TODO: finish comments parsing */
}
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 = 3 * 2 + pi_header[0] + pi_header[1];
+ p_extra = p_enc->fmt_out.p_extra = malloc( p_enc->fmt_out.i_extra );
+ 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_int( 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_int( 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 );
+}