git.sesse.net Git - vlc/blob - modules/codec/speex.c

   1 /*****************************************************************************
   2  * speex.c: speex decoder/packetizer/encoder module making use of libspeex.
   3  *****************************************************************************
   4  * Copyright (C) 2003-2009 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Gildas Bazin <gbazin@videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <vlc_common.h>
  32 #include <vlc_plugin.h>
  33 #include <vlc_input.h>
  34 #include <vlc_codec.h>
  35 #include <vlc_aout.h>
  36 #include "../demux/xiph.h"
  37
  38 #include <ogg/ogg.h>
  39 #include <speex/speex.h>
  40 #include <speex/speex_header.h>
  41 #include <speex/speex_stereo.h>
  42 #include <speex/speex_callbacks.h>
  43
  44 #include <assert.h>
  45
  46 /*****************************************************************************
  47  * Module descriptor
  48  *****************************************************************************/
  49 static int  OpenDecoder   ( vlc_object_t * );
  50 static int  OpenPacketizer( vlc_object_t * );
  51 static void CloseDecoder  ( vlc_object_t * );
  52 static int OpenEncoder   ( vlc_object_t * );
  53 static void CloseEncoder ( vlc_object_t * );
  54
  55 #define ENC_CFG_PREFIX "sout-speex-"
  56
  57 #define ENC_MODE_TEXT N_("Mode" )
  58 #define ENC_MODE_LONGTEXT N_( \
  59     "Enforce the mode of the encoder." )
  60
  61 #define ENC_QUALITY_TEXT N_("Encoding quality")
  62 #define ENC_QUALITY_LONGTEXT N_( \
  63     "Enforce a quality between 0 (low) and 10 (high)." )
  64
  65 #define ENC_COMPLEXITY_TEXT N_("Encoding complexity" )
  66 #define ENC_COMPLEXITY_LONGTEXT N_( \
  67     "Enforce the complexity of the encoder." )
  68
  69 #define ENC_MAXBITRATE_TEXT N_( "Maximal bitrate" )
  70 #define ENC_MAXBITRATE_LONGTEXT N_( \
  71     "Enforce the maximal VBR bitrate" )
  72
  73 #define ENC_CBR_TEXT N_( "CBR encoding" )
  74 #define ENC_CBR_LONGTEXT N_( \
  75     "Enforce a constant bitrate encoding (CBR) instead of default " \
  76     "variable bitrate encoding (VBR)." )
  77
  78 #define ENC_VAD_TEXT N_( "Voice activity detection" )
  79 #define ENC_VAD_LONGTEXT N_( \
  80     "Enable voice activity detection (VAD). It is automatically " \
  81     "activated in VBR mode." )
  82
  83 #define ENC_DTX_TEXT N_( "Discontinuous Transmission" )
  84 #define ENC_DTX_LONGTEXT N_( \
  85     "Enable discontinuous transmission (DTX)." )
  86
  87 static const int pi_enc_mode_values[] = { 0, 1, 2 };
  88 static const char * const ppsz_enc_mode_descriptions[] = {
  89     N_("Narrow-band (8kHz)"), N_("Wide-band (16kHz)"), N_("Ultra-wideband (32kHz)"), NULL
  90 };
  91
  92 vlc_module_begin ()
  93     set_category( CAT_INPUT )
  94     set_subcategory( SUBCAT_INPUT_ACODEC )
  95
  96     set_description( N_("Speex audio decoder") )
  97     set_capability( "decoder", 100 )
  98     set_shortname( N_("Speex") )
  99     set_callbacks( OpenDecoder, CloseDecoder )
 100
 101     add_submodule ()
 102     set_description( N_("Speex audio packetizer") )
 103     set_capability( "packetizer", 100 )
 104     set_callbacks( OpenPacketizer, CloseDecoder )
 105
 106     add_submodule ()
 107     set_description( N_("Speex audio encoder") )
 108     set_capability( "encoder", 100 )
 109     set_callbacks( OpenEncoder, CloseEncoder )
 110
 111     add_integer( ENC_CFG_PREFIX "mode", 0, ENC_MODE_TEXT,
 112                  ENC_MODE_LONGTEXT, false )
 113         change_integer_list( pi_enc_mode_values, ppsz_enc_mode_descriptions )
 114
 115     add_integer( ENC_CFG_PREFIX "complexity", 3, ENC_COMPLEXITY_TEXT,
 116                  ENC_COMPLEXITY_LONGTEXT, false )
 117         change_integer_range( 1, 10 )
 118
 119     add_bool( ENC_CFG_PREFIX "cbr", false, ENC_CBR_TEXT,
 120                  ENC_CBR_LONGTEXT, false )
 121
 122     add_float( ENC_CFG_PREFIX "quality", 8.0, ENC_QUALITY_TEXT,
 123                ENC_QUALITY_LONGTEXT, false )
 124         change_float_range( 0.0, 10.0 )
 125
 126     add_integer( ENC_CFG_PREFIX "max-bitrate", 0, ENC_MAXBITRATE_TEXT,
 127                  ENC_MAXBITRATE_LONGTEXT, false )
 128
 129     add_bool( ENC_CFG_PREFIX "vad", true, ENC_VAD_TEXT,
 130                  ENC_VAD_LONGTEXT, false )
 131
 132     add_bool( ENC_CFG_PREFIX "dtx", false, ENC_DTX_TEXT,
 133                  ENC_DTX_LONGTEXT, false )
 134
 135     /* TODO agc, noise suppression, */
 136
 137 vlc_module_end ()
 138
 139 static const char *const ppsz_enc_options[] = {
 140     "mode", "complexity", "cbr", "quality", "max-bitrate", "vad", "dtx", NULL
 141 };
 142
 143 /*****************************************************************************
 144  * decoder_sys_t : speex decoder descriptor
 145  *****************************************************************************/
 146 struct decoder_sys_t
 147 {
 148     /* Module mode */
 149     bool b_packetizer;
 150
 151     /*
 152      * Input properties
 153      */
 154     bool b_has_headers;
 155     int i_frame_in_packet;
 156
 157     /*
 158      * Speex properties
 159      */
 160     SpeexBits bits;
 161     SpeexHeader *p_header;
 162     SpeexStereoState stereo;
 163     void *p_state;
 164     unsigned int rtp_rate;
 165
 166     /*
 167      * Common properties
 168      */
 169     date_t end_date;
 170
 171 };
 172
 173 static const int pi_channels_maps[6] =
 174 {
 175     0,
 176     AOUT_CHAN_CENTER,   AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
 177     AOUT_CHAN_CENTER | AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
 178     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARLEFT
 179      | AOUT_CHAN_REARRIGHT,
 180     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
 181      | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT
 182 };
 183
 184 /****************************************************************************
 185  * Local prototypes
 186  ****************************************************************************/
 187
 188 static block_t *DecodeBlock  ( decoder_t *, block_t ** );
 189 static aout_buffer_t *DecodeRtpSpeexPacket( decoder_t *, block_t **);
 190 static int  ProcessHeaders( decoder_t * );
 191 static int  ProcessInitialHeader ( decoder_t *, ogg_packet * );
 192 static void *ProcessPacket( decoder_t *, ogg_packet *, block_t ** );
 193
 194 static aout_buffer_t *DecodePacket( decoder_t *, ogg_packet * );
 195 static block_t *SendPacket( decoder_t *, block_t * );
 196
 197 static void ParseSpeexComments( decoder_t *, ogg_packet * );
 198
 199 static block_t *Encode   ( encoder_t *, aout_buffer_t * );
 200
 201 /*****************************************************************************
 202  * OpenDecoder: probe the decoder and return score
 203  *****************************************************************************/
 204 static int OpenDecoder( vlc_object_t *p_this )
 205 {
 206     decoder_t *p_dec = (decoder_t*)p_this;
 207     decoder_sys_t *p_sys;
 208
 209     if( p_dec->fmt_in.i_codec != VLC_CODEC_SPEEX )
 210         return VLC_EGENERIC;
 211
 212     /* Allocate the memory needed to store the decoder's structure */
 213     if( ( p_dec->p_sys = p_sys = malloc(sizeof(decoder_sys_t)) ) == NULL )
 214         return VLC_ENOMEM;
 215     p_dec->p_sys->bits.buf_size = 0;
 216     p_dec->p_sys->b_packetizer = false;
 217     p_dec->p_sys->rtp_rate = p_dec->fmt_in.audio.i_rate;
 218     p_dec->p_sys->b_has_headers = false;
 219
 220     date_Set( &p_sys->end_date, 0 );
 221
 222     /* Set output properties */
 223     p_dec->fmt_out.i_cat = AUDIO_ES;
 224     p_dec->fmt_out.i_codec = VLC_CODEC_S16N;
 225
 226     /*
 227       Set callbacks
 228       If the codec is spxr then this decoder is
 229       being invoked on a Speex stream arriving via RTP.
 230       A special decoder callback is used.
 231     */
 232     if (p_dec->fmt_in.i_original_fourcc == VLC_FOURCC('s', 'p', 'x', 'r'))
 233     {
 234         msg_Dbg( p_dec, "Using RTP version of Speex decoder @ rate %d.",
 235             p_dec->fmt_in.audio.i_rate );
 236         p_dec->pf_decode_audio = DecodeRtpSpeexPacket;
 237     }
 238     else
 239     {
 240         p_dec->pf_decode_audio = DecodeBlock;
 241     }
 242     p_dec->pf_packetize    = DecodeBlock;
 243
 244     p_sys->p_state = NULL;
 245     p_sys->p_header = NULL;
 246     p_sys->i_frame_in_packet = 0;
 247
 248     return VLC_SUCCESS;
 249 }
 250
 251 static int OpenPacketizer( vlc_object_t *p_this )
 252 {
 253     decoder_t *p_dec = (decoder_t*)p_this;
 254
 255     int i_ret = OpenDecoder( p_this );
 256
 257     if( i_ret == VLC_SUCCESS )
 258     {
 259         p_dec->p_sys->b_packetizer = true;
 260         p_dec->fmt_out.i_codec = VLC_CODEC_SPEEX;
 261     }
 262
 263     return i_ret;
 264 }
 265
 266 /****************************************************************************
 267  * DecodeBlock: the whole thing
 268  ****************************************************************************
 269  * This function must be fed with ogg packets.
 270  ****************************************************************************/
 271 static block_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
 272 {
 273     decoder_sys_t *p_sys = p_dec->p_sys;
 274     ogg_packet oggpacket;
 275
 276     if( !pp_block ) return NULL;
 277
 278     if( *pp_block )
 279     {
 280         /* Block to Ogg packet */
 281         oggpacket.packet = (*pp_block)->p_buffer;
 282         oggpacket.bytes = (*pp_block)->i_buffer;
 283     }
 284     else
 285     {
 286         if( p_sys->b_packetizer ) return NULL;
 287
 288         /* Block to Ogg packet */
 289         oggpacket.packet = NULL;
 290         oggpacket.bytes = 0;
 291     }
 292
 293     oggpacket.granulepos = -1;
 294     oggpacket.b_o_s = 0;
 295     oggpacket.e_o_s = 0;
 296     oggpacket.packetno = 0;
 297
 298     /* Check for headers */
 299     if( !p_sys->b_has_headers )
 300     {
 301         if( ProcessHeaders( p_dec ) )
 302         {
 303             block_Release( *pp_block );
 304             return NULL;
 305         }
 306         p_sys->b_has_headers = true;
 307     }
 308
 309     return ProcessPacket( p_dec, &oggpacket, pp_block );
 310 }
 311
 312 /*****************************************************************************
 313  * ProcessHeaders: process Speex headers.
 314  *****************************************************************************/
 315 static int ProcessHeaders( decoder_t *p_dec )
 316 {
 317     decoder_sys_t *p_sys = p_dec->p_sys;
 318     ogg_packet oggpacket;
 319
 320     unsigned pi_size[XIPH_MAX_HEADER_COUNT];
 321     void     *pp_data[XIPH_MAX_HEADER_COUNT];
 322     unsigned i_count;
 323     if( xiph_SplitHeaders( pi_size, pp_data, &i_count,
 324                            p_dec->fmt_in.i_extra, p_dec->fmt_in.p_extra) )
 325         return VLC_EGENERIC;
 326     if( i_count < 2 )
 327         goto error;
 328
 329     oggpacket.granulepos = -1;
 330     oggpacket.e_o_s = 0;
 331     oggpacket.packetno = 0;
 332
 333     /* Take care of the initial Vorbis header */
 334     oggpacket.b_o_s = 1; /* yes this actually is a b_o_s packet :) */
 335     oggpacket.bytes  = pi_size[0];
 336     oggpacket.packet = pp_data[0];
 337     if( ProcessInitialHeader( p_dec, &oggpacket ) != VLC_SUCCESS )
 338     {
 339         msg_Err( p_dec, "initial Speex header is corrupted" );
 340         goto error;
 341     }
 342
 343     /* The next packet in order is the comments header */
 344     oggpacket.b_o_s = 0;
 345     oggpacket.bytes  = pi_size[1];
 346     oggpacket.packet = pp_data[1];
 347     ParseSpeexComments( p_dec, &oggpacket );
 348
 349     if( p_sys->b_packetizer )
 350     {
 351         p_dec->fmt_out.i_extra = p_dec->fmt_in.i_extra;
 352         p_dec->fmt_out.p_extra = xrealloc( p_dec->fmt_out.p_extra,
 353                                                   p_dec->fmt_out.i_extra );
 354         memcpy( p_dec->fmt_out.p_extra,
 355                 p_dec->fmt_in.p_extra, p_dec->fmt_out.i_extra );
 356     }
 357
 358     for( unsigned i = 0; i < i_count; i++ )
 359         free( pp_data[i] );
 360     return VLC_SUCCESS;
 361
 362 error:
 363     for( unsigned i = 0; i < i_count; i++ )
 364         free( pp_data[i] );
 365     return VLC_EGENERIC;
 366 }
 367
 368 /*****************************************************************************
 369  * ProcessInitialHeader: processes the inital Speex header packet.
 370  *****************************************************************************/
 371 static int ProcessInitialHeader( decoder_t *p_dec, ogg_packet *p_oggpacket )
 372 {
 373     decoder_sys_t *p_sys = p_dec->p_sys;
 374
 375     void *p_state;
 376     SpeexHeader *p_header;
 377     const SpeexMode *p_mode;
 378     SpeexCallback callback;
 379
 380     p_sys->p_header = p_header =
 381         speex_packet_to_header( (char *)p_oggpacket->packet,
 382                                 p_oggpacket->bytes );
 383     if( !p_header )
 384     {
 385         msg_Err( p_dec, "cannot read Speex header" );
 386         return VLC_EGENERIC;
 387     }
 388     if( p_header->mode >= SPEEX_NB_MODES || p_header->mode < 0 )
 389     {
 390         msg_Err( p_dec, "mode number %d does not (yet/any longer) exist in "
 391                  "this version of libspeex.", p_header->mode );
 392         return VLC_EGENERIC;
 393     }
 394
 395     p_mode = speex_mode_list[p_header->mode];
 396     if( p_mode == NULL )
 397         return VLC_EGENERIC;
 398
 399     if( p_header->speex_version_id > 1 )
 400     {
 401         msg_Err( p_dec, "this file was encoded with Speex bit-stream "
 402                  "version %d which is not supported by this decoder.",
 403                  p_header->speex_version_id );
 404         return VLC_EGENERIC;
 405     }
 406
 407     if( p_mode->bitstream_version < p_header->mode_bitstream_version )
 408     {
 409         msg_Err( p_dec, "file encoded with a newer version of Speex." );
 410         return VLC_EGENERIC;
 411     }
 412     if( p_mode->bitstream_version > p_header->mode_bitstream_version )
 413     {
 414         msg_Err( p_dec, "file encoded with an older version of Speex." );
 415         return VLC_EGENERIC;
 416     }
 417
 418     msg_Dbg( p_dec, "Speex %d Hz audio using %s mode %s%s",
 419              p_header->rate, p_mode->modeName,
 420              ( p_header->nb_channels == 1 ) ? " (mono" : " (stereo",
 421              p_header->vbr ? ", VBR)" : ")" );
 422
 423     /* Take care of speex decoder init */
 424     speex_bits_init( &p_sys->bits );
 425     p_sys->p_state = p_state = speex_decoder_init( p_mode );
 426     if( !p_state )
 427     {
 428         msg_Err( p_dec, "decoder initialization failed" );
 429         return VLC_EGENERIC;
 430     }
 431
 432     if( p_header->nb_channels == 2 )
 433     {
 434         SpeexStereoState stereo = SPEEX_STEREO_STATE_INIT;
 435         p_sys->stereo = stereo;
 436         callback.callback_id = SPEEX_INBAND_STEREO;
 437         callback.func = speex_std_stereo_request_handler;
 438         callback.data = &p_sys->stereo;
 439         speex_decoder_ctl( p_state, SPEEX_SET_HANDLER, &callback );
 440     }
 441     if( p_header->nb_channels <= 0 ||
 442         p_header->nb_channels > 5 )
 443     {
 444         msg_Err( p_dec, "invalid number of channels (not between 1 and 5): %i",
 445                  p_header->nb_channels );
 446         return VLC_EGENERIC;
 447     }
 448
 449     /* Setup the format */
 450     p_dec->fmt_out.audio.i_physical_channels =
 451         p_dec->fmt_out.audio.i_original_channels =
 452             pi_channels_maps[p_header->nb_channels];
 453     p_dec->fmt_out.audio.i_channels = p_header->nb_channels;
 454     p_dec->fmt_out.audio.i_rate = p_header->rate;
 455
 456     date_Init( &p_sys->end_date, p_header->rate, 1 );
 457
 458     return VLC_SUCCESS;
 459 }
 460
 461 /*****************************************************************************
 462  * ProcessPacket: processes a Speex packet.
 463  *****************************************************************************/
 464 static void *ProcessPacket( decoder_t *p_dec, ogg_packet *p_oggpacket,
 465                             block_t **pp_block )
 466 {
 467     decoder_sys_t *p_sys = p_dec->p_sys;
 468     block_t *p_block = *pp_block;
 469
 470     /* Date management */
 471     if( p_block && p_block->i_pts > VLC_TS_INVALID &&
 472         p_block->i_pts != date_Get( &p_sys->end_date ) )
 473     {
 474         date_Set( &p_sys->end_date, p_block->i_pts );
 475     }
 476
 477     if( !date_Get( &p_sys->end_date ) )
 478     {
 479         /* We've just started the stream, wait for the first PTS. */
 480         if( p_block ) block_Release( p_block );
 481         return NULL;
 482     }
 483
 484     *pp_block = NULL; /* To avoid being fed the same packet again */
 485
 486     if( p_sys->b_packetizer )
 487     {
 488         if ( p_sys->p_header->frames_per_packet > 1 )
 489         {
 490             short *p_frame_holder = NULL;
 491             int i_bits_before = 0, i_bits_after = 0, i_bytes_in_speex_frame = 0,
 492                 i_pcm_output_size = 0, i_bits_in_speex_frame = 0;
 493             block_t *p_new_block = NULL;
 494
 495             i_pcm_output_size = p_sys->p_header->frame_size;
 496             p_frame_holder = (short*)xmalloc( sizeof(short)*i_pcm_output_size );
 497
 498             speex_bits_read_from( &p_sys->bits, (char*)p_oggpacket->packet,
 499                 p_oggpacket->bytes);
 500             i_bits_before = speex_bits_remaining( &p_sys->bits );
 501             speex_decode_int(p_sys->p_state, &p_sys->bits, p_frame_holder);
 502             i_bits_after = speex_bits_remaining( &p_sys->bits );
 503
 504             i_bits_in_speex_frame = i_bits_before - i_bits_after;
 505             i_bytes_in_speex_frame = ( i_bits_in_speex_frame +
 506                 (8 - (i_bits_in_speex_frame % 8)) )
 507                 / 8;
 508
 509             p_new_block = block_New( p_dec, i_bytes_in_speex_frame );
 510             memset( p_new_block->p_buffer, 0xff, i_bytes_in_speex_frame );
 511
 512             /*
 513              * Copy the first frame in this packet to a new packet.
 514              */
 515             speex_bits_rewind( &p_sys->bits );
 516             speex_bits_write( &p_sys->bits,
 517                 (char*)p_new_block->p_buffer,
 518                     (int)i_bytes_in_speex_frame );
 519
 520             /*
 521              * Move the remaining part of the original packet (subsequent
 522              * frames, if there are any) into the beginning
 523              * of the original packet so
 524              * they are preserved following the realloc.
 525              * Note: Any bits that
 526              * remain in the initial packet
 527              * are "filler" if they do not constitute
 528              * an entire byte.
 529              */
 530             if ( i_bits_after > 7 )
 531             {
 532                 /* round-down since we rounded-up earlier (to include
 533                  * the speex terminator code.
 534                  */
 535                 i_bytes_in_speex_frame--;
 536                 speex_bits_write( &p_sys->bits,
 537                         (char*)p_block->p_buffer,
 538                         p_block->i_buffer - i_bytes_in_speex_frame );
 539             p_block = block_Realloc( p_block,
 540                     0,
 541                         p_block->i_buffer-i_bytes_in_speex_frame );
 542                 *pp_block = p_block;
 543             }
 544             else
 545             {
 546                 speex_bits_reset( &p_sys->bits );
 547             }
 548
 549             free( p_frame_holder );
 550             return SendPacket( p_dec, p_new_block);
 551         }
 552         else
 553         {
 554             return SendPacket( p_dec, p_block );
 555         }
 556     }
 557     else
 558     {
 559         aout_buffer_t *p_aout_buffer = DecodePacket( p_dec, p_oggpacket );
 560
 561         if( p_block )
 562             block_Release( p_block );
 563         return p_aout_buffer;
 564     }
 565 }
 566
 567 static aout_buffer_t *DecodeRtpSpeexPacket( decoder_t *p_dec, block_t **pp_block )
 568 {
 569     block_t *p_speex_bit_block = *pp_block;
 570     decoder_sys_t *p_sys = p_dec->p_sys;
 571     aout_buffer_t *p_aout_buffer;
 572     int i_decode_ret;
 573     unsigned int i_speex_frame_size;
 574
 575     if ( !p_speex_bit_block || p_speex_bit_block->i_pts <= VLC_TS_INVALID )
 576         return NULL;
 577
 578     /*
 579       If the SpeexBits buffer size is 0 (a default value),
 580       we know that a proper initialization has not yet been done.
 581     */
 582     if ( p_sys->bits.buf_size==0 )
 583     {
 584         p_sys->p_header = (SpeexHeader *)malloc(sizeof(SpeexHeader));
 585         if ( !p_sys->p_header )
 586         {
 587             msg_Err( p_dec, "Could not allocate a Speex header.");
 588             return NULL;
 589         }
 590         speex_init_header( p_sys->p_header,p_sys->rtp_rate,1,&speex_nb_mode );
 591         speex_bits_init( &p_sys->bits );
 592         p_sys->p_state = speex_decoder_init( &speex_nb_mode );
 593         if ( !p_sys->p_state )
 594         {
 595             msg_Err( p_dec, "Could not allocate a Speex decoder." );
 596             free( p_sys->p_header );
 597             return NULL;
 598         }
 599
 600         /*
 601           Assume that variable bit rate is enabled. Also assume
 602           that there is only one frame per packet.
 603         */
 604         p_sys->p_header->vbr = 1;
 605         p_sys->p_header->frames_per_packet = 1;
 606
 607         p_dec->fmt_out.audio.i_channels = p_sys->p_header->nb_channels;
 608         p_dec->fmt_out.audio.i_physical_channels =
 609         p_dec->fmt_out.audio.i_original_channels =
 610             pi_channels_maps[p_sys->p_header->nb_channels];
 611         p_dec->fmt_out.audio.i_rate = p_sys->p_header->rate;
 612
 613         if ( speex_mode_query( &speex_nb_mode,
 614             SPEEX_MODE_FRAME_SIZE,
 615             &i_speex_frame_size ) )
 616         {
 617             msg_Err( p_dec, "Could not determine the frame size." );
 618             speex_decoder_destroy( p_sys->p_state );
 619             free( p_sys->p_header );
 620             return NULL;
 621         }
 622         p_dec->fmt_out.audio.i_bytes_per_frame = i_speex_frame_size;
 623
 624         date_Init(&p_sys->end_date, p_sys->p_header->rate, 1);
 625     }
 626
 627     /*
 628       If the SpeexBits are initialized but there is
 629       still no header, an error must be thrown.
 630     */
 631     if ( !p_sys->p_header )
 632     {
 633         msg_Err( p_dec, "There is no valid Speex header found." );
 634         return NULL;
 635     }
 636     *pp_block = NULL;
 637
 638     if ( !date_Get( &p_sys->end_date ) )
 639         date_Set( &p_sys->end_date, p_speex_bit_block->i_dts );
 640
 641     /*
 642       Ask for a new audio output buffer and make sure
 643       we get one.
 644     */
 645     p_aout_buffer = decoder_NewAudioBuffer( p_dec,
 646         p_sys->p_header->frame_size );
 647     if ( !p_aout_buffer || p_aout_buffer->i_buffer == 0 )
 648     {
 649         msg_Err(p_dec, "Oops: No new buffer was returned!");
 650         return NULL;
 651     }
 652
 653     /*
 654       Read the Speex payload into the SpeexBits buffer.
 655     */
 656     speex_bits_read_from( &p_sys->bits,
 657         (char*)p_speex_bit_block->p_buffer,
 658         p_speex_bit_block->i_buffer );
 659
 660     /*
 661       Decode the input and ensure that no errors
 662       were encountered.
 663     */
 664     i_decode_ret = speex_decode_int( p_sys->p_state, &p_sys->bits,
 665             (int16_t*)p_aout_buffer->p_buffer );
 666     if ( i_decode_ret < 0 )
 667     {
 668         msg_Err( p_dec, "Decoding failed. Perhaps we have a bad stream?" );
 669         return NULL;
 670     }
 671
 672     /*
 673       Handle date management on the audio output buffer.
 674     */
 675     p_aout_buffer->i_pts = date_Get( &p_sys->end_date );
 676     p_aout_buffer->i_length = date_Increment( &p_sys->end_date,
 677         p_sys->p_header->frame_size ) - p_aout_buffer->i_pts;
 678
 679
 680     p_sys->i_frame_in_packet++;
 681     block_Release( p_speex_bit_block );
 682
 683     return p_aout_buffer;
 684 }
 685
 686 /*****************************************************************************
 687  * DecodePacket: decodes a Speex packet.
 688  *****************************************************************************/
 689 static aout_buffer_t *DecodePacket( decoder_t *p_dec, ogg_packet *p_oggpacket )
 690 {
 691     decoder_sys_t *p_sys = p_dec->p_sys;
 692
 693     if( p_oggpacket->bytes )
 694     {
 695         /* Copy Ogg packet to Speex bitstream */
 696         speex_bits_read_from( &p_sys->bits, (char *)p_oggpacket->packet,
 697                               p_oggpacket->bytes );
 698         p_sys->i_frame_in_packet = 0;
 699     }
 700
 701     /* Decode one frame at a time */
 702     if( p_sys->i_frame_in_packet < p_sys->p_header->frames_per_packet )
 703     {
 704         aout_buffer_t *p_aout_buffer;
 705         if( p_sys->p_header->frame_size == 0 )
 706             return NULL;
 707
 708         p_aout_buffer =
 709             decoder_NewAudioBuffer( p_dec, p_sys->p_header->frame_size );
 710         if( !p_aout_buffer )
 711         {
 712             return NULL;
 713         }
 714
 715         switch( speex_decode_int( p_sys->p_state, &p_sys->bits,
 716                                   (int16_t *)p_aout_buffer->p_buffer ) )
 717         {
 718             case -2:
 719                 msg_Err( p_dec, "decoding error: corrupted stream?" );
 720             case -1: /* End of stream */
 721                 return NULL;
 722         }
 723
 724         if( speex_bits_remaining( &p_sys->bits ) < 0 )
 725         {
 726             msg_Err( p_dec, "decoding overflow: corrupted stream?" );
 727         }
 728
 729         if( p_sys->p_header->nb_channels == 2 )
 730             speex_decode_stereo_int( (int16_t *)p_aout_buffer->p_buffer,
 731                                      p_sys->p_header->frame_size,
 732                                      &p_sys->stereo );
 733
 734         /* Date management */
 735         p_aout_buffer->i_pts = date_Get( &p_sys->end_date );
 736         p_aout_buffer->i_length =
 737             date_Increment( &p_sys->end_date, p_sys->p_header->frame_size )
 738             - p_aout_buffer->i_pts;
 739
 740         p_sys->i_frame_in_packet++;
 741
 742         return p_aout_buffer;
 743     }
 744     else
 745     {
 746         return NULL;
 747     }
 748 }
 749
 750 /*****************************************************************************
 751  * SendPacket: send an ogg packet to the stream output.
 752  *****************************************************************************/
 753 static block_t *SendPacket( decoder_t *p_dec, block_t *p_block )
 754 {
 755     decoder_sys_t *p_sys = p_dec->p_sys;
 756
 757     /* Date management */
 758     p_block->i_dts = p_block->i_pts = date_Get( &p_sys->end_date );
 759
 760     p_block->i_length =
 761         date_Increment( &p_sys->end_date,
 762                             p_sys->p_header->frame_size ) -
 763         p_block->i_pts;
 764
 765     return p_block;
 766 }
 767
 768 /*****************************************************************************
 769  * ParseSpeexComments:
 770  *****************************************************************************/
 771 #define readint(buf, base) (((buf[base+3]<<24)&0xff000000)| \
 772                            ((buf[base+2]<<16)&0xff0000)| \
 773                            ((buf[base+1]<<8)&0xff00)| \
 774                             (buf[base]&0xff))
 775
 776 static void ParseSpeexComments( decoder_t *p_dec, ogg_packet *p_oggpacket )
 777 {
 778     decoder_sys_t *p_sys = p_dec->p_sys;
 779     const SpeexMode *p_mode;
 780
 781     assert( p_sys->p_header->mode < SPEEX_NB_MODES );
 782
 783     p_mode = speex_mode_list[p_sys->p_header->mode];
 784     assert( p_mode != NULL );
 785
 786     if( !p_dec->p_description )
 787     {
 788         p_dec->p_description = vlc_meta_New();
 789         if( !p_dec->p_description )
 790             return;
 791     }
 792
 793     /* */
 794     char *psz_mode;
 795     if( asprintf( &psz_mode, "%s%s", p_mode->modeName, p_sys->p_header->vbr ? " VBR" : "" ) >= 0 )
 796     {
 797         vlc_meta_AddExtra( p_dec->p_description, _("Mode"), psz_mode );
 798         free( psz_mode );
 799     }
 800
 801     /* TODO: finish comments parsing */
 802     VLC_UNUSED( p_oggpacket );
 803 }
 804
 805 /*****************************************************************************
 806  * CloseDecoder: speex decoder destruction
 807  *****************************************************************************/
 808 static void CloseDecoder( vlc_object_t *p_this )
 809 {
 810     decoder_t * p_dec = (decoder_t *)p_this;
 811     decoder_sys_t *p_sys = p_dec->p_sys;
 812
 813     if( p_sys->p_state )
 814     {
 815         speex_decoder_destroy( p_sys->p_state );
 816         speex_bits_destroy( &p_sys->bits );
 817     }
 818
 819     free( p_sys->p_header );
 820     free( p_sys );
 821 }
 822
 823 /*****************************************************************************
 824  * encoder_sys_t: encoder descriptor
 825  *****************************************************************************/
 826 #define MAX_FRAME_SIZE  2000
 827 #define MAX_FRAME_BYTES 2000
 828
 829 struct encoder_sys_t
 830 {
 831     /*
 832      * Input properties
 833      */
 834     char *p_buffer;
 835     char p_buffer_out[MAX_FRAME_BYTES];
 836
 837     /*
 838      * Speex properties
 839      */
 840     SpeexBits bits;
 841     SpeexHeader header;
 842     SpeexStereoState stereo;
 843     void *p_state;
 844
 845     int i_frames_per_packet;
 846     int i_frames_in_packet;
 847
 848     int i_frame_length;
 849     int i_samples_delay;
 850     int i_frame_size;
 851 };
 852
 853 /*****************************************************************************
 854  * OpenEncoder: probe the encoder and return score
 855  *****************************************************************************/
 856 static int OpenEncoder( vlc_object_t *p_this )
 857 {
 858     encoder_t *p_enc = (encoder_t *)p_this;
 859     encoder_sys_t *p_sys;
 860     const SpeexMode *p_speex_mode = &speex_nb_mode;
 861     int i_tmp, i;
 862     const char *pp_header[2];
 863     int pi_header[2];
 864     uint8_t *p_extra;
 865
 866     if( p_enc->fmt_out.i_codec != VLC_CODEC_SPEEX &&
 867         !p_enc->b_force )
 868     {
 869         return VLC_EGENERIC;
 870     }
 871
 872     config_ChainParse( p_enc, ENC_CFG_PREFIX, ppsz_enc_options, p_enc->p_cfg );
 873     switch( var_GetInteger( p_enc, ENC_CFG_PREFIX "mode" ) )
 874     {
 875     case 1:
 876         msg_Dbg( p_enc, "Using wideband" );
 877         p_speex_mode = &speex_wb_mode;
 878         break;
 879     case 2:
 880         msg_Dbg( p_enc, "Using ultra-wideband" );
 881         p_speex_mode = &speex_uwb_mode;
 882         break;
 883     default:
 884         msg_Dbg( p_enc, "Using narrowband" );
 885         p_speex_mode = &speex_nb_mode;
 886         break;
 887     }
 888
 889     /* Allocate the memory needed to store the decoder's structure */
 890     if( ( p_sys = (encoder_sys_t *)malloc(sizeof(encoder_sys_t)) ) == NULL )
 891         return VLC_ENOMEM;
 892     p_enc->p_sys = p_sys;
 893     p_enc->pf_encode_audio = Encode;
 894     p_enc->fmt_in.i_codec = VLC_CODEC_S16N;
 895     p_enc->fmt_out.i_codec = VLC_CODEC_SPEEX;
 896
 897     speex_init_header( &p_sys->header, p_enc->fmt_in.audio.i_rate,
 898                        1, p_speex_mode );
 899
 900     p_sys->header.frames_per_packet = 1;
 901     p_sys->header.vbr = var_GetBool( p_enc, ENC_CFG_PREFIX "cbr" ) ? 0 : 1;
 902     p_sys->header.nb_channels = p_enc->fmt_in.audio.i_channels;
 903
 904     /* Create a new encoder state in narrowband mode */
 905     p_sys->p_state = speex_encoder_init( p_speex_mode );
 906
 907     /* Parameters */
 908     i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX "complexity" );
 909     speex_encoder_ctl( p_sys->p_state, SPEEX_SET_COMPLEXITY, &i_tmp );
 910
 911     i_tmp = var_GetBool( p_enc, ENC_CFG_PREFIX "cbr" ) ? 0 : 1;
 912     speex_encoder_ctl( p_sys->p_state, SPEEX_SET_VBR, &i_tmp );
 913
 914     if( i_tmp == 0 ) /* CBR */
 915     {
 916         i_tmp = var_GetFloat( p_enc, ENC_CFG_PREFIX "quality" );
 917         speex_encoder_ctl( p_sys->p_state, SPEEX_SET_QUALITY, &i_tmp );
 918
 919         i_tmp = var_GetBool( p_enc, ENC_CFG_PREFIX "vad" ) ? 1 : 0;
 920         speex_encoder_ctl( p_sys->p_state, SPEEX_SET_VAD, &i_tmp );
 921     }
 922     else
 923     {
 924         float f_tmp;
 925
 926         f_tmp = var_GetFloat( p_enc, ENC_CFG_PREFIX "quality" );
 927         speex_encoder_ctl( p_sys->p_state, SPEEX_SET_VBR_QUALITY, &f_tmp );
 928
 929         i_tmp = var_GetInteger( p_enc, ENC_CFG_PREFIX "max-bitrate" );
 930         if( i_tmp > 0 )
 931 #ifdef SPEEX_SET_VBR_MAX_BITRATE
 932             speex_encoder_ctl( p_sys->p_state, SPEEX_SET_VBR_MAX_BITRATE, &i_tmp );
 933 #else
 934             msg_Dbg( p_enc, "max-bitrate cannot be set in this version of libspeex");
 935 #endif
 936     }
 937
 938     i_tmp = var_GetBool( p_enc, ENC_CFG_PREFIX "dtx" ) ? 1 : 0;
 939     speex_encoder_ctl( p_sys->p_state, SPEEX_SET_DTX, &i_tmp );
 940
 941
 942     /*Initialization of the structure that holds the bits*/
 943     speex_bits_init( &p_sys->bits );
 944
 945     p_sys->i_frames_in_packet = 0;
 946     p_sys->i_samples_delay = 0;
 947
 948     speex_encoder_ctl( p_sys->p_state, SPEEX_GET_FRAME_SIZE,
 949                        &p_sys->i_frame_length );
 950
 951     p_sys->i_frame_size = p_sys->i_frame_length *
 952         sizeof(int16_t) * p_enc->fmt_in.audio.i_channels;
 953     p_sys->p_buffer = xmalloc( p_sys->i_frame_size );
 954
 955     /* Create and store headers */
 956     pp_header[0] = speex_header_to_packet( &p_sys->header, &pi_header[0] );
 957     pp_header[1] = "ENCODER=VLC media player";
 958     pi_header[1] = sizeof("ENCODER=VLC media player");
 959
 960     p_enc->fmt_out.i_extra = 3 * 2 + pi_header[0] + pi_header[1];
 961     p_extra = p_enc->fmt_out.p_extra = xmalloc( p_enc->fmt_out.i_extra );
 962     for( i = 0; i < 2; i++ )
 963     {
 964         *(p_extra++) = pi_header[i] >> 8;
 965         *(p_extra++) = pi_header[i] & 0xFF;
 966         memcpy( p_extra, pp_header[i], pi_header[i] );
 967         p_extra += pi_header[i];
 968     }
 969
 970     msg_Dbg( p_enc, "encoding: frame size:%d, channels:%d, samplerate:%d",
 971              p_sys->i_frame_size, p_enc->fmt_in.audio.i_channels,
 972              p_enc->fmt_in.audio.i_rate );
 973
 974     return VLC_SUCCESS;
 975 }
 976
 977 /****************************************************************************
 978  * Encode: the whole thing
 979  ****************************************************************************
 980  * This function spits out ogg packets.
 981  ****************************************************************************/
 982 static block_t *Encode( encoder_t *p_enc, aout_buffer_t *p_aout_buf )
 983 {
 984     encoder_sys_t *p_sys = p_enc->p_sys;
 985     block_t *p_block, *p_chain = NULL;
 986
 987     unsigned char *p_buffer = p_aout_buf->p_buffer;
 988     int i_samples = p_aout_buf->i_nb_samples;
 989     int i_samples_delay = p_sys->i_samples_delay;
 990
 991     mtime_t i_pts = p_aout_buf->i_pts -
 992                 (mtime_t)1000000 * (mtime_t)p_sys->i_samples_delay /
 993                 (mtime_t)p_enc->fmt_in.audio.i_rate;
 994
 995     p_sys->i_samples_delay += i_samples;
 996
 997     while( p_sys->i_samples_delay >= p_sys->i_frame_length )
 998     {
 999         int16_t *p_samples;
1000         int i_out;
1001
1002         if( i_samples_delay )
1003         {
1004             /* Take care of the left-over from last time */
1005             int i_delay_size = i_samples_delay * 2 *
1006                                  p_enc->fmt_in.audio.i_channels;
1007             int i_size = p_sys->i_frame_size - i_delay_size;
1008
1009             p_samples = (int16_t *)p_sys->p_buffer;
1010             memcpy( p_sys->p_buffer + i_delay_size, p_buffer, i_size );
1011             p_buffer -= i_delay_size;
1012             i_samples += i_samples_delay;
1013             i_samples_delay = 0;
1014         }
1015         else
1016         {
1017             p_samples = (int16_t *)p_buffer;
1018         }
1019
1020         /* Encode current frame */
1021         if( p_enc->fmt_in.audio.i_channels == 2 )
1022             speex_encode_stereo_int( p_samples, p_sys->i_frame_length,
1023                                      &p_sys->bits );
1024
1025 #if 0
1026         if( p_sys->preprocess )
1027             speex_preprocess( p_sys->preprocess, p_samples, NULL );
1028 #endif
1029
1030         speex_encode_int( p_sys->p_state, p_samples, &p_sys->bits );
1031
1032         p_buffer += p_sys->i_frame_size;
1033         p_sys->i_samples_delay -= p_sys->i_frame_length;
1034         i_samples -= p_sys->i_frame_length;
1035
1036         p_sys->i_frames_in_packet++;
1037
1038         if( p_sys->i_frames_in_packet < p_sys->header.frames_per_packet )
1039             continue;
1040
1041         p_sys->i_frames_in_packet = 0;
1042
1043         speex_bits_insert_terminator( &p_sys->bits );
1044         i_out = speex_bits_write( &p_sys->bits, p_sys->p_buffer_out,
1045                                   MAX_FRAME_BYTES );
1046         speex_bits_reset( &p_sys->bits );
1047
1048         p_block = block_New( p_enc, i_out );
1049         memcpy( p_block->p_buffer, p_sys->p_buffer_out, i_out );
1050
1051         p_block->i_length = (mtime_t)1000000 *
1052             (mtime_t)p_sys->i_frame_length * p_sys->header.frames_per_packet /
1053             (mtime_t)p_enc->fmt_in.audio.i_rate;
1054
1055         p_block->i_dts = p_block->i_pts = i_pts;
1056
1057         /* Update pts */
1058         i_pts += p_block->i_length;
1059         block_ChainAppend( &p_chain, p_block );
1060
1061     }
1062
1063     /* Backup the remaining raw samples */
1064     if( i_samples )
1065     {
1066         memcpy( p_sys->p_buffer + i_samples_delay * 2 *
1067                 p_enc->fmt_in.audio.i_channels, p_buffer,
1068                 i_samples * 2 * p_enc->fmt_in.audio.i_channels );
1069     }
1070
1071     return p_chain;
1072 }
1073
1074 /*****************************************************************************
1075  * CloseEncoder: encoder destruction
1076  *****************************************************************************/
1077 static void CloseEncoder( vlc_object_t *p_this )
1078 {
1079     encoder_t *p_enc = (encoder_t *)p_this;
1080     encoder_sys_t *p_sys = p_enc->p_sys;
1081
1082     speex_encoder_destroy( p_sys->p_state );
1083     speex_bits_destroy( &p_sys->bits );
1084
1085     free( p_sys->p_buffer );
1086     free( p_sys );
1087 }