]> git.sesse.net Git - vlc/blob - modules/demux/flac.c
demux: ogg: remove old debug info
[vlc] / modules / demux / flac.c
1 /*****************************************************************************
2  * flac.c : FLAC demux module for vlc
3  *****************************************************************************
4  * Copyright (C) 2001-2008 VLC authors and VideoLAN
5  * $Id$
6  *
7  * Authors: Gildas Bazin <gbazin@netcourrier.com>
8  *          Laurent Aimar <fenrir@via.ecp.fr>
9  *
10  * This program is free software; you can redistribute it and/or modify it
11  * under the terms of the GNU Lesser General Public License as published by
12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 /*****************************************************************************
26  * Preamble
27  *****************************************************************************/
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_demux.h>
35 #include <vlc_meta.h>                 /* vlc_meta_* */
36 #include <vlc_input.h>                /* vlc_input_attachment, vlc_seekpoint */
37 #include <vlc_codec.h>                /* decoder_t */
38 #include <vlc_charset.h>              /* EnsureUTF8 */
39
40 #include <assert.h>
41 #include "xiph_metadata.h"            /* vorbis comments */
42
43 /*****************************************************************************
44  * Module descriptor
45  *****************************************************************************/
46 static int  Open  ( vlc_object_t * );
47 static void Close ( vlc_object_t * );
48
49 vlc_module_begin ()
50     set_description( N_("FLAC demuxer") )
51     set_capability( "demux", 155 )
52     set_category( CAT_INPUT )
53     set_subcategory( SUBCAT_INPUT_DEMUX )
54     set_callbacks( Open, Close )
55     add_shortcut( "flac" )
56 vlc_module_end ()
57
58 /*****************************************************************************
59  * Local prototypes
60  *****************************************************************************/
61 static int Demux  ( demux_t * );
62 static int Control( demux_t *, int, va_list );
63
64 static int  ReadMeta( demux_t *, uint8_t **pp_streaminfo, int *pi_streaminfo );
65
66 struct demux_sys_t
67 {
68     bool  b_start;
69     es_out_id_t *p_es;
70
71     /* Packetizer */
72     decoder_t *p_packetizer;
73
74     vlc_meta_t *p_meta;
75
76     int64_t i_time_offset;
77     int64_t i_pts;
78     int64_t i_pts_start;
79
80     int64_t i_length; /* Length from stream info */
81     int64_t i_data_pos;
82
83     /* */
84     int         i_seekpoint;
85     seekpoint_t **seekpoint;
86
87     /* */
88     int                i_attachments;
89     input_attachment_t **attachments;
90     int                i_cover_idx;
91     int                i_cover_score;
92 };
93
94 #define STREAMINFO_SIZE 34
95 #define FLAC_PACKET_SIZE 16384
96
97 /*****************************************************************************
98  * Open: initializes ES structures
99  *****************************************************************************/
100 static int Open( vlc_object_t * p_this )
101 {
102     demux_t     *p_demux = (demux_t*)p_this;
103     demux_sys_t *p_sys;
104     const uint8_t *p_peek;
105     uint8_t     *p_streaminfo;
106     int         i_streaminfo;
107     es_format_t fmt;
108
109     /* Have a peep at the show. */
110     if( stream_Peek( p_demux->s, &p_peek, 4 ) < 4 ) return VLC_EGENERIC;
111
112     if( p_peek[0]!='f' || p_peek[1]!='L' || p_peek[2]!='a' || p_peek[3]!='C' )
113     {
114         if( !p_demux->b_force ) return VLC_EGENERIC;
115
116         /* User forced */
117         msg_Err( p_demux, "this doesn't look like a flac stream, "
118                  "continuing anyway" );
119     }
120
121     p_sys = malloc( sizeof( demux_sys_t ) );
122     if( unlikely(p_sys == NULL) )
123         return VLC_ENOMEM;
124
125     p_demux->pf_demux   = Demux;
126     p_demux->pf_control = Control;
127     p_demux->p_sys      = p_sys;
128     p_sys->b_start = true;
129     p_sys->p_meta = NULL;
130     p_sys->i_length = 0;
131     p_sys->i_time_offset = 0;
132     p_sys->i_pts = 0;
133     p_sys->i_pts_start = 0;
134     p_sys->p_es = NULL;
135     TAB_INIT( p_sys->i_seekpoint, p_sys->seekpoint );
136     TAB_INIT( p_sys->i_attachments, p_sys->attachments);
137     p_sys->i_cover_idx = 0;
138     p_sys->i_cover_score = 0;
139
140     /* We need to read and store the STREAMINFO metadata */
141     if( ReadMeta( p_demux, &p_streaminfo, &i_streaminfo ) )
142     {
143         free( p_sys );
144         return VLC_EGENERIC;
145     }
146
147     /* Load the FLAC packetizer */
148     /* Store STREAMINFO for the decoder and packetizer */
149     es_format_Init( &fmt, AUDIO_ES, VLC_CODEC_FLAC );
150     fmt.i_extra = i_streaminfo;
151     fmt.p_extra = p_streaminfo;
152
153     p_sys->p_packetizer = demux_PacketizerNew( p_demux, &fmt, "flac" );
154     if( !p_sys->p_packetizer )
155     {
156         free( p_sys );
157         return VLC_EGENERIC;
158     }
159
160     if( p_sys->i_cover_idx < p_sys->i_attachments )
161     {
162         char psz_url[128];
163         if( !p_sys->p_meta )
164             p_sys->p_meta = vlc_meta_New();
165         snprintf( psz_url, sizeof(psz_url), "attachment://%s",
166                   p_sys->attachments[p_sys->i_cover_idx]->psz_name );
167         vlc_meta_Set( p_sys->p_meta, vlc_meta_ArtworkURL, psz_url );
168     }
169     return VLC_SUCCESS;
170 }
171
172 /*****************************************************************************
173  * Close: frees unused data
174  *****************************************************************************/
175 static void Close( vlc_object_t * p_this )
176 {
177     demux_t     *p_demux = (demux_t*)p_this;
178     demux_sys_t *p_sys = p_demux->p_sys;
179
180     for( int i = 0; i < p_sys->i_seekpoint; i++ )
181         vlc_seekpoint_Delete(p_sys->seekpoint[i]);
182     TAB_CLEAN( p_sys->i_seekpoint, p_sys->seekpoint );
183
184     for( int i = 0; i < p_sys->i_attachments; i++ )
185         vlc_input_attachment_Delete( p_sys->attachments[i] );
186     TAB_CLEAN( p_sys->i_attachments, p_sys->attachments);
187
188     /* Delete the decoder */
189     demux_PacketizerDestroy( p_sys->p_packetizer );
190
191     if( p_sys->p_meta )
192         vlc_meta_Delete( p_sys->p_meta );
193     free( p_sys );
194 }
195
196 /*****************************************************************************
197  * Demux: reads and demuxes data packets
198  *****************************************************************************
199  * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
200  *****************************************************************************/
201 static int Demux( demux_t *p_demux )
202 {
203     demux_sys_t *p_sys = p_demux->p_sys;
204     block_t     *p_block_in, *p_block_out;
205
206     if( !( p_block_in = stream_Block( p_demux->s, FLAC_PACKET_SIZE ) ) )
207         return 0;
208
209     p_block_in->i_pts = p_block_in->i_dts = p_sys->b_start ? VLC_TS_0 : VLC_TS_INVALID;
210     p_sys->b_start = false;
211
212     while( (p_block_out = p_sys->p_packetizer->pf_packetize(
213                 p_sys->p_packetizer, &p_block_in )) )
214     {
215         while( p_block_out )
216         {
217             block_t *p_next = p_block_out->p_next;
218
219             p_block_out->p_next = NULL;
220
221             if( p_sys->p_es == NULL )
222             {
223                 p_sys->p_packetizer->fmt_out.b_packetized = true;
224                 p_sys->p_es = es_out_Add( p_demux->out, &p_sys->p_packetizer->fmt_out);
225             }
226
227             p_sys->i_pts = p_block_out->i_dts - VLC_TS_0;
228
229             /* Correct timestamp */
230             p_block_out->i_pts += p_sys->i_time_offset;
231             p_block_out->i_dts += p_sys->i_time_offset;
232
233             /* set PCR */
234             es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block_out->i_dts );
235
236             es_out_Send( p_demux->out, p_sys->p_es, p_block_out );
237
238             p_block_out = p_next;
239         }
240     }
241     return 1;
242 }
243
244 /*****************************************************************************
245  * Control:
246  *****************************************************************************/
247 static int64_t ControlGetLength( demux_t *p_demux )
248 {
249     demux_sys_t *p_sys = p_demux->p_sys;
250     const int64_t i_size = stream_Size(p_demux->s) - p_sys->i_data_pos;
251     int64_t i_length = p_sys->i_length;
252     int i;
253
254     /* Try to fix length using seekpoint and current size for truncated file */
255     for( i = p_sys->i_seekpoint-1; i >= 0; i-- )
256     {
257         seekpoint_t *s = p_sys->seekpoint[i];
258         if( s->i_byte_offset <= i_size )
259         {
260             if( i+1 < p_sys->i_seekpoint )
261             {
262                 /* Broken file */
263                 seekpoint_t *n = p_sys->seekpoint[i+1];
264                 assert( n->i_byte_offset != s->i_byte_offset); /* Should be ensured by ParseSeekTable */
265                 i_length = s->i_time_offset + (n->i_time_offset-s->i_time_offset) * (i_size-s->i_byte_offset) / (n->i_byte_offset-s->i_byte_offset);
266             }
267             break;
268         }
269     }
270     return i_length;
271 }
272
273 static int64_t ControlGetTime( demux_t *p_demux )
274 {
275     demux_sys_t *p_sys = p_demux->p_sys;
276     return __MAX(p_sys->i_pts, p_sys->i_pts_start) + p_sys->i_time_offset;
277 }
278
279 static int ControlSetTime( demux_t *p_demux, int64_t i_time )
280 {
281     demux_sys_t *p_sys = p_demux->p_sys;
282     int64_t i_delta_time;
283     bool b_seekable;
284     int i;
285
286     /* */
287     stream_Control( p_demux->s, STREAM_CAN_SEEK, &b_seekable );
288     if( !b_seekable )
289         return VLC_EGENERIC;
290
291     /* */
292     assert( p_sys->i_seekpoint > 0 );   /* ReadMeta ensure at least (0,0) */
293     for( i = p_sys->i_seekpoint-1; i >= 0; i-- )
294     {
295         if( p_sys->seekpoint[i]->i_time_offset <= i_time )
296             break;
297     }
298     i_delta_time = i_time - p_sys->seekpoint[i]->i_time_offset;
299
300     /* XXX We do exact seek if it's not too far away(45s) */
301     if( i_delta_time < 45*INT64_C(1000000) )
302     {
303         if( stream_Seek( p_demux->s, p_sys->seekpoint[i]->i_byte_offset+p_sys->i_data_pos ) )
304             return VLC_EGENERIC;
305
306         p_sys->i_time_offset = p_sys->seekpoint[i]->i_time_offset - p_sys->i_pts;
307         p_sys->i_pts_start = p_sys->i_pts+i_delta_time;
308         es_out_Control( p_demux->out, ES_OUT_SET_NEXT_DISPLAY_TIME, p_sys->i_pts_start + p_sys->i_time_offset );
309     }
310     else
311     {
312         int64_t i_delta_offset;
313         int64_t i_next_time;
314         int64_t i_next_offset;
315         uint32_t i_time_align = 1;
316
317         if( i+1 < p_sys->i_seekpoint )
318         {
319             i_next_time   = p_sys->seekpoint[i+1]->i_time_offset;
320             i_next_offset = p_sys->seekpoint[i+1]->i_byte_offset;
321         }
322         else
323         {
324             i_next_time   = p_sys->i_length;
325             i_next_offset = stream_Size(p_demux->s)-p_sys->i_data_pos;
326         }
327
328         i_delta_offset = 0;
329
330         if ( INT64_MAX / i_delta_time < (i_next_offset - p_sys->seekpoint[i]->i_byte_offset) )
331             i_time_align = 1000000;
332
333         if( i_next_time-p_sys->seekpoint[i]->i_time_offset > 0 )
334             i_delta_offset = (i_next_offset - p_sys->seekpoint[i]->i_byte_offset) * (i_delta_time / i_time_align) /
335                              ((i_next_time-p_sys->seekpoint[i]->i_time_offset) / i_time_align);
336
337         if( stream_Seek( p_demux->s, p_sys->seekpoint[i]->i_byte_offset+p_sys->i_data_pos + i_delta_offset ) )
338             return VLC_EGENERIC;
339
340         p_sys->i_pts_start = p_sys->i_pts;
341         i_delta_time = ( i_delta_time / i_time_align ) * i_time_align;
342         p_sys->i_time_offset = (p_sys->seekpoint[i]->i_time_offset+i_delta_time) - p_sys->i_pts;
343     }
344     return VLC_SUCCESS;
345 }
346
347 static int Control( demux_t *p_demux, int i_query, va_list args )
348 {
349     demux_sys_t *p_sys = p_demux->p_sys;
350
351     if( i_query == DEMUX_GET_META )
352     {
353         vlc_meta_t *p_meta = (vlc_meta_t *)va_arg( args, vlc_meta_t* );
354         if( p_demux->p_sys->p_meta )
355             vlc_meta_Merge( p_meta, p_demux->p_sys->p_meta );
356         return VLC_SUCCESS;
357     }
358     else if( i_query == DEMUX_HAS_UNSUPPORTED_META )
359     {
360         bool *pb_bool = (bool*)va_arg( args, bool* );
361         *pb_bool = true;
362         return VLC_SUCCESS;
363     }
364     else if( i_query == DEMUX_GET_LENGTH )
365     {
366         int64_t *pi64 = (int64_t*)va_arg( args, int64_t * );
367         *pi64 = ControlGetLength( p_demux );
368         return VLC_SUCCESS;
369     }
370     else if( i_query == DEMUX_SET_TIME )
371     {
372         int64_t i_time = (int64_t)va_arg( args, int64_t );
373         return ControlSetTime( p_demux, i_time );
374     }
375     else if( i_query == DEMUX_SET_POSITION )
376     {
377         const double f = (double)va_arg( args, double );
378         int64_t i_time = f * ControlGetLength( p_demux );
379         return ControlSetTime( p_demux, i_time );
380     }
381     else if( i_query == DEMUX_GET_TIME )
382     {
383         int64_t *pi64 = (int64_t*)va_arg( args, int64_t * );
384         *pi64 = ControlGetTime( p_demux );
385         return VLC_SUCCESS;
386     }
387     else if( i_query == DEMUX_GET_POSITION )
388     {
389         double *pf = (double*)va_arg( args, double * );
390         const int64_t i_length = ControlGetLength(p_demux);
391         if( i_length > 0 )
392         {
393             double current = ControlGetTime(p_demux);
394             *pf = current / (double)i_length;
395         }
396         else
397             *pf= 0.0;
398         return VLC_SUCCESS;
399     }
400     else if( i_query == DEMUX_GET_ATTACHMENTS )
401     {
402         input_attachment_t ***ppp_attach =
403             (input_attachment_t***)va_arg( args, input_attachment_t*** );
404         int *pi_int = (int*)va_arg( args, int * );
405
406         if( p_sys->i_attachments <= 0 )
407             return VLC_EGENERIC;
408
409         *pi_int = p_sys->i_attachments;
410         *ppp_attach = xmalloc( sizeof(input_attachment_t*) * p_sys->i_attachments );
411         for( int i = 0; i < p_sys->i_attachments; i++ )
412             (*ppp_attach)[i] = vlc_input_attachment_Duplicate( p_sys->attachments[i] );
413         return VLC_SUCCESS;
414     }
415
416     return demux_vaControlHelper( p_demux->s, p_sys->i_data_pos, -1,
417                                    8*0, 1, i_query, args );
418 }
419
420 enum
421 {
422     META_STREAMINFO = 0,
423     META_SEEKTABLE = 3,
424     META_COMMENT = 4,
425     META_PICTURE = 6,
426 };
427
428 static inline int Get24bBE( const uint8_t *p )
429 {
430     return (p[0] << 16)|(p[1] << 8)|(p[2]);
431 }
432
433 static void ParseStreamInfo( int *pi_rate, int64_t *pi_count, uint8_t *p_data );
434 static void ParseSeekTable( demux_t *p_demux, const uint8_t *p_data, int i_data,
435                             int i_sample_rate );
436 static void ParseComment( demux_t *, const uint8_t *p_data, int i_data );
437 static void ParsePicture( demux_t *, const uint8_t *p_data, int i_data );
438
439 static int  ReadMeta( demux_t *p_demux, uint8_t **pp_streaminfo, int *pi_streaminfo )
440 {
441     demux_sys_t *p_sys = p_demux->p_sys;
442     int     i_peek;
443     const uint8_t *p_peek;
444     bool b_last;
445     int i_sample_rate = 0;
446     int64_t i_sample_count;
447
448     *pp_streaminfo = NULL;
449
450     /* Be sure we have seekpoint 0 */
451     seekpoint_t *s = vlc_seekpoint_New();
452     s->i_time_offset = 0;
453     s->i_byte_offset = 0;
454     TAB_APPEND( p_sys->i_seekpoint, p_sys->seekpoint, s );
455
456     uint8_t header[4];
457     if( stream_Read( p_demux->s, header, 4) < 4)
458         return VLC_EGENERIC;
459
460     if (memcmp(header, "fLaC", 4))
461         return VLC_EGENERIC;
462
463     b_last = 0;
464     while( !b_last )
465     {
466         int i_len;
467         int i_type;
468
469         i_peek = stream_Peek( p_demux->s, &p_peek, 4 );
470         if( i_peek < 4 )
471             break;
472         b_last = p_peek[0]&0x80;
473         i_type = p_peek[0]&0x7f;
474         i_len  = Get24bBE( &p_peek[1] );
475
476         if( i_type == META_STREAMINFO && !*pp_streaminfo )
477         {
478             if( i_len != STREAMINFO_SIZE ) {
479                 msg_Err( p_demux, "invalid size %d for a STREAMINFO metadata block", i_len );
480                 return VLC_EGENERIC;
481             }
482
483             *pi_streaminfo = STREAMINFO_SIZE;
484             *pp_streaminfo = malloc( STREAMINFO_SIZE);
485             if( *pp_streaminfo == NULL )
486                 return VLC_EGENERIC;
487
488             if( stream_Read( p_demux->s, NULL, 4) < 4)
489             {
490                 free( *pp_streaminfo );
491                 return VLC_EGENERIC;
492             }
493             if( stream_Read( p_demux->s, *pp_streaminfo, STREAMINFO_SIZE ) != STREAMINFO_SIZE )
494             {
495                 msg_Err( p_demux, "failed to read STREAMINFO metadata block" );
496                 free( *pp_streaminfo );
497                 return VLC_EGENERIC;
498             }
499
500             /* */
501             ParseStreamInfo( &i_sample_rate, &i_sample_count, *pp_streaminfo );
502             if( i_sample_rate > 0 )
503                 p_sys->i_length = i_sample_count * INT64_C(1000000)/i_sample_rate;
504             continue;
505         }
506         else if( i_type == META_SEEKTABLE )
507         {
508             i_peek = stream_Peek( p_demux->s, &p_peek, 4+i_len );
509             if( i_peek == 4+i_len )
510                 ParseSeekTable( p_demux, p_peek, i_peek, i_sample_rate );
511         }
512         else if( i_type == META_COMMENT )
513         {
514             i_peek = stream_Peek( p_demux->s, &p_peek, 4+i_len );
515             if( i_peek == 4+i_len )
516                 ParseComment( p_demux, p_peek, i_peek );
517         }
518         else if( i_type == META_PICTURE )
519         {
520             i_peek = stream_Peek( p_demux->s, &p_peek, 4+i_len );
521             if( i_peek == 4+i_len )
522                 ParsePicture( p_demux, p_peek, i_peek );
523         }
524
525         if( stream_Read( p_demux->s, NULL, 4+i_len ) < 4+i_len )
526             break;
527     }
528
529     /* */
530     p_sys->i_data_pos = stream_Tell( p_demux->s );
531
532     if (!*pp_streaminfo)
533         return VLC_EGENERIC;
534
535     return VLC_SUCCESS;
536 }
537 static void ParseStreamInfo( int *pi_rate, int64_t *pi_count, uint8_t *p_data )
538 {
539     *pi_rate = GetDWBE(&p_data[4+6]) >> 12;
540     *pi_count = GetQWBE(&p_data[4+6]) &  ((INT64_C(1)<<36)-1);
541 }
542
543 static void ParseSeekTable( demux_t *p_demux, const uint8_t *p_data, int i_data,
544                             int i_sample_rate )
545 {
546     demux_sys_t *p_sys = p_demux->p_sys;
547     seekpoint_t *s;
548     int i;
549
550     if( i_sample_rate <= 0 )
551         return;
552
553     /* */
554     for( i = 0; i < (i_data-4)/18; i++ )
555     {
556         const int64_t i_sample = GetQWBE( &p_data[4+18*i+0] );
557         int j;
558
559         if( i_sample < 0 || i_sample >= INT64_MAX )
560             continue;
561
562         s = vlc_seekpoint_New();
563         s->i_time_offset = i_sample * INT64_C(1000000)/i_sample_rate;
564         s->i_byte_offset = GetQWBE( &p_data[4+18*i+8] );
565
566         /* Check for duplicate entry */
567         for( j = 0; j < p_sys->i_seekpoint; j++ )
568         {
569             if( p_sys->seekpoint[j]->i_time_offset == s->i_time_offset ||
570                 p_sys->seekpoint[j]->i_byte_offset == s->i_byte_offset )
571             {
572                 vlc_seekpoint_Delete( s );
573                 s = NULL;
574                 break;
575             }
576         }
577         if( s )
578         {
579             TAB_APPEND( p_sys->i_seekpoint, p_sys->seekpoint, s );
580         }
581     }
582     /* TODO sort it by size and remove wrong seek entry (time not increasing) */
583 }
584
585 static void ParseComment( demux_t *p_demux, const uint8_t *p_data, int i_data )
586 {
587     demux_sys_t *p_sys = p_demux->p_sys;
588
589     if( i_data < 4 )
590         return;
591
592     vorbis_ParseComment( &p_sys->p_meta, &p_data[4], i_data - 4,
593         &p_sys->i_attachments, &p_sys->attachments,
594         &p_sys->i_cover_score, &p_sys->i_cover_idx, NULL, NULL, NULL, NULL );
595 }
596
597 static void ParsePicture( demux_t *p_demux, const uint8_t *p_data, int i_data )
598 {
599     demux_sys_t *p_sys = p_demux->p_sys;
600
601     i_data -= 4; p_data += 4;
602
603     input_attachment_t *p_attachment = ParseFlacPicture( p_data, i_data,
604         p_sys->i_attachments, &p_sys->i_cover_score, &p_sys->i_cover_idx );
605     if( p_attachment == NULL )
606         return;
607
608     TAB_APPEND( p_sys->i_attachments, p_sys->attachments, p_attachment );
609 }
610