1 /*****************************************************************************
2 * flac.c : FLAC demux module for vlc
3 *****************************************************************************
4 * Copyright (C) 2001-2008 VLC authors and VideoLAN
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 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.
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.
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 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
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 */
41 #include "xiph_metadata.h" /* vorbis comments */
43 /*****************************************************************************
45 *****************************************************************************/
46 static int Open ( vlc_object_t * );
47 static void Close ( vlc_object_t * );
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" )
58 /*****************************************************************************
60 *****************************************************************************/
61 static int Demux ( demux_t * );
62 static int Control( demux_t *, int, va_list );
64 static int ReadMeta( demux_t *, uint8_t **pp_streaminfo, int *pi_streaminfo );
72 decoder_t *p_packetizer;
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_sys = malloc( sizeof( demux_sys_t ) );
122 if( unlikely(p_sys == NULL) )
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;
131 p_sys->i_time_offset = 0;
133 p_sys->i_pts_start = 0;
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;
140 /* We need to read and store the STREAMINFO metadata */
141 if( ReadMeta( p_demux, &p_streaminfo, &i_streaminfo ) )
147 /* Load the FLAC packetizer */
148 /* Store STREAMINFO for the decoder and packetizer */
149 p_streaminfo[4] |= 0x80; /* Fake this as the last metadata block */
150 es_format_Init( &fmt, AUDIO_ES, VLC_CODEC_FLAC );
151 fmt.i_extra = i_streaminfo;
152 fmt.p_extra = p_streaminfo;
154 p_sys->p_packetizer = demux_PacketizerNew( p_demux, &fmt, "flac" );
155 if( !p_sys->p_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 );
173 /*****************************************************************************
174 * Close: frees unused data
175 *****************************************************************************/
176 static void Close( vlc_object_t * p_this )
178 demux_t *p_demux = (demux_t*)p_this;
179 demux_sys_t *p_sys = p_demux->p_sys;
181 for( int i = 0; i < p_sys->i_seekpoint; i++ )
182 vlc_seekpoint_Delete(p_sys->seekpoint[i]);
183 TAB_CLEAN( p_sys->i_seekpoint, p_sys->seekpoint );
185 for( int i = 0; i < p_sys->i_attachments; i++ )
186 vlc_input_attachment_Delete( p_sys->attachments[i] );
187 TAB_CLEAN( p_sys->i_attachments, p_sys->attachments);
189 /* Delete the decoder */
190 demux_PacketizerDestroy( p_sys->p_packetizer );
193 vlc_meta_Delete( p_sys->p_meta );
197 /*****************************************************************************
198 * Demux: reads and demuxes data packets
199 *****************************************************************************
200 * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
201 *****************************************************************************/
202 static int Demux( demux_t *p_demux )
204 demux_sys_t *p_sys = p_demux->p_sys;
205 block_t *p_block_in, *p_block_out;
207 if( !( p_block_in = stream_Block( p_demux->s, FLAC_PACKET_SIZE ) ) )
210 p_block_in->i_pts = p_block_in->i_dts = p_sys->b_start ? VLC_TS_0 : VLC_TS_INVALID;
211 p_sys->b_start = false;
213 while( (p_block_out = p_sys->p_packetizer->pf_packetize(
214 p_sys->p_packetizer, &p_block_in )) )
218 block_t *p_next = p_block_out->p_next;
220 p_block_out->p_next = NULL;
222 if( p_sys->p_es == NULL )
224 p_sys->p_packetizer->fmt_out.b_packetized = true;
225 p_sys->p_es = es_out_Add( p_demux->out, &p_sys->p_packetizer->fmt_out);
228 p_sys->i_pts = p_block_out->i_dts - VLC_TS_0;
230 /* Correct timestamp */
231 p_block_out->i_pts += p_sys->i_time_offset;
232 p_block_out->i_dts += p_sys->i_time_offset;
235 es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block_out->i_dts );
237 es_out_Send( p_demux->out, p_sys->p_es, p_block_out );
239 p_block_out = p_next;
245 /*****************************************************************************
247 *****************************************************************************/
248 static int64_t ControlGetLength( demux_t *p_demux )
250 demux_sys_t *p_sys = p_demux->p_sys;
251 const int64_t i_size = stream_Size(p_demux->s) - p_sys->i_data_pos;
252 int64_t i_length = p_sys->i_length;
255 /* Try to fix length using seekpoint and current size for truncated file */
256 for( i = p_sys->i_seekpoint-1; i >= 0; i-- )
258 seekpoint_t *s = p_sys->seekpoint[i];
259 if( s->i_byte_offset <= i_size )
261 if( i+1 < p_sys->i_seekpoint )
264 seekpoint_t *n = p_sys->seekpoint[i+1];
265 assert( n->i_byte_offset != s->i_byte_offset); /* Should be ensured by ParseSeekTable */
266 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);
274 static int64_t ControlGetTime( demux_t *p_demux )
276 demux_sys_t *p_sys = p_demux->p_sys;
277 return __MAX(p_sys->i_pts, p_sys->i_pts_start) + p_sys->i_time_offset;
280 static int ControlSetTime( demux_t *p_demux, int64_t i_time )
282 demux_sys_t *p_sys = p_demux->p_sys;
283 int64_t i_delta_time;
288 stream_Control( p_demux->s, STREAM_CAN_SEEK, &b_seekable );
293 assert( p_sys->i_seekpoint > 0 ); /* ReadMeta ensure at least (0,0) */
294 for( i = p_sys->i_seekpoint-1; i >= 0; i-- )
296 if( p_sys->seekpoint[i]->i_time_offset <= i_time )
299 i_delta_time = i_time - p_sys->seekpoint[i]->i_time_offset;
301 /* XXX We do exact seek if it's not too far away(45s) */
302 if( i_delta_time < 45*INT64_C(1000000) )
304 if( stream_Seek( p_demux->s, p_sys->seekpoint[i]->i_byte_offset+p_sys->i_data_pos ) )
307 p_sys->i_time_offset = p_sys->seekpoint[i]->i_time_offset - p_sys->i_pts;
308 p_sys->i_pts_start = p_sys->i_pts+i_delta_time;
309 es_out_Control( p_demux->out, ES_OUT_SET_NEXT_DISPLAY_TIME, p_sys->i_pts_start + p_sys->i_time_offset );
313 int64_t i_delta_offset;
315 int64_t i_next_offset;
317 if( i+1 < p_sys->i_seekpoint )
319 i_next_time = p_sys->seekpoint[i+1]->i_time_offset;
320 i_next_offset = p_sys->seekpoint[i+1]->i_byte_offset;
324 i_next_time = p_sys->i_length;
325 i_next_offset = stream_Size(p_demux->s)-p_sys->i_data_pos;
329 if( i_next_time-p_sys->seekpoint[i]->i_time_offset > 0 )
330 i_delta_offset = (i_next_offset - p_sys->seekpoint[i]->i_byte_offset) * i_delta_time /
331 (i_next_time-p_sys->seekpoint[i]->i_time_offset);
333 if( stream_Seek( p_demux->s, p_sys->seekpoint[i]->i_byte_offset+p_sys->i_data_pos + i_delta_offset ) )
336 p_sys->i_pts_start = p_sys->i_pts;
337 p_sys->i_time_offset = (p_sys->seekpoint[i]->i_time_offset+i_delta_time) - p_sys->i_pts;
342 static int Control( demux_t *p_demux, int i_query, va_list args )
344 demux_sys_t *p_sys = p_demux->p_sys;
346 if( i_query == DEMUX_GET_META )
348 vlc_meta_t *p_meta = (vlc_meta_t *)va_arg( args, vlc_meta_t* );
349 if( p_demux->p_sys->p_meta )
350 vlc_meta_Merge( p_meta, p_demux->p_sys->p_meta );
353 else if( i_query == DEMUX_HAS_UNSUPPORTED_META )
355 bool *pb_bool = (bool*)va_arg( args, bool* );
359 else if( i_query == DEMUX_GET_LENGTH )
361 int64_t *pi64 = (int64_t*)va_arg( args, int64_t * );
362 *pi64 = ControlGetLength( p_demux );
365 else if( i_query == DEMUX_SET_TIME )
367 int64_t i_time = (int64_t)va_arg( args, int64_t );
368 return ControlSetTime( p_demux, i_time );
370 else if( i_query == DEMUX_SET_POSITION )
372 const double f = (double)va_arg( args, double );
373 int64_t i_time = f * ControlGetLength( p_demux );
374 return ControlSetTime( p_demux, i_time );
376 else if( i_query == DEMUX_GET_TIME )
378 int64_t *pi64 = (int64_t*)va_arg( args, int64_t * );
379 *pi64 = ControlGetTime( p_demux );
382 else if( i_query == DEMUX_GET_POSITION )
384 double *pf = (double*)va_arg( args, double * );
385 const int64_t i_length = ControlGetLength(p_demux);
388 double current = ControlGetTime(p_demux);
389 *pf = current / (double)i_length;
395 else if( i_query == DEMUX_GET_ATTACHMENTS )
397 input_attachment_t ***ppp_attach =
398 (input_attachment_t***)va_arg( args, input_attachment_t*** );
399 int *pi_int = (int*)va_arg( args, int * );
401 if( p_sys->i_attachments <= 0 )
404 *pi_int = p_sys->i_attachments;
405 *ppp_attach = xmalloc( sizeof(input_attachment_t**) * p_sys->i_attachments );
406 for( int i = 0; i < p_sys->i_attachments; i++ )
407 (*ppp_attach)[i] = vlc_input_attachment_Duplicate( p_sys->attachments[i] );
411 return demux_vaControlHelper( p_demux->s, p_sys->i_data_pos, -1,
412 8*0, 1, i_query, args );
423 static inline int Get24bBE( const uint8_t *p )
425 return (p[0] << 16)|(p[1] << 8)|(p[2]);
428 static void ParseStreamInfo( int *pi_rate, int64_t *pi_count, uint8_t *p_data );
429 static void ParseSeekTable( demux_t *p_demux, const uint8_t *p_data, int i_data,
431 static void ParseComment( demux_t *, const uint8_t *p_data, int i_data );
432 static void ParsePicture( demux_t *, const uint8_t *p_data, int i_data );
434 static int ReadMeta( demux_t *p_demux, uint8_t **pp_streaminfo, int *pi_streaminfo )
436 demux_sys_t *p_sys = p_demux->p_sys;
438 const uint8_t *p_peek;
440 int i_sample_rate = 0;
441 int64_t i_sample_count;
443 *pp_streaminfo = NULL;
445 /* Be sure we have seekpoint 0 */
446 seekpoint_t *s = vlc_seekpoint_New();
447 s->i_time_offset = 0;
448 s->i_byte_offset = 0;
449 TAB_APPEND( p_sys->i_seekpoint, p_sys->seekpoint, s );
451 static const uint8_t marker[4] = { 'f', 'L', 'a', 'C' };
453 if( stream_Read( p_demux->s, header, 4) < 4)
456 if (memcmp(header, marker, 4))
465 i_peek = stream_Peek( p_demux->s, &p_peek, 4 );
468 b_last = p_peek[0]&0x80;
469 i_type = p_peek[0]&0x7f;
470 i_len = Get24bBE( &p_peek[1] );
472 if( i_type == META_STREAMINFO && !*pp_streaminfo )
474 if( i_len != (STREAMINFO_SIZE - 4) ) {
475 msg_Err( p_demux, "invalid size %d for a STREAMINFO metadata block", i_len );
478 i_peek = stream_Peek( p_demux->s, &p_peek, STREAMINFO_SIZE);
479 if( i_peek == STREAMINFO_SIZE)
481 *pi_streaminfo = STREAMINFO_SIZE + 4;
482 *pp_streaminfo = malloc( STREAMINFO_SIZE + 4 );
483 if( *pp_streaminfo == NULL )
486 if( stream_Read( p_demux->s, &(*pp_streaminfo)[4], STREAMINFO_SIZE ) != STREAMINFO_SIZE )
488 msg_Err( p_demux, "failed to read STREAMINFO metadata block" );
489 free( *pp_streaminfo );
493 memcpy(*pp_streaminfo, marker, 4);
496 ParseStreamInfo( &i_sample_rate, &i_sample_count, *pp_streaminfo );
497 if( i_sample_rate > 0 )
498 p_sys->i_length = i_sample_count * INT64_C(1000000)/i_sample_rate;
501 else if( i_type == META_SEEKTABLE )
503 i_peek = stream_Peek( p_demux->s, &p_peek, 4+i_len );
504 if( i_peek == 4+i_len )
505 ParseSeekTable( p_demux, p_peek, i_peek, i_sample_rate );
507 else if( i_type == META_COMMENT )
509 i_peek = stream_Peek( p_demux->s, &p_peek, 4+i_len );
510 if( i_peek == 4+i_len )
511 ParseComment( p_demux, p_peek, i_peek );
513 else if( i_type == META_PICTURE )
515 i_peek = stream_Peek( p_demux->s, &p_peek, 4+i_len );
516 if( i_peek == 4+i_len )
517 ParsePicture( p_demux, p_peek, i_peek );
520 if( stream_Read( p_demux->s, NULL, 4+i_len ) < 4+i_len )
525 p_sys->i_data_pos = stream_Tell( p_demux->s );
532 static void ParseStreamInfo( int *pi_rate, int64_t *pi_count, uint8_t *p_data )
534 const int i_skip = 4+4;
536 *pi_rate = GetDWBE(&p_data[i_skip+4+6]) >> 12;
537 *pi_count = GetQWBE(&p_data[i_skip+4+6]) & ((INT64_C(1)<<36)-1);
540 static void ParseSeekTable( demux_t *p_demux, const uint8_t *p_data, int i_data,
543 demux_sys_t *p_sys = p_demux->p_sys;
547 if( i_sample_rate <= 0 )
551 for( i = 0; i < (i_data-4)/18; i++ )
553 const int64_t i_sample = GetQWBE( &p_data[4+18*i+0] );
556 if( i_sample < 0 || i_sample >= INT64_MAX )
559 s = vlc_seekpoint_New();
560 s->i_time_offset = i_sample * INT64_C(1000000)/i_sample_rate;
561 s->i_byte_offset = GetQWBE( &p_data[4+18*i+8] );
563 /* Check for duplicate entry */
564 for( j = 0; j < p_sys->i_seekpoint; j++ )
566 if( p_sys->seekpoint[j]->i_time_offset == s->i_time_offset ||
567 p_sys->seekpoint[j]->i_byte_offset == s->i_byte_offset )
569 vlc_seekpoint_Delete( s );
576 TAB_APPEND( p_sys->i_seekpoint, p_sys->seekpoint, s );
579 /* TODO sort it by size and remove wrong seek entry (time not increasing) */
582 static void ParseComment( demux_t *p_demux, const uint8_t *p_data, int i_data )
584 demux_sys_t *p_sys = p_demux->p_sys;
589 vorbis_ParseComment( &p_sys->p_meta, &p_data[4], i_data - 4,
590 &p_sys->i_attachments, &p_sys->attachments,
591 &p_sys->i_cover_score, &p_sys->i_cover_idx, NULL, NULL );
594 static void ParsePicture( demux_t *p_demux, const uint8_t *p_data, int i_data )
596 demux_sys_t *p_sys = p_demux->p_sys;
598 i_data -= 4; p_data += 4;
600 input_attachment_t *p_attachment = ParseFlacPicture( p_data, i_data,
601 p_sys->i_attachments, &p_sys->i_cover_score, &p_sys->i_cover_idx );
602 if( p_attachment == NULL )
605 TAB_APPEND( p_sys->i_attachments, p_sys->attachments, p_attachment );