git.sesse.net Git - vlc/blob - modules/meta_engine/id3tag.c

   1 /*****************************************************************************
   2  * id3tag.c: id3/ape tag parser/skipper based on libid3tag
   3  *****************************************************************************
   4  * Copyright (C) 2002-2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <config.h>
  28
  29
  30 #ifdef HAVE_CONFIG_H
  31 # include "config.h"
  32 #endif
  33
  34 #include <vlc_common.h>
  35 #include <vlc_plugin.h>
  36 #include <vlc_interface.h>
  37 #include <vlc_demux.h>
  38 #include <vlc_charset.h>
  39
  40 #include <sys/types.h>
  41
  42 #include <vlc_meta.h>
  43
  44 #include <id3tag.h>
  45 #include "id3genres.h"
  46
  47 /*****************************************************************************
  48  * Local prototypes
  49  *****************************************************************************/
  50 static int  ParseTags ( vlc_object_t * );
  51
  52 /*****************************************************************************
  53  * Module descriptor
  54  *****************************************************************************/
  55 vlc_module_begin ()
  56     set_description( N_("ID3v1/2 and APEv1/2 tags parser" ) )
  57     set_capability( "meta reader", 70 )
  58     set_callbacks( ParseTags, NULL )
  59 vlc_module_end ()
  60
  61 /*****************************************************************************
  62  * ParseID3Tag : parse an id3tag into the info structures
  63  *****************************************************************************/
  64 static void ParseID3Tag( demux_meta_t *p_demux_meta, const uint8_t *p_data, int i_size )
  65 {
  66     struct id3_tag   *p_id3_tag;
  67     struct id3_frame *p_frame;
  68     vlc_meta_t       *p_meta;
  69     int i;
  70
  71     p_id3_tag = id3_tag_parse( p_data, i_size );
  72     if( !p_id3_tag )
  73         return;
  74
  75     if( !p_demux_meta->p_meta )
  76         p_demux_meta->p_meta = vlc_meta_New();
  77     p_meta = p_demux_meta->p_meta;
  78
  79 #define ID_IS( a ) (!strcmp(  p_frame->id, a ))
  80 #define DESCR_IS( a) strstr( (char*)p_frame->description, a )
  81 #define GET_STRING(frame,fidx) id3_ucs4_latin1duplicate( id3_field_getstring( &(frame)->fields[fidx] ) )
  82
  83     /* */
  84     for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "UFID", i )) != NULL; i++ )
  85     {
  86         const char *psz_owner = id3_field_getlatin1( &p_frame->fields[0] );
  87
  88         if( !strncmp( psz_owner, "http://musicbrainz.org", 22 ) )
  89         {
  90             id3_byte_t const * p_ufid;
  91             id3_length_t i_ufidlen;
  92
  93             p_ufid = id3_field_getbinarydata( &p_frame->fields[1], &i_ufidlen );
  94             char *psz_ufid = strndup( p_ufid, i_ufidlen );
  95
  96             vlc_meta_SetTrackID( p_meta, psz_ufid );
  97             free( psz_ufid );
  98         }
  99     }
 100
 101     /* User defined text (TXXX) */
 102     for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "TXXX", i )) != NULL; i++ )
 103     {
 104         /* 3 fields: 'encoding', 'description', 'value' */
 105         char *psz_name = GET_STRING( p_frame, 1 );
 106         char *psz_value = GET_STRING( p_frame, 2 );
 107
 108         vlc_meta_AddExtra( p_meta, psz_name, psz_value );
 109 #if 0
 110         if( !strncmp( psz_name, "MusicBrainz Artist Id", 21 ) )
 111             vlc_meta_SetArtistID( p_meta, psz_value );
 112         if( !strncmp( psz_desc, "MusicBrainz Album Id", 20 ) )
 113             vlc_meta_SetAlbumID( p_meta, psz_value );
 114 #endif
 115         free( psz_name );
 116         free( psz_value );
 117     }
 118
 119     /* Relative volume adjustment */
 120     for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "RVA2", i )) != NULL; i++ )
 121     {
 122         /* 2 fields: 'latin1', 'binary' */
 123         const char *psz_type = id3_field_getlatin1( &p_frame->fields[0] );
 124         if( !strcasecmp( psz_type, "track" ) || !strcasecmp( psz_type, "album" ) ||
 125             !strcasecmp( psz_type, "normalize" ) )
 126         {
 127             id3_byte_t const * p_data;
 128             id3_length_t i_data;
 129
 130             p_data = id3_field_getbinarydata( &p_frame->fields[1], &i_data );
 131             while( i_data >= 4 )
 132             {
 133                 const unsigned int i_peak_size = p_data[3];
 134                 const float f_temp = GetWBE( &p_data[1] );
 135                 const float f_gain = f_temp / 512.0;
 136                 char psz_value[32];
 137
 138                 if( i_data < i_peak_size + 4 )
 139                     break;
 140                 /* only master volume */
 141                 if( p_data[0] == 0x01 )
 142                 {
 143                     snprintf( psz_value, sizeof(psz_value), "%f", f_gain );
 144                     if( !strcasecmp( psz_type, "album" ) )
 145                         vlc_meta_AddExtra( p_meta, "REPLAYGAIN_ALBUM_GAIN", psz_value );
 146                     else
 147                         vlc_meta_AddExtra( p_meta, "REPLAYGAIN_TRACK_GAIN", psz_value );
 148                     /* XXX I have no idea what peak unit is ... */
 149                 }
 150                 i_data -= 4+i_peak_size;
 151             }
 152         }
 153     }
 154
 155     /* TODO 'RGAD' if it is used somewhere */
 156
 157     /* T--- Text informations */
 158     for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "T", i )) != NULL; i++ )
 159     {
 160         unsigned i_strings;
 161
 162         /* Special case TXXX is not the same beast */
 163         if( ID_IS( "TXXX" ) )
 164             continue;
 165
 166         i_strings = id3_field_getnstrings( &p_frame->fields[1] );
 167         while( i_strings > 0 )
 168         {
 169             char *psz_temp = id3_ucs4_utf8duplicate(
 170                 id3_field_getstrings( &p_frame->fields[1], --i_strings ) );
 171
 172             if( ID_IS( ID3_FRAME_GENRE ) )
 173             {
 174                 char *psz_endptr;
 175                 int i_genre = strtol( psz_temp, &psz_endptr, 10 );
 176
 177                 if( psz_temp != psz_endptr &&
 178                     i_genre >= 0 && i_genre < NUM_GENRES )
 179                 {
 180                     vlc_meta_SetGenre( p_meta, ppsz_genres[atoi(psz_temp)]);
 181                 }
 182                 else
 183                 {
 184                     /* Unknown genre */
 185                     vlc_meta_SetGenre( p_meta,psz_temp );
 186                 }
 187             }
 188             else if( ID_IS( ID3_FRAME_TITLE ) )
 189             {
 190                 vlc_meta_SetTitle( p_meta, psz_temp );
 191             }
 192             else if( ID_IS( ID3_FRAME_ARTIST ) )
 193             {
 194                 vlc_meta_SetArtist( p_meta, psz_temp );
 195             }
 196             else if( ID_IS( ID3_FRAME_YEAR ) )
 197             {
 198                 vlc_meta_SetDate( p_meta, psz_temp );
 199             }
 200             else if( ID_IS( ID3_FRAME_COMMENT ) )
 201             {
 202                 vlc_meta_SetDescription( p_meta, psz_temp );
 203             }
 204             else if( DESCR_IS( "Copyright" ) )
 205             {
 206                 vlc_meta_SetCopyright( p_meta, psz_temp );
 207             }
 208             else if( DESCR_IS( "Publisher" ) )
 209             {
 210                 vlc_meta_SetPublisher( p_meta, psz_temp );
 211             }
 212             else if( DESCR_IS( "Track number/position in set" ) )
 213             {
 214                 vlc_meta_SetTrackNum( p_meta, psz_temp );
 215             }
 216             else if( DESCR_IS( "Album/movie/show title" ) )
 217             {
 218                 vlc_meta_SetAlbum( p_meta, psz_temp );
 219             }
 220             else if( DESCR_IS( "Encoded by" ) )
 221             {
 222                 vlc_meta_SetEncodedBy( p_meta, psz_temp );
 223             }
 224             else if( ID_IS ( "APIC" ) )
 225             {
 226                 msg_Dbg( p_demux_meta, "** Has APIC **" );
 227             }
 228             else if( p_frame->description )
 229             {
 230                 /* Unhandled meta */
 231                 vlc_meta_AddExtra( p_meta, (char*)p_frame->description, psz_temp );
 232             }
 233             free( psz_temp );
 234         }
 235     }
 236     id3_tag_delete( p_id3_tag );
 237 #undef GET_STRING
 238 #undef DESCR_IS
 239 #undef ID_IS
 240 }
 241 /*****************************************************************************
 242  * APEv1/2
 243  *****************************************************************************/
 244 #define APE_TAG_HEADERSIZE (32)
 245 static size_t GetAPEvXSize( const uint8_t *p_data, int i_data )
 246 {
 247     uint32_t flags;
 248     size_t i_body;
 249
 250     if( i_data < APE_TAG_HEADERSIZE ||
 251         ( GetDWLE( &p_data[8] ) != 1000 && GetDWLE( &p_data[8] ) != 2000 ) || /* v1/v2 only */
 252         strncmp( (char*)p_data, "APETAGEX", 8 ) ||
 253         GetDWLE( &p_data[8+4+4] ) <= 0 )
 254         return 0;
 255
 256     i_body = GetDWLE( &p_data[8+4] );
 257     flags = GetDWLE( &p_data[8+4+4] );
 258
 259     /* is it the header */
 260     if( flags & (1<<29) )
 261         return i_body + ( (flags&(1<<30)) ? APE_TAG_HEADERSIZE : 0 );
 262
 263     /* it is the footer */
 264     return i_body + ( (flags&(1<<31)) ? APE_TAG_HEADERSIZE : 0 );
 265 }
 266 static void ParseAPEvXTag( demux_meta_t *p_demux_meta, const uint8_t *p_data, int i_data )
 267 {
 268     vlc_meta_t       *p_meta;
 269     bool b_start;
 270     bool b_end;
 271     const uint8_t *p_header = NULL;
 272     int i_entry;
 273
 274     if( i_data < APE_TAG_HEADERSIZE )
 275         return;
 276
 277     b_start = !strncmp( (char*)&p_data[0], "APETAGEX", 8 );
 278     b_end = !strncmp( (char*)&p_data[i_data-APE_TAG_HEADERSIZE], "APETAGEX", 8 );
 279     if( !b_end && !b_start )
 280         return;
 281
 282     if( !p_demux_meta->p_meta )
 283         p_demux_meta->p_meta = vlc_meta_New();
 284     p_meta = p_demux_meta->p_meta;
 285
 286     if( b_start )
 287     {
 288         p_header = &p_data[0];
 289         p_data += APE_TAG_HEADERSIZE;
 290         i_data -= APE_TAG_HEADERSIZE;
 291     }
 292     if( b_end )
 293     {
 294         p_header = &p_data[i_data-APE_TAG_HEADERSIZE];
 295         i_data -= APE_TAG_HEADERSIZE;
 296     }
 297     if( i_data <= 0 )
 298         return;
 299
 300     i_entry = GetDWLE( &p_header[8+4+4] );
 301     if( i_entry <= 0 )
 302         return;
 303
 304     while( i_entry > 0 && i_data >= 10 )
 305     {
 306         const int i_size = GetDWLE( &p_data[0] );
 307         const uint32_t flags = GetDWLE( &p_data[4] );
 308         char psz_name[256];
 309         int n;
 310
 311         strlcpy( psz_name, (char*)&p_data[8], sizeof(psz_name) );
 312         n = strlen( psz_name );
 313         if( n <= 0 )
 314             break;
 315
 316         p_data += 8+n+1;
 317         i_data -= 8+n+1;
 318         if( i_data < i_size )
 319             break;
 320
 321         /* Retreive UTF-8 fields only */
 322         if( ((flags>>1) & 0x03) == 0x00 )
 323         {
 324             /* FIXME list are separated by '\0' */
 325             char *psz_value = strndup( (char*)&p_data[0], i_size );
 326
 327             EnsureUTF8( psz_name );
 328             EnsureUTF8( psz_value );
 329 #define IS(s) (!strcasecmp( psz_name, s ) )
 330             if( IS( "Title" ) )
 331                 vlc_meta_SetTitle( p_meta, psz_value );
 332             else  if( IS( "Artist" ) )
 333                 vlc_meta_SetArtist( p_meta, psz_value );
 334             else  if( IS( "Album" ) )
 335                 vlc_meta_SetAlbum( p_meta, psz_value );
 336             else  if( IS( "Publisher" ) )
 337                 vlc_meta_SetPublisher( p_meta, psz_value );
 338             else  if( IS( "Track" ) )
 339             {
 340                 char *p = strchr( psz_value, '/' );
 341                 if( p )
 342                     *p++ = '\0';
 343                 vlc_meta_SetTrackNum( p_meta, psz_value );
 344             }
 345             else  if( IS( "Comment" ) )
 346                 vlc_meta_SetDescription( p_meta, psz_value );
 347             else  if( IS( "Copyright" ) )
 348                 vlc_meta_SetCopyright( p_meta, psz_value );
 349             else  if( IS( "Year" ) )
 350                 vlc_meta_SetDate( p_meta, psz_value );
 351             else  if( IS( "Genre" ) )
 352                 vlc_meta_SetGenre( p_meta, psz_value );
 353             else  if( IS( "Language" ) )
 354                 vlc_meta_SetLanguage( p_meta, psz_value );
 355             else
 356                 vlc_meta_AddExtra( p_meta, psz_name, psz_value );
 357 #undef IS
 358             free( psz_value );
 359         }
 360
 361         p_data += i_size;
 362         i_data -= i_size;
 363         i_entry--;
 364     }
 365 }
 366
 367 /*****************************************************************************
 368  * CheckFooter: check for ID3/APE at the end of the file
 369  * CheckHeader: check for ID3/APE at the begining of the file
 370  *****************************************************************************/
 371 static void CheckFooter( demux_meta_t *p_demux_meta )
 372 {
 373     demux_t      *p_demux = (demux_t *)p_demux_meta->p_demux;
 374     const int64_t i_pos = stream_Size( p_demux->s );
 375     const size_t i_peek = 128+APE_TAG_HEADERSIZE;
 376     const uint8_t *p_peek;
 377     const uint8_t *p_peek_id3;
 378     int64_t i_id3v2_pos = -1;
 379     int64_t i_apevx_pos = -1;
 380     int i_id3v2_size;
 381     int i_apevx_size;
 382     size_t i_id3v1_size;
 383
 384     if( i_pos < i_peek )
 385         return;
 386     if( stream_Seek( p_demux->s, i_pos - i_peek ) )
 387         return;
 388
 389     if( stream_Peek( p_demux->s, &p_peek, i_peek ) < i_peek )
 390         return;
 391     p_peek_id3 = &p_peek[APE_TAG_HEADERSIZE];
 392
 393     /* Check/Parse ID3v1 */
 394     i_id3v1_size = id3_tag_query( p_peek_id3, ID3_TAG_QUERYSIZE );
 395     if( i_id3v1_size == 128 )
 396     {
 397         msg_Dbg( p_demux, "found ID3v1 tag" );
 398         ParseID3Tag( p_demux_meta, p_peek_id3, i_id3v1_size );
 399     }
 400
 401     /* Compute ID3v2 position */
 402     i_id3v2_size = -id3_tag_query( &p_peek_id3[128-ID3_TAG_QUERYSIZE], ID3_TAG_QUERYSIZE );
 403     if( i_id3v2_size > 0 )
 404         i_id3v2_pos = i_pos - i_id3v2_size;
 405
 406     /* Compute APE2v2 position */
 407     i_apevx_size = GetAPEvXSize( &p_peek[128+0], APE_TAG_HEADERSIZE );
 408     if( i_apevx_size > 0 )
 409     {
 410         i_apevx_pos = i_pos - i_apevx_size;
 411     }
 412     else if( i_id3v1_size > 0 )
 413     {
 414         /* it can be before ID3v1 */
 415         i_apevx_size = GetAPEvXSize( p_peek, APE_TAG_HEADERSIZE );
 416         if( i_apevx_size > 0 )
 417             i_apevx_pos = i_pos - 128 - i_apevx_size;
 418     }
 419
 420     if( i_id3v2_pos > 0 && i_apevx_pos > 0 )
 421     {
 422         msg_Warn( p_demux,
 423                   "Both ID3v2 and APEv1/2 at the end of file, ignoring APEv1/2" );
 424         i_apevx_pos = -1;
 425     }
 426
 427     /* Parse ID3v2.4 */
 428     if( i_id3v2_pos > 0 )
 429     {
 430         if( !stream_Seek( p_demux->s, i_id3v2_pos ) &&
 431             stream_Peek( p_demux->s, &p_peek, i_id3v2_size ) == i_id3v2_size )
 432         {
 433             msg_Dbg( p_demux, "found ID3v2 tag at end of file" );
 434             ParseID3Tag( p_demux_meta, p_peek, i_id3v2_size );
 435         }
 436     }
 437
 438     /* Parse APEv1/2 */
 439     if( i_apevx_pos > 0 )
 440     {
 441         if( !stream_Seek( p_demux->s, i_apevx_pos ) &&
 442             stream_Peek( p_demux->s, &p_peek, i_apevx_size ) == i_apevx_size )
 443         {
 444             msg_Dbg( p_demux, "found APEvx tag at end of file" );
 445             ParseAPEvXTag( p_demux_meta, p_peek, i_apevx_size );
 446         }
 447     }
 448 }
 449 static void CheckHeader( demux_meta_t *p_demux_meta )
 450 {
 451     const uint8_t *p_peek;
 452     int i_size;
 453
 454     demux_t      *p_demux = (demux_t *)p_demux_meta->p_demux;
 455
 456     if( stream_Seek( p_demux->s, 0 ) )
 457         return;
 458
 459     /* Test ID3v2 first */
 460     if( stream_Peek( p_demux->s, &p_peek, ID3_TAG_QUERYSIZE ) != ID3_TAG_QUERYSIZE )
 461         return;
 462     i_size = id3_tag_query( p_peek, ID3_TAG_QUERYSIZE );
 463     if( i_size > 0 &&
 464         stream_Peek( p_demux->s, &p_peek, i_size ) == i_size )
 465     {
 466         msg_Dbg( p_demux, "found ID3v2 tag" );
 467         ParseID3Tag( p_demux_meta, p_peek, i_size );
 468         return;
 469     }
 470
 471     /* Test APEv1 */
 472     if( stream_Peek( p_demux->s, &p_peek, APE_TAG_HEADERSIZE ) != APE_TAG_HEADERSIZE )
 473         return;
 474     i_size = GetAPEvXSize( p_peek, APE_TAG_HEADERSIZE );
 475     if( i_size > 0 &&
 476         stream_Peek( p_demux->s, &p_peek, i_size ) == i_size )
 477     {
 478         msg_Dbg( p_demux, "found APEv1/2 tag" );
 479         ParseAPEvXTag( p_demux_meta, p_peek, i_size );
 480     }
 481 }
 482
 483 /*****************************************************************************
 484  * ParseTags: check if ID3/APE tags at common locations.
 485  ****************************************************************************/
 486 static int ParseTags( vlc_object_t *p_this )
 487 {
 488     demux_meta_t *p_demux_meta = (demux_meta_t *)p_this;
 489     demux_t      *p_demux = (demux_t *)p_demux_meta->p_demux;
 490     bool    b_seekable;
 491     int64_t       i_init;
 492
 493     msg_Dbg( p_demux_meta, "checking for ID3v1/2 and APEv1/2 tags" );
 494     stream_Control( p_demux->s, STREAM_CAN_FASTSEEK, &b_seekable );
 495     if( !b_seekable )
 496         return VLC_EGENERIC;
 497
 498     i_init = stream_Tell( p_demux->s );
 499
 500     TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
 501     p_demux_meta->p_meta = NULL;
 502
 503     /* */
 504     CheckFooter( p_demux_meta );
 505
 506     /* */
 507     CheckHeader( p_demux_meta );
 508
 509     /* Restore position
 510      *  Demuxer will not see tags at the start as src/input/demux.c skips it
 511      *  for them
 512      */
 513     stream_Seek( p_demux->s, i_init );
 514     if( !p_demux_meta->p_meta && p_demux_meta->i_attachments <= 0 )
 515         return VLC_EGENERIC;
 516     return VLC_SUCCESS;
 517 }
 518