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>
41 /*****************************************************************************
43 *****************************************************************************/
44 static int Open ( vlc_object_t * );
45 static void Close ( vlc_object_t * );
48 set_description( N_("FLAC demuxer") );
49 set_capability( "demux", 155 );
50 set_category( CAT_INPUT );
51 set_subcategory( SUBCAT_INPUT_DEMUX );
52 set_callbacks( Open, Close );
53 add_shortcut( "flac" );
56 /*****************************************************************************
58 *****************************************************************************/
59 static int Demux ( demux_t * );
60 static int Control( demux_t *, int, va_list );
62 static int ReadMeta( demux_t *, uint8_t **pp_streaminfo, int *pi_streaminfo );
70 decoder_t *p_packetizer;
73 audio_replay_gain_t replay_gain;
75 int64_t i_time_offset;
79 int64_t i_length; /* Length from stream info */
84 seekpoint_t **seekpoint;
88 input_attachment_t **attachments;
93 #define STREAMINFO_SIZE 38
94 #define FLAC_PACKET_SIZE 16384
96 /*****************************************************************************
97 * Open: initializes ES structures
98 *****************************************************************************/
99 static int Open( vlc_object_t * p_this )
101 demux_t *p_demux = (demux_t*)p_this;
103 const uint8_t *p_peek;
104 uint8_t *p_streaminfo;
107 /* Have a peep at the show. */
108 if( stream_Peek( p_demux->s, &p_peek, 4 ) < 4 ) return VLC_EGENERIC;
110 if( p_peek[0]!='f' || p_peek[1]!='L' || p_peek[2]!='a' || p_peek[3]!='C' )
112 if( !p_demux->b_force ) return VLC_EGENERIC;
115 msg_Err( p_demux, "this doesn't look like a flac stream, "
116 "continuing anyway" );
119 p_demux->pf_demux = Demux;
120 p_demux->pf_control = Control;
121 p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
122 p_sys->b_start = true;
123 p_sys->p_meta = NULL;
124 memset( &p_sys->replay_gain, 0, sizeof(p_sys->replay_gain) );
126 p_sys->i_time_offset = 0;
128 p_sys->i_pts_start = 0;
130 TAB_INIT( p_sys->i_seekpoint, p_sys->seekpoint );
131 TAB_INIT( p_sys->i_attachments, p_sys->attachments);
132 p_sys->i_cover_idx = 0;
133 p_sys->i_cover_score = 0;
135 /* We need to read and store the STREAMINFO metadata */
136 if( ReadMeta( p_demux, &p_streaminfo, &i_streaminfo ) )
142 /* Load the FLAC packetizer */
143 INIT_APACKETIZER( p_sys->p_packetizer, 'f', 'l', 'a', 'c' );
145 /* Store STREAMINFO for the decoder and packetizer */
146 p_streaminfo[4] |= 0x80; /* Fake this as the last metadata block */
147 p_sys->p_packetizer->fmt_in.i_extra = i_streaminfo;
148 p_sys->p_packetizer->fmt_in.p_extra = p_streaminfo;
150 p_sys->p_packetizer->p_module =
151 module_Need( p_sys->p_packetizer, "packetizer", NULL, 0 );
152 if( !p_sys->p_packetizer->p_module )
154 free( p_sys->p_packetizer->fmt_in.p_extra );
155 vlc_object_release( p_sys->p_packetizer );
157 msg_Err( p_demux, "cannot find flac packetizer" );
161 if( p_sys->i_cover_idx < p_sys->i_attachments )
165 p_sys->p_meta = vlc_meta_New();
166 snprintf( psz_url, sizeof(psz_url), "attachment://%s",
167 p_sys->attachments[p_sys->i_cover_idx]->psz_name );
168 vlc_meta_Set( p_sys->p_meta, vlc_meta_ArtworkURL, psz_url );
170 vlc_audio_replay_gain_MergeFromMeta( &p_sys->replay_gain, p_sys->p_meta );
174 /*****************************************************************************
175 * Close: frees unused data
176 *****************************************************************************/
177 static void Close( vlc_object_t * p_this )
179 demux_t *p_demux = (demux_t*)p_this;
180 demux_sys_t *p_sys = p_demux->p_sys;
182 TAB_CLEAN( p_sys->i_seekpoint, p_sys->seekpoint );
185 for( i = 0; i < p_sys->i_attachments; i++ )
186 free( p_sys->attachments[i] );
187 TAB_CLEAN( p_sys->i_attachments, p_sys->attachments);
190 module_Unneed( p_sys->p_packetizer, p_sys->p_packetizer->p_module );
192 free( p_sys->p_packetizer->fmt_in.p_extra );
194 /* Delete the decoder */
195 vlc_object_release( p_sys->p_packetizer );
197 vlc_meta_Delete( p_sys->p_meta );
201 /*****************************************************************************
202 * Demux: reads and demuxes data packets
203 *****************************************************************************
204 * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
205 *****************************************************************************/
206 static int Demux( demux_t *p_demux )
208 demux_sys_t *p_sys = p_demux->p_sys;
209 block_t *p_block_in, *p_block_out;
211 if( !( p_block_in = stream_Block( p_demux->s, FLAC_PACKET_SIZE ) ) )
214 p_block_in->i_pts = p_block_in->i_dts = p_sys->b_start ? 1 : 0;
215 p_sys->b_start = false;
217 while( (p_block_out = p_sys->p_packetizer->pf_packetize(
218 p_sys->p_packetizer, &p_block_in )) )
222 block_t *p_next = p_block_out->p_next;
224 p_block_out->p_next = NULL;
226 if( p_sys->p_es == NULL )
228 p_sys->p_packetizer->fmt_out.b_packetized = true;
229 p_sys->p_packetizer->fmt_out.audio_replay_gain = p_sys->replay_gain;
230 p_sys->p_es = es_out_Add( p_demux->out, &p_sys->p_packetizer->fmt_out);
233 p_sys->i_pts = p_block_out->i_dts;
235 /* Correct timestamp */
236 p_block_out->i_pts += p_sys->i_time_offset;
237 p_block_out->i_dts += p_sys->i_time_offset;
240 if( p_block_out->i_dts >= p_sys->i_pts_start + p_sys->i_time_offset )
241 es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block_out->i_dts );
243 es_out_Control( p_demux->out, ES_OUT_RESET_PCR );
245 es_out_Send( p_demux->out, p_sys->p_es, p_block_out );
247 p_block_out = p_next;
253 /*****************************************************************************
255 *****************************************************************************/
256 static int64_t ControlGetLength( demux_t *p_demux )
258 demux_sys_t *p_sys = p_demux->p_sys;
259 const int64_t i_size = stream_Size(p_demux->s) - p_sys->i_data_pos;
260 int64_t i_length = p_sys->i_length;
263 /* Try to fix length using seekpoint and current size for truncated file */
264 for( i = p_sys->i_seekpoint-1; i >= 0; i-- )
266 seekpoint_t *s = p_sys->seekpoint[i];
267 if( s->i_byte_offset <= i_size )
269 if( i+1 < p_sys->i_seekpoint )
272 seekpoint_t *n = p_sys->seekpoint[i+1];
273 assert( n->i_byte_offset != s->i_byte_offset); /* Should be ensured by ParseSeekTable */
274 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);
282 static int64_t ControlGetTime( demux_t *p_demux )
284 demux_sys_t *p_sys = p_demux->p_sys;
285 return __MAX(p_sys->i_pts, p_sys->i_pts_start) + p_sys->i_time_offset;
288 static int ControlSetTime( demux_t *p_demux, int64_t i_time )
290 demux_sys_t *p_sys = p_demux->p_sys;
291 int64_t i_delta_time;
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 i_delta_time = i_time - p_sys->seekpoint[i]->i_time_offset;
309 /* XXX We do exact seek if it's not too far away(45s) */
310 if( i_delta_time < 45*INT64_C(1000000) )
312 if( stream_Seek( p_demux->s, p_sys->seekpoint[i]->i_byte_offset+p_sys->i_data_pos ) )
315 p_sys->i_time_offset = p_sys->seekpoint[i]->i_time_offset - p_sys->i_pts;
316 p_sys->i_pts_start = p_sys->i_pts+i_delta_time;
317 es_out_Control( p_demux->out, ES_OUT_SET_NEXT_DISPLAY_TIME, p_sys->p_es, p_sys->i_pts_start + p_sys->i_time_offset );
321 int64_t i_delta_offset;
323 int64_t i_next_offset;
325 if( i+1 < p_sys->i_seekpoint )
327 i_next_time = p_sys->seekpoint[i+1]->i_time_offset;
328 i_next_offset = p_sys->seekpoint[i+1]->i_byte_offset;
332 i_next_time = p_sys->i_length;
333 i_next_offset = stream_Size(p_demux->s)-p_sys->i_data_pos;
337 if( i_next_time-p_sys->seekpoint[i]->i_time_offset > 0 )
338 i_delta_offset = (i_next_offset - p_sys->seekpoint[i]->i_byte_offset) * i_delta_time /
339 (i_next_time-p_sys->seekpoint[i]->i_time_offset);
341 if( stream_Seek( p_demux->s, p_sys->seekpoint[i]->i_byte_offset+p_sys->i_data_pos + i_delta_offset ) )
344 p_sys->i_pts_start = p_sys->i_pts;
345 p_sys->i_time_offset = (p_sys->seekpoint[i]->i_time_offset+i_delta_time) - p_sys->i_pts;
350 static int Control( demux_t *p_demux, int i_query, va_list args )
352 demux_sys_t *p_sys = p_demux->p_sys;
354 if( i_query == DEMUX_GET_META )
356 vlc_meta_t *p_meta = (vlc_meta_t *)va_arg( args, vlc_meta_t* );
357 if( p_demux->p_sys->p_meta )
358 vlc_meta_Merge( p_meta, p_demux->p_sys->p_meta );
361 else if( i_query == DEMUX_HAS_UNSUPPORTED_META )
363 bool *pb_bool = (bool*)va_arg( args, bool* );
367 else if( i_query == DEMUX_GET_LENGTH )
369 int64_t *pi64 = (int64_t*)va_arg( args, int64_t * );
370 *pi64 = ControlGetLength( p_demux );
373 else if( i_query == DEMUX_SET_TIME )
375 int64_t i_time = (int64_t)va_arg( args, int64_t );
376 return ControlSetTime( p_demux, i_time );
378 else if( i_query == DEMUX_SET_POSITION )
380 const double f = (double)va_arg( args, double );
381 int64_t i_time = f * ControlGetLength( p_demux );
382 return ControlSetTime( p_demux, i_time );
384 else if( i_query == DEMUX_GET_TIME )
386 int64_t *pi64 = (int64_t*)va_arg( args, int64_t * );
387 *pi64 = ControlGetTime( p_demux );
390 else if( i_query == DEMUX_GET_POSITION )
392 double *pf = (double*)va_arg( args, double * );
393 const int64_t i_length = ControlGetLength(p_demux);
395 *pf = (double)ControlGetTime(p_demux) / (double)i_length;
400 else if( i_query == DEMUX_GET_ATTACHMENTS )
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 * );
407 if( p_sys->i_attachments <= 0 )
410 *pi_int = p_sys->i_attachments;;
411 *ppp_attach = malloc( sizeof(input_attachment_t**) * p_sys->i_attachments );
412 for( i = 0; i < p_sys->i_attachments; i++ )
413 (*ppp_attach)[i] = vlc_input_attachment_Duplicate( p_sys->attachments[i] );
417 return demux_vaControlHelper( p_demux->s, p_sys->i_data_pos, -1,
418 8*0, 1, i_query, args );
429 static inline int Get24bBE( const uint8_t *p )
431 return (p[0] << 16)|(p[1] << 8)|(p[2]);
434 static void ParseStreamInfo( int *pi_rate, int64_t *pi_count, uint8_t *p_data );
435 static void ParseSeekTable( demux_t *p_demux, const uint8_t *p_data, int i_data,
437 static void ParseComment( demux_t *, const uint8_t *p_data, int i_data );
438 static void ParsePicture( demux_t *, const uint8_t *p_data, int i_data );
440 static int ReadMeta( demux_t *p_demux, uint8_t **pp_streaminfo, int *pi_streaminfo )
442 demux_sys_t *p_sys = p_demux->p_sys;
444 const uint8_t *p_peek;
447 int64_t i_sample_count;
450 /* Read STREAMINFO */
451 i_peek = stream_Peek( p_demux->s, &p_peek, 8 );
452 if( (p_peek[4] & 0x7F) != META_STREAMINFO )
454 msg_Err( p_demux, "this isn't a STREAMINFO metadata block" );
457 if( Get24bBE(&p_peek[5]) != (STREAMINFO_SIZE - 4) )
459 msg_Err( p_demux, "invalid size for a STREAMINFO metadata block" );
463 *pi_streaminfo = 4 + STREAMINFO_SIZE;
464 *pp_streaminfo = malloc( 4 + STREAMINFO_SIZE );
465 if( *pp_streaminfo == NULL )
468 if( stream_Read( p_demux->s, *pp_streaminfo, 4+STREAMINFO_SIZE ) != 4+STREAMINFO_SIZE )
470 msg_Err( p_demux, "failed to read STREAMINFO metadata block" );
471 free( *pp_streaminfo );
476 ParseStreamInfo( &i_sample_rate, &i_sample_count, *pp_streaminfo );
477 if( i_sample_rate > 0 )
478 p_sys->i_length = i_sample_count * INT64_C(1000000)/i_sample_rate;
480 /* Be sure we have seekpoint 0 */
481 s = vlc_seekpoint_New();
482 s->i_time_offset = 0;
483 s->i_byte_offset = 0;
484 TAB_APPEND( p_sys->i_seekpoint, p_sys->seekpoint, s );
486 b_last = (*pp_streaminfo)[4]&0x80;
492 i_peek = stream_Peek( p_demux->s, &p_peek, 4 );
495 b_last = p_peek[0]&0x80;
496 i_type = p_peek[0]&0x7f;
497 i_len = Get24bBE( &p_peek[1] );
499 if( i_type == META_SEEKTABLE )
501 i_peek = stream_Peek( p_demux->s, &p_peek, 4+i_len );
502 if( i_peek == 4+i_len )
503 ParseSeekTable( p_demux, p_peek, i_peek, i_sample_rate );
505 else if( i_type == META_COMMENT )
507 i_peek = stream_Peek( p_demux->s, &p_peek, 4+i_len );
508 if( i_peek == 4+i_len )
509 ParseComment( p_demux, p_peek, i_peek );
511 else if( i_type == META_PICTURE )
513 i_peek = stream_Peek( p_demux->s, &p_peek, 4+i_len );
514 if( i_peek == 4+i_len )
515 ParsePicture( p_demux, p_peek, i_peek );
518 if( stream_Read( p_demux->s, NULL, 4+i_len ) < 4+i_len )
523 p_sys->i_data_pos = stream_Tell( p_demux->s );
527 static void ParseStreamInfo( int *pi_rate, int64_t *pi_count, uint8_t *p_data )
529 const int i_skip = 4+4;
531 *pi_rate = GetDWBE(&p_data[i_skip+4+6]) >> 12;
532 *pi_count = GetQWBE(&p_data[i_skip+4+6]) & ((INT64_C(1)<<36)-1);
535 static void ParseSeekTable( demux_t *p_demux, const uint8_t *p_data, int i_data,
538 demux_sys_t *p_sys = p_demux->p_sys;
542 if( i_sample_rate <= 0 )
546 for( i = 0; i < (i_data-4)/18; i++ )
548 const int64_t i_sample = GetQWBE( &p_data[4+18*i+0] );
551 if( i_sample < 0 || i_sample >= INT64_MAX )
554 s = vlc_seekpoint_New();
555 s->i_time_offset = i_sample * INT64_C(1000000)/i_sample_rate;
556 s->i_byte_offset = GetQWBE( &p_data[4+18*i+8] );
558 /* Check for duplicate entry */
559 for( j = 0; j < p_sys->i_seekpoint; j++ )
561 if( p_sys->seekpoint[j]->i_time_offset == s->i_time_offset ||
562 p_sys->seekpoint[j]->i_byte_offset == s->i_byte_offset )
564 vlc_seekpoint_Delete( s );
571 TAB_APPEND( p_sys->i_seekpoint, p_sys->seekpoint, s );
574 /* TODO sort it by size and remove wrong seek entry (time not increasing) */
577 #define RM(x) do { i_data -= (x); p_data += (x); } while(0)
578 static void ParseComment( demux_t *p_demux, const 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( (const char*)p_data, n );
628 #define IF_EXTRACT(txt,var) \
629 if( !strncasecmp(psz, txt, strlen(txt)) ) \
631 const char *oldval = vlc_meta_Get( p_sys->p_meta, vlc_meta_ ## var ); \
635 if( asprintf( &newval, "%s,%s", oldval, &psz[strlen(txt)] ) == -1 ) \
637 vlc_meta_Set( p_sys->p_meta, vlc_meta_ ## var, newval ); \
641 vlc_meta_Set( p_sys->p_meta, vlc_meta_ ## var, &psz[strlen(txt)] ); \
643 IF_EXTRACT("TITLE=", Title )
644 else IF_EXTRACT("ALBUM=", Album )
645 else IF_EXTRACT("TRACKNUMBER=", TrackNumber )
646 else IF_EXTRACT("ARTIST=", Artist )
647 else IF_EXTRACT("COPYRIGHT=", Copyright )
648 else IF_EXTRACT("DESCRIPTION=", Description )
649 else IF_EXTRACT("GENRE=", Genre )
650 else IF_EXTRACT("DATE=", Date )
651 else if( strchr( psz, '=' ) )
653 /* generic (PERFORMER/LICENSE/ORGANIZATION/LOCATION/CONTACT/ISRC,
654 * undocumented tags and replay gain ) */
655 char *p = strchr( psz, '=' );
657 vlc_meta_AddExtra( p_sys->p_meta, psz, p );
665 static void ParsePicture( demux_t *p_demux, const uint8_t *p_data, int i_data )
667 static const int pi_cover_score[] = {
670 10, /* front cover */
672 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
673 6, /* movie/video screen capture */
675 7, /* Illustration */
676 8, /* Band/Artist logotype */
677 0, /* Publisher/Studio */
679 demux_sys_t *p_sys = p_demux->p_sys;
682 char *psz_mime = NULL;
683 char *psz_description = NULL;
684 input_attachment_t *p_attachment;
687 if( i_data < 4 + 3*4 )
689 #define RM(x) do { i_data -= (x); p_data += (x); } while(0)
692 i_type = GetDWBE( p_data ); RM(4);
693 i_len = GetDWBE( p_data ); RM(4);
694 if( i_len < 0 || i_data < i_len + 4 )
696 psz_mime = strndup( (const char*)p_data, i_len ); RM(i_len);
697 i_len = GetDWBE( p_data ); RM(4);
698 if( i_len < 0 || i_data < i_len + 4*4 + 4)
700 psz_description = strndup( (const char*)p_data, i_len ); RM(i_len);
701 EnsureUTF8( psz_description );
703 i_len = GetDWBE( p_data ); RM(4);
704 if( i_len < 0 || i_len > i_data )
707 msg_Dbg( p_demux, "FLAC: Picture type=%d mime=%s description='%s' file length=%d",
708 i_type, psz_mime, psz_description, i_len );
710 snprintf( psz_name, sizeof(psz_name), "picture%d", p_sys->i_attachments );
711 if( !strcasecmp( psz_mime, "image/jpeg" ) )
712 strcat( psz_name, ".jpg" );
713 else if( !strcasecmp( psz_mime, "image/png" ) )
714 strcat( psz_name, ".png" );
716 p_attachment = vlc_input_attachment_New( psz_name, psz_mime, psz_description,
718 TAB_APPEND( p_sys->i_attachments, p_sys->attachments, p_attachment );
720 if( i_type >= 0 && (unsigned int)i_type < sizeof(pi_cover_score)/sizeof(pi_cover_score[0]) &&
721 p_sys->i_cover_score < pi_cover_score[i_type] )
723 p_sys->i_cover_idx = p_sys->i_attachments-1;
724 p_sys->i_cover_score = pi_cover_score[i_type];
728 free( psz_description );