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
;
108 /* Have a peep at the show. */
109 if( stream_Peek( p_demux
->s
, &p_peek
, 4 ) < 4 ) return VLC_EGENERIC
;
111 if( p_peek
[0]!='f' || p_peek
[1]!='L' || p_peek
[2]!='a' || p_peek
[3]!='C' )
113 if( !p_demux
->b_force
) return VLC_EGENERIC
;
116 msg_Err( p_demux
, "this doesn't look like a flac stream, "
117 "continuing anyway" );
120 p_demux
->pf_demux
= Demux
;
121 p_demux
->pf_control
= Control
;
122 p_demux
->p_sys
= p_sys
= malloc( sizeof( demux_sys_t
) );
123 p_sys
->b_start
= true;
124 p_sys
->p_meta
= NULL
;
125 memset( &p_sys
->replay_gain
, 0, sizeof(p_sys
->replay_gain
) );
127 p_sys
->i_time_offset
= 0;
129 p_sys
->i_pts_start
= 0;
131 TAB_INIT( p_sys
->i_seekpoint
, p_sys
->seekpoint
);
132 TAB_INIT( p_sys
->i_attachments
, p_sys
->attachments
);
133 p_sys
->i_cover_idx
= 0;
134 p_sys
->i_cover_score
= 0;
136 /* We need to read and store the STREAMINFO metadata */
137 if( ReadMeta( p_demux
, &p_streaminfo
, &i_streaminfo
) )
143 /* Load the FLAC packetizer */
144 /* Store STREAMINFO for the decoder and packetizer */
145 p_streaminfo
[4] |= 0x80; /* Fake this as the last metadata block */
146 es_format_Init( &fmt
, AUDIO_ES
, VLC_FOURCC( 'f', 'l', 'a', 'c' ) );
147 fmt
.i_extra
= i_streaminfo
;
148 fmt
.p_extra
= p_streaminfo
;
150 p_sys
->p_packetizer
= demux_PacketizerNew( p_demux
, &fmt
, "flac" );
151 if( !p_sys
->p_packetizer
)
157 if( p_sys
->i_cover_idx
< p_sys
->i_attachments
)
161 p_sys
->p_meta
= vlc_meta_New();
162 snprintf( psz_url
, sizeof(psz_url
), "attachment://%s",
163 p_sys
->attachments
[p_sys
->i_cover_idx
]->psz_name
);
164 vlc_meta_Set( p_sys
->p_meta
, vlc_meta_ArtworkURL
, psz_url
);
166 vlc_audio_replay_gain_MergeFromMeta( &p_sys
->replay_gain
, p_sys
->p_meta
);
170 /*****************************************************************************
171 * Close: frees unused data
172 *****************************************************************************/
173 static void Close( vlc_object_t
* p_this
)
175 demux_t
*p_demux
= (demux_t
*)p_this
;
176 demux_sys_t
*p_sys
= p_demux
->p_sys
;
178 TAB_CLEAN( p_sys
->i_seekpoint
, p_sys
->seekpoint
);
181 for( i
= 0; i
< p_sys
->i_attachments
; i
++ )
182 free( p_sys
->attachments
[i
] );
183 TAB_CLEAN( p_sys
->i_attachments
, p_sys
->attachments
);
185 /* Delete the decoder */
186 demux_PacketizerDestroy( p_sys
->p_packetizer
);
189 vlc_meta_Delete( p_sys
->p_meta
);
193 /*****************************************************************************
194 * Demux: reads and demuxes data packets
195 *****************************************************************************
196 * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
197 *****************************************************************************/
198 static int Demux( demux_t
*p_demux
)
200 demux_sys_t
*p_sys
= p_demux
->p_sys
;
201 block_t
*p_block_in
, *p_block_out
;
203 if( !( p_block_in
= stream_Block( p_demux
->s
, FLAC_PACKET_SIZE
) ) )
206 p_block_in
->i_pts
= p_block_in
->i_dts
= p_sys
->b_start
? 1 : 0;
207 p_sys
->b_start
= false;
209 while( (p_block_out
= p_sys
->p_packetizer
->pf_packetize(
210 p_sys
->p_packetizer
, &p_block_in
)) )
214 block_t
*p_next
= p_block_out
->p_next
;
216 p_block_out
->p_next
= NULL
;
218 if( p_sys
->p_es
== NULL
)
220 p_sys
->p_packetizer
->fmt_out
.b_packetized
= true;
221 p_sys
->p_packetizer
->fmt_out
.audio_replay_gain
= p_sys
->replay_gain
;
222 p_sys
->p_es
= es_out_Add( p_demux
->out
, &p_sys
->p_packetizer
->fmt_out
);
225 p_sys
->i_pts
= p_block_out
->i_dts
;
227 /* Correct timestamp */
228 p_block_out
->i_pts
+= p_sys
->i_time_offset
;
229 p_block_out
->i_dts
+= p_sys
->i_time_offset
;
232 es_out_Control( p_demux
->out
, ES_OUT_SET_PCR
, p_block_out
->i_dts
);
234 es_out_Send( p_demux
->out
, p_sys
->p_es
, p_block_out
);
236 p_block_out
= p_next
;
242 /*****************************************************************************
244 *****************************************************************************/
245 static int64_t ControlGetLength( demux_t
*p_demux
)
247 demux_sys_t
*p_sys
= p_demux
->p_sys
;
248 const int64_t i_size
= stream_Size(p_demux
->s
) - p_sys
->i_data_pos
;
249 int64_t i_length
= p_sys
->i_length
;
252 /* Try to fix length using seekpoint and current size for truncated file */
253 for( i
= p_sys
->i_seekpoint
-1; i
>= 0; i
-- )
255 seekpoint_t
*s
= p_sys
->seekpoint
[i
];
256 if( s
->i_byte_offset
<= i_size
)
258 if( i
+1 < p_sys
->i_seekpoint
)
261 seekpoint_t
*n
= p_sys
->seekpoint
[i
+1];
262 assert( n
->i_byte_offset
!= s
->i_byte_offset
); /* Should be ensured by ParseSeekTable */
263 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
);
271 static int64_t ControlGetTime( demux_t
*p_demux
)
273 demux_sys_t
*p_sys
= p_demux
->p_sys
;
274 return __MAX(p_sys
->i_pts
, p_sys
->i_pts_start
) + p_sys
->i_time_offset
;
277 static int ControlSetTime( demux_t
*p_demux
, int64_t i_time
)
279 demux_sys_t
*p_sys
= p_demux
->p_sys
;
280 int64_t i_delta_time
;
285 stream_Control( p_demux
->s
, STREAM_CAN_SEEK
, &b_seekable
);
290 assert( p_sys
->i_seekpoint
> 0 ); /* ReadMeta ensure at least (0,0) */
291 for( i
= p_sys
->i_seekpoint
-1; i
>= 0; i
-- )
293 if( p_sys
->seekpoint
[i
]->i_time_offset
<= i_time
)
296 i_delta_time
= i_time
- p_sys
->seekpoint
[i
]->i_time_offset
;
298 /* XXX We do exact seek if it's not too far away(45s) */
299 if( i_delta_time
< 45*INT64_C(1000000) )
301 if( stream_Seek( p_demux
->s
, p_sys
->seekpoint
[i
]->i_byte_offset
+p_sys
->i_data_pos
) )
304 p_sys
->i_time_offset
= p_sys
->seekpoint
[i
]->i_time_offset
- p_sys
->i_pts
;
305 p_sys
->i_pts_start
= p_sys
->i_pts
+i_delta_time
;
306 es_out_Control( p_demux
->out
, ES_OUT_SET_NEXT_DISPLAY_TIME
, p_sys
->i_pts_start
+ p_sys
->i_time_offset
);
310 int64_t i_delta_offset
;
312 int64_t i_next_offset
;
314 if( i
+1 < p_sys
->i_seekpoint
)
316 i_next_time
= p_sys
->seekpoint
[i
+1]->i_time_offset
;
317 i_next_offset
= p_sys
->seekpoint
[i
+1]->i_byte_offset
;
321 i_next_time
= p_sys
->i_length
;
322 i_next_offset
= stream_Size(p_demux
->s
)-p_sys
->i_data_pos
;
326 if( i_next_time
-p_sys
->seekpoint
[i
]->i_time_offset
> 0 )
327 i_delta_offset
= (i_next_offset
- p_sys
->seekpoint
[i
]->i_byte_offset
) * i_delta_time
/
328 (i_next_time
-p_sys
->seekpoint
[i
]->i_time_offset
);
330 if( stream_Seek( p_demux
->s
, p_sys
->seekpoint
[i
]->i_byte_offset
+p_sys
->i_data_pos
+ i_delta_offset
) )
333 p_sys
->i_pts_start
= p_sys
->i_pts
;
334 p_sys
->i_time_offset
= (p_sys
->seekpoint
[i
]->i_time_offset
+i_delta_time
) - p_sys
->i_pts
;
339 static int Control( demux_t
*p_demux
, int i_query
, va_list args
)
341 demux_sys_t
*p_sys
= p_demux
->p_sys
;
343 if( i_query
== DEMUX_GET_META
)
345 vlc_meta_t
*p_meta
= (vlc_meta_t
*)va_arg( args
, vlc_meta_t
* );
346 if( p_demux
->p_sys
->p_meta
)
347 vlc_meta_Merge( p_meta
, p_demux
->p_sys
->p_meta
);
350 else if( i_query
== DEMUX_HAS_UNSUPPORTED_META
)
352 bool *pb_bool
= (bool*)va_arg( args
, bool* );
356 else if( i_query
== DEMUX_GET_LENGTH
)
358 int64_t *pi64
= (int64_t*)va_arg( args
, int64_t * );
359 *pi64
= ControlGetLength( p_demux
);
362 else if( i_query
== DEMUX_SET_TIME
)
364 int64_t i_time
= (int64_t)va_arg( args
, int64_t );
365 return ControlSetTime( p_demux
, i_time
);
367 else if( i_query
== DEMUX_SET_POSITION
)
369 const double f
= (double)va_arg( args
, double );
370 int64_t i_time
= f
* ControlGetLength( p_demux
);
371 return ControlSetTime( p_demux
, i_time
);
373 else if( i_query
== DEMUX_GET_TIME
)
375 int64_t *pi64
= (int64_t*)va_arg( args
, int64_t * );
376 *pi64
= ControlGetTime( p_demux
);
379 else if( i_query
== DEMUX_GET_POSITION
)
381 double *pf
= (double*)va_arg( args
, double * );
382 const int64_t i_length
= ControlGetLength(p_demux
);
384 *pf
= (double)ControlGetTime(p_demux
) / (double)i_length
;
389 else if( i_query
== DEMUX_GET_ATTACHMENTS
)
391 input_attachment_t
***ppp_attach
=
392 (input_attachment_t
***)va_arg( args
, input_attachment_t
*** );
393 int *pi_int
= (int*)va_arg( args
, int * );
396 if( p_sys
->i_attachments
<= 0 )
399 *pi_int
= p_sys
->i_attachments
;;
400 *ppp_attach
= malloc( sizeof(input_attachment_t
**) * p_sys
->i_attachments
);
401 for( i
= 0; i
< p_sys
->i_attachments
; i
++ )
402 (*ppp_attach
)[i
] = vlc_input_attachment_Duplicate( p_sys
->attachments
[i
] );
406 return demux_vaControlHelper( p_demux
->s
, p_sys
->i_data_pos
, -1,
407 8*0, 1, i_query
, args
);
418 static inline int Get24bBE( const uint8_t *p
)
420 return (p
[0] << 16)|(p
[1] << 8)|(p
[2]);
423 static void ParseStreamInfo( int *pi_rate
, int64_t *pi_count
, uint8_t *p_data
);
424 static void ParseSeekTable( demux_t
*p_demux
, const uint8_t *p_data
, int i_data
,
426 static void ParseComment( demux_t
*, const uint8_t *p_data
, int i_data
);
427 static void ParsePicture( demux_t
*, const uint8_t *p_data
, int i_data
);
429 static int ReadMeta( demux_t
*p_demux
, uint8_t **pp_streaminfo
, int *pi_streaminfo
)
431 demux_sys_t
*p_sys
= p_demux
->p_sys
;
433 const uint8_t *p_peek
;
436 int64_t i_sample_count
;
439 /* Read STREAMINFO */
440 i_peek
= stream_Peek( p_demux
->s
, &p_peek
, 8 );
441 if( (p_peek
[4] & 0x7F) != META_STREAMINFO
)
443 msg_Err( p_demux
, "this isn't a STREAMINFO metadata block" );
446 if( Get24bBE(&p_peek
[5]) != (STREAMINFO_SIZE
- 4) )
448 msg_Err( p_demux
, "invalid size for a STREAMINFO metadata block" );
452 *pi_streaminfo
= 4 + STREAMINFO_SIZE
;
453 *pp_streaminfo
= malloc( 4 + STREAMINFO_SIZE
);
454 if( *pp_streaminfo
== NULL
)
457 if( stream_Read( p_demux
->s
, *pp_streaminfo
, 4+STREAMINFO_SIZE
) != 4+STREAMINFO_SIZE
)
459 msg_Err( p_demux
, "failed to read STREAMINFO metadata block" );
460 free( *pp_streaminfo
);
465 ParseStreamInfo( &i_sample_rate
, &i_sample_count
, *pp_streaminfo
);
466 if( i_sample_rate
> 0 )
467 p_sys
->i_length
= i_sample_count
* INT64_C(1000000)/i_sample_rate
;
469 /* Be sure we have seekpoint 0 */
470 s
= vlc_seekpoint_New();
471 s
->i_time_offset
= 0;
472 s
->i_byte_offset
= 0;
473 TAB_APPEND( p_sys
->i_seekpoint
, p_sys
->seekpoint
, s
);
475 b_last
= (*pp_streaminfo
)[4]&0x80;
481 i_peek
= stream_Peek( p_demux
->s
, &p_peek
, 4 );
484 b_last
= p_peek
[0]&0x80;
485 i_type
= p_peek
[0]&0x7f;
486 i_len
= Get24bBE( &p_peek
[1] );
488 if( i_type
== META_SEEKTABLE
)
490 i_peek
= stream_Peek( p_demux
->s
, &p_peek
, 4+i_len
);
491 if( i_peek
== 4+i_len
)
492 ParseSeekTable( p_demux
, p_peek
, i_peek
, i_sample_rate
);
494 else if( i_type
== META_COMMENT
)
496 i_peek
= stream_Peek( p_demux
->s
, &p_peek
, 4+i_len
);
497 if( i_peek
== 4+i_len
)
498 ParseComment( p_demux
, p_peek
, i_peek
);
500 else if( i_type
== META_PICTURE
)
502 i_peek
= stream_Peek( p_demux
->s
, &p_peek
, 4+i_len
);
503 if( i_peek
== 4+i_len
)
504 ParsePicture( p_demux
, p_peek
, i_peek
);
507 if( stream_Read( p_demux
->s
, NULL
, 4+i_len
) < 4+i_len
)
512 p_sys
->i_data_pos
= stream_Tell( p_demux
->s
);
516 static void ParseStreamInfo( int *pi_rate
, int64_t *pi_count
, uint8_t *p_data
)
518 const int i_skip
= 4+4;
520 *pi_rate
= GetDWBE(&p_data
[i_skip
+4+6]) >> 12;
521 *pi_count
= GetQWBE(&p_data
[i_skip
+4+6]) & ((INT64_C(1)<<36)-1);
524 static void ParseSeekTable( demux_t
*p_demux
, const uint8_t *p_data
, int i_data
,
527 demux_sys_t
*p_sys
= p_demux
->p_sys
;
531 if( i_sample_rate
<= 0 )
535 for( i
= 0; i
< (i_data
-4)/18; i
++ )
537 const int64_t i_sample
= GetQWBE( &p_data
[4+18*i
+0] );
540 if( i_sample
< 0 || i_sample
>= INT64_MAX
)
543 s
= vlc_seekpoint_New();
544 s
->i_time_offset
= i_sample
* INT64_C(1000000)/i_sample_rate
;
545 s
->i_byte_offset
= GetQWBE( &p_data
[4+18*i
+8] );
547 /* Check for duplicate entry */
548 for( j
= 0; j
< p_sys
->i_seekpoint
; j
++ )
550 if( p_sys
->seekpoint
[j
]->i_time_offset
== s
->i_time_offset
||
551 p_sys
->seekpoint
[j
]->i_byte_offset
== s
->i_byte_offset
)
553 vlc_seekpoint_Delete( s
);
560 TAB_APPEND( p_sys
->i_seekpoint
, p_sys
->seekpoint
, s
);
563 /* TODO sort it by size and remove wrong seek entry (time not increasing) */
566 #define RM(x) do { i_data -= (x); p_data += (x); } while(0)
567 static void ParseComment( demux_t
*p_demux
, const uint8_t *p_data
, int i_data
)
569 demux_sys_t
*p_sys
= p_demux
->p_sys
;
578 n
= GetDWLE(p_data
); RM(4);
579 if( n
< 0 || n
> i_data
)
584 /* TODO report vendor string ? */
585 char *psz_vendor
= psz_vendor
= strndup( p_data
, n
);
586 msg_Dbg( p_demux
, "FLAC: COMMENT vendor length=%d vendor=%s\n", n
, psz_vendor
);
595 i_comment
= GetDWLE(p_data
); RM(4);
599 p_sys
->p_meta
= vlc_meta_New();
601 for( ; i_comment
> 0; i_comment
-- )
606 n
= GetDWLE(p_data
); RM(4);
612 psz
= strndup( (const char*)p_data
, n
);
617 #define IF_EXTRACT(txt,var) \
618 if( !strncasecmp(psz, txt, strlen(txt)) ) \
620 const char *oldval = vlc_meta_Get( p_sys->p_meta, vlc_meta_ ## var ); \
624 if( asprintf( &newval, "%s,%s", oldval, &psz[strlen(txt)] ) == -1 ) \
626 vlc_meta_Set( p_sys->p_meta, vlc_meta_ ## var, newval ); \
630 vlc_meta_Set( p_sys->p_meta, vlc_meta_ ## var, &psz[strlen(txt)] ); \
632 IF_EXTRACT("TITLE=", Title
)
633 else IF_EXTRACT("ALBUM=", Album
)
634 else IF_EXTRACT("TRACKNUMBER=", TrackNumber
)
635 else IF_EXTRACT("ARTIST=", Artist
)
636 else IF_EXTRACT("COPYRIGHT=", Copyright
)
637 else IF_EXTRACT("DESCRIPTION=", Description
)
638 else IF_EXTRACT("GENRE=", Genre
)
639 else IF_EXTRACT("DATE=", Date
)
640 else if( strchr( psz
, '=' ) )
642 /* generic (PERFORMER/LICENSE/ORGANIZATION/LOCATION/CONTACT/ISRC,
643 * undocumented tags and replay gain ) */
644 char *p
= strchr( psz
, '=' );
646 vlc_meta_AddExtra( p_sys
->p_meta
, psz
, p
);
654 static void ParsePicture( demux_t
*p_demux
, const uint8_t *p_data
, int i_data
)
656 static const int pi_cover_score
[] = {
659 10, /* front cover */
661 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
662 6, /* movie/video screen capture */
664 7, /* Illustration */
665 8, /* Band/Artist logotype */
666 0, /* Publisher/Studio */
668 demux_sys_t
*p_sys
= p_demux
->p_sys
;
671 char *psz_mime
= NULL
;
672 char *psz_description
= NULL
;
673 input_attachment_t
*p_attachment
;
676 if( i_data
< 4 + 3*4 )
678 #define RM(x) do { i_data -= (x); p_data += (x); } while(0)
681 i_type
= GetDWBE( p_data
); RM(4);
682 i_len
= GetDWBE( p_data
); RM(4);
683 if( i_len
< 0 || i_data
< i_len
+ 4 )
685 psz_mime
= strndup( (const char*)p_data
, i_len
); RM(i_len
);
686 i_len
= GetDWBE( p_data
); RM(4);
687 if( i_len
< 0 || i_data
< i_len
+ 4*4 + 4)
689 psz_description
= strndup( (const char*)p_data
, i_len
); RM(i_len
);
690 EnsureUTF8( psz_description
);
692 i_len
= GetDWBE( p_data
); RM(4);
693 if( i_len
< 0 || i_len
> i_data
)
696 msg_Dbg( p_demux
, "FLAC: Picture type=%d mime=%s description='%s' file length=%d",
697 i_type
, psz_mime
, psz_description
, i_len
);
699 snprintf( psz_name
, sizeof(psz_name
), "picture%d", p_sys
->i_attachments
);
700 if( !strcasecmp( psz_mime
, "image/jpeg" ) )
701 strcat( psz_name
, ".jpg" );
702 else if( !strcasecmp( psz_mime
, "image/png" ) )
703 strcat( psz_name
, ".png" );
705 p_attachment
= vlc_input_attachment_New( psz_name
, psz_mime
, psz_description
,
707 TAB_APPEND( p_sys
->i_attachments
, p_sys
->attachments
, p_attachment
);
709 if( i_type
>= 0 && (unsigned int)i_type
< sizeof(pi_cover_score
)/sizeof(pi_cover_score
[0]) &&
710 p_sys
->i_cover_score
< pi_cover_score
[i_type
] )
712 p_sys
->i_cover_idx
= p_sys
->i_attachments
-1;
713 p_sys
->i_cover_score
= pi_cover_score
[i_type
];
717 free( psz_description
);