1 /*****************************************************************************
2 * flac.c : FLAC demux module for vlc
3 *****************************************************************************
4 * Copyright (C) 2001-2007 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>
34 #include <vlc_charset.h>
36 /*****************************************************************************
38 *****************************************************************************/
39 static int Open ( vlc_object_t * );
40 static void Close ( vlc_object_t * );
43 set_description( _("FLAC demuxer") );
44 set_capability( "demux2", 155 );
45 set_category( CAT_INPUT );
46 set_subcategory( SUBCAT_INPUT_DEMUX );
47 set_callbacks( Open, Close );
48 add_shortcut( "flac" );
51 /*****************************************************************************
53 *****************************************************************************/
54 static int Demux ( demux_t * );
55 static int Control( demux_t *, int, va_list );
57 static int ReadMeta( demux_t *, uint8_t **pp_streaminfo, int *pi_streaminfo );
65 decoder_t *p_packetizer;
67 audio_replay_gain_t replay_gain;
69 int64_t i_time_offset;
73 int64_t i_length; /* Length from stream info */
78 seekpoint_t **seekpoint;
82 input_attachment_t **attachments;
87 #define STREAMINFO_SIZE 38
88 #define FLAC_PACKET_SIZE 16384
90 /*****************************************************************************
91 * Open: initializes ES structures
92 *****************************************************************************/
93 static int Open( vlc_object_t * p_this )
95 demux_t *p_demux = (demux_t*)p_this;
99 uint8_t *p_streaminfo;
102 /* Have a peep at the show. */
103 if( stream_Peek( p_demux->s, &p_peek, 4 ) < 4 ) return VLC_EGENERIC;
105 if( p_peek[0]!='f' || p_peek[1]!='L' || p_peek[2]!='a' || p_peek[3]!='C' )
107 if( !p_demux->b_force ) return VLC_EGENERIC;
110 msg_Err( p_demux, "this doesn't look like a flac stream, "
111 "continuing anyway" );
114 p_demux->pf_demux = Demux;
115 p_demux->pf_control = Control;
116 p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
117 p_sys->b_start = VLC_TRUE;
118 p_sys->p_meta = NULL;
119 memset( &p_sys->replay_gain, 0, sizeof(p_sys->replay_gain) );
121 p_sys->i_time_offset = 0;
123 p_sys->i_pts_start = 0;
125 TAB_INIT( p_sys->i_seekpoint, p_sys->seekpoint );
126 TAB_INIT( p_sys->i_attachments, p_sys->attachments);
127 p_sys->i_cover_idx = 0;
128 p_sys->i_cover_score = 0;
130 /* We need to read and store the STREAMINFO metadata */
131 if( ReadMeta( p_demux, &p_streaminfo, &i_streaminfo ) )
137 /* Load the FLAC packetizer */
138 INIT_APACKETIZER( p_sys->p_packetizer, 'f', 'l', 'a', 'c' );
140 /* Store STREAMINFO for the decoder and packetizer */
141 p_streaminfo[4] |= 0x80; /* Fake this as the last metadata block */
142 p_sys->p_packetizer->fmt_in.i_extra = i_streaminfo;
143 p_sys->p_packetizer->fmt_in.p_extra = p_streaminfo;
145 p_sys->p_packetizer->p_module =
146 module_Need( p_sys->p_packetizer, "packetizer", NULL, 0 );
147 if( !p_sys->p_packetizer->p_module )
149 if( p_sys->p_packetizer->fmt_in.p_extra )
150 free( p_sys->p_packetizer->fmt_in.p_extra );
151 vlc_object_destroy( p_sys->p_packetizer );
153 msg_Err( p_demux, "cannot find flac packetizer" );
157 /* Parse possible id3 header */
158 input_thread_t *p_input = (input_thread_t *)vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
161 if( !( input_GetItem( p_input )->p_meta->i_status & ITEM_PREPARSED ) )
163 p_demux->p_private = malloc( sizeof( demux_meta_t ) );
164 if( !p_demux->p_private )
166 vlc_object_release( p_input );
169 if( ( p_id3 = module_Need( p_demux, "meta reader", NULL, 0 ) ) )
171 demux_meta_t *p_demux_meta = (demux_meta_t *)p_demux->p_private;
172 vlc_meta_t *p_meta = p_demux_meta->p_meta;
176 p_sys->p_meta = p_meta;
180 vlc_meta_Merge( p_sys->p_meta, p_meta );
181 vlc_meta_Delete( p_meta );
183 p_demux->p_private = NULL;
184 module_Unneed( p_demux, p_id3 );
186 for( i = 0; i < p_demux_meta->i_attachments; i++ )
187 TAB_APPEND_CAST( (input_attachment_t**),
188 p_sys->i_attachments, p_sys->attachments,
189 p_demux_meta->attachments[p_demux_meta->i_attachments] );
190 TAB_CLEAN( p_demux_meta->i_attachments,
191 p_demux_meta->attachments );
193 free( p_demux->p_private );
195 vlc_object_release( p_input );
198 if( p_sys->i_cover_idx < p_sys->i_attachments )
202 p_sys->p_meta = vlc_meta_New();
203 snprintf( psz_url, sizeof(psz_url), "attachment://%s",
204 p_sys->attachments[p_sys->i_cover_idx]->psz_name );
205 vlc_meta_Set( p_sys->p_meta, vlc_meta_ArtworkURL, psz_url );
207 vlc_audio_replay_gain_MergeFromMeta( &p_sys->replay_gain, p_sys->p_meta );
211 /*****************************************************************************
212 * Close: frees unused data
213 *****************************************************************************/
214 static void Close( vlc_object_t * p_this )
216 demux_t *p_demux = (demux_t*)p_this;
217 demux_sys_t *p_sys = p_demux->p_sys;
219 TAB_CLEAN( p_sys->i_seekpoint, p_sys->seekpoint );
222 for( i = 0; i < p_sys->i_attachments; i++ )
223 free( p_sys->attachments[i] );
224 TAB_CLEAN( p_sys->i_attachments, p_sys->attachments);
227 module_Unneed( p_sys->p_packetizer, p_sys->p_packetizer->p_module );
229 if( p_sys->p_packetizer->fmt_in.p_extra )
230 free( p_sys->p_packetizer->fmt_in.p_extra );
232 /* Delete the decoder */
233 vlc_object_destroy( p_sys->p_packetizer );
235 vlc_meta_Delete( p_sys->p_meta );
239 /*****************************************************************************
240 * Demux: reads and demuxes data packets
241 *****************************************************************************
242 * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
243 *****************************************************************************/
244 static int Demux( demux_t *p_demux )
246 demux_sys_t *p_sys = p_demux->p_sys;
247 block_t *p_block_in, *p_block_out;
249 if( !( p_block_in = stream_Block( p_demux->s, FLAC_PACKET_SIZE ) ) )
252 p_block_in->i_pts = p_block_in->i_dts = p_sys->b_start ? 1 : 0;
253 p_sys->b_start = VLC_FALSE;
255 while( (p_block_out = p_sys->p_packetizer->pf_packetize(
256 p_sys->p_packetizer, &p_block_in )) )
260 block_t *p_next = p_block_out->p_next;
262 p_block_out->p_next = NULL;
264 if( p_sys->p_es == NULL )
266 p_sys->p_packetizer->fmt_out.b_packetized = VLC_TRUE;
267 p_sys->p_packetizer->fmt_out.audio_replay_gain = p_sys->replay_gain;
268 p_sys->p_es = es_out_Add( p_demux->out, &p_sys->p_packetizer->fmt_out);
272 if( p_block_out->i_dts >= p_sys->i_pts_start )
273 es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block_out->i_dts );
275 es_out_Control( p_demux->out, ES_OUT_RESET_PCR );
277 p_sys->i_pts = p_block_out->i_dts;
278 es_out_Send( p_demux->out, p_sys->p_es, p_block_out );
280 p_block_out = p_next;
286 /*****************************************************************************
288 *****************************************************************************/
289 static int64_t ControlGetLength( demux_t *p_demux )
291 demux_sys_t *p_sys = p_demux->p_sys;
292 const int64_t i_size = stream_Size(p_demux->s) - p_sys->i_data_pos;
293 int64_t i_length = p_sys->i_length;
296 /* Try to fix length using seekpoint and current size for truncated file */
297 for( i = p_sys->i_seekpoint-1; i >= 0; i-- )
299 seekpoint_t *s = p_sys->seekpoint[i];
300 if( s->i_byte_offset <= i_size )
302 if( i+1 < p_sys->i_seekpoint )
305 seekpoint_t *n = p_sys->seekpoint[i+1];
306 assert( n->i_byte_offset != s->i_byte_offset); /* Should be ensured by ParseSeekTable */
307 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);
315 static int64_t ControlGetTime( demux_t *p_demux )
317 demux_sys_t *p_sys = p_demux->p_sys;
318 return __MAX(p_sys->i_pts, p_sys->i_pts_start) + p_sys->i_time_offset;
321 static int ControlSetTime( demux_t *p_demux, int64_t i_time )
323 demux_sys_t *p_sys = p_demux->p_sys;
325 int64_t i_next_offset;
326 int64_t i_delta_time;
327 int64_t i_delta_offset;
328 vlc_bool_t b_seekable;
332 stream_Control( p_demux->s, STREAM_CAN_SEEK, &b_seekable );
337 assert( p_sys->i_seekpoint > 0 ); /* ReadMeta ensure at least (0,0) */
338 for( i = p_sys->i_seekpoint-1; i >= 0; i-- )
340 if( p_sys->seekpoint[i]->i_time_offset <= i_time )
343 if( i+1 < p_sys->i_seekpoint )
345 i_next_time = p_sys->seekpoint[i+1]->i_time_offset;
346 i_next_offset = p_sys->seekpoint[i+1]->i_byte_offset;
350 i_next_time = p_sys->i_length;
351 i_next_offset = stream_Size(p_demux->s)-p_sys->i_data_pos;
353 i_delta_time = i_time - p_sys->seekpoint[i]->i_time_offset;
354 i_delta_offset = (i_next_offset - p_sys->seekpoint[i]->i_byte_offset) * i_delta_time /
355 (p_sys->seekpoint[i+1]->i_time_offset-p_sys->seekpoint[i]->i_time_offset);
357 /* XXX We do exact seek if it's not too far away(45s) */
358 if( i_delta_time < 45*I64C(1000000) )
360 if( stream_Seek( p_demux->s, p_sys->seekpoint[i]->i_byte_offset+p_sys->i_data_pos ) )
362 p_sys->i_time_offset = p_sys->seekpoint[i]->i_time_offset - p_sys->i_pts;
363 p_sys->i_pts_start = p_sys->i_pts+i_delta_time;
364 es_out_Control( p_demux->out, ES_OUT_SET_NEXT_DISPLAY_TIME, p_sys->p_es, p_sys->i_pts_start );
368 if( stream_Seek( p_demux->s, p_sys->seekpoint[i]->i_byte_offset+p_sys->i_data_pos + i_delta_offset ) )
370 p_sys->i_pts_start = p_sys->i_pts;
371 p_sys->i_time_offset = (p_sys->seekpoint[i]->i_time_offset+i_delta_time) - p_sys->i_pts;
376 static int Control( demux_t *p_demux, int i_query, va_list args )
378 demux_sys_t *p_sys = p_demux->p_sys;
380 if( i_query == DEMUX_GET_META )
382 vlc_meta_t *p_meta = (vlc_meta_t *)va_arg( args, vlc_meta_t* );
383 if( p_demux->p_sys->p_meta )
384 vlc_meta_Merge( p_meta, p_demux->p_sys->p_meta );
387 else if( i_query == DEMUX_GET_LENGTH )
389 int64_t *pi64 = (int64_t*)va_arg( args, int64_t * );
390 *pi64 = ControlGetLength( p_demux );
393 else if( i_query == DEMUX_SET_TIME )
395 int64_t i_time = (int64_t)va_arg( args, int64_t );
396 return ControlSetTime( p_demux, i_time );
398 else if( i_query == DEMUX_SET_POSITION )
400 const double f = (double)va_arg( args, double );
401 int64_t i_time = f * ControlGetLength( p_demux );
402 return ControlSetTime( p_demux, i_time );
404 else if( i_query == DEMUX_GET_TIME )
406 int64_t *pi64 = (int64_t*)va_arg( args, int64_t * );
407 *pi64 = ControlGetTime( p_demux );
410 else if( i_query == DEMUX_GET_POSITION )
412 double *pf = (double*)va_arg( args, double * );
413 const int64_t i_length = ControlGetLength(p_demux);
415 *pf = (double)ControlGetTime(p_demux) / (double)i_length;
420 else if( i_query == DEMUX_GET_ATTACHMENTS )
422 input_attachment_t ***ppp_attach =
423 (input_attachment_t***)va_arg( args, input_attachment_t*** );
424 int *pi_int = (int*)va_arg( args, int * );
427 if( p_sys->i_attachments <= 0 )
430 *pi_int = p_sys->i_attachments;;
431 *ppp_attach = malloc( sizeof(input_attachment_t**) * p_sys->i_attachments );
432 for( i = 0; i < p_sys->i_attachments; i++ )
433 (*ppp_attach)[i] = vlc_input_attachment_Duplicate( p_sys->attachments[i] );
437 return demux2_vaControlHelper( p_demux->s, p_sys->i_data_pos, -1,
438 8*0, 1, i_query, args );
449 static inline int Get24bBE( const uint8_t *p )
451 return (p[0] << 16)|(p[1] << 8)|(p[2]);
454 static void ParseStreamInfo( demux_t *p_demux, int *pi_rate, int64_t *pi_count, uint8_t *p_data, int i_data );
455 static void ParseSeekTable( demux_t *p_demux, const uint8_t *p_data, int i_data,
457 static void ParseComment( demux_t *, const uint8_t *p_data, int i_data );
458 static void ParsePicture( demux_t *, const uint8_t *p_data, int i_data );
460 static int ReadMeta( demux_t *p_demux, uint8_t **pp_streaminfo, int *pi_streaminfo )
462 demux_sys_t *p_sys = p_demux->p_sys;
464 const uint8_t *p_peek;
467 int64_t i_sample_count;
470 /* Read STREAMINFO */
471 i_peek = stream_Peek( p_demux->s, &p_peek, 8 );
472 if( (p_peek[4] & 0x7F) != META_STREAMINFO )
474 msg_Err( p_demux, "this isn't a STREAMINFO metadata block" );
477 if( Get24bBE(&p_peek[5]) != (STREAMINFO_SIZE - 4) )
479 msg_Err( p_demux, "invalid size for a STREAMINFO metadata block" );
483 *pi_streaminfo = 4 + STREAMINFO_SIZE;
484 *pp_streaminfo = malloc( 4 + STREAMINFO_SIZE );
485 if( *pp_streaminfo == NULL )
488 if( stream_Read( p_demux->s, *pp_streaminfo, 4+STREAMINFO_SIZE ) != 4+STREAMINFO_SIZE )
490 msg_Err( p_demux, "failed to read STREAMINFO metadata block" );
491 free( *pp_streaminfo );
496 ParseStreamInfo( p_demux, &i_sample_rate, &i_sample_count, *pp_streaminfo, *pi_streaminfo );
497 if( i_sample_rate > 0 )
498 p_sys->i_length = i_sample_count * I64C(1000000)/i_sample_rate;
500 /* Be sure we have seekpoint 0 */
501 s = vlc_seekpoint_New();
502 s->i_time_offset = 0;
503 s->i_byte_offset = 0;
504 TAB_APPEND( p_sys->i_seekpoint, p_sys->seekpoint, s );
506 b_last = (*pp_streaminfo)[4]&0x80;
512 i_peek = stream_Peek( p_demux->s, &p_peek, 4 );
515 b_last = p_peek[0]&0x80;
516 i_type = p_peek[0]&0x7f;
517 i_len = Get24bBE( &p_peek[1] );
519 if( i_type == META_SEEKTABLE )
521 i_peek = stream_Peek( p_demux->s, &p_peek, 4+i_len );
522 if( i_peek == 4+i_len )
523 ParseSeekTable( p_demux, p_peek, i_peek, i_sample_rate );
525 else if( i_type == META_COMMENT )
527 i_peek = stream_Peek( p_demux->s, &p_peek, 4+i_len );
528 if( i_peek == 4+i_len )
529 ParseComment( p_demux, p_peek, i_peek );
531 else if( i_type == META_PICTURE )
533 i_peek = stream_Peek( p_demux->s, &p_peek, 4+i_len );
534 if( i_peek == 4+i_len )
535 ParsePicture( p_demux, p_peek, i_peek );
538 if( stream_Read( p_demux->s, NULL, 4+i_len ) < 4+i_len )
543 p_sys->i_data_pos = stream_Tell( p_demux->s );
547 static void ParseStreamInfo( demux_t *p_demux, int *pi_rate, int64_t *pi_count, uint8_t *p_data, int i_data )
549 const int i_skip = 4+4;
551 *pi_rate = GetDWBE(&p_data[i_skip+4+6]) >> 12;
552 *pi_count = GetQWBE(&p_data[i_skip+4+6]) & ((I64C(1)<<36)-1);
555 static void ParseSeekTable( demux_t *p_demux, const uint8_t *p_data, int i_data,
558 demux_sys_t *p_sys = p_demux->p_sys;
562 if( i_sample_rate <= 0 )
566 for( i = 0; i < (i_data-4)/18; i++ )
568 const int64_t i_sample = GetQWBE( &p_data[4+18*i+0] );
571 if( i_sample < 0 || i_sample >= INT64_MAX )
574 s = vlc_seekpoint_New();
575 s->i_time_offset = i_sample * I64C(1000000)/i_sample_rate;
576 s->i_byte_offset = GetQWBE( &p_data[4+18*i+8] );
578 /* Check for duplicate entry */
579 for( j = 0; j < p_sys->i_seekpoint; j++ )
581 if( p_sys->seekpoint[j]->i_time_offset == s->i_time_offset ||
582 p_sys->seekpoint[j]->i_byte_offset == s->i_byte_offset )
584 vlc_seekpoint_Delete( s );
591 TAB_APPEND( p_sys->i_seekpoint, p_sys->seekpoint, s );
594 /* TODO sort it by size and remove wrong seek entry (time not increasing) */
597 #define RM(x) do { i_data -= (x); p_data += (x); } while(0)
598 static void ParseComment( demux_t *p_demux, const uint8_t *p_data, int i_data )
600 demux_sys_t *p_sys = p_demux->p_sys;
609 n = GetDWLE(p_data); RM(4);
610 if( n < 0 || n > i_data )
615 /* TODO report vendor string ? */
616 char *psz_vendor = psz_vendor = strndup( p_data, n );
617 msg_Dbg( p_demux, "FLAC: COMMENT vendor length=%d vendor=%s\n", n, psz_vendor );
626 i_comment = GetDWLE(p_data); RM(4);
630 p_sys->p_meta = vlc_meta_New();
632 for( ; i_comment > 0; i_comment-- )
637 n = GetDWLE(p_data); RM(4);
643 psz = strndup( p_data, n );
648 #define IF_EXTRACT(txt,var) \
649 if( !strncasecmp(psz, txt, strlen(txt)) ) \
651 const char *oldval = vlc_meta_Get( p_sys->p_meta, vlc_meta_ ## var ); \
655 asprintf( &newval, "%s,%s", oldval, &psz[strlen(txt)] ); \
656 vlc_meta_Set( p_sys->p_meta, vlc_meta_ ## var, newval ); \
660 vlc_meta_Set( p_sys->p_meta, vlc_meta_ ## var, &psz[strlen(txt)] ); \
662 IF_EXTRACT("TITLE=", Title )
663 else IF_EXTRACT("ALBUM=", Album )
664 else IF_EXTRACT("TRACKNUMBER=", TrackNumber )
665 else IF_EXTRACT("ARTIST=", Artist )
666 else IF_EXTRACT("COPYRIGHT=", Copyright )
667 else IF_EXTRACT("DESCRIPTION=", Description )
668 else IF_EXTRACT("GENRE=", Genre )
669 else IF_EXTRACT("DATE=", Date )
670 else if( strchr( psz, '=' ) )
672 /* generic (PERFORMER/LICENSE/ORGANIZATION/LOCATION/CONTACT/ISRC,
673 * undocumented tags and replay gain ) */
674 audio_replay_gain_t *r = &p_sys->replay_gain;
675 char *p = strchr( psz, '=' );
677 vlc_meta_AddExtra( p_sys->p_meta, psz, p );
685 static void ParsePicture( demux_t *p_demux, const uint8_t *p_data, int i_data )
687 static const int pi_cover_score[] = {
690 10, /* front cover */
692 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
693 6, /* movie/video screen capture */
695 7, /* Illustration */
696 8, /* Band/Artist logotype */
697 0, /* Publisher/Studio */
699 demux_sys_t *p_sys = p_demux->p_sys;
702 char *psz_mime = NULL;
703 char *psz_description = NULL;
704 input_attachment_t *p_attachment;
707 if( i_data < 4 + 3*4 )
709 #define RM(x) do { i_data -= (x); p_data += (x); } while(0)
712 i_type = GetDWBE( p_data ); RM(4);
713 i_len = GetDWBE( p_data ); RM(4);
714 if( i_data < i_len + 4 )
716 psz_mime = strndup( p_data, i_len ); RM(i_len);
717 i_len = GetDWBE( p_data ); RM(4);
718 if( i_data < i_len + 4*4 + 4)
720 psz_description = strndup( p_data, i_len ); RM(i_len);
721 EnsureUTF8( psz_description );
723 i_len = GetDWBE( p_data ); RM(4);
727 msg_Dbg( p_demux, "FLAC: Picture type=%d mime=%s description='%s' file length=%d",
728 i_type, psz_mime, psz_description, i_len );
730 snprintf( psz_name, sizeof(psz_name), "picture%d", p_sys->i_attachments );
731 if( !strcasecmp( psz_mime, "image/jpeg" ) )
732 strcat( psz_name, ".jpg" );
733 else if( !strcasecmp( psz_mime, "image/png" ) )
734 strcat( psz_name, ".png" );
736 p_attachment = vlc_input_attachment_New( psz_name, psz_mime, psz_description,
738 TAB_APPEND( p_sys->i_attachments, p_sys->attachments, p_attachment );
740 if( i_type >= 0 && i_type < sizeof(pi_cover_score)/sizeof(pi_cover_score[0]) &&
741 p_sys->i_cover_score < pi_cover_score[i_type] )
743 p_sys->i_cover_idx = p_sys->i_attachments-1;
744 p_sys->i_cover_score = pi_cover_score[i_type];
749 if( psz_description )
750 free( psz_description );