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

   1 /*****************************************************************************
   2  * vorbis.c: vorbis decoder/encoder/packetizer module using of libvorbis.
   3  *****************************************************************************
   4  * Copyright (C) 2001-2003 the VideoLAN team
   5  * Copyright (C) 2007 Société des arts technologiques
   6  * Copyright (C) 2007 Savoir-faire Linux
   7  *
   8  * $Id$
   9  *
  10  * Authors: Gildas Bazin <gbazin@videolan.org>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 /*****************************************************************************
  28  * Preamble
  29  *****************************************************************************/
  30 #include <vlc/vlc.h>
  31 #include <vlc_codec.h>
  32 #include <vlc_aout.h>
  33 #include <vlc_input.h>
  34 #include <vlc_sout.h>
  35
  36 #include <ogg/ogg.h>
  37
  38 #ifdef MODULE_NAME_IS_tremor
  39 #include <tremor/ivorbiscodec.h>
  40
  41 #else
  42 #include <vorbis/codec.h>
  43
  44 /* vorbis header */
  45 #ifdef HAVE_VORBIS_VORBISENC_H
  46 #   include <vorbis/vorbisenc.h>
  47 #   ifndef OV_ECTL_RATEMANAGE_AVG
  48 #       define OV_ECTL_RATEMANAGE_AVG 0x0
  49 #   endif
  50 #endif
  51
  52 #endif
  53
  54 /*****************************************************************************
  55  * decoder_sys_t : vorbis decoder descriptor
  56  *****************************************************************************/
  57 struct decoder_sys_t
  58 {
  59     /* Module mode */
  60     vlc_bool_t b_packetizer;
  61
  62     /*
  63      * Input properties
  64      */
  65     int i_headers;
  66
  67     /*
  68      * Vorbis properties
  69      */
  70     vorbis_info      vi; /* struct that stores all the static vorbis bitstream
  71                             settings */
  72     vorbis_comment   vc; /* struct that stores all the bitstream user
  73                           * comments */
  74     vorbis_dsp_state vd; /* central working state for the packet->PCM
  75                           * decoder */
  76     vorbis_block     vb; /* local working space for packet->PCM decode */
  77
  78     /*
  79      * Common properties
  80      */
  81     audio_date_t end_date;
  82     int          i_last_block_size;
  83
  84     int i_input_rate;
  85
  86     /*
  87     ** Channel reordering
  88     */
  89     int pi_chan_table[AOUT_CHAN_MAX];
  90 };
  91
  92 static int pi_channels_maps[9] =
  93 {
  94     0,
  95     AOUT_CHAN_CENTER,
  96     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
  97     AOUT_CHAN_CENTER | AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
  98     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARLEFT
  99      | AOUT_CHAN_REARRIGHT,
 100     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
 101      | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT,
 102     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
 103      | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE,
 104     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
 105      | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_MIDDLELEFT
 106      | AOUT_CHAN_MIDDLERIGHT,
 107     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER | AOUT_CHAN_REARLEFT
 108      | AOUT_CHAN_REARRIGHT | AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT
 109      | AOUT_CHAN_LFE
 110 };
 111
 112 /*
 113 **  channel order as defined in http://www.ogghelp.com/ogg/glossary.cfm#Audio_Channels
 114 */
 115
 116 /* recommended vorbis channel order for 6 channels */
 117 static const uint32_t pi_6channels_in[] =
 118 { AOUT_CHAN_LEFT, AOUT_CHAN_CENTER, AOUT_CHAN_RIGHT,
 119   AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,AOUT_CHAN_LFE,0 };
 120
 121 /* recommended vorbis channel order for 4 channels */
 122 static const uint32_t pi_4channels_in[] =
 123 { AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT, AOUT_CHAN_CENTER, AOUT_CHAN_LFE, 0 };
 124
 125 /* recommended vorbis channel order for 3 channels */
 126 static const uint32_t pi_3channels_in[] =
 127 { AOUT_CHAN_LEFT, AOUT_CHAN_CENTER, AOUT_CHAN_RIGHT, 0 };
 128
 129 /* our internal channel order (WG-4 order) */
 130 static const uint32_t pi_channels_out[] =
 131 { AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT, AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,
 132   AOUT_CHAN_CENTER, AOUT_CHAN_LFE, 0 };
 133
 134 /****************************************************************************
 135  * Local prototypes
 136  ****************************************************************************/
 137 static int  OpenDecoder   ( vlc_object_t * );
 138 static int  OpenPacketizer( vlc_object_t * );
 139 static void CloseDecoder  ( vlc_object_t * );
 140 static void *DecodeBlock  ( decoder_t *, block_t ** );
 141
 142 static int  ProcessHeaders( decoder_t * );
 143 static void *ProcessPacket ( decoder_t *, ogg_packet *, block_t ** );
 144
 145 static aout_buffer_t *DecodePacket  ( decoder_t *, ogg_packet * );
 146 static block_t *SendPacket( decoder_t *, ogg_packet *, block_t * );
 147
 148 static void ParseVorbisComments( decoder_t * );
 149
 150 static void ConfigureChannelOrder(int *, int, uint32_t, vlc_bool_t );
 151
 152 #ifdef MODULE_NAME_IS_tremor
 153 static void Interleave   ( int32_t *, const int32_t **, int, int, int * );
 154 #else
 155 static void Interleave   ( float *, const float **, int, int, int * );
 156 #endif
 157
 158 #ifndef MODULE_NAME_IS_tremor
 159 static int OpenEncoder   ( vlc_object_t * );
 160 static void CloseEncoder ( vlc_object_t * );
 161 static block_t *Encode   ( encoder_t *, aout_buffer_t * );
 162 #endif
 163
 164 /*****************************************************************************
 165  * Module descriptor
 166  *****************************************************************************/
 167 #define ENC_QUALITY_TEXT N_("Encoding quality")
 168 #define ENC_QUALITY_LONGTEXT N_( \
 169   "Enforce a quality between 1 (low) and 10 (high), instead " \
 170   "of specifying a particular bitrate. This will produce a VBR stream." )
 171 #define ENC_MAXBR_TEXT N_("Maximum encoding bitrate")
 172 #define ENC_MAXBR_LONGTEXT N_( \
 173   "Maximum bitrate in kbps. This is useful for streaming applications." )
 174 #define ENC_MINBR_TEXT N_("Minimum encoding bitrate")
 175 #define ENC_MINBR_LONGTEXT N_( \
 176   "Minimum bitrate in kbps. This is useful for encoding for a fixed-size channel." )
 177 #define ENC_CBR_TEXT N_("CBR encoding")
 178 #define ENC_CBR_LONGTEXT N_( \
 179   "Force a constant bitrate encoding (CBR)." )
 180
 181 vlc_module_begin();
 182     set_shortname( "Vorbis" );
 183     set_description( _("Vorbis audio decoder") );
 184 #ifdef MODULE_NAME_IS_tremor
 185     set_capability( "decoder", 90 );
 186 #else
 187     set_capability( "decoder", 100 );
 188 #endif
 189     set_category( CAT_INPUT );
 190     set_subcategory( SUBCAT_INPUT_ACODEC );
 191     set_callbacks( OpenDecoder, CloseDecoder );
 192
 193     add_submodule();
 194     set_description( _("Vorbis audio packetizer") );
 195     set_capability( "packetizer", 100 );
 196     set_callbacks( OpenPacketizer, CloseDecoder );
 197
 198 #ifndef MODULE_NAME_IS_tremor
 199 #   define ENC_CFG_PREFIX "sout-vorbis-"
 200     add_submodule();
 201     set_description( _("Vorbis audio encoder") );
 202     set_capability( "encoder", 100 );
 203 #if defined(HAVE_VORBIS_VORBISENC_H)
 204     set_callbacks( OpenEncoder, CloseEncoder );
 205 #endif
 206
 207     add_integer( ENC_CFG_PREFIX "quality", 0, NULL, ENC_QUALITY_TEXT,
 208                  ENC_QUALITY_LONGTEXT, VLC_FALSE );
 209     add_integer( ENC_CFG_PREFIX "max-bitrate", 0, NULL, ENC_MAXBR_TEXT,
 210                  ENC_MAXBR_LONGTEXT, VLC_FALSE );
 211     add_integer( ENC_CFG_PREFIX "min-bitrate", 0, NULL, ENC_MINBR_TEXT,
 212                  ENC_MINBR_LONGTEXT, VLC_FALSE );
 213     add_bool( ENC_CFG_PREFIX "cbr", 0, NULL, ENC_CBR_TEXT,
 214                  ENC_CBR_LONGTEXT, VLC_FALSE );
 215 #endif
 216
 217 vlc_module_end();
 218
 219 #ifndef MODULE_NAME_IS_tremor
 220 static const char *ppsz_enc_options[] = {
 221     "quality", "max-bitrate", "min-bitrate", "cbr", NULL
 222 };
 223 #endif
 224
 225 /*****************************************************************************
 226  * OpenDecoder: probe the decoder and return score
 227  *****************************************************************************/
 228 static int OpenDecoder( vlc_object_t *p_this )
 229 {
 230     decoder_t *p_dec = (decoder_t*)p_this;
 231     decoder_sys_t *p_sys;
 232
 233     if( p_dec->fmt_in.i_codec != VLC_FOURCC('v','o','r','b') )
 234     {
 235         return VLC_EGENERIC;
 236     }
 237
 238     /* Allocate the memory needed to store the decoder's structure */
 239     if( ( p_dec->p_sys = p_sys =
 240           (decoder_sys_t *)malloc(sizeof(decoder_sys_t)) ) == NULL )
 241     {
 242         msg_Err( p_dec, "out of memory" );
 243         return VLC_EGENERIC;
 244     }
 245
 246     /* Misc init */
 247     aout_DateSet( &p_sys->end_date, 0 );
 248     p_sys->i_last_block_size = 0;
 249     p_sys->b_packetizer = VLC_FALSE;
 250     p_sys->i_headers = 0;
 251     p_sys->i_input_rate = INPUT_RATE_DEFAULT;
 252
 253     /* Take care of vorbis init */
 254     vorbis_info_init( &p_sys->vi );
 255     vorbis_comment_init( &p_sys->vc );
 256
 257     /* Set output properties */
 258     p_dec->fmt_out.i_cat = AUDIO_ES;
 259 #ifdef MODULE_NAME_IS_tremor
 260     p_dec->fmt_out.i_codec = VLC_FOURCC('f','i','3','2');
 261 #else
 262     p_dec->fmt_out.i_codec = VLC_FOURCC('f','l','3','2');
 263 #endif
 264
 265     /* Set callbacks */
 266     p_dec->pf_decode_audio = (aout_buffer_t *(*)(decoder_t *, block_t **))
 267         DecodeBlock;
 268     p_dec->pf_packetize    = (block_t *(*)(decoder_t *, block_t **))
 269         DecodeBlock;
 270
 271     return VLC_SUCCESS;
 272 }
 273
 274 static int OpenPacketizer( vlc_object_t *p_this )
 275 {
 276     decoder_t *p_dec = (decoder_t*)p_this;
 277
 278     int i_ret = OpenDecoder( p_this );
 279
 280     if( i_ret == VLC_SUCCESS )
 281     {
 282         p_dec->p_sys->b_packetizer = VLC_TRUE;
 283         p_dec->fmt_out.i_codec = VLC_FOURCC('v','o','r','b');
 284     }
 285
 286     return i_ret;
 287 }
 288
 289 /****************************************************************************
 290  * DecodeBlock: the whole thing
 291  ****************************************************************************
 292  * This function must be fed with ogg packets.
 293  ****************************************************************************/
 294 static void *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
 295 {
 296     decoder_sys_t *p_sys = p_dec->p_sys;
 297     ogg_packet oggpacket;
 298
 299     if( !pp_block ) return NULL;
 300
 301     if( *pp_block )
 302     {
 303         /* Block to Ogg packet */
 304         oggpacket.packet = (*pp_block)->p_buffer;
 305         oggpacket.bytes = (*pp_block)->i_buffer;
 306
 307         if( (*pp_block)->i_rate > 0 )
 308             p_sys->i_input_rate = (*pp_block)->i_rate;
 309     }
 310     else
 311     {
 312         if( p_sys->b_packetizer ) return NULL;
 313
 314         /* Block to Ogg packet */
 315         oggpacket.packet = NULL;
 316         oggpacket.bytes = 0;
 317     }
 318
 319     oggpacket.granulepos = -1;
 320     oggpacket.b_o_s = 0;
 321     oggpacket.e_o_s = 0;
 322     oggpacket.packetno = 0;
 323
 324     /* Check for headers */
 325     if( p_sys->i_headers == 0 && p_dec->fmt_in.i_extra )
 326     {
 327         /* Headers already available as extra data */
 328         msg_Dbg( p_dec, "headers already available as extra data" );
 329         p_sys->i_headers = 3;
 330     }
 331     else if( oggpacket.bytes && p_sys->i_headers < 3 )
 332     {
 333         /* Backup headers as extra data */
 334         uint8_t *p_extra;
 335
 336         p_dec->fmt_in.p_extra =
 337             realloc( p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra +
 338                      oggpacket.bytes + 2 );
 339         p_extra = (uint8_t *)p_dec->fmt_in.p_extra + p_dec->fmt_in.i_extra;
 340         *(p_extra++) = oggpacket.bytes >> 8;
 341         *(p_extra++) = oggpacket.bytes & 0xFF;
 342
 343         memcpy( p_extra, oggpacket.packet, oggpacket.bytes );
 344         p_dec->fmt_in.i_extra += oggpacket.bytes + 2;
 345
 346         block_Release( *pp_block );
 347         p_sys->i_headers++;
 348         return NULL;
 349     }
 350
 351     if( p_sys->i_headers == 3 )
 352     {
 353         if( ProcessHeaders( p_dec ) != VLC_SUCCESS )
 354         {
 355             p_sys->i_headers = 0;
 356             p_dec->fmt_in.i_extra = 0;
 357             block_Release( *pp_block );
 358             return NULL;
 359         }
 360         else p_sys->i_headers++;
 361     }
 362
 363     return ProcessPacket( p_dec, &oggpacket, pp_block );
 364 }
 365
 366 /*****************************************************************************
 367  * ProcessHeaders: process Vorbis headers.
 368  *****************************************************************************/
 369 static int ProcessHeaders( decoder_t *p_dec )
 370 {
 371     decoder_sys_t *p_sys = p_dec->p_sys;
 372     ogg_packet oggpacket;
 373     uint8_t *p_extra;
 374     int i_extra;
 375
 376     if( !p_dec->fmt_in.i_extra ) return VLC_EGENERIC;
 377
 378     oggpacket.granulepos = -1;
 379     oggpacket.b_o_s = 1; /* yes this actually is a b_o_s packet :) */
 380     oggpacket.e_o_s = 0;
 381     oggpacket.packetno = 0;
 382     p_extra = p_dec->fmt_in.p_extra;
 383     i_extra = p_dec->fmt_in.i_extra;
 384
 385     /* Take care of the initial Vorbis header */
 386     oggpacket.bytes = *(p_extra++) << 8;
 387     oggpacket.bytes |= (*(p_extra++) & 0xFF);
 388     oggpacket.packet = p_extra;
 389     p_extra += oggpacket.bytes;
 390     i_extra -= (oggpacket.bytes + 2);
 391     if( i_extra < 0 )
 392     {
 393         msg_Err( p_dec, "header data corrupted");
 394         return VLC_EGENERIC;
 395     }
 396
 397     if( vorbis_synthesis_headerin( &p_sys->vi, &p_sys->vc, &oggpacket ) < 0 )
 398     {
 399         msg_Err( p_dec, "this bitstream does not contain Vorbis audio data");
 400         return VLC_EGENERIC;
 401     }
 402
 403     /* Setup the format */
 404     p_dec->fmt_out.audio.i_rate     = p_sys->vi.rate;
 405     p_dec->fmt_out.audio.i_channels = p_sys->vi.channels;
 406
 407     if( p_dec->fmt_out.audio.i_channels > 9 )
 408     {
 409         msg_Err( p_dec, "invalid number of channels (not between 1 and 9): %i",
 410                  p_dec->fmt_out.audio.i_channels );
 411         return VLC_EGENERIC;
 412     }
 413
 414     p_dec->fmt_out.audio.i_physical_channels =
 415         p_dec->fmt_out.audio.i_original_channels =
 416             pi_channels_maps[p_sys->vi.channels];
 417     p_dec->fmt_out.i_bitrate = p_sys->vi.bitrate_nominal;
 418
 419     aout_DateInit( &p_sys->end_date, p_sys->vi.rate );
 420
 421     msg_Dbg( p_dec, "channels:%d samplerate:%ld bitrate:%ld",
 422              p_sys->vi.channels, p_sys->vi.rate, p_sys->vi.bitrate_nominal );
 423
 424     /* The next packet in order is the comments header */
 425     oggpacket.b_o_s = 0;
 426     oggpacket.bytes = *(p_extra++) << 8;
 427     oggpacket.bytes |= (*(p_extra++) & 0xFF);
 428     oggpacket.packet = p_extra;
 429     p_extra += oggpacket.bytes;
 430     i_extra -= (oggpacket.bytes + 2);
 431     if( i_extra < 0 )
 432     {
 433         msg_Err( p_dec, "header data corrupted");
 434         return VLC_EGENERIC;
 435     }
 436
 437     if( vorbis_synthesis_headerin( &p_sys->vi, &p_sys->vc, &oggpacket ) < 0 )
 438     {
 439         msg_Err( p_dec, "2nd Vorbis header is corrupted" );
 440         return VLC_EGENERIC;
 441     }
 442     ParseVorbisComments( p_dec );
 443
 444     /* The next packet in order is the codebooks header
 445      * We need to watch out that this packet is not missing as a
 446      * missing or corrupted header is fatal. */
 447     oggpacket.bytes = *(p_extra++) << 8;
 448     oggpacket.bytes |= (*(p_extra++) & 0xFF);
 449     oggpacket.packet = p_extra;
 450     i_extra -= (oggpacket.bytes + 2);
 451     if( i_extra < 0 )
 452     {
 453         msg_Err( p_dec, "header data corrupted");
 454         return VLC_EGENERIC;
 455     }
 456
 457     if( vorbis_synthesis_headerin( &p_sys->vi, &p_sys->vc, &oggpacket ) < 0 )
 458     {
 459         msg_Err( p_dec, "3rd Vorbis header is corrupted" );
 460         return VLC_EGENERIC;
 461     }
 462
 463     if( !p_sys->b_packetizer )
 464     {
 465         /* Initialize the Vorbis packet->PCM decoder */
 466         vorbis_synthesis_init( &p_sys->vd, &p_sys->vi );
 467         vorbis_block_init( &p_sys->vd, &p_sys->vb );
 468     }
 469     else
 470     {
 471         p_dec->fmt_out.i_extra = p_dec->fmt_in.i_extra;
 472         p_dec->fmt_out.p_extra =
 473             realloc( p_dec->fmt_out.p_extra, p_dec->fmt_out.i_extra );
 474         memcpy( p_dec->fmt_out.p_extra,
 475                 p_dec->fmt_in.p_extra, p_dec->fmt_out.i_extra );
 476     }
 477
 478     ConfigureChannelOrder(p_sys->pi_chan_table, p_sys->vi.channels,
 479             p_dec->fmt_out.audio.i_physical_channels, VLC_TRUE);
 480
 481     return VLC_SUCCESS;
 482 }
 483
 484 /*****************************************************************************
 485  * ProcessPacket: processes a Vorbis packet.
 486  *****************************************************************************/
 487 static void *ProcessPacket( decoder_t *p_dec, ogg_packet *p_oggpacket,
 488                             block_t **pp_block )
 489 {
 490     decoder_sys_t *p_sys = p_dec->p_sys;
 491     block_t *p_block = *pp_block;
 492
 493     /* Date management */
 494     if( p_block && p_block->i_pts > 0 &&
 495         p_block->i_pts != aout_DateGet( &p_sys->end_date ) )
 496     {
 497         aout_DateSet( &p_sys->end_date, p_block->i_pts );
 498     }
 499
 500     if( !aout_DateGet( &p_sys->end_date ) )
 501     {
 502         /* We've just started the stream, wait for the first PTS. */
 503         if( p_block ) block_Release( p_block );
 504         return NULL;
 505     }
 506
 507     *pp_block = NULL; /* To avoid being fed the same packet again */
 508
 509     if( p_sys->b_packetizer )
 510     {
 511         return SendPacket( p_dec, p_oggpacket, p_block );
 512     }
 513     else
 514     {
 515         aout_buffer_t *p_aout_buffer;
 516
 517         if( p_sys->i_headers >= 3 )
 518             p_aout_buffer = DecodePacket( p_dec, p_oggpacket );
 519         else
 520             p_aout_buffer = NULL;
 521
 522         if( p_block ) block_Release( p_block );
 523         return p_aout_buffer;
 524     }
 525 }
 526
 527 /*****************************************************************************
 528  * DecodePacket: decodes a Vorbis packet.
 529  *****************************************************************************/
 530 static aout_buffer_t *DecodePacket( decoder_t *p_dec, ogg_packet *p_oggpacket )
 531 {
 532     decoder_sys_t *p_sys = p_dec->p_sys;
 533     int           i_samples;
 534
 535 #ifdef MODULE_NAME_IS_tremor
 536     int32_t       **pp_pcm;
 537 #else
 538     float         **pp_pcm;
 539 #endif
 540
 541     if( p_oggpacket->bytes &&
 542 #ifdef MODULE_NAME_IS_tremor
 543         vorbis_synthesis( &p_sys->vb, p_oggpacket, 1 ) == 0 )
 544 #else
 545         vorbis_synthesis( &p_sys->vb, p_oggpacket ) == 0 )
 546 #endif
 547         vorbis_synthesis_blockin( &p_sys->vd, &p_sys->vb );
 548
 549     /* **pp_pcm is a multichannel float vector. In stereo, for
 550      * example, pp_pcm[0] is left, and pp_pcm[1] is right. i_samples is
 551      * the size of each channel. Convert the float values
 552      * (-1.<=range<=1.) to whatever PCM format and write it out */
 553
 554     if( ( i_samples = vorbis_synthesis_pcmout( &p_sys->vd, &pp_pcm ) ) > 0 )
 555     {
 556
 557         aout_buffer_t *p_aout_buffer;
 558
 559         p_aout_buffer =
 560             p_dec->pf_aout_buffer_new( p_dec, i_samples );
 561
 562         if( p_aout_buffer == NULL ) return NULL;
 563
 564         /* Interleave the samples */
 565 #ifdef MODULE_NAME_IS_tremor
 566         Interleave( (int32_t *)p_aout_buffer->p_buffer,
 567                     (const int32_t **)pp_pcm, p_sys->vi.channels, i_samples, p_sys->pi_chan_table);
 568 #else
 569         Interleave( (float *)p_aout_buffer->p_buffer,
 570                     (const float **)pp_pcm, p_sys->vi.channels, i_samples, p_sys->pi_chan_table);
 571 #endif
 572
 573         /* Tell libvorbis how many samples we actually consumed */
 574         vorbis_synthesis_read( &p_sys->vd, i_samples );
 575
 576         /* Date management */
 577         p_aout_buffer->start_date = aout_DateGet( &p_sys->end_date );
 578         p_aout_buffer->end_date = aout_DateIncrement( &p_sys->end_date,
 579                                                       i_samples * p_sys->i_input_rate / INPUT_RATE_DEFAULT );
 580         return p_aout_buffer;
 581     }
 582     else
 583     {
 584         return NULL;
 585     }
 586 }
 587
 588 /*****************************************************************************
 589  * SendPacket: send an ogg dated packet to the stream output.
 590  *****************************************************************************/
 591 static block_t *SendPacket( decoder_t *p_dec, ogg_packet *p_oggpacket,
 592                             block_t *p_block )
 593 {
 594     decoder_sys_t *p_sys = p_dec->p_sys;
 595     int i_block_size, i_samples;
 596
 597     i_block_size = vorbis_packet_blocksize( &p_sys->vi, p_oggpacket );
 598     if( i_block_size < 0 ) i_block_size = 0; /* non audio packet */
 599     i_samples = ( p_sys->i_last_block_size + i_block_size ) >> 2;
 600     p_sys->i_last_block_size = i_block_size;
 601
 602     /* Date management */
 603     p_block->i_dts = p_block->i_pts = aout_DateGet( &p_sys->end_date );
 604
 605     if( p_sys->i_headers >= 3 )
 606         p_block->i_length = aout_DateIncrement( &p_sys->end_date,
 607             i_samples * p_sys->i_input_rate / INPUT_RATE_DEFAULT ) -
 608                 p_block->i_pts;
 609     else
 610         p_block->i_length = 0;
 611
 612     return p_block;
 613 }
 614
 615 /*****************************************************************************
 616  * ParseVorbisComments
 617  *****************************************************************************/
 618 static void ParseVorbisComments( decoder_t *p_dec )
 619 {
 620     input_thread_t *p_input = (input_thread_t *)p_dec->p_parent;
 621     char *psz_name, *psz_value, *psz_comment;
 622     input_item_t *p_item;
 623     int i = 0;
 624
 625     if( p_input->i_object_type != VLC_OBJECT_INPUT ) return;
 626
 627     p_item = input_GetItem( p_input );
 628
 629     while( i < p_dec->p_sys->vc.comments )
 630     {
 631         psz_comment = strdup( p_dec->p_sys->vc.user_comments[i] );
 632         if( !psz_comment )
 633         {
 634             msg_Warn( p_dec, "out of memory" );
 635             break;
 636         }
 637         psz_name = psz_comment;
 638         psz_value = strchr( psz_comment, '=' );
 639         if( psz_value )
 640         {
 641             *psz_value = '\0';
 642             psz_value++;
 643             input_Control( p_input, INPUT_ADD_INFO, _("Vorbis comment"),
 644                            psz_name, "%s", psz_value );
 645 #ifndef HAVE_TAGLIB
 646             if( !strcasecmp( psz_name, "artist" ) )
 647             {
 648                 if( psz_value && ( *psz_value != '\0' ) )
 649                 {
 650                     input_item_SetArtist( p_item, psz_value );
 651                     input_ItemAddInfo( p_item,
 652                                         _(VLC_META_INFO_CAT),
 653                                         _(VLC_META_ARTIST),
 654                                         "%s", psz_value );
 655                 }
 656             }
 657             else if( !strcasecmp( psz_name, "title" ) )
 658             {
 659                 if( psz_value && ( *psz_value != '\0' ) )
 660                 {
 661                     input_item_SetTitle( p_item, psz_value );
 662                     p_item->psz_name = strdup( psz_value );
 663                 }
 664             }
 665             else if( !strcasecmp( psz_name, "album" ) )
 666             {
 667                 if( psz_value && ( *psz_value != '\0' ) )
 668                 {
 669                     input_item_SetAlbum( p_item, psz_value );
 670                 }
 671             }
 672             else if( !strcasecmp( psz_name, "musicbrainz_trackid" ) )
 673             {
 674                 if( psz_value && ( *psz_value != '\0' ) )
 675                 {
 676                     input_item_SetTrackID( p_item, psz_value );
 677                 }
 678             }
 679 #if 0 //not used
 680             else if( !strcasecmp( psz_name, "musicbrainz_artistid" ) )
 681             {
 682                 if( psz_value && ( *psz_value != '\0' ) )
 683                 {
 684                     vlc_meta_SetArtistID( p_item, psz_value );
 685                 }
 686             }
 687             else if( !strcasecmp( psz_name, "musicbrainz_albumid" ) )
 688             {
 689                 if( psz_value && ( *psz_value != '\0' ) )
 690                 {
 691                     input_item_SetAlbumID( p_item, psz_value );
 692                 }
 693             }
 694 #endif
 695 #endif
 696             if( !strcasecmp( psz_name, "REPLAYGAIN_TRACK_GAIN" ) ||
 697                      !strcasecmp( psz_name, "RG_RADIO" ) )
 698             {
 699                 audio_replay_gain_t *r = &p_dec->fmt_out.audio_replay_gain;
 700
 701                 r->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = VLC_TRUE;
 702                 r->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
 703             }
 704             else if( !strcasecmp( psz_name, "REPLAYGAIN_TRACK_PEAK" ) ||
 705                      !strcasecmp( psz_name, "RG_PEAK" ) )
 706             {
 707                 audio_replay_gain_t *r = &p_dec->fmt_out.audio_replay_gain;
 708
 709                 r->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = VLC_TRUE;
 710                 r->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
 711             }
 712             else if( !strcasecmp( psz_name, "REPLAYGAIN_ALBUM_GAIN" ) ||
 713                      !strcasecmp( psz_name, "RG_AUDIOPHILE" ) )
 714             {
 715                 audio_replay_gain_t *r = &p_dec->fmt_out.audio_replay_gain;
 716
 717                 r->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = VLC_TRUE;
 718                 r->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
 719             }
 720             else if( !strcasecmp( psz_name, "REPLAYGAIN_ALBUM_PEAK" ) )
 721             {
 722                 audio_replay_gain_t *r = &p_dec->fmt_out.audio_replay_gain;
 723
 724                 r->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = VLC_TRUE;
 725                 r->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
 726             }
 727         }
 728         /* FIXME */
 729         var_SetInteger( p_input, "item-change", p_item->i_id );
 730         free( psz_comment );
 731         i++;
 732     }
 733 }
 734
 735 /*****************************************************************************
 736  * Interleave: helper function to interleave channels
 737  *****************************************************************************/
 738 static void ConfigureChannelOrder(int *pi_chan_table, int i_channels, uint32_t i_channel_mask, vlc_bool_t b_decode)
 739 {
 740     const uint32_t *pi_channels_in;
 741     switch( i_channels )
 742     {
 743         case 6:
 744         case 5:
 745             pi_channels_in = pi_6channels_in;
 746             break;
 747         case 4:
 748             pi_channels_in = pi_4channels_in;
 749             break;
 750         case 3:
 751             pi_channels_in = pi_3channels_in;
 752             break;
 753         default:
 754             {
 755                 int i;
 756                 for( i = 0; i< i_channels; ++i )
 757                 {
 758                     pi_chan_table[i] = i;
 759                 }
 760                 return;
 761             }
 762     }
 763
 764     if( b_decode )
 765         aout_CheckChannelReorder( pi_channels_in, pi_channels_out,
 766                                   i_channel_mask & AOUT_CHAN_PHYSMASK,
 767                                   i_channels,
 768                                   pi_chan_table );
 769     else
 770         aout_CheckChannelReorder( pi_channels_out, pi_channels_in,
 771                                   i_channel_mask & AOUT_CHAN_PHYSMASK,
 772                                   i_channels,
 773                                   pi_chan_table );
 774 }
 775
 776 /*****************************************************************************
 777  * Interleave: helper function to interleave channels
 778  *****************************************************************************/
 779 #ifdef MODULE_NAME_IS_tremor
 780 static void Interleave( int32_t *p_out, const int32_t **pp_in,
 781                         int i_nb_channels, int i_samples, int *pi_chan_table)
 782 {
 783     int i, j;
 784
 785     for ( j = 0; j < i_samples; j++ )
 786         for ( i = 0; i < i_nb_channels; i++ )
 787             p_out[j * i_nb_channels + pi_chan_table[i]] = pp_in[i][j] * (FIXED32_ONE >> 24);
 788 }
 789 #else
 790 static void Interleave( float *p_out, const float **pp_in,
 791                         int i_nb_channels, int i_samples, int *pi_chan_table )
 792 {
 793     int i, j;
 794
 795     for ( j = 0; j < i_samples; j++ )
 796         for ( i = 0; i < i_nb_channels; i++ )
 797             p_out[j * i_nb_channels + pi_chan_table[i]] = pp_in[i][j];
 798 }
 799 #endif
 800
 801 /*****************************************************************************
 802  * CloseDecoder: vorbis decoder destruction
 803  *****************************************************************************/
 804 static void CloseDecoder( vlc_object_t *p_this )
 805 {
 806     decoder_t *p_dec = (decoder_t *)p_this;
 807     decoder_sys_t *p_sys = p_dec->p_sys;
 808
 809     if( !p_sys->b_packetizer && p_sys->i_headers > 3 )
 810     {
 811         vorbis_block_clear( &p_sys->vb );
 812         vorbis_dsp_clear( &p_sys->vd );
 813     }
 814
 815     vorbis_comment_clear( &p_sys->vc );
 816     vorbis_info_clear( &p_sys->vi );  /* must be called last */
 817
 818     free( p_sys );
 819 }
 820
 821 #if defined(HAVE_VORBIS_VORBISENC_H) && !defined(MODULE_NAME_IS_tremor)
 822
 823 /*****************************************************************************
 824  * encoder_sys_t : vorbis encoder descriptor
 825  *****************************************************************************/
 826 struct encoder_sys_t
 827 {
 828     /*
 829      * Vorbis properties
 830      */
 831     vorbis_info      vi; /* struct that stores all the static vorbis bitstream
 832                             settings */
 833     vorbis_comment   vc; /* struct that stores all the bitstream user
 834                           * comments */
 835     vorbis_dsp_state vd; /* central working state for the packet->PCM
 836                           * decoder */
 837     vorbis_block     vb; /* local working space for packet->PCM decode */
 838
 839     int i_last_block_size;
 840     int i_samples_delay;
 841     int i_channels;
 842
 843     /*
 844      * Common properties
 845      */
 846     mtime_t i_pts;
 847
 848     /*
 849     ** Channel reordering
 850     */
 851     int pi_chan_table[AOUT_CHAN_MAX];
 852
 853 };
 854
 855 /*****************************************************************************
 856  * OpenEncoder: probe the encoder and return score
 857  *****************************************************************************/
 858 static int OpenEncoder( vlc_object_t *p_this )
 859 {
 860     encoder_t *p_enc = (encoder_t *)p_this;
 861     encoder_sys_t *p_sys;
 862     int i_quality, i_min_bitrate, i_max_bitrate, i;
 863     ogg_packet header[3];
 864     vlc_value_t val;
 865     uint8_t *p_extra;
 866
 867     if( p_enc->fmt_out.i_codec != VLC_FOURCC('v','o','r','b') &&
 868         !p_enc->b_force )
 869     {
 870         return VLC_EGENERIC;
 871     }
 872
 873     /* Allocate the memory needed to store the decoder's structure */
 874     if( ( p_sys = (encoder_sys_t *)malloc(sizeof(encoder_sys_t)) ) == NULL )
 875     {
 876         msg_Err( p_enc, "out of memory" );
 877         return VLC_EGENERIC;
 878     }
 879     p_enc->p_sys = p_sys;
 880
 881     p_enc->pf_encode_audio = Encode;
 882     p_enc->fmt_in.i_codec = VLC_FOURCC('f','l','3','2');
 883     p_enc->fmt_out.i_codec = VLC_FOURCC('v','o','r','b');
 884
 885     config_ChainParse( p_enc, ENC_CFG_PREFIX, ppsz_enc_options, p_enc->p_cfg );
 886
 887     var_Get( p_enc, ENC_CFG_PREFIX "quality", &val );
 888     i_quality = val.i_int;
 889     if( i_quality > 10 ) i_quality = 10;
 890     if( i_quality < 0 ) i_quality = 0;
 891     var_Get( p_enc, ENC_CFG_PREFIX "cbr", &val );
 892     if( val.b_bool ) i_quality = 0;
 893     var_Get( p_enc, ENC_CFG_PREFIX "max-bitrate", &val );
 894     i_max_bitrate = val.i_int;
 895     var_Get( p_enc, ENC_CFG_PREFIX "min-bitrate", &val );
 896     i_min_bitrate = val.i_int;
 897
 898     /* Initialize vorbis encoder */
 899     vorbis_info_init( &p_sys->vi );
 900
 901     if( i_quality > 0 )
 902     {
 903         /* VBR mode */
 904         if( vorbis_encode_setup_vbr( &p_sys->vi,
 905               p_enc->fmt_in.audio.i_channels, p_enc->fmt_in.audio.i_rate,
 906               i_quality * 0.1 ) )
 907         {
 908             vorbis_info_clear( &p_sys->vi );
 909             free( p_enc->p_sys );
 910             msg_Err( p_enc, "VBR mode initialisation failed" );
 911             return VLC_EGENERIC;
 912         }
 913
 914         /* Do we have optional hard quality restrictions? */
 915         if( i_max_bitrate > 0 || i_min_bitrate > 0 )
 916         {
 917             struct ovectl_ratemanage_arg ai;
 918             vorbis_encode_ctl( &p_sys->vi, OV_ECTL_RATEMANAGE_GET, &ai );
 919
 920             ai.bitrate_hard_min = i_min_bitrate;
 921             ai.bitrate_hard_max = i_max_bitrate;
 922             ai.management_active = 1;
 923
 924             vorbis_encode_ctl( &p_sys->vi, OV_ECTL_RATEMANAGE_SET, &ai );
 925
 926         }
 927         else
 928         {
 929             /* Turn off management entirely */
 930             vorbis_encode_ctl( &p_sys->vi, OV_ECTL_RATEMANAGE_SET, NULL );
 931         }
 932     }
 933     else
 934     {
 935         if( vorbis_encode_setup_managed( &p_sys->vi,
 936               p_enc->fmt_in.audio.i_channels, p_enc->fmt_in.audio.i_rate,
 937               i_min_bitrate > 0 ? i_min_bitrate * 1000: -1,
 938               p_enc->fmt_out.i_bitrate,
 939               i_max_bitrate > 0 ? i_max_bitrate * 1000: -1 ) )
 940           {
 941               vorbis_info_clear( &p_sys->vi );
 942               msg_Err( p_enc, "CBR mode initialisation failed" );
 943               free( p_enc->p_sys );
 944               return VLC_EGENERIC;
 945           }
 946     }
 947
 948     vorbis_encode_setup_init( &p_sys->vi );
 949
 950     /* Add a comment */
 951     vorbis_comment_init( &p_sys->vc);
 952     vorbis_comment_add_tag( &p_sys->vc, "ENCODER", "VLC media player");
 953
 954     /* Set up the analysis state and auxiliary encoding storage */
 955     vorbis_analysis_init( &p_sys->vd, &p_sys->vi );
 956     vorbis_block_init( &p_sys->vd, &p_sys->vb );
 957
 958     /* Create and store headers */
 959     vorbis_analysis_headerout( &p_sys->vd, &p_sys->vc,
 960                                &header[0], &header[1], &header[2]);
 961     p_enc->fmt_out.i_extra = 3 * 2 + header[0].bytes +
 962        header[1].bytes + header[2].bytes;
 963     p_extra = p_enc->fmt_out.p_extra = malloc( p_enc->fmt_out.i_extra );
 964     for( i = 0; i < 3; i++ )
 965     {
 966         *(p_extra++) = header[i].bytes >> 8;
 967         *(p_extra++) = header[i].bytes & 0xFF;
 968         memcpy( p_extra, header[i].packet, header[i].bytes );
 969         p_extra += header[i].bytes;
 970     }
 971
 972     p_sys->i_channels = p_enc->fmt_in.audio.i_channels;
 973     p_sys->i_last_block_size = 0;
 974     p_sys->i_samples_delay = 0;
 975     p_sys->i_pts = 0;
 976
 977     ConfigureChannelOrder(p_sys->pi_chan_table, p_sys->vi.channels,
 978             p_enc->fmt_in.audio.i_physical_channels, VLC_TRUE);
 979
 980     return VLC_SUCCESS;
 981 }
 982
 983 /****************************************************************************
 984  * Encode: the whole thing
 985  ****************************************************************************
 986  * This function spits out ogg packets.
 987  ****************************************************************************/
 988 static block_t *Encode( encoder_t *p_enc, aout_buffer_t *p_aout_buf )
 989 {
 990     encoder_sys_t *p_sys = p_enc->p_sys;
 991     ogg_packet oggpacket;
 992     block_t *p_block, *p_chain = NULL;
 993     float **buffer;
 994     int i;
 995     unsigned int j;
 996
 997     p_sys->i_pts = p_aout_buf->start_date -
 998                 (mtime_t)1000000 * (mtime_t)p_sys->i_samples_delay /
 999                 (mtime_t)p_enc->fmt_in.audio.i_rate;
1000
1001     p_sys->i_samples_delay += p_aout_buf->i_nb_samples;
1002
1003     buffer = vorbis_analysis_buffer( &p_sys->vd, p_aout_buf->i_nb_samples );
1004
1005     /* convert samples to float and uninterleave */
1006     for( i = 0; i < p_sys->i_channels; i++ )
1007     {
1008         for( j = 0 ; j < p_aout_buf->i_nb_samples ; j++ )
1009         {
1010             buffer[i][j]= ((float *)p_aout_buf->p_buffer)
1011                                     [j * p_sys->i_channels + p_sys->pi_chan_table[i]];
1012         }
1013     }
1014
1015     vorbis_analysis_wrote( &p_sys->vd, p_aout_buf->i_nb_samples );
1016
1017     while( vorbis_analysis_blockout( &p_sys->vd, &p_sys->vb ) == 1 )
1018     {
1019         int i_samples;
1020
1021         vorbis_analysis( &p_sys->vb, NULL );
1022         vorbis_bitrate_addblock( &p_sys->vb );
1023
1024         while( vorbis_bitrate_flushpacket( &p_sys->vd, &oggpacket ) )
1025         {
1026             int i_block_size;
1027             p_block = block_New( p_enc, oggpacket.bytes );
1028             memcpy( p_block->p_buffer, oggpacket.packet, oggpacket.bytes );
1029
1030             i_block_size = vorbis_packet_blocksize( &p_sys->vi, &oggpacket );
1031
1032             if( i_block_size < 0 ) i_block_size = 0;
1033             i_samples = ( p_sys->i_last_block_size + i_block_size ) >> 2;
1034             p_sys->i_last_block_size = i_block_size;
1035
1036             p_block->i_length = (mtime_t)1000000 *
1037                 (mtime_t)i_samples / (mtime_t)p_enc->fmt_in.audio.i_rate;
1038
1039             p_block->i_dts = p_block->i_pts = p_sys->i_pts;
1040
1041             p_sys->i_samples_delay -= i_samples;
1042
1043             /* Update pts */
1044             p_sys->i_pts += p_block->i_length;
1045             block_ChainAppend( &p_chain, p_block );
1046         }
1047     }
1048
1049     return p_chain;
1050 }
1051
1052 /*****************************************************************************
1053  * CloseEncoder: vorbis encoder destruction
1054  *****************************************************************************/
1055 static void CloseEncoder( vlc_object_t *p_this )
1056 {
1057     encoder_t *p_enc = (encoder_t *)p_this;
1058     encoder_sys_t *p_sys = p_enc->p_sys;
1059
1060     vorbis_block_clear( &p_sys->vb );
1061     vorbis_dsp_clear( &p_sys->vd );
1062     vorbis_comment_clear( &p_sys->vc );
1063     vorbis_info_clear( &p_sys->vi );  /* must be called last */
1064
1065     free( p_sys );
1066 }
1067
1068 #endif /* HAVE_VORBIS_VORBISENC_H && !MODULE_NAME_IS_tremor */