git.sesse.net Git - vlc/blob - modules/meta_engine/taglib.cpp

   1 /*****************************************************************************
   2  * taglib.cpp: Taglib tag parser/writer
   3  *****************************************************************************
   4  * Copyright (C) 2003-2006 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *          Rafaël Carré <funman@videolanorg>
   9  *
  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.
  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 General Public License for more details.
  19  *
  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  *****************************************************************************/
  24
  25 #include <vlc/vlc.h>
  26 #include <vlc_playlist.h>
  27 #include <vlc_meta.h>
  28 #include <vlc_demux.h>
  29 #include <vlc_strings.h>
  30
  31 #include <fileref.h>
  32 #include <tag.h>
  33 #include <tstring.h>
  34 #include <id3v2tag.h>
  35 #include <textidentificationframe.h>
  36 #include <tbytevector.h>
  37 #include <mpegfile.h>
  38 #include <flacfile.h>
  39 #include <attachedpictureframe.h>
  40 //#include <oggflacfile.h> /* ogg flac files aren't auto-casted by TagLib */
  41 #include <flacfile.h>
  42 #include <flacproperties.h>
  43 #include <vorbisfile.h>
  44 #include <vorbisproperties.h>
  45 #include <xiphcomment.h>
  46 #include <uniquefileidentifierframe.h>
  47 #include <textidentificationframe.h>
  48 //#include <relativevolumeframe.h> /* parse the tags without TagLib helpers? */
  49
  50 static int  ReadMeta    ( vlc_object_t * );
  51 static int  DownloadArt ( vlc_object_t * );
  52 static int  WriteMeta   ( vlc_object_t * );
  53
  54 vlc_module_begin();
  55     set_capability( "meta reader", 1000 );
  56     set_callbacks( ReadMeta, NULL );
  57     add_submodule();
  58         set_capability( "art downloader", 50 );
  59         set_callbacks( DownloadArt, NULL );
  60     add_submodule();
  61         set_capability( "meta writer", 50 );
  62         set_callbacks( WriteMeta, NULL );
  63 vlc_module_end();
  64
  65 using namespace TagLib;
  66
  67 /* Try detecting embedded art */
  68 static void DetectImage( FileRef f, demux_t *p_demux )
  69 {
  70     demux_meta_t        *p_demux_meta   = (demux_meta_t *)p_demux->p_private;
  71     vlc_meta_t          *p_meta         = p_demux_meta->p_meta;
  72     int                 i_score         = -1;
  73
  74     /* Preferred type of image
  75      * The 21 types are defined in id3v2 standard:
  76      * http://www.id3.org/id3v2.4.0-frames */
  77     static const int pi_cover_score[] = {
  78         0,  /* Other */
  79         5,  /* 32x32 PNG image that should be used as the file icon */
  80         4,  /* File icon of a different size or format. */
  81         20, /* Front cover image of the album. */
  82         19, /* Back cover image of the album. */
  83         13, /* Inside leaflet page of the album. */
  84         18, /* Image from the album itself. */
  85         17, /* Picture of the lead artist or soloist. */
  86         16, /* Picture of the artist or performer. */
  87         14, /* Picture of the conductor. */
  88         15, /* Picture of the band or orchestra. */
  89         9,  /* Picture of the composer. */
  90         8,  /* Picture of the lyricist or text writer. */
  91         7,  /* Picture of the recording location or studio. */
  92         10, /* Picture of the artists during recording. */
  93         11, /* Picture of the artists during performance. */
  94         6,  /* Picture from a movie or video related to the track. */
  95         1,  /* Picture of a large, coloured fish. */
  96         12, /* Illustration related to the track. */
  97         3,  /* Logo of the band or performer. */
  98         2   /* Logo of the publisher (record company). */
  99     };
 100
 101     if( MPEG::File *mpeg = dynamic_cast<MPEG::File *>(f.file() ) )
 102     {
 103         ID3v2::Tag  *p_tag = mpeg->ID3v2Tag();
 104         if( !p_tag )
 105             return;
 106         ID3v2::FrameList list = p_tag->frameListMap()[ "APIC" ];
 107         if( list.isEmpty() )
 108             return;
 109         ID3v2::AttachedPictureFrame *p_apic;
 110
 111         TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
 112         for( ID3v2::FrameList::Iterator iter = list.begin();
 113                 iter != list.end(); iter++ )
 114         {
 115             p_apic = dynamic_cast<ID3v2::AttachedPictureFrame*>(*iter);
 116             input_attachment_t *p_attachment;
 117
 118             const char *psz_name, *psz_mime, *psz_description;
 119             ByteVector p_data_taglib; const char *p_data; int i_data;
 120
 121             psz_mime = p_apic->mimeType().toCString(true);
 122
 123             /* some old iTunes version not only sets incorrectly the mime type
 124              * but also embeds incorrectly the image.
 125              * Recent versions seem to behave correctly */
 126             if( !strncmp( psz_mime, "PNG", 3 ) )
 127             {
 128                 msg_Warn( p_demux,
 129                     "%s: Invalid picture embedded by broken iTunes version",
 130                     f.file()->name() );
 131                 break;
 132             }
 133
 134             psz_description = p_apic->description().toCString(true);
 135             psz_name = psz_description;
 136
 137             p_data_taglib = p_apic->picture();
 138             p_data = p_data_taglib.data();
 139             i_data = p_data_taglib.size();
 140
 141             msg_Dbg( p_demux, "Found embedded art: %s (%s) is %i bytes",
 142                     psz_name, psz_mime, i_data );
 143
 144             p_attachment = vlc_input_attachment_New( psz_name, psz_mime,
 145                     psz_description, p_data, i_data );
 146             TAB_APPEND_CAST( (input_attachment_t**),
 147                     p_demux_meta->i_attachments, p_demux_meta->attachments,
 148                     p_attachment );
 149
 150             if( pi_cover_score[p_apic->type()] > i_score )
 151             {
 152                 i_score = pi_cover_score[p_apic->type()];
 153                 char *psz_url;
 154                 if( asprintf( &psz_url, "attachment://%s",
 155                         p_attachment->psz_name ) == -1 )
 156                     return;
 157                 vlc_meta_SetArtURL( p_meta, psz_url );
 158                 free( psz_url );
 159             }
 160         }
 161     }
 162     else
 163     if( Ogg::Vorbis::File *oggv = dynamic_cast<Ogg::Vorbis::File *>(f.file() ) )
 164     {
 165         Ogg::XiphComment *p_tag = oggv->tag();
 166         if( !p_tag )
 167             return;
 168
 169         StringList mime_list = p_tag->fieldListMap()[ "COVERARTMIME" ];
 170         StringList art_list = p_tag->fieldListMap()[ "COVERART" ];
 171
 172         /* we support only one cover in ogg/vorbis */
 173         if( mime_list.size() != 1 || art_list.size() != 1 )
 174             return;
 175
 176         input_attachment_t *p_attachment;
 177
 178         const char *psz_name, *psz_mime, *psz_description;
 179         uint8_t *p_data;
 180         int i_data;
 181
 182         psz_name = "cover";
 183         psz_mime = mime_list[0].toCString(true);
 184         psz_description = "cover";
 185
 186         i_data = vlc_b64_decode_binary( &p_data, art_list[0].toCString(true) );
 187
 188         msg_Dbg( p_demux, "Found embedded art: %s (%s) is %i bytes",
 189                     psz_name, psz_mime, i_data );
 190
 191         TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
 192         p_attachment = vlc_input_attachment_New( psz_name, psz_mime,
 193                 psz_description, p_data, i_data );
 194         free( p_data );
 195
 196         TAB_APPEND_CAST( (input_attachment_t**),
 197                 p_demux_meta->i_attachments, p_demux_meta->attachments,
 198                 p_attachment );
 199
 200         vlc_meta_SetArtURL( p_meta, "attachment://cover" );
 201     }
 202
 203 #if 0
 204     //flac embedded images are extracted in the flac demuxer
 205     else if( FLAC::File *flac =
 206              dynamic_cast<FLAC::File *>(f.file() ) )
 207     {
 208         p_tag = flac->ID3v2Tag();
 209         if( p_tag )
 210             return;
 211         ID3v2::FrameList l = p_tag->frameListMap()[ "APIC" ];
 212         if( l.isEmpty() )
 213             return;
 214             vlc_meta_SetArtURL( p_meta, "APIC" );
 215     }
 216 #endif
 217 #if 0
 218 /* TagLib doesn't support MP4 file yet */
 219     else if( MP4::File *mp4 =
 220                dynamic_cast<MP4::File *>( f.file() ) )
 221     {
 222         MP4::Tag *mp4tag =
 223                 dynamic_cast<MP4::Tag *>( mp4->tag() );
 224         if( mp4tag && mp4tag->cover().size() )
 225             vlc_meta_SetArtURL( p_meta, "MP4C" );
 226     }
 227 #endif
 228 }
 229
 230 static int ReadMeta( vlc_object_t *p_this )
 231 {
 232     demux_t         *p_demux = (demux_t *)p_this;
 233     demux_meta_t    *p_demux_meta = (demux_meta_t*)p_demux->p_private;
 234     vlc_meta_t      *p_meta;
 235
 236     TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
 237     p_demux_meta->p_meta = NULL;
 238
 239     FileRef f( p_demux->psz_path );
 240     if( f.isNull() )
 241         return VLC_EGENERIC;
 242
 243     if ( !f.tag() || f.tag()->isEmpty() )
 244         return VLC_EGENERIC;
 245
 246     p_demux_meta->p_meta = p_meta = vlc_meta_New();
 247     Tag *p_tag = f.tag();
 248
 249     if( MPEG::File *p_mpeg =
 250         dynamic_cast<MPEG::File *>(f.file() ) )
 251     {
 252         if( p_mpeg->ID3v2Tag() )
 253         {
 254             ID3v2::Tag *p_tag = p_mpeg->ID3v2Tag();
 255             ID3v2::FrameList list = p_tag->frameListMap()["UFID"];
 256             ID3v2::UniqueFileIdentifierFrame* p_ufid;
 257             for( ID3v2::FrameList::Iterator iter = list.begin();
 258                     iter != list.end(); iter++ )
 259             {
 260                 p_ufid = dynamic_cast<ID3v2::UniqueFileIdentifierFrame*>(*iter);
 261                 const char *owner = p_ufid->owner().toCString();
 262                 if (!strcmp( owner, "http://musicbrainz.org" ))
 263                 {
 264                     /* ID3v2 UFID contains up to 64 bytes binary data
 265                         * but in our case it will be a '\0'
 266                         * terminated string */
 267                     char *psz_ufid = (char*) malloc( 64 );
 268                     int j = 0;
 269                     while( ( j < 63 ) &&
 270                             ( j < p_ufid->identifier().size() ) )
 271                         psz_ufid[j] = p_ufid->identifier()[j++];
 272                     psz_ufid[j] = '\0';
 273                     vlc_meta_SetTrackID( p_meta, psz_ufid );
 274                     free( psz_ufid );
 275                 }
 276             }
 277
 278             list = p_tag->frameListMap()["TXXX"];
 279             ID3v2::UserTextIdentificationFrame* p_txxx;
 280             for( ID3v2::FrameList::Iterator iter = list.begin();
 281                     iter != list.end(); iter++ )
 282             {
 283                 p_txxx = dynamic_cast<ID3v2::UserTextIdentificationFrame*>(*iter);
 284                 const char *psz_desc= p_txxx->description().toCString();
 285                 vlc_meta_AddExtra( p_meta, psz_desc,
 286                             p_txxx->fieldList().toString().toCString());
 287             }
 288 #if 0
 289             list = p_tag->frameListMap()["RVA2"];
 290             ID3v2::RelativeVolumeFrame* p_rva2;
 291             for( ID3v2::FrameList::Iterator iter = list.begin();
 292                     iter != list.end(); iter++ )
 293             {
 294                 p_rva2 = dynamic_cast<ID3v2::RelativeVolumeFrame*>(*iter);
 295                 /* TODO: process rva2 frames */
 296             }
 297 #endif
 298             list = p_tag->frameList();
 299             ID3v2::Frame* p_t;
 300             char psz_tag[4];
 301             for( ID3v2::FrameList::Iterator iter = list.begin();
 302                     iter != list.end(); iter++ )
 303             {
 304                 p_t = dynamic_cast<ID3v2::Frame*> (*iter);
 305                 memcpy( psz_tag, p_t->frameID().data(), 4);
 306
 307 #define SET( foo, bar ) if( !strncmp( psz_tag, foo, 4 ) ) \
 308 vlc_meta_Set##bar( p_meta, p_t->toString().toCString(true))
 309                 SET( "TPUB", Publisher );
 310                 SET( "TCOP", Copyright );
 311                 SET( "TENC", EncodedBy );
 312                 SET( "TLAN", Language );
 313                 //SET( "POPM", Rating ); /* rating needs special handling in id3v2 */
 314                 //if( !strncmp( psz_tag, "RVA2", 4 ) )
 315                     /* TODO */
 316 #undef SET
 317             }
 318         }
 319     }
 320
 321     else if( Ogg::Vorbis::File *p_ogg_v =
 322         dynamic_cast<Ogg::Vorbis::File *>(f.file() ) )
 323     {
 324         int i_ogg_v_length = p_ogg_v->audioProperties()->length();
 325
 326         input_thread_t *p_input = (input_thread_t *)
 327                 vlc_object_find( p_demux,VLC_OBJECT_INPUT, FIND_PARENT );
 328         if( p_input )
 329         {
 330             input_item_t *p_item = input_GetItem( p_input );
 331             if( p_item )
 332                 input_item_SetDuration( p_item,
 333                         (mtime_t) i_ogg_v_length * 1000000 );
 334             vlc_object_release( p_input );
 335         }
 336
 337     }
 338 #if 0 /* at this moment, taglib is unable to detect ogg/flac files
 339 * becauses type detection is based on file extension:
 340 * ogg = ogg/vorbis
 341 * flac = flac
 342 * ø = ogg/flac
 343 */
 344     else if( Ogg::FLAC::File *p_ogg_f =
 345         dynamic_cast<Ogg::FLAC::File *>(f.file() ) )
 346     {
 347         long i_ogg_f_length = p_ogg_f->streamLength();
 348         input_thread_t *p_input = (input_thread_t *)
 349                 vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
 350         if( p_input )
 351         {
 352             input_item_t *p_item = input_GetItem( p_input );
 353             if( p_item )
 354                 input_item_SetDuration( p_item,
 355                         (mtime_t) i_ogg_f_length * 1000000 );
 356             vlc_object_release( p_input );
 357         }
 358     }
 359 #endif
 360     else if( FLAC::File *p_flac =
 361         dynamic_cast<FLAC::File *>(f.file() ) )
 362     {
 363         long i_flac_length = p_flac->audioProperties()->length();
 364         input_thread_t *p_input = (input_thread_t *)
 365                 vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
 366         if( p_input )
 367         {
 368             input_item_t *p_item = input_GetItem( p_input );
 369             if( p_item )
 370                 input_item_SetDuration( p_item,
 371                         (mtime_t) i_flac_length * 1000000 );
 372             vlc_object_release( p_input );
 373         }
 374     }
 375
 376 #define SET( foo, bar ) vlc_meta_Set##foo( p_meta, p_tag->bar ().toCString(true))
 377 #define SETINT( foo, bar ) { \
 378         char psz_tmp[10]; \
 379         snprintf( (char*)psz_tmp, 10, "%d", p_tag->bar() ); \
 380         vlc_meta_Set##foo( p_meta, (char*)psz_tmp ); \
 381     }
 382
 383     SET( Title, title );
 384     SET( Artist, artist );
 385     SET( Album, album );
 386     SET( Description, comment );
 387     SET( Genre, genre );
 388     SETINT( Date, year );
 389     SETINT( Tracknum , track );
 390 #undef SET
 391 #undef SETINT
 392
 393     DetectImage( f, p_demux );
 394
 395     return VLC_SUCCESS;
 396 }
 397
 398 static int WriteMeta( vlc_object_t *p_this )
 399 {
 400     playlist_t *p_playlist = (playlist_t *)p_this;
 401     meta_export_t *p_export = (meta_export_t *)p_playlist->p_private;
 402     input_item_t *p_item = p_export->p_item;
 403
 404     if( p_item == NULL )
 405     {
 406         msg_Err( p_this, "Can't save meta data of an empty input" );
 407         return VLC_EGENERIC;
 408     }
 409
 410     FileRef f( p_export->psz_file );
 411     if( f.isNull() || !f.tag() || f.file()->readOnly() )
 412     {
 413         msg_Err( p_this, "File %s can't be opened for tag writing\n",
 414             p_export->psz_file );
 415         return VLC_EGENERIC;
 416     }
 417
 418     msg_Dbg( p_this, "Writing metadata for %s", p_export->psz_file );
 419
 420     Tag *p_tag = f.tag();
 421
 422     char *psz_meta;
 423
 424 #define SET(a,b) \
 425         if(b) { \
 426             String *psz_##a = new String( b, \
 427                 String::UTF8 ); \
 428             p_tag->set##a( *psz_##a ); \
 429             delete psz_##a; \
 430         }
 431
 432
 433     psz_meta = input_item_GetArtist( p_item );
 434     SET( Artist, psz_meta );
 435     free( psz_meta );
 436
 437     psz_meta = input_item_GetTitle( p_item );
 438     if( !psz_meta ) psz_meta = input_item_GetName( p_item );
 439     String *psz_title = new String( psz_meta,
 440         String::UTF8 );
 441     p_tag->setTitle( *psz_title );
 442     delete psz_title;
 443     free( psz_meta );
 444
 445     psz_meta = input_item_GetAlbum( p_item );
 446     SET( Album, psz_meta );
 447     free( psz_meta );
 448
 449     psz_meta = input_item_GetGenre( p_item );
 450     SET( Genre, psz_meta );
 451     free( psz_meta );
 452
 453 #undef SET
 454
 455     psz_meta = input_item_GetDate( p_item );
 456     if( psz_meta ) p_tag->setYear( atoi( psz_meta ) );
 457     free( psz_meta );
 458
 459     psz_meta = input_item_GetTrackNum( p_item );
 460     if( psz_meta ) p_tag->setTrack( atoi( psz_meta ) );
 461     free( psz_meta );
 462
 463     if( ID3v2::Tag *p_id3tag =
 464         dynamic_cast<ID3v2::Tag *>(p_tag) )
 465     {
 466 #define WRITE( foo, bar ) \
 467         psz_meta = input_item_Get##foo( p_item ); \
 468         if( psz_meta ) \
 469         { \
 470             ByteVector p_byte( bar, 4 ); \
 471             ID3v2::TextIdentificationFrame p_frame( p_byte ); \
 472             p_frame.setText( psz_meta ); \
 473             p_id3tag->addFrame( &p_frame ); \
 474             free( psz_meta ); \
 475         } \
 476
 477         WRITE( Publisher, "TPUB" );
 478         WRITE( Copyright, "TCOP" );
 479         WRITE( EncodedBy, "TENC" );
 480         WRITE( Language, "TLAN" );
 481
 482 #undef WRITE
 483     }
 484
 485     f.save();
 486     return VLC_SUCCESS;
 487 }
 488
 489 static int DownloadArt( vlc_object_t *p_this )
 490 {
 491     /* We need to be passed the file name
 492      * Fetch the thing from the file, save it to the cache folder
 493      */
 494     return VLC_EGENERIC;
 495 }
 496