07beb3e3d36aa8f7d9ad880c38b73732f8f2fff5
[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
74 static const uint32_t pi_channels_in[MAX_CHANNEL_POSITIONS] =
75     { FRONT_CHANNEL_CENTER, FRONT_CHANNEL_LEFT, FRONT_CHANNEL_RIGHT,
76       SIDE_CHANNEL_LEFT, SIDE_CHANNEL_RIGHT,
77       BACK_CHANNEL_LEFT, BACK_CHANNEL_RIGHT,
78       BACK_CHANNEL_CENTER, LFE_CHANNEL };
79 static const uint32_t pi_channels_out[MAX_CHANNEL_POSITIONS] =
80     { AOUT_CHAN_CENTER, AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
81       AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
82       AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,
83       AOUT_CHAN_REARCENTER, AOUT_CHAN_LFE };
84 static const uint32_t pi_channels_ordered[MAX_CHANNEL_POSITIONS] =
85     { AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
86       AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
87       AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,
88       AOUT_CHAN_CENTER, AOUT_CHAN_REARCENTER, AOUT_CHAN_LFE
89     };
90
91 /*****************************************************************************
92  * OpenDecoder: probe the decoder and return score
93  *****************************************************************************/
94 static int Open( vlc_object_t *p_this )
95 {
96     decoder_t *p_dec = (decoder_t*)p_this;
97     decoder_sys_t *p_sys = p_dec->p_sys;
98     faacDecConfiguration *cfg;
99
100     if( p_dec->fmt_in.i_codec != VLC_FOURCC('m','p','4','a') )
101     {
102         return VLC_EGENERIC;
103     }
104
105     /* Allocate the memory needed to store the decoder's structure */
106     if( ( p_dec->p_sys = p_sys =
107           (decoder_sys_t *)malloc(sizeof(decoder_sys_t)) ) == NULL )
108     {
109         msg_Err( p_dec, "out of memory" );
110         return VLC_EGENERIC;
111     }
112
113     /* Open a faad context */
114     if( ( p_sys->hfaad = faacDecOpen() ) == NULL )
115     {
116         msg_Err( p_dec, "cannot initialize faad" );
117         return VLC_EGENERIC;
118     }
119
120     /* Misc init */
121     aout_DateSet( &p_sys->date, 0 );
122     p_dec->fmt_out.i_cat = AUDIO_ES;
123
124     if (vlc_CPU() & CPU_CAPABILITY_FPU)
125         p_dec->fmt_out.i_codec = VLC_FOURCC('f','l','3','2');
126     else
127         p_dec->fmt_out.i_codec = AOUT_FMT_S16_NE;
128     p_dec->pf_decode_audio = DecodeBlock;
129
130     p_dec->fmt_out.audio.i_physical_channels =
131         p_dec->fmt_out.audio.i_original_channels = 0;
132
133     if( p_dec->fmt_in.i_extra > 0 )
134     {
135         /* We have a decoder config so init the handle */
136         unsigned long i_rate;
137         unsigned char i_channels;
138
139         if( faacDecInit2( p_sys->hfaad, p_dec->fmt_in.p_extra,
140                           p_dec->fmt_in.i_extra,
141                           &i_rate, &i_channels ) < 0 )
142         {
143             return VLC_EGENERIC;
144         }
145
146         p_dec->fmt_out.audio.i_rate = i_rate;
147         p_dec->fmt_out.audio.i_channels = i_channels;
148         aout_DateInit( &p_sys->date, i_rate );
149     }
150     else
151     {
152         /* Will be initalised from first frame */
153         p_dec->fmt_out.audio.i_rate = 0;
154         p_dec->fmt_out.audio.i_channels = 0;
155     }
156
157     /* Set the faad config */
158     cfg = faacDecGetCurrentConfiguration( p_sys->hfaad );
159     if (vlc_CPU() & CPU_CAPABILITY_FPU)
160         cfg->outputFormat = FAAD_FMT_FLOAT;
161     else
162         cfg->outputFormat = FAAD_FMT_16BIT;
163     faacDecSetConfiguration( p_sys->hfaad, cfg );
164
165     /* buffer */
166     p_sys->i_buffer = p_sys->i_buffer_size = 0;
167     p_sys->p_buffer = 0;
168
169     /* Faad2 can't deal with truncated data (eg. from MPEG TS) */
170     p_dec->b_need_packetized = VLC_TRUE;
171
172     p_sys->b_sbr = p_sys->b_ps = VLC_FALSE;
173     return VLC_SUCCESS;
174 }
175
176 /*****************************************************************************
177  * DecodeBlock:
178  *****************************************************************************/
179 static aout_buffer_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
180 {
181     decoder_sys_t *p_sys = p_dec->p_sys;
182     block_t *p_block;
183
184     if( !pp_block || !*pp_block ) return NULL;
185
186     p_block = *pp_block;
187
188     if( p_block->i_flags&(BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
189     {
190         block_Release( p_block );
191         return NULL;
192     }
193
194     /* Append the block to the temporary buffer */
195     if( p_sys->i_buffer_size < p_sys->i_buffer + p_block->i_buffer )
196     {
197         p_sys->i_buffer_size = p_sys->i_buffer + p_block->i_buffer;
198         p_sys->p_buffer = realloc( p_sys->p_buffer, p_sys->i_buffer_size );
199     }
200
201     if( p_block->i_buffer )
202     {
203         memcpy( &p_sys->p_buffer[p_sys->i_buffer],
204                 p_block->p_buffer, p_block->i_buffer );
205         p_sys->i_buffer += p_block->i_buffer;
206         p_block->i_buffer = 0;
207     }
208
209     if( p_dec->fmt_out.audio.i_rate == 0 && p_dec->fmt_in.i_extra > 0 )
210     {
211         /* We have a decoder config so init the handle */
212         unsigned long i_rate;
213         unsigned char i_channels;
214
215         if( faacDecInit2( p_sys->hfaad, p_dec->fmt_in.p_extra,
216                           p_dec->fmt_in.i_extra,
217                           &i_rate, &i_channels ) >= 0 )
218         {
219             p_dec->fmt_out.audio.i_rate = i_rate;
220             p_dec->fmt_out.audio.i_channels = i_channels;
221             aout_DateInit( &p_sys->date, i_rate );
222         }
223     }
224
225     if( p_dec->fmt_out.audio.i_rate == 0 && p_sys->i_buffer )
226     {
227         unsigned long i_rate;
228         unsigned char i_channels;
229
230         /* Init faad with the first frame */
231         if( faacDecInit( p_sys->hfaad,
232                          p_sys->p_buffer, p_sys->i_buffer,
233                          &i_rate, &i_channels ) < 0 )
234         {
235             block_Release( p_block );
236             return NULL;
237         }
238
239         p_dec->fmt_out.audio.i_rate = i_rate;
240         p_dec->fmt_out.audio.i_channels = i_channels;
241         aout_DateInit( &p_sys->date, i_rate );
242     }
243
244     if( p_block->i_pts != 0 && p_block->i_pts != aout_DateGet( &p_sys->date ) )
245     {
246         aout_DateSet( &p_sys->date, p_block->i_pts );
247     }
248     else if( !aout_DateGet( &p_sys->date ) )
249     {
250         /* We've just started the stream, wait for the first PTS. */
251         block_Release( p_block );
252         p_sys->i_buffer = 0;
253         return NULL;
254     }
255
256     /* Decode all data */
257     if( p_sys->i_buffer )
258     {
259         void *samples;
260         faacDecFrameInfo frame;
261         aout_buffer_t *p_out;
262         int i, j;
263
264         samples = faacDecDecode( p_sys->hfaad, &frame,
265                                  p_sys->p_buffer, p_sys->i_buffer );
266
267         if( frame.error > 0 )
268         {
269             msg_Warn( p_dec, "%s", faacDecGetErrorMessage( frame.error ) );
270
271             /* Flush the buffer */
272             p_sys->i_buffer = 0;
273             block_Release( p_block );
274             return NULL;
275         }
276
277         if( frame.channels <= 0 || frame.channels > 8 || frame.channels == 7 )
278         {
279             msg_Warn( p_dec, "invalid channels count: %i", frame.channels );
280
281             /* Flush the buffer */
282             p_sys->i_buffer -= frame.bytesconsumed;
283             if( p_sys->i_buffer > 0 )
284             {
285                 memmove( p_sys->p_buffer,&p_sys->p_buffer[frame.bytesconsumed],
286                          p_sys->i_buffer );
287             }
288             block_Release( p_block );
289             return NULL;
290         }
291
292         if( frame.samples <= 0 )
293         {
294             msg_Warn( p_dec, "decoded zero sample" );
295
296             /* Flush the buffer */
297             p_sys->i_buffer -= frame.bytesconsumed;
298             if( p_sys->i_buffer > 0 )
299             {
300                 memmove( p_sys->p_buffer,&p_sys->p_buffer[frame.bytesconsumed],
301                          p_sys->i_buffer );
302             }
303             block_Release( p_block );
304             return NULL;
305         }
306
307         /* We decoded a valid frame */
308         if( p_dec->fmt_out.audio.i_rate != frame.samplerate )
309         {
310             aout_DateInit( &p_sys->date, frame.samplerate );
311             aout_DateSet( &p_sys->date, p_block->i_pts );
312         }
313         p_block->i_pts = 0;  /* PTS is valid only once */
314
315         p_dec->fmt_out.audio.i_rate = frame.samplerate;
316         p_dec->fmt_out.audio.i_channels = frame.channels;
317
318         /* Adjust stream info when dealing with SBR/PS */
319         if( (p_sys->b_sbr != frame.sbr || p_sys->b_ps != frame.ps) &&
320             p_dec->p_parent->i_object_type == VLC_OBJECT_INPUT )
321         {
322           input_thread_t *p_input = (input_thread_t *)p_dec->p_parent;
323           char *psz_cat;
324           const char *psz_ext = (frame.sbr && frame.ps) ? "SBR+PS" :
325                                     frame.sbr ? "SBR" : "PS";
326
327           msg_Dbg( p_dec, "AAC %s (channels: %u, samplerate: %lu)",
328                    psz_ext, frame.channels, frame.samplerate );
329
330           asprintf( &psz_cat, _("Stream %d"), p_dec->fmt_in.i_id );
331           input_Control( p_input, INPUT_ADD_INFO, psz_cat,
332                           _("AAC extension"), "%s", psz_ext );
333           input_Control( p_input, INPUT_ADD_INFO, psz_cat,
334                          _("Channels"), "%d", frame.channels );
335           input_Control( p_input, INPUT_ADD_INFO, psz_cat,
336                          _("Sample rate"), _("%d Hz"), frame.samplerate );
337           free( psz_cat );
338           p_sys->b_sbr = frame.sbr; p_sys->b_ps = frame.ps;
339         }
340
341         /* Convert frame.channel_position to our own channel values */
342         p_dec->fmt_out.audio.i_physical_channels = 0;
343         for( i = 0; i < frame.channels; i++ )
344         {
345             /* Find the channel code */
346             for( j = 0; j < MAX_CHANNEL_POSITIONS; j++ )
347             {
348                 if( frame.channel_position[i] == pi_channels_in[j] )
349                     break;
350             }
351             if( j >= MAX_CHANNEL_POSITIONS )
352             {
353                 msg_Warn( p_dec, "unknown channel ordering" );
354                 /* Invent something */
355                 j = i;
356             }
357             /* */
358             p_sys->pi_channel_positions[i] = pi_channels_out[j];
359             if( p_dec->fmt_out.audio.i_physical_channels & pi_channels_out[j] )
360                 frame.channels--; /* We loose a duplicated channel */
361             else
362                 p_dec->fmt_out.audio.i_physical_channels |= pi_channels_out[j];
363         }
364         p_dec->fmt_out.audio.i_original_channels =
365             p_dec->fmt_out.audio.i_physical_channels;
366
367         p_out = p_dec->pf_aout_buffer_new(p_dec, frame.samples/frame.channels);
368         if( p_out == NULL )
369         {
370             p_sys->i_buffer = 0;
371             block_Release( p_block );
372             return NULL;
373         }
374
375         p_out->start_date = aout_DateGet( &p_sys->date );
376         p_out->end_date = aout_DateIncrement( &p_sys->date,
377                                               frame.samples / frame.channels );
378
379         DoReordering( p_dec, (uint32_t *)p_out->p_buffer, samples,
380                       frame.samples / frame.channels, frame.channels,
381                       p_sys->pi_channel_positions );
382
383         p_sys->i_buffer -= frame.bytesconsumed;
384         if( p_sys->i_buffer > 0 )
385         {
386             memmove( p_sys->p_buffer, &p_sys->p_buffer[frame.bytesconsumed],
387                      p_sys->i_buffer );
388         }
389
390         return p_out;
391     }
392
393     block_Release( p_block );
394     return NULL;
395 }
396
397 /*****************************************************************************
398  * Close:
399  *****************************************************************************/
400 static void Close( vlc_object_t *p_this )
401 {
402     decoder_t *p_dec = (decoder_t *)p_this;
403     decoder_sys_t *p_sys = p_dec->p_sys;
404
405     faacDecClose( p_sys->hfaad );
406     if( p_sys->p_buffer ) free( p_sys->p_buffer );
407     free( p_sys );
408 }
409
410 /*****************************************************************************
411  * DoReordering: do some channel re-ordering (the ac3 channel order is
412  *   different from the aac one).
413  *****************************************************************************/
414 static void DoReordering( decoder_t *p_dec,
415                           uint32_t *p_out, uint32_t *p_in, int i_samples,
416                           int i_nb_channels, uint32_t *pi_chan_positions )
417 {
418     int pi_chan_table[MAX_CHANNEL_POSITIONS];
419     int i, j, k;
420
421     /* Find the channels mapping */
422     for( k = 0, j = 0; k < i_nb_channels; k++ )
423     {
424         for( i = 0; i < MAX_CHANNEL_POSITIONS; i++ )
425         {
426             if( pi_channels_ordered[i] == pi_chan_positions[k] )
427             {
428                 pi_chan_table[k] = j++;
429                 break;
430             }
431         }
432     }
433
434     /* Do the actual reordering */
435     if( vlc_CPU() & CPU_CAPABILITY_FPU )
436         for( i = 0; i < i_samples; i++ )
437             for( j = 0; j < i_nb_channels; j++ )
438                 p_out[i * i_nb_channels + pi_chan_table[j]] =
439                     p_in[i * i_nb_channels + j];
440     else
441         for( i = 0; i < i_samples; i++ )
442             for( j = 0; j < i_nb_channels; j++ )
443                 ((uint16_t *)p_out)[i * i_nb_channels + pi_chan_table[j]] =
444                     ((uint16_t *)p_in)[i * i_nb_channels + j];
445 }