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 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_demux.h>
36 #include <vlc_input.h>
37 #include <vlc_codec.h>
39 #include <vlc_charset.h>
42 /*****************************************************************************
44 *****************************************************************************/
45 static int Open ( vlc_object_t * );
46 static void Close ( vlc_object_t * );
49 set_description( N_("FLAC demuxer") )
50 set_capability( "demux", 155 )
51 set_category( CAT_INPUT )
52 set_subcategory( SUBCAT_INPUT_DEMUX )
53 set_callbacks( Open, Close )
54 add_shortcut( "flac" )
57 /*****************************************************************************
59 *****************************************************************************/
60 static int Demux ( demux_t * );
61 static int Control( demux_t *, int, va_list );
63 static int ReadMeta( demux_t *, uint8_t **pp_streaminfo, int *pi_streaminfo );
71 decoder_t *p_packetizer;
74 audio_replay_gain_t replay_gain;
76 int64_t i_time_offset;
80 int64_t i_length; /* Length from stream info */
85 seekpoint_t **seekpoint;
89 input_attachment_t **attachments;
94 #define STREAMINFO_SIZE 38
95 #define FLAC_PACKET_SIZE 16384
97 /*****************************************************************************
98 * Open: initializes ES structures
99 *****************************************************************************/
100 static int Open( vlc_object_t * p_this )
102 demux_t *p_demux = (demux_t*)p_this;
104 const uint8_t *p_peek;
105 uint8_t *p_streaminfo;
109 /* Have a peep at the show. */
110 if( stream_Peek( p_demux->s, &p_peek, 4 ) < 4 ) return VLC_EGENERIC;
112 if( p_peek[0]!='f' || p_peek[1]!='L' || p_peek[2]!='a' || p_peek[3]!='C' )
114 if( !p_demux->b_force ) return VLC_EGENERIC;
117 msg_Err( p_demux, "this doesn't look like a flac stream, "
118 "continuing anyway" );
121 p_demux->pf_demux = Demux;
122 p_demux->pf_control = Control;
123 p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
124 p_sys->b_start = true;
125 p_sys->p_meta = NULL;
126 memset( &p_sys->replay_gain, 0, sizeof(p_sys->replay_gain) );
128 p_sys->i_time_offset = 0;
130 p_sys->i_pts_start = 0;
132 TAB_INIT( p_sys->i_seekpoint, p_sys->seekpoint );
133 TAB_INIT( p_sys->i_attachments, p_sys->attachments);
134 p_sys->i_cover_idx = 0;
135 p_sys->i_cover_score = 0;
137 /* We need to read and store the STREAMINFO metadata */
138 if( ReadMeta( p_demux, &p_streaminfo, &i_streaminfo ) )
144 /* Load the FLAC packetizer */
145 /* Store STREAMINFO for the decoder and packetizer */
146 p_streaminfo[4] |= 0x80; /* Fake this as the last metadata block */
147 es_format_Init( &fmt, AUDIO_ES, VLC_CODEC_FLAC );
148 fmt.i_extra = i_streaminfo;
149 fmt.p_extra = p_streaminfo;
151 p_sys->p_packetizer = demux_PacketizerNew( p_demux, &fmt, "flac" );
152 if( !p_sys->p_packetizer )
158 if( p_sys->i_cover_idx < p_sys->i_attachments )
162 p_sys->p_meta = vlc_meta_New();
163 snprintf( psz_url, sizeof(psz_url), "attachment://%s",
164 p_sys->attachments[p_sys->i_cover_idx]->psz_name );
165 vlc_meta_Set( p_sys->p_meta, vlc_meta_ArtworkURL, psz_url );
167 vlc_audio_replay_gain_MergeFromMeta( &p_sys->replay_gain, p_sys->p_meta );
171 /*****************************************************************************
172 * Close: frees unused data
173 *****************************************************************************/
174 static void Close( vlc_object_t * p_this )
176 demux_t *p_demux = (demux_t*)p_this;
177 demux_sys_t *p_sys = p_demux->p_sys;
179 TAB_CLEAN( p_sys->i_seekpoint, p_sys->seekpoint );
182 for( i = 0; i < p_sys->i_attachments; i++ )
183 free( p_sys->attachments[i] );
184 TAB_CLEAN( p_sys->i_attachments, p_sys->attachments);
186 /* Delete the decoder */
187 demux_PacketizerDestroy( p_sys->p_packetizer );
190 vlc_meta_Delete( p_sys->p_meta );
194 /*****************************************************************************
195 * Demux: reads and demuxes data packets
196 *****************************************************************************
197 * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
198 *****************************************************************************/
199 static int Demux( demux_t *p_demux )
201 demux_sys_t *p_sys = p_demux->p_sys;
202 block_t *p_block_in, *p_block_out;
204 if( !( p_block_in = stream_Block( p_demux->s, FLAC_PACKET_SIZE ) ) )
207 p_block_in->i_pts = p_block_in->i_dts = p_sys->b_start ? VLC_TS_0 : VLC_TS_INVALID;
208 p_sys->b_start = false;
210 while( (p_block_out = p_sys->p_packetizer->pf_packetize(
211 p_sys->p_packetizer, &p_block_in )) )
215 block_t *p_next = p_block_out->p_next;
217 p_block_out->p_next = NULL;
219 if( p_sys->p_es == NULL )
221 p_sys->p_packetizer->fmt_out.b_packetized = true;
222 p_sys->p_packetizer->fmt_out.audio_replay_gain = p_sys->replay_gain;
223 p_sys->p_es = es_out_Add( p_demux->out, &p_sys->p_packetizer->fmt_out);
226 p_sys->i_pts = p_block_out->i_dts - VLC_TS_0;
228 /* Correct timestamp */
229 p_block_out->i_pts += p_sys->i_time_offset;
230 p_block_out->i_dts += p_sys->i_time_offset;
233 es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block_out->i_dts );
235 es_out_Send( p_demux->out, p_sys->p_es, p_block_out );
237 p_block_out = p_next;
243 /*****************************************************************************
245 *****************************************************************************/
246 static int64_t ControlGetLength( demux_t *p_demux )
248 demux_sys_t *p_sys = p_demux->p_sys;
249 const int64_t i_size = stream_Size(p_demux->s) - p_sys->i_data_pos;
250 int64_t i_length = p_sys->i_length;
253 /* Try to fix length using seekpoint and current size for truncated file */
254 for( i = p_sys->i_seekpoint-1; i >= 0; i-- )
256 seekpoint_t *s = p_sys->seekpoint[i];
257 if( s->i_byte_offset <= i_size )
259 if( i+1 < p_sys->i_seekpoint )
262 seekpoint_t *n = p_sys->seekpoint[i+1];
263 assert( n->i_byte_offset != s->i_byte_offset); /* Should be ensured by ParseSeekTable */
264 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);
272 static int64_t ControlGetTime( demux_t *p_demux )
274 demux_sys_t *p_sys = p_demux->p_sys;
275 return __MAX(p_sys->i_pts, p_sys->i_pts_start) + p_sys->i_time_offset;
278 static int ControlSetTime( demux_t *p_demux, int64_t i_time )
280 demux_sys_t *p_sys = p_demux->p_sys;
281 int64_t i_delta_time;
286 stream_Control( p_demux->s, STREAM_CAN_SEEK, &b_seekable );
291 assert( p_sys->i_seekpoint > 0 ); /* ReadMeta ensure at least (0,0) */
292 for( i = p_sys->i_seekpoint-1; i >= 0; i-- )
294 if( p_sys->seekpoint[i]->i_time_offset <= i_time )
297 i_delta_time = i_time - p_sys->seekpoint[i]->i_time_offset;
299 /* XXX We do exact seek if it's not too far away(45s) */
300 if( i_delta_time < 45*INT64_C(1000000) )
302 if( stream_Seek( p_demux->s, p_sys->seekpoint[i]->i_byte_offset+p_sys->i_data_pos ) )
305 p_sys->i_time_offset = p_sys->seekpoint[i]->i_time_offset - p_sys->i_pts;
306 p_sys->i_pts_start = p_sys->i_pts+i_delta_time;
307 es_out_Control( p_demux->out, ES_OUT_SET_NEXT_DISPLAY_TIME, p_sys->i_pts_start + p_sys->i_time_offset );
311 int64_t i_delta_offset;
313 int64_t i_next_offset;
315 if( i+1 < p_sys->i_seekpoint )
317 i_next_time = p_sys->seekpoint[i+1]->i_time_offset;
318 i_next_offset = p_sys->seekpoint[i+1]->i_byte_offset;
322 i_next_time = p_sys->i_length;
323 i_next_offset = stream_Size(p_demux->s)-p_sys->i_data_pos;
327 if( i_next_time-p_sys->seekpoint[i]->i_time_offset > 0 )
328 i_delta_offset = (i_next_offset - p_sys->seekpoint[i]->i_byte_offset) * i_delta_time /
329 (i_next_time-p_sys->seekpoint[i]->i_time_offset);
331 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_HAS_UNSUPPORTED_META )
353 bool *pb_bool = (bool*)va_arg( args, bool* );
357 else if( i_query == DEMUX_GET_LENGTH )
359 int64_t *pi64 = (int64_t*)va_arg( args, int64_t * );
360 *pi64 = ControlGetLength( p_demux );
363 else if( i_query == DEMUX_SET_TIME )
365 int64_t i_time = (int64_t)va_arg( args, int64_t );
366 return ControlSetTime( p_demux, i_time );
368 else if( i_query == DEMUX_SET_POSITION )
370 const double f = (double)va_arg( args, double );
371 int64_t i_time = f * ControlGetLength( p_demux );
372 return ControlSetTime( p_demux, i_time );
374 else if( i_query == DEMUX_GET_TIME )
376 int64_t *pi64 = (int64_t*)va_arg( args, int64_t * );
377 *pi64 = ControlGetTime( p_demux );
380 else if( i_query == DEMUX_GET_POSITION )
382 double *pf = (double*)va_arg( args, double * );
383 const int64_t i_length = ControlGetLength(p_demux);
386 double current = ControlGetTime(p_demux);
387 *pf = current / (double)i_length;
393 else if( i_query == DEMUX_GET_ATTACHMENTS )
395 input_attachment_t ***ppp_attach =
396 (input_attachment_t***)va_arg( args, input_attachment_t*** );
397 int *pi_int = (int*)va_arg( args, int * );
400 if( p_sys->i_attachments <= 0 )
403 *pi_int = p_sys->i_attachments;;
404 *ppp_attach = malloc( sizeof(input_attachment_t**) * p_sys->i_attachments );
405 for( i = 0; i < p_sys->i_attachments; i++ )
406 (*ppp_attach)[i] = vlc_input_attachment_Duplicate( p_sys->attachments[i] );
410 return demux_vaControlHelper( p_demux->s, p_sys->i_data_pos, -1,
411 8*0, 1, i_query, args );
422 static inline int Get24bBE( const uint8_t *p )
424 return (p[0] << 16)|(p[1] << 8)|(p[2]);
427 static void ParseStreamInfo( int *pi_rate, int64_t *pi_count, uint8_t *p_data );
428 static void ParseSeekTable( demux_t *p_demux, const uint8_t *p_data, int i_data,
430 static void ParseComment( demux_t *, const uint8_t *p_data, int i_data );
431 static void ParsePicture( demux_t *, const uint8_t *p_data, int i_data );
433 static int ReadMeta( demux_t *p_demux, uint8_t **pp_streaminfo, int *pi_streaminfo )
435 demux_sys_t *p_sys = p_demux->p_sys;
437 const uint8_t *p_peek;
440 int64_t i_sample_count;
443 /* Read STREAMINFO */
444 i_peek = stream_Peek( p_demux->s, &p_peek, 8 );
445 if( (p_peek[4] & 0x7F) != META_STREAMINFO )
447 msg_Err( p_demux, "this isn't a STREAMINFO metadata block" );
450 if( Get24bBE(&p_peek[5]) != (STREAMINFO_SIZE - 4) )
452 msg_Err( p_demux, "invalid size for a STREAMINFO metadata block" );
456 *pi_streaminfo = 4 + STREAMINFO_SIZE;
457 *pp_streaminfo = malloc( 4 + STREAMINFO_SIZE );
458 if( *pp_streaminfo == NULL )
461 if( stream_Read( p_demux->s, *pp_streaminfo, 4+STREAMINFO_SIZE ) != 4+STREAMINFO_SIZE )
463 msg_Err( p_demux, "failed to read STREAMINFO metadata block" );
464 free( *pp_streaminfo );
469 ParseStreamInfo( &i_sample_rate, &i_sample_count, *pp_streaminfo );
470 if( i_sample_rate > 0 )
471 p_sys->i_length = i_sample_count * INT64_C(1000000)/i_sample_rate;
473 /* Be sure we have seekpoint 0 */
474 s = vlc_seekpoint_New();
475 s->i_time_offset = 0;
476 s->i_byte_offset = 0;
477 TAB_APPEND( p_sys->i_seekpoint, p_sys->seekpoint, s );
479 b_last = (*pp_streaminfo)[4]&0x80;
485 i_peek = stream_Peek( p_demux->s, &p_peek, 4 );
488 b_last = p_peek[0]&0x80;
489 i_type = p_peek[0]&0x7f;
490 i_len = Get24bBE( &p_peek[1] );
492 if( i_type == META_SEEKTABLE )
494 i_peek = stream_Peek( p_demux->s, &p_peek, 4+i_len );
495 if( i_peek == 4+i_len )
496 ParseSeekTable( p_demux, p_peek, i_peek, i_sample_rate );
498 else if( i_type == META_COMMENT )
500 i_peek = stream_Peek( p_demux->s, &p_peek, 4+i_len );
501 if( i_peek == 4+i_len )
502 ParseComment( p_demux, p_peek, i_peek );
504 else if( i_type == META_PICTURE )
506 i_peek = stream_Peek( p_demux->s, &p_peek, 4+i_len );
507 if( i_peek == 4+i_len )
508 ParsePicture( p_demux, p_peek, i_peek );
511 if( stream_Read( p_demux->s, NULL, 4+i_len ) < 4+i_len )
516 p_sys->i_data_pos = stream_Tell( p_demux->s );
520 static void ParseStreamInfo( int *pi_rate, int64_t *pi_count, uint8_t *p_data )
522 const int i_skip = 4+4;
524 *pi_rate = GetDWBE(&p_data[i_skip+4+6]) >> 12;
525 *pi_count = GetQWBE(&p_data[i_skip+4+6]) & ((INT64_C(1)<<36)-1);
528 static void ParseSeekTable( demux_t *p_demux, const uint8_t *p_data, int i_data,
531 demux_sys_t *p_sys = p_demux->p_sys;
535 if( i_sample_rate <= 0 )
539 for( i = 0; i < (i_data-4)/18; i++ )
541 const int64_t i_sample = GetQWBE( &p_data[4+18*i+0] );
544 if( i_sample < 0 || i_sample >= INT64_MAX )
547 s = vlc_seekpoint_New();
548 s->i_time_offset = i_sample * INT64_C(1000000)/i_sample_rate;
549 s->i_byte_offset = GetQWBE( &p_data[4+18*i+8] );
551 /* Check for duplicate entry */
552 for( j = 0; j < p_sys->i_seekpoint; j++ )
554 if( p_sys->seekpoint[j]->i_time_offset == s->i_time_offset ||
555 p_sys->seekpoint[j]->i_byte_offset == s->i_byte_offset )
557 vlc_seekpoint_Delete( s );
564 TAB_APPEND( p_sys->i_seekpoint, p_sys->seekpoint, s );
567 /* TODO sort it by size and remove wrong seek entry (time not increasing) */
570 #define RM(x) do { i_data -= (x); p_data += (x); } while(0)
571 static void ParseComment( demux_t *p_demux, const uint8_t *p_data, int i_data )
573 demux_sys_t *p_sys = p_demux->p_sys;
578 vorbis_ParseComment( &p_sys->p_meta, &p_data[4], i_data - 4 );
582 static void ParsePicture( demux_t *p_demux, const uint8_t *p_data, int i_data )
584 static const int pi_cover_score[] = {
587 10, /* front cover */
589 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
590 6, /* movie/video screen capture */
592 7, /* Illustration */
593 8, /* Band/Artist logotype */
594 0, /* Publisher/Studio */
596 demux_sys_t *p_sys = p_demux->p_sys;
599 char *psz_mime = NULL;
600 char *psz_description = NULL;
601 input_attachment_t *p_attachment;
604 if( i_data < 4 + 3*4 )
606 #define RM(x) do { i_data -= (x); p_data += (x); } while(0)
609 i_type = GetDWBE( p_data ); RM(4);
610 i_len = GetDWBE( p_data ); RM(4);
611 if( i_len < 0 || i_data < i_len + 4 )
613 psz_mime = strndup( (const char*)p_data, i_len ); RM(i_len);
614 i_len = GetDWBE( p_data ); RM(4);
615 if( i_len < 0 || i_data < i_len + 4*4 + 4)
617 psz_description = strndup( (const char*)p_data, i_len ); RM(i_len);
618 EnsureUTF8( psz_description );
620 i_len = GetDWBE( p_data ); RM(4);
621 if( i_len < 0 || i_len > i_data )
624 msg_Dbg( p_demux, "FLAC: Picture type=%d mime=%s description='%s' file length=%d",
625 i_type, psz_mime, psz_description, i_len );
627 snprintf( psz_name, sizeof(psz_name), "picture%d", p_sys->i_attachments );
628 if( !strcasecmp( psz_mime, "image/jpeg" ) )
629 strcat( psz_name, ".jpg" );
630 else if( !strcasecmp( psz_mime, "image/png" ) )
631 strcat( psz_name, ".png" );
633 p_attachment = vlc_input_attachment_New( psz_name, psz_mime, psz_description,
635 TAB_APPEND( p_sys->i_attachments, p_sys->attachments, p_attachment );
637 if( i_type >= 0 && (unsigned int)i_type < sizeof(pi_cover_score)/sizeof(pi_cover_score[0]) &&
638 p_sys->i_cover_score < pi_cover_score[i_type] )
640 p_sys->i_cover_idx = p_sys->i_attachments-1;
641 p_sys->i_cover_score = pi_cover_score[i_type];
645 free( psz_description );