git.sesse.net Git - vlc/blob - modules/demux/flac.c

   1 /*****************************************************************************
   2  * flac.c : FLAC demux module for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2001-2008 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Gildas Bazin <gbazin@netcourrier.com>
   8  *          Laurent Aimar <fenrir@via.ecp.fr>
   9  *
  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.
  14  *
  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.
  19  *
  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  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  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 */
  39
  40 #include <assert.h>
  41 #include "vorbis.h"                   /* vorbis comments */
  42
  43 /*****************************************************************************
  44  * Module descriptor
  45  *****************************************************************************/
  46 static int  Open  ( vlc_object_t * );
  47 static void Close ( vlc_object_t * );
  48
  49 vlc_module_begin ()
  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" )
  56 vlc_module_end ()
  57
  58 /*****************************************************************************
  59  * Local prototypes
  60  *****************************************************************************/
  61 static int Demux  ( demux_t * );
  62 static int Control( demux_t *, int, va_list );
  63
  64 static int  ReadMeta( demux_t *, uint8_t **pp_streaminfo, int *pi_streaminfo );
  65
  66 struct demux_sys_t
  67 {
  68     bool  b_start;
  69     es_out_id_t *p_es;
  70
  71     /* Packetizer */
  72     decoder_t *p_packetizer;
  73
  74     vlc_meta_t *p_meta;
  75
  76     int64_t i_time_offset;
  77     int64_t i_pts;
  78     int64_t i_pts_start;
  79
  80     int64_t i_length; /* Length from stream info */
  81     int64_t i_data_pos;
  82
  83     /* */
  84     int         i_seekpoint;
  85     seekpoint_t **seekpoint;
  86
  87     /* */
  88     int                i_attachments;
  89     input_attachment_t **attachments;
  90     int                i_cover_idx;
  91     int                i_cover_score;
  92 };
  93
  94 #define STREAMINFO_SIZE 38
  95 #define FLAC_PACKET_SIZE 16384
  96
  97 /*****************************************************************************
  98  * Open: initializes ES structures
  99  *****************************************************************************/
 100 static int Open( vlc_object_t * p_this )
 101 {
 102     demux_t     *p_demux = (demux_t*)p_this;
 103     demux_sys_t *p_sys;
 104     const uint8_t *p_peek;
 105     uint8_t     *p_streaminfo;
 106     int         i_streaminfo;
 107     es_format_t fmt;
 108
 109     /* Have a peep at the show. */
 110     if( stream_Peek( p_demux->s, &p_peek, 4 ) < 4 ) return VLC_EGENERIC;
 111
 112     if( p_peek[0]!='f' || p_peek[1]!='L' || p_peek[2]!='a' || p_peek[3]!='C' )
 113     {
 114         if( !p_demux->b_force ) return VLC_EGENERIC;
 115
 116         /* User forced */
 117         msg_Err( p_demux, "this doesn't look like a flac stream, "
 118                  "continuing anyway" );
 119     }
 120
 121     p_sys = malloc( sizeof( demux_sys_t ) );
 122     if( unlikely(p_sys == NULL) )
 123         return VLC_ENOMEM;
 124
 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;
 130     p_sys->i_length = 0;
 131     p_sys->i_time_offset = 0;
 132     p_sys->i_pts = 0;
 133     p_sys->i_pts_start = 0;
 134     p_sys->p_es = NULL;
 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;
 139
 140     /* We need to read and store the STREAMINFO metadata */
 141     if( ReadMeta( p_demux, &p_streaminfo, &i_streaminfo ) )
 142     {
 143         free( p_sys );
 144         return VLC_EGENERIC;
 145     }
 146
 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;
 153
 154     p_sys->p_packetizer = demux_PacketizerNew( p_demux, &fmt, "flac" );
 155     if( !p_sys->p_packetizer )
 156     {
 157         free( p_sys );
 158         return VLC_EGENERIC;
 159     }
 160
 161     if( p_sys->i_cover_idx < p_sys->i_attachments )
 162     {
 163         char psz_url[128];
 164         if( !p_sys->p_meta )
 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 );
 169     }
 170     return VLC_SUCCESS;
 171 }
 172
 173 /*****************************************************************************
 174  * Close: frees unused data
 175  *****************************************************************************/
 176 static void Close( vlc_object_t * p_this )
 177 {
 178     demux_t     *p_demux = (demux_t*)p_this;
 179     demux_sys_t *p_sys = p_demux->p_sys;
 180
 181     TAB_CLEAN( p_sys->i_seekpoint, p_sys->seekpoint );
 182
 183     int i;
 184     for( i = 0; i < p_sys->i_attachments; i++ )
 185         free( p_sys->attachments[i] );
 186     TAB_CLEAN( p_sys->i_attachments, p_sys->attachments);
 187
 188     /* Delete the decoder */
 189     demux_PacketizerDestroy( p_sys->p_packetizer );
 190
 191     if( p_sys->p_meta )
 192         vlc_meta_Delete( p_sys->p_meta );
 193     free( p_sys );
 194 }
 195
 196 /*****************************************************************************
 197  * Demux: reads and demuxes data packets
 198  *****************************************************************************
 199  * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
 200  *****************************************************************************/
 201 static int Demux( demux_t *p_demux )
 202 {
 203     demux_sys_t *p_sys = p_demux->p_sys;
 204     block_t     *p_block_in, *p_block_out;
 205
 206     if( !( p_block_in = stream_Block( p_demux->s, FLAC_PACKET_SIZE ) ) )
 207         return 0;
 208
 209     p_block_in->i_pts = p_block_in->i_dts = p_sys->b_start ? VLC_TS_0 : VLC_TS_INVALID;
 210     p_sys->b_start = false;
 211
 212     while( (p_block_out = p_sys->p_packetizer->pf_packetize(
 213                 p_sys->p_packetizer, &p_block_in )) )
 214     {
 215         while( p_block_out )
 216         {
 217             block_t *p_next = p_block_out->p_next;
 218
 219             p_block_out->p_next = NULL;
 220
 221             if( p_sys->p_es == NULL )
 222             {
 223                 p_sys->p_packetizer->fmt_out.b_packetized = true;
 224                 p_sys->p_es = es_out_Add( p_demux->out, &p_sys->p_packetizer->fmt_out);
 225             }
 226
 227             p_sys->i_pts = p_block_out->i_dts - VLC_TS_0;
 228
 229             /* Correct timestamp */
 230             p_block_out->i_pts += p_sys->i_time_offset;
 231             p_block_out->i_dts += p_sys->i_time_offset;
 232
 233             /* set PCR */
 234             es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block_out->i_dts );
 235
 236             es_out_Send( p_demux->out, p_sys->p_es, p_block_out );
 237
 238             p_block_out = p_next;
 239         }
 240     }
 241     return 1;
 242 }
 243
 244 /*****************************************************************************
 245  * Control:
 246  *****************************************************************************/
 247 static int64_t ControlGetLength( demux_t *p_demux )
 248 {
 249     demux_sys_t *p_sys = p_demux->p_sys;
 250     const int64_t i_size = stream_Size(p_demux->s) - p_sys->i_data_pos;
 251     int64_t i_length = p_sys->i_length;
 252     int i;
 253
 254     /* Try to fix length using seekpoint and current size for truncated file */
 255     for( i = p_sys->i_seekpoint-1; i >= 0; i-- )
 256     {
 257         seekpoint_t *s = p_sys->seekpoint[i];
 258         if( s->i_byte_offset <= i_size )
 259         {
 260             if( i+1 < p_sys->i_seekpoint )
 261             {
 262                 /* Broken file */
 263                 seekpoint_t *n = p_sys->seekpoint[i+1];
 264                 assert( n->i_byte_offset != s->i_byte_offset); /* Should be ensured by ParseSeekTable */
 265                 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);
 266             }
 267             break;
 268         }
 269     }
 270     return i_length;
 271 }
 272
 273 static int64_t ControlGetTime( demux_t *p_demux )
 274 {
 275     demux_sys_t *p_sys = p_demux->p_sys;
 276     return __MAX(p_sys->i_pts, p_sys->i_pts_start) + p_sys->i_time_offset;
 277 }
 278
 279 static int ControlSetTime( demux_t *p_demux, int64_t i_time )
 280 {
 281     demux_sys_t *p_sys = p_demux->p_sys;
 282     int64_t i_delta_time;
 283     bool b_seekable;
 284     int i;
 285
 286     /* */
 287     stream_Control( p_demux->s, STREAM_CAN_SEEK, &b_seekable );
 288     if( !b_seekable )
 289         return VLC_EGENERIC;
 290
 291     /* */
 292     assert( p_sys->i_seekpoint > 0 );   /* ReadMeta ensure at least (0,0) */
 293     for( i = p_sys->i_seekpoint-1; i >= 0; i-- )
 294     {
 295         if( p_sys->seekpoint[i]->i_time_offset <= i_time )
 296             break;
 297     }
 298     i_delta_time = i_time - p_sys->seekpoint[i]->i_time_offset;
 299
 300     /* XXX We do exact seek if it's not too far away(45s) */
 301     if( i_delta_time < 45*INT64_C(1000000) )
 302     {
 303         if( stream_Seek( p_demux->s, p_sys->seekpoint[i]->i_byte_offset+p_sys->i_data_pos ) )
 304             return VLC_EGENERIC;
 305
 306         p_sys->i_time_offset = p_sys->seekpoint[i]->i_time_offset - p_sys->i_pts;
 307         p_sys->i_pts_start = p_sys->i_pts+i_delta_time;
 308         es_out_Control( p_demux->out, ES_OUT_SET_NEXT_DISPLAY_TIME, p_sys->i_pts_start + p_sys->i_time_offset );
 309     }
 310     else
 311     {
 312         int64_t i_delta_offset;
 313         int64_t i_next_time;
 314         int64_t i_next_offset;
 315
 316         if( i+1 < p_sys->i_seekpoint )
 317         {
 318             i_next_time   = p_sys->seekpoint[i+1]->i_time_offset;
 319             i_next_offset = p_sys->seekpoint[i+1]->i_byte_offset;
 320         }
 321         else
 322         {
 323             i_next_time   = p_sys->i_length;
 324             i_next_offset = stream_Size(p_demux->s)-p_sys->i_data_pos;
 325         }
 326
 327         i_delta_offset = 0;
 328         if( i_next_time-p_sys->seekpoint[i]->i_time_offset > 0 )
 329             i_delta_offset = (i_next_offset - p_sys->seekpoint[i]->i_byte_offset) * i_delta_time /
 330                              (i_next_time-p_sys->seekpoint[i]->i_time_offset);
 331
 332         if( stream_Seek( p_demux->s, p_sys->seekpoint[i]->i_byte_offset+p_sys->i_data_pos + i_delta_offset ) )
 333             return VLC_EGENERIC;
 334
 335         p_sys->i_pts_start = p_sys->i_pts;
 336         p_sys->i_time_offset = (p_sys->seekpoint[i]->i_time_offset+i_delta_time) - p_sys->i_pts;
 337     }
 338     return VLC_SUCCESS;
 339 }
 340
 341 static int Control( demux_t *p_demux, int i_query, va_list args )
 342 {
 343     demux_sys_t *p_sys = p_demux->p_sys;
 344
 345     if( i_query == DEMUX_GET_META )
 346     {
 347         vlc_meta_t *p_meta = (vlc_meta_t *)va_arg( args, vlc_meta_t* );
 348         if( p_demux->p_sys->p_meta )
 349             vlc_meta_Merge( p_meta, p_demux->p_sys->p_meta );
 350         return VLC_SUCCESS;
 351     }
 352     else if( i_query == DEMUX_HAS_UNSUPPORTED_META )
 353     {
 354         bool *pb_bool = (bool*)va_arg( args, bool* );
 355         *pb_bool = true;
 356         return VLC_SUCCESS;
 357     }
 358     else if( i_query == DEMUX_GET_LENGTH )
 359     {
 360         int64_t *pi64 = (int64_t*)va_arg( args, int64_t * );
 361         *pi64 = ControlGetLength( p_demux );
 362         return VLC_SUCCESS;
 363     }
 364     else if( i_query == DEMUX_SET_TIME )
 365     {
 366         int64_t i_time = (int64_t)va_arg( args, int64_t );
 367         return ControlSetTime( p_demux, i_time );
 368     }
 369     else if( i_query == DEMUX_SET_POSITION )
 370     {
 371         const double f = (double)va_arg( args, double );
 372         int64_t i_time = f * ControlGetLength( p_demux );
 373         return ControlSetTime( p_demux, i_time );
 374     }
 375     else if( i_query == DEMUX_GET_TIME )
 376     {
 377         int64_t *pi64 = (int64_t*)va_arg( args, int64_t * );
 378         *pi64 = ControlGetTime( p_demux );
 379         return VLC_SUCCESS;
 380     }
 381     else if( i_query == DEMUX_GET_POSITION )
 382     {
 383         double *pf = (double*)va_arg( args, double * );
 384         const int64_t i_length = ControlGetLength(p_demux);
 385         if( i_length > 0 )
 386         {
 387             double current = ControlGetTime(p_demux);
 388             *pf = current / (double)i_length;
 389         }
 390         else
 391             *pf= 0.0;
 392         return VLC_SUCCESS;
 393     }
 394     else if( i_query == DEMUX_GET_ATTACHMENTS )
 395     {
 396         input_attachment_t ***ppp_attach =
 397             (input_attachment_t***)va_arg( args, input_attachment_t*** );
 398         int *pi_int = (int*)va_arg( args, int * );
 399
 400         if( p_sys->i_attachments <= 0 )
 401             return VLC_EGENERIC;
 402
 403         *pi_int = p_sys->i_attachments;
 404         *ppp_attach = xmalloc( sizeof(input_attachment_t**) * p_sys->i_attachments );
 405         for( int i = 0; i < p_sys->i_attachments; i++ )
 406             (*ppp_attach)[i] = vlc_input_attachment_Duplicate( p_sys->attachments[i] );
 407         return VLC_SUCCESS;
 408     }
 409
 410     return demux_vaControlHelper( p_demux->s, p_sys->i_data_pos, -1,
 411                                    8*0, 1, i_query, args );
 412 }
 413
 414 enum
 415 {
 416     META_STREAMINFO = 0,
 417     META_SEEKTABLE = 3,
 418     META_COMMENT = 4,
 419     META_PICTURE = 6,
 420 };
 421
 422 static inline int Get24bBE( const uint8_t *p )
 423 {
 424     return (p[0] << 16)|(p[1] << 8)|(p[2]);
 425 }
 426
 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,
 429                             int i_sample_rate );
 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 );
 432
 433 static int  ReadMeta( demux_t *p_demux, uint8_t **pp_streaminfo, int *pi_streaminfo )
 434 {
 435     demux_sys_t *p_sys = p_demux->p_sys;
 436     int     i_peek;
 437     const uint8_t *p_peek;
 438     bool b_last;
 439     int i_sample_rate;
 440     int64_t i_sample_count;
 441     seekpoint_t *s;
 442
 443     /* Read STREAMINFO */
 444     i_peek = stream_Peek( p_demux->s, &p_peek, 8 );
 445     if( (p_peek[4] & 0x7F) != META_STREAMINFO )
 446     {
 447         msg_Err( p_demux, "this isn't a STREAMINFO metadata block" );
 448         return VLC_EGENERIC;
 449     }
 450     if( Get24bBE(&p_peek[5]) != (STREAMINFO_SIZE - 4) )
 451     {
 452         msg_Err( p_demux, "invalid size for a STREAMINFO metadata block" );
 453         return VLC_EGENERIC;
 454     }
 455
 456     *pi_streaminfo = 4 + STREAMINFO_SIZE;
 457     *pp_streaminfo = malloc( 4 + STREAMINFO_SIZE );
 458     if( *pp_streaminfo == NULL )
 459         return VLC_EGENERIC;
 460
 461     if( stream_Read( p_demux->s, *pp_streaminfo, 4+STREAMINFO_SIZE ) != 4+STREAMINFO_SIZE )
 462     {
 463         msg_Err( p_demux, "failed to read STREAMINFO metadata block" );
 464         free( *pp_streaminfo );
 465         return VLC_EGENERIC;
 466     }
 467
 468     /* */
 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;
 472
 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 );
 478
 479     b_last = (*pp_streaminfo)[4]&0x80;
 480     while( !b_last )
 481     {
 482         int i_len;
 483         int i_type;
 484
 485         i_peek = stream_Peek( p_demux->s, &p_peek, 4 );
 486         if( i_peek < 4 )
 487             break;
 488         b_last = p_peek[0]&0x80;
 489         i_type = p_peek[0]&0x7f;
 490         i_len  = Get24bBE( &p_peek[1] );
 491
 492         if( i_type == META_SEEKTABLE )
 493         {
 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 );
 497         }
 498         else if( i_type == META_COMMENT )
 499         {
 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 );
 503         }
 504         else if( i_type == META_PICTURE )
 505         {
 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 );
 509         }
 510
 511         if( stream_Read( p_demux->s, NULL, 4+i_len ) < 4+i_len )
 512             break;
 513     }
 514
 515     /* */
 516     p_sys->i_data_pos = stream_Tell( p_demux->s );
 517
 518     return VLC_SUCCESS;
 519 }
 520 static void ParseStreamInfo( int *pi_rate, int64_t *pi_count, uint8_t *p_data )
 521 {
 522     const int i_skip = 4+4;
 523
 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);
 526 }
 527
 528 static void ParseSeekTable( demux_t *p_demux, const uint8_t *p_data, int i_data,
 529                             int i_sample_rate )
 530 {
 531     demux_sys_t *p_sys = p_demux->p_sys;
 532     seekpoint_t *s;
 533     int i;
 534
 535     if( i_sample_rate <= 0 )
 536         return;
 537
 538     /* */
 539     for( i = 0; i < (i_data-4)/18; i++ )
 540     {
 541         const int64_t i_sample = GetQWBE( &p_data[4+18*i+0] );
 542         int j;
 543
 544         if( i_sample < 0 || i_sample >= INT64_MAX )
 545             continue;
 546
 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] );
 550
 551         /* Check for duplicate entry */
 552         for( j = 0; j < p_sys->i_seekpoint; j++ )
 553         {
 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 )
 556             {
 557                 vlc_seekpoint_Delete( s );
 558                 s = NULL;
 559                 break;
 560             }
 561         }
 562         if( s )
 563         {
 564             TAB_APPEND( p_sys->i_seekpoint, p_sys->seekpoint, s );
 565         }
 566     }
 567     /* TODO sort it by size and remove wrong seek entry (time not increasing) */
 568 }
 569
 570 static void ParseComment( demux_t *p_demux, const uint8_t *p_data, int i_data )
 571 {
 572     demux_sys_t *p_sys = p_demux->p_sys;
 573
 574     if( i_data < 4 )
 575         return;
 576
 577     vorbis_ParseComment( &p_sys->p_meta, &p_data[4], i_data - 4,
 578         &p_sys->i_attachments, &p_sys->attachments,
 579         &p_sys->i_cover_score, &p_sys->i_cover_idx, NULL, NULL );
 580 }
 581
 582 static void ParsePicture( demux_t *p_demux, const uint8_t *p_data, int i_data )
 583 {
 584     demux_sys_t *p_sys = p_demux->p_sys;
 585
 586     i_data -= 4; p_data += 4;
 587
 588     input_attachment_t *p_attachment = ParseFlacPicture( p_data, i_data,
 589         p_sys->i_attachments, &p_sys->i_cover_score, &p_sys->i_cover_idx );
 590     if( p_attachment == NULL )
 591         return;
 592
 593     TAB_APPEND( p_sys->i_attachments, p_sys->attachments, p_attachment );
 594 }
 595