All: preliminary support for audio while playing faster/slower (1/4 -> 4).
[vlc.git] / modules / codec / faad.c
1 /*****************************************************************************
2  * decoder.c: AAC decoder using libfaad2
3  *****************************************************************************
4  * Copyright (C) 2001, 2003 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *          Gildas Bazin <gbazin@videolan.org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 #include <vlc/vlc.h>
26 #include <vlc_aout.h>
27 #include <vlc_codec.h>
28 #include <vlc_input.h>
29
30 #include <faad.h>
31
32 /*****************************************************************************
33  * Module descriptor
34  *****************************************************************************/
35 static int  Open( vlc_object_t * );
36 static void Close( vlc_object_t * );
37
38 vlc_module_begin();
39     set_description( _("AAC audio decoder (using libfaad2)") );
40     set_capability( "decoder", 100 );
41     set_category( CAT_INPUT );
42     set_subcategory( SUBCAT_INPUT_ACODEC );
43     set_callbacks( Open, Close );
44 vlc_module_end();
45
46 /****************************************************************************
47  * Local prototypes
48  ****************************************************************************/
49 static aout_buffer_t *DecodeBlock( decoder_t *, block_t ** );
50 static void DoReordering( decoder_t *, uint32_t *, uint32_t *, int, int,
51                           uint32_t * );
52
53 #define MAX_CHANNEL_POSITIONS 9
54
55 struct decoder_sys_t
56 {
57     /* faad handler */
58     faacDecHandle *hfaad;
59
60     /* samples */
61     audio_date_t date;
62
63     /* temporary buffer */
64     uint8_t *p_buffer;
65     int     i_buffer;
66     int     i_buffer_size;
67
68     /* Channel positions of the current stream (for re-ordering) */
69     uint32_t pi_channel_positions[MAX_CHANNEL_POSITIONS];
70
71     vlc_bool_t b_sbr, b_ps;
72
73     int i_input_rate;
74 };
75
76 static const uint32_t pi_channels_in[MAX_CHANNEL_POSITIONS] =
77     { FRONT_CHANNEL_CENTER, FRONT_CHANNEL_LEFT, FRONT_CHANNEL_RIGHT,
78       SIDE_CHANNEL_LEFT, SIDE_CHANNEL_RIGHT,
79       BACK_CHANNEL_LEFT, BACK_CHANNEL_RIGHT,
80       BACK_CHANNEL_CENTER, LFE_CHANNEL };
81 static const uint32_t pi_channels_out[MAX_CHANNEL_POSITIONS] =
82     { AOUT_CHAN_CENTER, AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
83       AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
84       AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,
85       AOUT_CHAN_REARCENTER, AOUT_CHAN_LFE };
86 static const uint32_t pi_channels_ordered[MAX_CHANNEL_POSITIONS] =
87     { AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
88       AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
89       AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,
90       AOUT_CHAN_CENTER, AOUT_CHAN_REARCENTER, AOUT_CHAN_LFE
91     };
92
93 /*****************************************************************************
94  * OpenDecoder: probe the decoder and return score
95  *****************************************************************************/
96 static int Open( vlc_object_t *p_this )
97 {
98     decoder_t *p_dec = (decoder_t*)p_this;
99     decoder_sys_t *p_sys = p_dec->p_sys;
100     faacDecConfiguration *cfg;
101
102     if( p_dec->fmt_in.i_codec != VLC_FOURCC('m','p','4','a') )
103     {
104         return VLC_EGENERIC;
105     }
106
107     /* Allocate the memory needed to store the decoder's structure */
108     if( ( p_dec->p_sys = p_sys =
109           (decoder_sys_t *)malloc(sizeof(decoder_sys_t)) ) == NULL )
110     {
111         msg_Err( p_dec, "out of memory" );
112         return VLC_EGENERIC;
113     }
114
115     /* Open a faad context */
116     if( ( p_sys->hfaad = faacDecOpen() ) == NULL )
117     {
118         msg_Err( p_dec, "cannot initialize faad" );
119         return VLC_EGENERIC;
120     }
121
122     /* Misc init */
123     aout_DateSet( &p_sys->date, 0 );
124     p_dec->fmt_out.i_cat = AUDIO_ES;
125
126     if (vlc_CPU() & CPU_CAPABILITY_FPU)
127         p_dec->fmt_out.i_codec = VLC_FOURCC('f','l','3','2');
128     else
129         p_dec->fmt_out.i_codec = AOUT_FMT_S16_NE;
130     p_dec->pf_decode_audio = DecodeBlock;
131
132     p_dec->fmt_out.audio.i_physical_channels =
133         p_dec->fmt_out.audio.i_original_channels = 0;
134
135     if( p_dec->fmt_in.i_extra > 0 )
136     {
137         /* We have a decoder config so init the handle */
138         unsigned long i_rate;
139         unsigned char i_channels;
140
141         if( faacDecInit2( p_sys->hfaad, p_dec->fmt_in.p_extra,
142                           p_dec->fmt_in.i_extra,
143                           &i_rate, &i_channels ) < 0 )
144         {
145             return VLC_EGENERIC;
146         }
147
148         p_dec->fmt_out.audio.i_rate = i_rate;
149         p_dec->fmt_out.audio.i_channels = i_channels;
150         aout_DateInit( &p_sys->date, i_rate );
151     }
152     else
153     {
154         /* Will be initalised from first frame */
155         p_dec->fmt_out.audio.i_rate = 0;
156         p_dec->fmt_out.audio.i_channels = 0;
157     }
158
159     /* Set the faad config */
160     cfg = faacDecGetCurrentConfiguration( p_sys->hfaad );
161     if (vlc_CPU() & CPU_CAPABILITY_FPU)
162         cfg->outputFormat = FAAD_FMT_FLOAT;
163     else
164         cfg->outputFormat = FAAD_FMT_16BIT;
165     faacDecSetConfiguration( p_sys->hfaad, cfg );
166
167     /* buffer */
168     p_sys->i_buffer = p_sys->i_buffer_size = 0;
169     p_sys->p_buffer = 0;
170
171     p_sys->i_input_rate = INPUT_RATE_DEFAULT;
172
173     /* Faad2 can't deal with truncated data (eg. from MPEG TS) */
174     p_dec->b_need_packetized = VLC_TRUE;
175
176     p_sys->b_sbr = p_sys->b_ps = VLC_FALSE;
177     return VLC_SUCCESS;
178 }
179
180 /*****************************************************************************
181  * DecodeBlock:
182  *****************************************************************************/
183 static aout_buffer_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
184 {
185     decoder_sys_t *p_sys = p_dec->p_sys;
186     block_t *p_block;
187
188     if( !pp_block || !*pp_block ) return NULL;
189
190     p_block = *pp_block;
191
192     if( p_block->i_flags&(BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
193     {
194         block_Release( p_block );
195         return NULL;
196     }
197
198     if( p_block->i_rate > 0 )
199         p_sys->i_input_rate = p_block->i_rate;
200
201     /* Append the block to the temporary buffer */
202     if( p_sys->i_buffer_size < p_sys->i_buffer + p_block->i_buffer )
203     {
204         p_sys->i_buffer_size = p_sys->i_buffer + p_block->i_buffer;
205         p_sys->p_buffer = realloc( p_sys->p_buffer, p_sys->i_buffer_size );
206     }
207
208     if( p_block->i_buffer )
209     {
210         memcpy( &p_sys->p_buffer[p_sys->i_buffer],
211                 p_block->p_buffer, p_block->i_buffer );
212         p_sys->i_buffer += p_block->i_buffer;
213         p_block->i_buffer = 0;
214     }
215
216     if( p_dec->fmt_out.audio.i_rate == 0 && p_dec->fmt_in.i_extra > 0 )
217     {
218         /* We have a decoder config so init the handle */
219         unsigned long i_rate;
220         unsigned char i_channels;
221
222         if( faacDecInit2( p_sys->hfaad, p_dec->fmt_in.p_extra,
223                           p_dec->fmt_in.i_extra,
224                           &i_rate, &i_channels ) >= 0 )
225         {
226             p_dec->fmt_out.audio.i_rate = i_rate;
227             p_dec->fmt_out.audio.i_channels = i_channels;
228             aout_DateInit( &p_sys->date, i_rate );
229         }
230     }
231
232     if( p_dec->fmt_out.audio.i_rate == 0 && p_sys->i_buffer )
233     {
234         unsigned long i_rate;
235         unsigned char i_channels;
236
237         /* Init faad with the first frame */
238         if( faacDecInit( p_sys->hfaad,
239                          p_sys->p_buffer, p_sys->i_buffer,
240                          &i_rate, &i_channels ) < 0 )
241         {
242             block_Release( p_block );
243             return NULL;
244         }
245
246         p_dec->fmt_out.audio.i_rate = i_rate;
247         p_dec->fmt_out.audio.i_channels = i_channels;
248         aout_DateInit( &p_sys->date, i_rate );
249     }
250
251     if( p_block->i_pts != 0 && p_block->i_pts != aout_DateGet( &p_sys->date ) )
252     {
253         aout_DateSet( &p_sys->date, p_block->i_pts );
254     }
255     else if( !aout_DateGet( &p_sys->date ) )
256     {
257         /* We've just started the stream, wait for the first PTS. */
258         block_Release( p_block );
259         p_sys->i_buffer = 0;
260         return NULL;
261     }
262
263     /* Decode all data */
264     if( p_sys->i_buffer )
265     {
266         void *samples;
267         faacDecFrameInfo frame;
268         aout_buffer_t *p_out;
269         int i, j;
270
271         samples = faacDecDecode( p_sys->hfaad, &frame,
272                                  p_sys->p_buffer, p_sys->i_buffer );
273
274         if( frame.error > 0 )
275         {
276             msg_Warn( p_dec, "%s", faacDecGetErrorMessage( frame.error ) );
277
278             /* Flush the buffer */
279             p_sys->i_buffer = 0;
280             block_Release( p_block );
281             return NULL;
282         }
283
284         if( frame.channels <= 0 || frame.channels > 8 || frame.channels == 7 )
285         {
286             msg_Warn( p_dec, "invalid channels count: %i", frame.channels );
287
288             /* Flush the buffer */
289             p_sys->i_buffer -= frame.bytesconsumed;
290             if( p_sys->i_buffer > 0 )
291             {
292                 memmove( p_sys->p_buffer,&p_sys->p_buffer[frame.bytesconsumed],
293                          p_sys->i_buffer );
294             }
295             block_Release( p_block );
296             return NULL;
297         }
298
299         if( frame.samples <= 0 )
300         {
301             msg_Warn( p_dec, "decoded zero sample" );
302
303             /* Flush the buffer */
304             p_sys->i_buffer -= frame.bytesconsumed;
305             if( p_sys->i_buffer > 0 )
306             {
307                 memmove( p_sys->p_buffer,&p_sys->p_buffer[frame.bytesconsumed],
308                          p_sys->i_buffer );
309             }
310             block_Release( p_block );
311             return NULL;
312         }
313
314         /* We decoded a valid frame */
315         if( p_dec->fmt_out.audio.i_rate != frame.samplerate )
316         {
317             aout_DateInit( &p_sys->date, frame.samplerate );
318             aout_DateSet( &p_sys->date, p_block->i_pts );
319         }
320         p_block->i_pts = 0;  /* PTS is valid only once */
321
322         p_dec->fmt_out.audio.i_rate = frame.samplerate;
323         p_dec->fmt_out.audio.i_channels = frame.channels;
324
325         /* Adjust stream info when dealing with SBR/PS */
326         if( (p_sys->b_sbr != frame.sbr || p_sys->b_ps != frame.ps) &&
327             p_dec->p_parent->i_object_type == VLC_OBJECT_INPUT )
328         {
329           input_thread_t *p_input = (input_thread_t *)p_dec->p_parent;
330           char *psz_cat;
331           const char *psz_ext = (frame.sbr && frame.ps) ? "SBR+PS" :
332                                     frame.sbr ? "SBR" : "PS";
333
334           msg_Dbg( p_dec, "AAC %s (channels: %u, samplerate: %lu)",
335                    psz_ext, frame.channels, frame.samplerate );
336
337           asprintf( &psz_cat, _("Stream %d"), p_dec->fmt_in.i_id );
338           input_Control( p_input, INPUT_ADD_INFO, psz_cat,
339                           _("AAC extension"), "%s", psz_ext );
340           input_Control( p_input, INPUT_ADD_INFO, psz_cat,
341                          _("Channels"), "%d", frame.channels );
342           input_Control( p_input, INPUT_ADD_INFO, psz_cat,
343                          _("Sample rate"), _("%d Hz"), frame.samplerate );
344           free( psz_cat );
345           p_sys->b_sbr = frame.sbr; p_sys->b_ps = frame.ps;
346         }
347
348         /* Convert frame.channel_position to our own channel values */
349         p_dec->fmt_out.audio.i_physical_channels = 0;
350         for( i = 0; i < frame.channels; i++ )
351         {
352             /* Find the channel code */
353             for( j = 0; j < MAX_CHANNEL_POSITIONS; j++ )
354             {
355                 if( frame.channel_position[i] == pi_channels_in[j] )
356                     break;
357             }
358             if( j >= MAX_CHANNEL_POSITIONS )
359             {
360                 msg_Warn( p_dec, "unknown channel ordering" );
361                 /* Invent something */
362                 j = i;
363             }
364             /* */
365             p_sys->pi_channel_positions[i] = pi_channels_out[j];
366             if( p_dec->fmt_out.audio.i_physical_channels & pi_channels_out[j] )
367                 frame.channels--; /* We loose a duplicated channel */
368             else
369                 p_dec->fmt_out.audio.i_physical_channels |= pi_channels_out[j];
370         }
371         p_dec->fmt_out.audio.i_original_channels =
372             p_dec->fmt_out.audio.i_physical_channels;
373
374         p_out = p_dec->pf_aout_buffer_new(p_dec, frame.samples/frame.channels);
375         if( p_out == NULL )
376         {
377             p_sys->i_buffer = 0;
378             block_Release( p_block );
379             return NULL;
380         }
381
382         p_out->start_date = aout_DateGet( &p_sys->date );
383         p_out->end_date = aout_DateIncrement( &p_sys->date,
384             (frame.samples / frame.channels) * p_sys->i_input_rate / INPUT_RATE_DEFAULT );
385
386         DoReordering( p_dec, (uint32_t *)p_out->p_buffer, samples,
387                       frame.samples / frame.channels, frame.channels,
388                       p_sys->pi_channel_positions );
389
390         p_sys->i_buffer -= frame.bytesconsumed;
391         if( p_sys->i_buffer > 0 )
392         {
393             memmove( p_sys->p_buffer, &p_sys->p_buffer[frame.bytesconsumed],
394                      p_sys->i_buffer );
395         }
396
397         return p_out;
398     }
399
400     block_Release( p_block );
401     return NULL;
402 }
403
404 /*****************************************************************************
405  * Close:
406  *****************************************************************************/
407 static void Close( vlc_object_t *p_this )
408 {
409     decoder_t *p_dec = (decoder_t *)p_this;
410     decoder_sys_t *p_sys = p_dec->p_sys;
411
412     faacDecClose( p_sys->hfaad );
413     if( p_sys->p_buffer ) free( p_sys->p_buffer );
414     free( p_sys );
415 }
416
417 /*****************************************************************************
418  * DoReordering: do some channel re-ordering (the ac3 channel order is
419  *   different from the aac one).
420  *****************************************************************************/
421 static void DoReordering( decoder_t *p_dec,
422                           uint32_t *p_out, uint32_t *p_in, int i_samples,
423                           int i_nb_channels, uint32_t *pi_chan_positions )
424 {
425     int pi_chan_table[MAX_CHANNEL_POSITIONS];
426     int i, j, k;
427
428     /* Find the channels mapping */
429     for( k = 0, j = 0; k < i_nb_channels; k++ )
430     {
431         for( i = 0; i < MAX_CHANNEL_POSITIONS; i++ )
432         {
433             if( pi_channels_ordered[i] == pi_chan_positions[k] )
434             {
435                 pi_chan_table[k] = j++;
436                 break;
437             }
438         }
439     }
440
441     /* Do the actual reordering */
442     if( vlc_CPU() & CPU_CAPABILITY_FPU )
443         for( i = 0; i < i_samples; i++ )
444             for( j = 0; j < i_nb_channels; j++ )
445                 p_out[i * i_nb_channels + pi_chan_table[j]] =
446                     p_in[i * i_nb_channels + j];
447     else
448         for( i = 0; i < i_samples; i++ )
449             for( j = 0; j < i_nb_channels; j++ )
450                 ((uint16_t *)p_out)[i * i_nb_channels + pi_chan_table[j]] =
451                     ((uint16_t *)p_in)[i * i_nb_channels + j];
452 }