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