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