1 /*****************************************************************************
2 * flac.c : FLAC demux module for vlc
3 *****************************************************************************
4 * Copyright (C) 2001-2003 the VideoLAN team
7 * Authors: Gildas Bazin <gbazin@netcourrier.com>
8 * Laurent Aimar <fenrir@via.ecp.fr>
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.
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.
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 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
29 #include <vlc_demux.h>
31 #include <vlc_input.h>
32 #include <vlc_codec.h>
35 /*****************************************************************************
37 *****************************************************************************/
38 static int Open ( vlc_object_t * );
39 static void Close ( vlc_object_t * );
42 set_description( _("FLAC demuxer") );
43 set_capability( "demux2", 155 );
44 set_category( CAT_INPUT );
45 set_subcategory( SUBCAT_INPUT_DEMUX );
46 set_callbacks( Open, Close );
47 add_shortcut( "flac" );
50 /*****************************************************************************
52 *****************************************************************************/
53 static int Demux ( demux_t * );
54 static int Control( demux_t *, int, va_list );
56 static int ReadMeta( demux_t *, uint8_t **pp_streaminfo, int *pi_streaminfo );
64 decoder_t *p_packetizer;
67 int64_t i_time_offset;
71 int64_t i_length; /* Length from stream info */
76 seekpoint_t **seekpoint;
80 input_attachment_t **attachment;
85 #define STREAMINFO_SIZE 38
86 #define FLAC_PACKET_SIZE 16384
88 /*****************************************************************************
89 * Open: initializes ES structures
90 *****************************************************************************/
91 static int Open( vlc_object_t * p_this )
93 demux_t *p_demux = (demux_t*)p_this;
97 uint8_t *p_streaminfo;
100 /* Have a peep at the show. */
101 if( stream_Peek( p_demux->s, &p_peek, 4 ) < 4 ) return VLC_EGENERIC;
103 if( p_peek[0]!='f' || p_peek[1]!='L' || p_peek[2]!='a' || p_peek[3]!='C' )
105 if( !p_demux->b_force ) return VLC_EGENERIC;
108 msg_Err( p_demux, "this doesn't look like a flac stream, "
109 "continuing anyway" );
112 p_demux->pf_demux = Demux;
113 p_demux->pf_control = Control;
114 p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
115 p_sys->b_start = VLC_TRUE;
116 p_sys->p_meta = NULL;
118 p_sys->i_time_offset = 0;
120 p_sys->i_pts_start = 0;
122 TAB_INIT( p_sys->i_seekpoint, p_sys->seekpoint );
123 TAB_INIT( p_sys->i_attachment, p_sys->attachment );
124 p_sys->i_cover_idx = 0;
125 p_sys->i_cover_score = 0;
127 /* We need to read and store the STREAMINFO metadata */
128 if( ReadMeta( p_demux, &p_streaminfo, &i_streaminfo ) )
134 /* Load the FLAC packetizer */
135 INIT_APACKETIZER( p_sys->p_packetizer, 'f', 'l', 'a', 'c' );
137 /* Store STREAMINFO for the decoder and packetizer */
138 p_streaminfo[4] |= 0x80; /* Fake this as the last metadata block */
139 p_sys->p_packetizer->fmt_in.i_extra = i_streaminfo;
140 p_sys->p_packetizer->fmt_in.p_extra = p_streaminfo;
142 p_sys->p_packetizer->p_module =
143 module_Need( p_sys->p_packetizer, "packetizer", NULL, 0 );
144 if( !p_sys->p_packetizer->p_module )
146 if( p_sys->p_packetizer->fmt_in.p_extra )
147 free( p_sys->p_packetizer->fmt_in.p_extra );
148 vlc_object_destroy( p_sys->p_packetizer );
150 msg_Err( p_demux, "cannot find flac packetizer" );
154 /* Parse possible id3 header */
155 if( ( p_id3 = module_Need( p_demux, "meta reader", NULL, 0 ) ) )
157 vlc_meta_t *p_meta = (vlc_meta_t *)p_demux->p_private;
161 p_sys->p_meta = p_meta;
165 vlc_meta_Merge( p_sys->p_meta, p_meta );
166 vlc_meta_Delete( p_meta );
168 p_demux->p_private = NULL;
169 module_Unneed( p_demux, p_id3 );
172 if( p_sys->i_cover_idx < p_sys->i_attachment )
176 p_sys->p_meta = vlc_meta_New();
177 snprintf( psz_url, sizeof(psz_url), "attachment://%s",
178 p_sys->attachment[p_sys->i_cover_idx]->psz_name );
179 vlc_meta_SetArtURL( p_sys->p_meta, psz_url );
184 /*****************************************************************************
185 * Close: frees unused data
186 *****************************************************************************/
187 static void Close( vlc_object_t * p_this )
189 demux_t *p_demux = (demux_t*)p_this;
190 demux_sys_t *p_sys = p_demux->p_sys;
193 module_Unneed( p_sys->p_packetizer, p_sys->p_packetizer->p_module );
195 if( p_sys->p_packetizer->fmt_in.p_extra )
196 free( p_sys->p_packetizer->fmt_in.p_extra );
198 /* Delete the decoder */
199 vlc_object_destroy( p_sys->p_packetizer );
201 vlc_meta_Delete( p_sys->p_meta );
205 /*****************************************************************************
206 * Demux: reads and demuxes data packets
207 *****************************************************************************
208 * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
209 *****************************************************************************/
210 static int Demux( demux_t *p_demux )
212 demux_sys_t *p_sys = p_demux->p_sys;
213 block_t *p_block_in, *p_block_out;
215 if( !( p_block_in = stream_Block( p_demux->s, FLAC_PACKET_SIZE ) ) )
218 p_block_in->i_pts = p_block_in->i_dts = p_sys->b_start ? 1 : 0;
219 p_sys->b_start = VLC_FALSE;
221 while( (p_block_out = p_sys->p_packetizer->pf_packetize(
222 p_sys->p_packetizer, &p_block_in )) )
226 block_t *p_next = p_block_out->p_next;
228 p_block_out->p_next = NULL;
230 if( p_sys->p_es == NULL )
232 p_sys->p_packetizer->fmt_out.b_packetized = VLC_TRUE;
233 p_sys->p_es = es_out_Add( p_demux->out, &p_sys->p_packetizer->fmt_out);
237 if( p_block_out->i_dts >= p_sys->i_pts_start )
238 es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block_out->i_dts );
240 es_out_Control( p_demux->out, ES_OUT_RESET_PCR );
242 p_sys->i_pts = p_block_out->i_dts;
243 es_out_Send( p_demux->out, p_sys->p_es, p_block_out );
245 p_block_out = p_next;
252 /*****************************************************************************
254 *****************************************************************************/
255 static int64_t ControlGetLength( demux_t *p_demux )
257 demux_sys_t *p_sys = p_demux->p_sys;
258 const int64_t i_size = stream_Size(p_demux->s) - p_sys->i_data_pos;
259 int64_t i_length = p_sys->i_length;
262 /* Try to fix length using seekpoint and current size for truncated file */
263 for( i = p_sys->i_seekpoint-1; i >= 0; i-- )
265 seekpoint_t *s = p_sys->seekpoint[i];
266 if( s->i_byte_offset <= i_size )
268 if( i+1 < p_sys->i_seekpoint )
271 seekpoint_t *n = p_sys->seekpoint[i+1];
272 assert( n->i_byte_offset != s->i_byte_offset); /* Should be ensured by ParseSeekTable */
273 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);
280 static int64_t ControlGetTime( demux_t *p_demux )
282 demux_sys_t *p_sys = p_demux->p_sys;
283 return __MAX(p_sys->i_pts, p_sys->i_pts_start) + p_sys->i_time_offset;
285 static int ControlSetTime( demux_t *p_demux, int64_t i_time )
287 demux_sys_t *p_sys = p_demux->p_sys;
289 int64_t i_next_offset;
290 int64_t i_delta_time;
291 int64_t i_delta_offset;
292 vlc_bool_t b_seekable;
296 stream_Control( p_demux->s, STREAM_CAN_SEEK, &b_seekable );
301 assert( p_sys->i_seekpoint > 0 ); /* ReadMeta ensure at least (0,0) */
302 for( i = p_sys->i_seekpoint-1; i >= 0; i-- )
304 if( p_sys->seekpoint[i]->i_time_offset <= i_time )
307 if( i+1 < p_sys->i_seekpoint )
309 i_next_time = p_sys->seekpoint[i+1]->i_time_offset;
310 i_next_offset = p_sys->seekpoint[i+1]->i_byte_offset;
314 i_next_time = p_sys->i_length;
315 i_next_offset = stream_Size(p_demux->s)-p_sys->i_data_pos;
317 i_delta_time = i_time - p_sys->seekpoint[i]->i_time_offset;
318 i_delta_offset = (i_next_offset - p_sys->seekpoint[i]->i_byte_offset) * i_delta_time /
319 (p_sys->seekpoint[i+1]->i_time_offset-p_sys->seekpoint[i]->i_time_offset);
321 /* XXX We do exact seek if it's not too far away(45s) */
322 if( i_delta_time < 45*I64C(1000000) )
324 if( stream_Seek( p_demux->s, p_sys->seekpoint[i]->i_byte_offset+p_sys->i_data_pos ) )
326 p_sys->i_time_offset = p_sys->seekpoint[i]->i_time_offset - p_sys->i_pts;
327 p_sys->i_pts_start = p_sys->i_pts+i_delta_time;
328 es_out_Control( p_demux->out, ES_OUT_SET_NEXT_DISPLAY_TIME, p_sys->p_es, p_sys->i_pts_start );
332 if( stream_Seek( p_demux->s, p_sys->seekpoint[i]->i_byte_offset+p_sys->i_data_pos + i_delta_offset ) )
334 p_sys->i_pts_start = p_sys->i_pts;
335 p_sys->i_time_offset = (p_sys->seekpoint[i]->i_time_offset+i_delta_time) - p_sys->i_pts;
340 static int Control( demux_t *p_demux, int i_query, va_list args )
342 demux_sys_t *p_sys = p_demux->p_sys;
344 if( i_query == DEMUX_GET_META )
346 vlc_meta_t *p_meta = (vlc_meta_t *)va_arg( args, vlc_meta_t* );
347 if( p_demux->p_sys->p_meta )
348 vlc_meta_Merge( p_meta, p_demux->p_sys->p_meta );
351 else if( i_query == DEMUX_GET_LENGTH )
353 int64_t *pi64 = (int64_t*)va_arg( args, int64_t * );
354 *pi64 = ControlGetLength( p_demux );
357 else if( i_query == DEMUX_SET_TIME )
359 int64_t i_time = (int64_t)va_arg( args, int64_t );
360 return ControlSetTime( p_demux, i_time );
362 else if( i_query == DEMUX_SET_POSITION )
364 const double f = (double)va_arg( args, double );
365 int64_t i_time = f * ControlGetLength( p_demux );
366 return ControlSetTime( p_demux, i_time );
368 else if( i_query == DEMUX_GET_TIME )
370 int64_t *pi64 = (int64_t*)va_arg( args, int64_t * );
371 *pi64 = ControlGetTime( p_demux );
374 else if( i_query == DEMUX_GET_POSITION )
376 double *pf = (double*)va_arg( args, double * );
377 const int64_t i_length = ControlGetLength(p_demux);
379 *pf = (double)ControlGetTime(p_demux) / (double)i_length;
384 else if( i_query == DEMUX_GET_ATTACHMENTS )
386 input_attachment_t ***ppp_attach =
387 (input_attachment_t***)va_arg( args, input_attachment_t*** );
388 int *pi_int = (int*)va_arg( args, int * );
391 if( p_sys->i_attachment <= 0 )
394 *pi_int = p_sys->i_attachment;;
395 *ppp_attach = malloc( sizeof(input_attachment_t**) * p_sys->i_attachment );
396 for( i = 0; i < p_sys->i_attachment; i++ )
397 *(ppp_attach)[i] = vlc_input_attachment_Duplicate( p_sys->attachment[i] );
401 return demux2_vaControlHelper( p_demux->s, p_sys->i_data_pos, -1,
402 8*0, 1, i_query, args );
413 static inline int Get24bBE( uint8_t *p )
415 return (p[0] << 16)|(p[1] << 8)|(p[2]);
418 static void ParseStreamInfo( demux_t *p_demux, int *pi_rate, int64_t *pi_count, uint8_t *p_data, int i_data );
419 static void ParseSeekTable( demux_t *p_demux, uint8_t *p_data, int i_data, int i_sample_rate );
420 static void ParseComment( demux_t *, uint8_t *p_data, int i_data );
421 static void ParsePicture( demux_t *, uint8_t *p_data, int i_data );
423 static int ReadMeta( demux_t *p_demux, uint8_t **pp_streaminfo, int *pi_streaminfo )
425 demux_sys_t *p_sys = p_demux->p_sys;
430 int64_t i_sample_count;
433 /* Read STREAMINFO */
434 i_peek = stream_Peek( p_demux->s, &p_peek, 8 );
435 if( (p_peek[4] & 0x7F) != META_STREAMINFO )
437 msg_Err( p_demux, "this isn't a STREAMINFO metadata block" );
440 if( Get24bBE(&p_peek[5]) != (STREAMINFO_SIZE - 4) )
442 msg_Err( p_demux, "invalid size for a STREAMINFO metadata block" );
446 *pi_streaminfo = 4 + STREAMINFO_SIZE;
447 *pp_streaminfo = malloc( 4 + STREAMINFO_SIZE );
448 if( *pp_streaminfo == NULL )
451 if( stream_Read( p_demux->s, *pp_streaminfo, 4+STREAMINFO_SIZE ) != 4+STREAMINFO_SIZE )
453 msg_Err( p_demux, "failed to read STREAMINFO metadata block" );
454 free( *pp_streaminfo );
459 ParseStreamInfo( p_demux, &i_sample_rate, &i_sample_count, *pp_streaminfo, *pi_streaminfo );
460 if( i_sample_rate > 0 )
461 p_sys->i_length = i_sample_count * I64C(1000000)/i_sample_rate;
463 /* Be sure we have seekpoint 0 */
464 s = vlc_seekpoint_New();
465 s->i_time_offset = 0;
466 s->i_byte_offset = 0;
467 TAB_APPEND( p_sys->i_seekpoint, p_sys->seekpoint, s );
471 b_last = (*pp_streaminfo)[4]&0x80;
477 i_peek = stream_Peek( p_demux->s, &p_peek, 4 );
480 b_last = p_peek[0]&0x80;
481 i_type = p_peek[0]&0x7f;
482 i_len = Get24bBE( &p_peek[1] );
484 if( i_type == META_SEEKTABLE )
486 i_peek = stream_Peek( p_demux->s, &p_peek, 4+i_len );
487 if( i_peek == 4+i_len )
488 ParseSeekTable( p_demux, p_peek, i_peek, i_sample_rate );
490 else if( i_type == META_COMMENT )
492 i_peek = stream_Peek( p_demux->s, &p_peek, 4+i_len );
493 if( i_peek == 4+i_len )
494 ParseComment( p_demux, p_peek, i_peek );
496 else if( i_type == META_PICTURE )
498 i_peek = stream_Peek( p_demux->s, &p_peek, 4+i_len );
499 if( i_peek == 4+i_len )
500 ParsePicture( p_demux, p_peek, i_peek );
503 if( stream_Read( p_demux->s, NULL, 4+i_len ) < 4+i_len )
508 p_sys->i_data_pos = stream_Tell( p_demux->s );
512 static void ParseStreamInfo( demux_t *p_demux, int *pi_rate, int64_t *pi_count, uint8_t *p_data, int i_data )
514 const int i_skip = 4+4;
516 *pi_rate = GetDWBE(&p_data[i_skip+4+6]) >> 12;
517 *pi_count = GetQWBE(&p_data[i_skip+4+6]) & ((I64C(1)<<36)-1);
519 static void ParseSeekTable( demux_t *p_demux, uint8_t *p_data, int i_data, int i_sample_rate )
521 demux_sys_t *p_sys = p_demux->p_sys;
525 if( i_sample_rate <= 0 )
529 for( i = 0; i < (i_data-4)/18; i++ )
531 const int64_t i_sample = GetQWBE( &p_data[4+18*i+0] );
534 if( i_sample < 0 || i_sample >= INT64_MAX )
537 s = vlc_seekpoint_New();
538 s->i_time_offset = i_sample * I64C(1000000)/i_sample_rate;
539 s->i_byte_offset = GetQWBE( &p_data[4+18*i+8] );
541 /* Check for duplicate entry */
542 for( j = 0; j < p_sys->i_seekpoint; j++ )
544 if( p_sys->seekpoint[j]->i_time_offset == s->i_time_offset ||
545 p_sys->seekpoint[j]->i_byte_offset == s->i_byte_offset )
547 vlc_seekpoint_Delete( s );
554 TAB_APPEND( p_sys->i_seekpoint, p_sys->seekpoint, s );
557 /* TODO sort it by size and remove wrong seek entry (time not increasing) */
559 static inline void astrcat( char **ppsz_dst, const char *psz_src )
561 char *psz_old = *ppsz_dst;
563 if( !psz_src || !psz_src[0] )
568 asprintf( ppsz_dst, "%s,%s", psz_old, psz_src );
573 *ppsz_dst = strdup( psz_src );
577 #define RM(x) do { i_data -= (x); p_data += (x); } while(0)
578 static void ParseComment( demux_t *p_demux, uint8_t *p_data, int i_data )
580 demux_sys_t *p_sys = p_demux->p_sys;
589 n = GetDWLE(p_data); RM(4);
590 if( n < 0 || n > i_data )
595 /* TODO report vendor string ? */
596 char *psz_vendor = psz_vendor = strndup( p_data, n );
597 msg_Dbg( p_demux, "FLAC: COMMENT vendor length=%d vendor=%s\n", n, psz_vendor );
606 i_comment = GetDWLE(p_data); RM(4);
610 p_sys->p_meta = vlc_meta_New();
612 for( ; i_comment > 0; i_comment-- )
617 n = GetDWLE(p_data); RM(4);
623 psz = strndup( p_data, n );
628 #define IF_EXTRACT(txt,var) if( !strncasecmp(psz, txt, strlen(txt)) ) { astrcat( &p_sys->p_meta->var, &psz[strlen(txt)] ); }
629 IF_EXTRACT("TITLE=", psz_title )
630 else IF_EXTRACT("ALBUM=", psz_album )
631 else IF_EXTRACT("TRACKNUMBER=", psz_tracknum )
632 else IF_EXTRACT("ARTIST=", psz_artist )
633 else IF_EXTRACT("COPYRIGHT=", psz_copyright )
634 else IF_EXTRACT("DESCRIPTION=", psz_description )
635 else IF_EXTRACT("GENRE=", psz_genre )
636 else IF_EXTRACT("DATE=", psz_date )
637 else if( strchr( psz, '=' ) )
639 /* generic (PERFORMER/LICENSE/ORGANIZATION/LOCATION/CONTACT/ISRC and undocumented tags) */
640 char *p = strchr( psz, '=' );
642 vlc_meta_AddExtra( p_sys->p_meta, psz, p );
650 static void ParsePicture( demux_t *p_demux, uint8_t *p_data, int i_data )
652 static const int pi_cover_score[] = {
655 10, /* front cover */
657 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
658 6, /* movie/video screen capture */
660 7, /* Illustration */
661 8, /* Band/Artist logotype */
662 0, /* Publisher/Studio */
664 demux_sys_t *p_sys = p_demux->p_sys;
667 char *psz_mime = NULL;
668 char *psz_description = NULL;
669 input_attachment_t *p_attachment;
672 if( i_data < 4 + 3*4 )
674 #define RM(x) do { i_data -= (x); p_data += (x); } while(0)
677 i_type = GetDWBE( p_data ); RM(4);
678 i_len = GetDWBE( p_data ); RM(4);
679 if( i_data < i_len + 4 )
681 psz_mime = strndup( p_data, i_len ); RM(i_len);
682 i_len = GetDWBE( p_data ); RM(4);
683 if( i_data < i_len + 4*4 + 4)
685 psz_description = strndup( p_data, i_len ); RM(i_len);
686 EnsureUTF8( psz_description );
688 i_len = GetDWBE( p_data ); RM(4);
692 msg_Dbg( p_demux, "FLAC: Picture type=%d mime=%s description='%s' file length=%d",
693 i_type, psz_mime, psz_description, i_len );
695 snprintf( psz_name, sizeof(psz_name), "picture%d", p_sys->i_attachment );
696 if( !strcasecmp( psz_mime, "image/jpeg" ) )
697 strcat( psz_name, ".jpg" );
698 else if( !strcasecmp( psz_mime, "image/png" ) )
699 strcat( psz_name, ".png" );
701 p_attachment = vlc_input_attachment_New( psz_name, psz_mime, psz_description,
703 TAB_APPEND( p_sys->i_attachment, p_sys->attachment, p_attachment );
705 if( i_type >= 0 && i_type < sizeof(pi_cover_score)/sizeof(pi_cover_score[0]) &&
706 p_sys->i_cover_score < pi_cover_score[i_type] )
708 p_sys->i_cover_idx = p_sys->i_attachment-1;
709 p_sys->i_cover_score = pi_cover_score[i_type];
714 if( psz_description )
715 free( psz_description );