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