]> git.sesse.net Git - vlc/blob - modules/codec/a52.c
a52: use VLC_TS_INVALID (refs #3135)
[vlc] / modules / codec / a52.c
1 /*****************************************************************************
2  * a52.c: parse A/52 audio sync info and packetize the stream
3  *****************************************************************************
4  * Copyright (C) 2001-2002 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Stéphane Borel <stef@via.ecp.fr>
8  *          Christophe Massiot <massiot@via.ecp.fr>
9  *          Gildas Bazin <gbazin@videolan.org>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24  *****************************************************************************/
25
26 /*****************************************************************************
27  * Preamble
28  *****************************************************************************/
29 #ifdef HAVE_CONFIG_H
30 # include "config.h"
31 #endif
32
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
35 #include <vlc_codec.h>
36 #include <vlc_aout.h>
37 #include <vlc_block_helper.h>
38
39 #include "a52.h"
40
41 /*****************************************************************************
42  * Module descriptor
43  *****************************************************************************/
44 static int  OpenDecoder   ( vlc_object_t * );
45 static int  OpenPacketizer( vlc_object_t * );
46 static void CloseCommon   ( vlc_object_t * );
47
48 vlc_module_begin ()
49     set_description( N_("A/52 parser") )
50     set_capability( "decoder", 100 )
51     set_callbacks( OpenDecoder, CloseCommon )
52     set_category( CAT_INPUT )
53     set_subcategory( SUBCAT_INPUT_ACODEC )
54
55     add_submodule ()
56     set_description( N_("A/52 audio packetizer") )
57     set_capability( "packetizer", 10 )
58     set_callbacks( OpenPacketizer, CloseCommon )
59 vlc_module_end ()
60
61 /*****************************************************************************
62  * decoder_sys_t : decoder descriptor
63  *****************************************************************************/
64
65 struct decoder_sys_t
66 {
67     /* Module mode */
68     bool b_packetizer;
69
70     /*
71      * Input properties
72      */
73     int i_state;
74
75     block_bytestream_t bytestream;
76
77     /*
78      * Common properties
79      */
80     date_t  end_date;
81
82     mtime_t i_pts;
83
84     vlc_a52_header_t frame;
85 };
86
87 enum {
88
89     STATE_NOSYNC,
90     STATE_SYNC,
91     STATE_HEADER,
92     STATE_NEXT_SYNC,
93     STATE_GET_DATA,
94     STATE_SEND_DATA
95 };
96
97 /****************************************************************************
98  * Local prototypes
99  ****************************************************************************/
100 static void *DecodeBlock  ( decoder_t *, block_t ** );
101
102 static uint8_t       *GetOutBuffer ( decoder_t *, void ** );
103 static aout_buffer_t *GetAoutBuffer( decoder_t * );
104 static block_t       *GetSoutBuffer( decoder_t * );
105
106 /*****************************************************************************
107  * OpenCommon: probe the decoder/packetizer and return score
108  *****************************************************************************/
109 static int OpenCommon( vlc_object_t *p_this, bool b_packetizer )
110 {
111     decoder_t *p_dec = (decoder_t*)p_this;
112     decoder_sys_t *p_sys;
113     vlc_fourcc_t i_codec;
114
115     switch( p_dec->fmt_in.i_codec )
116     {
117     case VLC_CODEC_A52:
118         i_codec = VLC_CODEC_A52;
119         break;
120     case VLC_CODEC_EAC3:
121         /* XXX ugly hack, a52 does not support eac3 so no eac3 pass-through
122          * support */
123         if( !b_packetizer )
124             return VLC_EGENERIC;
125         i_codec = VLC_CODEC_EAC3;
126         break;
127     default:
128         return VLC_EGENERIC;
129     }
130
131     /* Allocate the memory needed to store the decoder's structure */
132     if( ( p_dec->p_sys = p_sys =
133           (decoder_sys_t *)malloc(sizeof(decoder_sys_t)) ) == NULL )
134         return VLC_ENOMEM;
135
136     /* Misc init */
137     p_sys->b_packetizer = b_packetizer;
138     p_sys->i_state = STATE_NOSYNC;
139     date_Set( &p_sys->end_date, 0 );
140     p_sys->i_pts = VLC_TS_INVALID;
141
142     p_sys->bytestream = block_BytestreamInit();
143
144     /* Set output properties */
145     p_dec->fmt_out.i_cat = AUDIO_ES;
146     p_dec->fmt_out.i_codec = i_codec;
147     p_dec->fmt_out.audio.i_rate = 0; /* So end_date gets initialized */
148     p_dec->fmt_out.audio.i_bytes_per_frame = 0;
149
150     /* Set callback */
151     if( b_packetizer )
152         p_dec->pf_packetize    = (block_t *(*)(decoder_t *, block_t **))
153             DecodeBlock;
154     else
155         p_dec->pf_decode_audio = (aout_buffer_t *(*)(decoder_t *, block_t **))
156             DecodeBlock;
157     return VLC_SUCCESS;
158 }
159
160 static int OpenDecoder( vlc_object_t *p_this )
161 {
162     return OpenCommon( p_this, false );
163 }
164
165 static int OpenPacketizer( vlc_object_t *p_this )
166 {
167     return OpenCommon( p_this, true );
168 }
169
170 /****************************************************************************
171  * DecodeBlock: the whole thing
172  ****************************************************************************
173  * This function is called just after the thread is launched.
174  ****************************************************************************/
175 static void *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
176 {
177     decoder_sys_t *p_sys = p_dec->p_sys;
178     uint8_t p_header[VLC_A52_HEADER_SIZE];
179     uint8_t *p_buf;
180     void *p_out_buffer;
181
182     if( !pp_block || !*pp_block ) return NULL;
183
184     if( (*pp_block)->i_flags&(BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
185     {
186         if( (*pp_block)->i_flags&BLOCK_FLAG_CORRUPTED )
187         {
188             p_sys->i_state = STATE_NOSYNC;
189             block_BytestreamEmpty( &p_sys->bytestream );
190         }
191         date_Set( &p_sys->end_date, 0 );
192         block_Release( *pp_block );
193         return NULL;
194     }
195
196     if( !date_Get( &p_sys->end_date ) && (*pp_block)->i_pts <= VLC_TS_INVALID)
197     {
198         /* We've just started the stream, wait for the first PTS. */
199         block_Release( *pp_block );
200         return NULL;
201     }
202
203     block_BytestreamPush( &p_sys->bytestream, *pp_block );
204
205     while( 1 )
206     {
207         switch( p_sys->i_state )
208         {
209         case STATE_NOSYNC:
210             while( block_PeekBytes( &p_sys->bytestream, p_header, 2 )
211                    == VLC_SUCCESS )
212             {
213                 if( p_header[0] == 0x0b && p_header[1] == 0x77 )
214                 {
215                     p_sys->i_state = STATE_SYNC;
216                     break;
217                 }
218                 block_SkipByte( &p_sys->bytestream );
219             }
220             if( p_sys->i_state != STATE_SYNC )
221             {
222                 block_BytestreamFlush( &p_sys->bytestream );
223
224                 /* Need more data */
225                 return NULL;
226             }
227
228         case STATE_SYNC:
229             /* New frame, set the Presentation Time Stamp */
230             p_sys->i_pts = p_sys->bytestream.p_block->i_pts;
231             if( p_sys->i_pts > VLC_TS_INVALID &&
232                 p_sys->i_pts != date_Get( &p_sys->end_date ) )
233             {
234                 date_Set( &p_sys->end_date, p_sys->i_pts );
235             }
236             p_sys->i_state = STATE_HEADER;
237
238         case STATE_HEADER:
239             /* Get A/52 frame header (VLC_A52_HEADER_SIZE bytes) */
240             if( block_PeekBytes( &p_sys->bytestream, p_header,
241                                  VLC_A52_HEADER_SIZE ) != VLC_SUCCESS )
242             {
243                 /* Need more data */
244                 return NULL;
245             }
246
247             /* Check if frame is valid and get frame info */
248             if( vlc_a52_header_Parse( &p_sys->frame, p_header, VLC_A52_HEADER_SIZE ) )
249             {
250                 msg_Dbg( p_dec, "emulated sync word" );
251                 block_SkipByte( &p_sys->bytestream );
252                 p_sys->i_state = STATE_NOSYNC;
253                 break;
254             }
255
256             p_sys->i_state = STATE_NEXT_SYNC;
257
258         case STATE_NEXT_SYNC:
259             /* TODO: If pp_block == NULL, flush the buffer without checking the
260              * next sync word */
261
262             /* Check if next expected frame contains the sync word */
263             if( block_PeekOffsetBytes( &p_sys->bytestream,
264                                        p_sys->frame.i_size, p_header, 2 )
265                 != VLC_SUCCESS )
266             {
267                 /* Need more data */
268                 return NULL;
269             }
270
271             if( p_sys->b_packetizer &&
272                 p_header[0] == 0 && p_header[1] == 0 )
273             {
274                 /* A52 wav files and audio CD's use stuffing */
275                 p_sys->i_state = STATE_GET_DATA;
276                 break;
277             }
278
279             if( p_header[0] != 0x0b || p_header[1] != 0x77 )
280             {
281                 msg_Dbg( p_dec, "emulated sync word "
282                          "(no sync on following frame)" );
283                 p_sys->i_state = STATE_NOSYNC;
284                 block_SkipByte( &p_sys->bytestream );
285                 break;
286             }
287             p_sys->i_state = STATE_SEND_DATA;
288             break;
289
290         case STATE_GET_DATA:
291             /* Make sure we have enough data.
292              * (Not useful if we went through NEXT_SYNC) */
293             if( block_WaitBytes( &p_sys->bytestream,
294                                  p_sys->frame.i_size ) != VLC_SUCCESS )
295             {
296                 /* Need more data */
297                 return NULL;
298             }
299             p_sys->i_state = STATE_SEND_DATA;
300
301         case STATE_SEND_DATA:
302             if( !(p_buf = GetOutBuffer( p_dec, &p_out_buffer )) )
303             {
304                 //p_dec->b_error = true;
305                 return NULL;
306             }
307
308             /* Copy the whole frame into the buffer. When we reach this point
309              * we already know we have enough data available. */
310             block_GetBytes( &p_sys->bytestream, p_buf, p_sys->frame.i_size );
311
312             /* Make sure we don't reuse the same pts twice */
313             if( p_sys->i_pts == p_sys->bytestream.p_block->i_pts )
314                 p_sys->i_pts = p_sys->bytestream.p_block->i_pts = VLC_TS_INVALID;
315
316             /* So p_block doesn't get re-added several times */
317             *pp_block = block_BytestreamPop( &p_sys->bytestream );
318
319             p_sys->i_state = STATE_NOSYNC;
320
321             return p_out_buffer;
322         }
323     }
324
325     return NULL;
326 }
327
328 /*****************************************************************************
329  * CloseCommon: clean up the decoder
330  *****************************************************************************/
331 static void CloseCommon( vlc_object_t *p_this )
332 {
333     decoder_t *p_dec = (decoder_t*)p_this;
334     decoder_sys_t *p_sys = p_dec->p_sys;
335
336     block_BytestreamRelease( &p_sys->bytestream );
337
338     free( p_sys );
339 }
340
341 /*****************************************************************************
342  * GetOutBuffer:
343  *****************************************************************************/
344 static uint8_t *GetOutBuffer( decoder_t *p_dec, void **pp_out_buffer )
345 {
346     decoder_sys_t *p_sys = p_dec->p_sys;
347     uint8_t *p_buf;
348
349     if( p_dec->fmt_out.audio.i_rate != p_sys->frame.i_rate )
350     {
351         msg_Info( p_dec, "A/52 channels:%d samplerate:%d bitrate:%d",
352                   p_sys->frame.i_channels, p_sys->frame.i_rate, p_sys->frame.i_bitrate );
353
354         date_Init( &p_sys->end_date, p_sys->frame.i_rate, 1 );
355         date_Set( &p_sys->end_date, p_sys->i_pts );
356     }
357
358     p_dec->fmt_out.audio.i_rate     = p_sys->frame.i_rate;
359     p_dec->fmt_out.audio.i_channels = p_sys->frame.i_channels;
360     if( p_dec->fmt_out.audio.i_bytes_per_frame < p_sys->frame.i_size )
361         p_dec->fmt_out.audio.i_bytes_per_frame = p_sys->frame.i_size;
362     p_dec->fmt_out.audio.i_frame_length = p_sys->frame.i_samples;
363
364     p_dec->fmt_out.audio.i_original_channels = p_sys->frame.i_channels_conf;
365     p_dec->fmt_out.audio.i_physical_channels =
366         p_sys->frame.i_channels_conf & AOUT_CHAN_PHYSMASK;
367
368     p_dec->fmt_out.i_bitrate = p_sys->frame.i_bitrate;
369
370     if( p_sys->b_packetizer )
371     {
372         block_t *p_sout_buffer = GetSoutBuffer( p_dec );
373         p_buf = p_sout_buffer ? p_sout_buffer->p_buffer : NULL;
374         *pp_out_buffer = p_sout_buffer;
375     }
376     else
377     {
378         aout_buffer_t *p_aout_buffer = GetAoutBuffer( p_dec );
379         p_buf = p_aout_buffer ? p_aout_buffer->p_buffer : NULL;
380         *pp_out_buffer = p_aout_buffer;
381     }
382
383     return p_buf;
384 }
385
386 /*****************************************************************************
387  * GetAoutBuffer:
388  *****************************************************************************/
389 static aout_buffer_t *GetAoutBuffer( decoder_t *p_dec )
390 {
391     decoder_sys_t *p_sys = p_dec->p_sys;
392     aout_buffer_t *p_buf;
393
394     p_buf = decoder_NewAudioBuffer( p_dec, p_sys->frame.i_samples );
395     if( p_buf == NULL ) return NULL;
396
397     p_buf->i_pts = date_Get( &p_sys->end_date );
398     p_buf->i_length = date_Increment( &p_sys->end_date,
399                                       p_sys->frame.i_samples ) - p_buf->i_pts;
400
401     return p_buf;
402 }
403
404 /*****************************************************************************
405  * GetSoutBuffer:
406  *****************************************************************************/
407 static block_t *GetSoutBuffer( decoder_t *p_dec )
408 {
409     decoder_sys_t *p_sys = p_dec->p_sys;
410     block_t *p_block;
411
412     p_block = block_New( p_dec, p_sys->frame.i_size );
413     if( p_block == NULL ) return NULL;
414
415     p_block->i_pts = p_block->i_dts = date_Get( &p_sys->end_date );
416
417     p_block->i_length =
418         date_Increment( &p_sys->end_date, p_sys->frame.i_samples ) - p_block->i_pts;
419
420     return p_block;
421 }
422