1 /*****************************************************************************
2 * vorbis.c: vorbis decoder module making use of libvorbis.
3 *****************************************************************************
4 * Copyright (C) 1999-2001 VideoLAN
5 * $Id: vorbis.c,v 1.16 2003/03/30 18:14:36 gbazin Exp $
7 * Authors: Gildas Bazin <gbazin@netcourrier.com>
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.
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.
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
27 #include <stdlib.h> /* malloc(), free() */
28 #include <string.h> /* memcpy(), memset() */
32 #include <vlc/decoder.h>
33 #include <input_ext-dec.h>
35 #include <vlc/input.h>
38 #ifdef MODULE_NAME_IS_tremor
39 #include <tremor/ivorbiscodec.h>
41 #include <vorbis/codec.h>
44 /*****************************************************************************
45 * dec_thread_t : vorbis decoder thread descriptor
46 *****************************************************************************/
47 typedef struct dec_thread_t
52 vlc_thread_t thread_id; /* id for thread functions */
57 vorbis_info vi; /* struct that stores all the static vorbis bitstream
59 vorbis_comment vc; /* struct that stores all the bitstream user
61 vorbis_dsp_state vd; /* central working state for the packet->PCM
63 vorbis_block vb; /* local working space for packet->PCM decode */
68 decoder_fifo_t *p_fifo; /* stores the PES stream data */
69 pes_packet_t *p_pes; /* current PES we are decoding */
74 aout_instance_t *p_aout;
75 aout_input_t *p_aout_input;
76 audio_sample_format_t output_format;
77 audio_date_t end_date;
81 static int pi_channels_maps[6] =
84 AOUT_CHAN_CENTER, AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
85 AOUT_CHAN_CENTER | AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
86 AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARLEFT
87 | AOUT_CHAN_REARRIGHT,
88 AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
89 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT
92 /*****************************************************************************
94 *****************************************************************************/
95 static int OpenDecoder ( vlc_object_t * );
96 static int RunDecoder ( decoder_fifo_t * );
97 static void CloseDecoder ( dec_thread_t * );
99 static void DecodePacket ( dec_thread_t * );
100 static int GetOggPacket ( dec_thread_t *, ogg_packet *, mtime_t * );
102 #ifdef MODULE_NAME_IS_tremor
103 static void Interleave ( int32_t *, const int32_t **, int, int );
105 static void Interleave ( float *, const float **, int, int );
108 /*****************************************************************************
110 *****************************************************************************/
112 set_description( _("Vorbis audio decoder") );
113 #ifdef MODULE_NAME_IS_tremor
114 set_capability( "decoder", 90 );
116 set_capability( "decoder", 100 );
118 set_callbacks( OpenDecoder, NULL );
121 /*****************************************************************************
122 * OpenDecoder: probe the decoder and return score
123 *****************************************************************************/
124 static int OpenDecoder( vlc_object_t *p_this )
126 decoder_fifo_t *p_fifo = (decoder_fifo_t*) p_this;
128 if( p_fifo->i_fourcc != VLC_FOURCC('v','o','r','b') )
133 p_fifo->pf_run = RunDecoder;
137 /*****************************************************************************
138 * RunDecoder: the vorbis decoder
139 *****************************************************************************/
140 static int RunDecoder( decoder_fifo_t * p_fifo )
143 ogg_packet oggpacket;
146 /* Allocate the memory needed to store the thread's structure */
147 if( (p_dec = (dec_thread_t *)malloc (sizeof(dec_thread_t)) )
150 msg_Err( p_fifo, "out of memory" );
154 /* Initialize the thread properties */
155 memset( p_dec, 0, sizeof(dec_thread_t) );
156 p_dec->p_fifo = p_fifo;
159 /* Take care of the initial Vorbis header */
160 vorbis_info_init( &p_dec->vi );
161 vorbis_comment_init( &p_dec->vc );
163 if( GetOggPacket( p_dec, &oggpacket, &i_pts ) != VLC_SUCCESS )
166 oggpacket.b_o_s = 1; /* yes this actually is a b_o_s packet :) */
167 if( vorbis_synthesis_headerin( &p_dec->vi, &p_dec->vc, &oggpacket ) < 0 )
169 msg_Err( p_dec->p_fifo, "This bitstream does not contain Vorbis "
174 /* The next two packets in order are the comment and codebook headers.
175 We need to watch out that these packets are not missing as a
176 missing or corrupted header is fatal. */
177 if( GetOggPacket( p_dec, &oggpacket, &i_pts ) != VLC_SUCCESS )
180 if( vorbis_synthesis_headerin( &p_dec->vi, &p_dec->vc, &oggpacket ) < 0 )
182 msg_Err( p_dec->p_fifo, "2nd Vorbis header is corrupted" );
185 /* parse the vorbis comment. FIXME should be done in demuxer*/
187 input_thread_t *p_input = (input_thread_t *)p_fifo->p_parent;
188 input_info_category_t *p_cat = input_InfoCategory( p_input,
189 _("Vorbis Comment") );
191 char *psz_name, *psz_value, *psz_comment;
192 while ( i < p_dec->vc.comments )
194 psz_comment = strdup( p_dec->vc.user_comments[i] );
197 msg_Warn( p_dec->p_fifo, "Out of memory" );
200 psz_name = psz_comment;
201 psz_value = strchr( psz_comment, '=' );
206 input_AddInfo( p_cat, psz_name, psz_value );
213 if( GetOggPacket( p_dec, &oggpacket, &i_pts ) != VLC_SUCCESS )
216 if( vorbis_synthesis_headerin( &p_dec->vi, &p_dec->vc, &oggpacket ) < 0 )
218 msg_Err( p_dec->p_fifo, "3rd Vorbis header is corrupted" );
222 /* Initialize the Vorbis packet->PCM decoder */
223 vorbis_synthesis_init( &p_dec->vd, &p_dec->vi );
224 vorbis_block_init( &p_dec->vd, &p_dec->vb );
226 #ifdef MODULE_NAME_IS_tremor
227 p_dec->output_format.i_format = VLC_FOURCC('f','i','3','2');
229 p_dec->output_format.i_format = VLC_FOURCC('f','l','3','2');
231 p_dec->output_format.i_physical_channels =
232 p_dec->output_format.i_original_channels =
233 pi_channels_maps[p_dec->vi.channels];
234 p_dec->output_format.i_rate = p_dec->vi.rate;
236 aout_DateInit( &p_dec->end_date, p_dec->vi.rate );
237 p_dec->p_aout = NULL;
238 p_dec->p_aout_input = aout_DecNew( p_dec->p_fifo,
240 &p_dec->output_format );
242 if( p_dec->p_aout_input == NULL )
244 msg_Err( p_dec->p_fifo, "failed to create aout fifo" );
248 /* vorbis decoder thread's main loop */
249 while( (!p_dec->p_fifo->b_die) && (!p_dec->p_fifo->b_error) )
251 DecodePacket( p_dec );
254 /* If b_error is set, the vorbis decoder thread enters the error loop */
255 if( p_dec->p_fifo->b_error )
257 DecoderError( p_dec->p_fifo );
260 /* End of the vorbis decoder thread */
261 CloseDecoder( p_dec );
266 DecoderError( p_fifo );
270 p_dec->p_fifo->b_error = 1;
272 /* End of the vorbis decoder thread */
273 CloseDecoder( p_dec );
280 /*****************************************************************************
281 * DecodePacket: decodes a Vorbis packet.
282 *****************************************************************************/
283 static void DecodePacket( dec_thread_t *p_dec )
285 aout_buffer_t *p_aout_buffer;
286 ogg_packet oggpacket;
287 #ifdef MODULE_NAME_IS_tremor
295 if( GetOggPacket( p_dec, &oggpacket, &i_pts ) != VLC_SUCCESS )
297 /* This should mean an eos */
301 /* Date management */
302 if( i_pts > 0 && i_pts != aout_DateGet( &p_dec->end_date ) )
304 aout_DateSet( &p_dec->end_date, i_pts );
307 if( vorbis_synthesis( &p_dec->vb, &oggpacket ) == 0 )
308 vorbis_synthesis_blockin( &p_dec->vd, &p_dec->vb );
310 /* **pp_pcm is a multichannel float vector. In stereo, for
311 * example, pp_pcm[0] is left, and pp_pcm[1] is right. i_samples is
312 * the size of each channel. Convert the float values
313 * (-1.<=range<=1.) to whatever PCM format and write it out */
315 while( ( i_samples = vorbis_synthesis_pcmout( &p_dec->vd, &pp_pcm ) ) > 0 )
318 p_aout_buffer = aout_DecNewBuffer( p_dec->p_aout, p_dec->p_aout_input,
322 msg_Err( p_dec->p_fifo, "cannot get aout buffer" );
323 p_dec->p_fifo->b_error = 1;
327 /* Interleave the samples */
328 #ifdef MODULE_NAME_IS_tremor
329 Interleave( (int32_t *)p_aout_buffer->p_buffer,
330 (const int32_t **)pp_pcm, p_dec->vi.channels, i_samples );
332 Interleave( (float *)p_aout_buffer->p_buffer,
333 (const float **)pp_pcm, p_dec->vi.channels, i_samples );
336 /* Tell libvorbis how many samples we actually consumed */
337 vorbis_synthesis_read( &p_dec->vd, i_samples );
339 /* Date management */
340 p_aout_buffer->start_date = aout_DateGet( &p_dec->end_date );
341 p_aout_buffer->end_date = aout_DateIncrement( &p_dec->end_date,
344 aout_DecPlay( p_dec->p_aout, p_dec->p_aout_input, p_aout_buffer );
349 /*****************************************************************************
350 * GetOggPacket: get the following vorbis packet from the stream and send back
351 * the result in an ogg packet (for easy decoding by libvorbis).
352 *****************************************************************************
353 * Returns VLC_EGENERIC in case of eof.
354 *****************************************************************************/
355 static int GetOggPacket( dec_thread_t *p_dec, ogg_packet *p_oggpacket,
358 if( p_dec->p_pes ) input_DeletePES( p_dec->p_fifo->p_packets_mgt,
361 input_ExtractPES( p_dec->p_fifo, &p_dec->p_pes );
362 if( !p_dec->p_pes ) return VLC_EGENERIC;
364 p_oggpacket->packet = p_dec->p_pes->p_first->p_payload_start;
365 p_oggpacket->bytes = p_dec->p_pes->i_pes_size;
366 p_oggpacket->granulepos = p_dec->p_pes->i_dts;
367 p_oggpacket->b_o_s = 0;
368 p_oggpacket->e_o_s = 0;
369 p_oggpacket->packetno = 0;
371 *p_pts = p_dec->p_pes->i_pts;
376 /*****************************************************************************
377 * Interleave: helper function to interleave channels
378 *****************************************************************************/
379 #ifdef MODULE_NAME_IS_tremor
380 static void Interleave( int32_t *p_out, const int32_t **pp_in,
382 static void Interleave( float *p_out, const float **pp_in,
384 int i_nb_channels, int i_samples )
388 for ( j = 0; j < i_samples; j++ )
390 for ( i = 0; i < i_nb_channels; i++ )
392 p_out[j * i_nb_channels + i] = pp_in[i][j];
397 /*****************************************************************************
398 * CloseDecoder: vorbis decoder destruction
399 *****************************************************************************/
400 static void CloseDecoder( dec_thread_t * p_dec )
402 if( p_dec->p_aout_input != NULL )
404 aout_DecDelete( p_dec->p_aout, p_dec->p_aout_input );
410 input_DeletePES( p_dec->p_fifo->p_packets_mgt, p_dec->p_pes );
411 vorbis_block_clear( &p_dec->vb );
412 vorbis_dsp_clear( &p_dec->vd );
413 vorbis_comment_clear( &p_dec->vc );
414 vorbis_info_clear( &p_dec->vi ); /* must be called last */