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             psz_description = p_apic->description().toCString(true);
 123             psz_name = psz_description;
 124
 125             p_data_taglib = p_apic->picture();
 126             p_data = p_data_taglib.data();
 127             i_data = p_data_taglib.size();
 128
 129             msg_Dbg( p_demux, "Found embedded art: %s (%s) is %i bytes",
 130                     psz_name, psz_mime, i_data );
 131
 132             p_attachment = vlc_input_attachment_New( psz_name, psz_mime,
 133                     psz_description, p_data, i_data );
 134             TAB_APPEND_CAST( (input_attachment_t**),
 135                     p_demux_meta->i_attachments, p_demux_meta->attachments,
 136                     p_attachment );
 137
 138             if( pi_cover_score[p_apic->type()] > i_score )
 139             {
 140                 i_score = pi_cover_score[p_apic->type()];
 141                 char *psz_url;
 142                 if( asprintf( &psz_url, "attachment://%s",
 143                         p_attachment->psz_name ) == -1 )
 144                     return;
 145                 vlc_meta_SetArtURL( p_meta, psz_url );
 146                 free( psz_url );
 147             }
 148         }
 149     }
 150     else
 151     if( Ogg::Vorbis::File *oggv = dynamic_cast<Ogg::Vorbis::File *>(f.file() ) )
 152     {
 153         Ogg::XiphComment *p_tag = oggv->tag();
 154         if( !p_tag )
 155             return;
 156
 157         StringList mime_list = p_tag->fieldListMap()[ "COVERARTMIME" ];
 158         StringList art_list = p_tag->fieldListMap()[ "COVERART" ];
 159
 160         /* we support only one cover in ogg/vorbis */
 161         if( mime_list.size() != 1 || art_list.size() != 1 )
 162             return;
 163
 164         input_attachment_t *p_attachment;
 165
 166         const char *psz_name, *psz_mime, *psz_description;
 167         uint8_t *p_data;
 168         int i_data;
 169
 170         psz_name = "cover";
 171         psz_mime = mime_list[0].toCString(true);
 172         psz_description = "cover";
 173
 174         i_data = vlc_b64_decode_binary( &p_data, art_list[0].toCString(true) );
 175
 176         msg_Dbg( p_demux, "Found embedded art: %s (%s) is %i bytes",
 177                     psz_name, psz_mime, i_data );
 178
 179         TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
 180         p_attachment = vlc_input_attachment_New( psz_name, psz_mime,
 181                 psz_description, p_data, i_data );
 182         free( p_data );
 183
 184         TAB_APPEND_CAST( (input_attachment_t**),
 185                 p_demux_meta->i_attachments, p_demux_meta->attachments,
 186                 p_attachment );
 187
 188         vlc_meta_SetArtURL( p_meta, "attachment://cover" );
 189     }
 190
 191 #if 0
 192     //flac embedded images are extracted in the flac demuxer
 193     else if( FLAC::File *flac =
 194              dynamic_cast<FLAC::File *>(f.file() ) )
 195     {
 196         p_tag = flac->ID3v2Tag();
 197         if( p_tag )
 198             return;
 199         ID3v2::FrameList l = p_tag->frameListMap()[ "APIC" ];
 200         if( l.isEmpty() )
 201             return;
 202             vlc_meta_SetArtURL( p_meta, "APIC" );
 203     }
 204 #endif
 205 #if 0
 206 /* TagLib doesn't support MP4 file yet */
 207     else if( MP4::File *mp4 =
 208                dynamic_cast<MP4::File *>( f.file() ) )
 209     {
 210         MP4::Tag *mp4tag =
 211                 dynamic_cast<MP4::Tag *>( mp4->tag() );
 212         if( mp4tag && mp4tag->cover().size() )
 213             vlc_meta_SetArtURL( p_meta, "MP4C" );
 214     }
 215 #endif
 216 }
 217
 218 static int ReadMeta( vlc_object_t *p_this )
 219 {
 220     demux_t         *p_demux = (demux_t *)p_this;
 221     demux_meta_t    *p_demux_meta = (demux_meta_t*)p_demux->p_private;
 222     vlc_meta_t      *p_meta = p_demux_meta->p_meta;
 223
 224     TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
 225     p_demux_meta->p_meta = NULL;
 226
 227     FileRef f( p_demux->psz_path );
 228     if( f.isNull() )
 229         return VLC_EGENERIC;
 230
 231     if ( !f.tag() || f.tag()->isEmpty() )
 232         return VLC_EGENERIC;
 233
 234     p_demux_meta->p_meta = p_meta = vlc_meta_New();
 235     Tag *p_tag = f.tag();
 236
 237     if( MPEG::File *p_mpeg =
 238         dynamic_cast<MPEG::File *>(f.file() ) )
 239     {
 240         if( p_mpeg->ID3v2Tag() )
 241         {
 242             ID3v2::Tag *p_tag = p_mpeg->ID3v2Tag();
 243             ID3v2::FrameList list = p_tag->frameListMap()["UFID"];
 244             ID3v2::UniqueFileIdentifierFrame* p_ufid;
 245             for( ID3v2::FrameList::Iterator iter = list.begin();
 246                     iter != list.end(); iter++ )
 247             {
 248                 p_ufid = dynamic_cast<ID3v2::UniqueFileIdentifierFrame*>(*iter);
 249                 const char *owner = p_ufid->owner().toCString();
 250                 if (!strcmp( owner, "http://musicbrainz.org" ))
 251                 {
 252                     /* ID3v2 UFID contains up to 64 bytes binary data
 253                         * but in our case it will be a '\0'
 254                         * terminated string */
 255                     char *psz_ufid = (char*) malloc( 64 );
 256                     int j = 0;
 257                     while( ( j < 63 ) &&
 258                             ( j < p_ufid->identifier().size() ) )
 259                         psz_ufid[j] = p_ufid->identifier()[j++];
 260                     psz_ufid[j] = '\0';
 261                     vlc_meta_SetTrackID( p_meta, psz_ufid );
 262                     free( psz_ufid );
 263                 }
 264             }
 265
 266             list = p_tag->frameListMap()["TXXX"];
 267             ID3v2::UserTextIdentificationFrame* p_txxx;
 268             for( ID3v2::FrameList::Iterator iter = list.begin();
 269                     iter != list.end(); iter++ )
 270             {
 271                 p_txxx = dynamic_cast<ID3v2::UserTextIdentificationFrame*>(*iter);
 272                 const char *psz_desc= p_txxx->description().toCString();
 273                 vlc_meta_AddExtra( p_meta, psz_desc,
 274                             p_txxx->fieldList().toString().toCString());
 275             }
 276 #if 0
 277             list = p_tag->frameListMap()["RVA2"];
 278             ID3v2::RelativeVolumeFrame* p_rva2;
 279             for( ID3v2::FrameList::Iterator iter = list.begin();
 280                     iter != list.end(); iter++ )
 281             {
 282                 p_rva2 = dynamic_cast<ID3v2::RelativeVolumeFrame*>(*iter);
 283                 /* TODO: process rva2 frames */
 284             }
 285 #endif
 286             list = p_tag->frameList();
 287             ID3v2::Frame* p_t;
 288             char psz_tag[4];
 289             for( ID3v2::FrameList::Iterator iter = list.begin();
 290                     iter != list.end(); iter++ )
 291             {
 292                 p_t = dynamic_cast<ID3v2::Frame*> (*iter);
 293                 memcpy( psz_tag, p_t->frameID().data(), 4);
 294
 295 #define SET( foo, bar ) if( !strncmp( psz_tag, foo, 4 ) ) \
 296 vlc_meta_Set##bar( p_meta, p_t->toString().toCString(true))
 297                 SET( "TPUB", Publisher );
 298                 SET( "TCOP", Copyright );
 299                 SET( "TENC", EncodedBy );
 300                 SET( "TLAN", Language );
 301                 //SET( "POPM", Rating ); /* rating needs special handling in id3v2 */
 302                 //if( !strncmp( psz_tag, "RVA2", 4 ) )
 303                     /* TODO */
 304 #undef SET
 305             }
 306         }
 307     }
 308
 309     else if( Ogg::Vorbis::File *p_ogg_v =
 310         dynamic_cast<Ogg::Vorbis::File *>(f.file() ) )
 311     {
 312         int i_ogg_v_length = p_ogg_v->audioProperties()->length();
 313
 314         input_thread_t *p_input = (input_thread_t *)
 315                 vlc_object_find( p_demux,VLC_OBJECT_INPUT, FIND_PARENT );
 316         if( p_input )
 317         {
 318             input_item_t *p_item = input_GetItem( p_input );
 319             if( p_item )
 320                 input_item_SetDuration( p_item,
 321                         (mtime_t) i_ogg_v_length * 1000000 );
 322             vlc_object_release( p_input );
 323         }
 324
 325     }
 326 #if 0 /* at this moment, taglib is unable to detect ogg/flac files
 327 * becauses type detection is based on file extension:
 328 * ogg = ogg/vorbis
 329 * flac = flac
 330 * ø = ogg/flac
 331 */
 332     else if( Ogg::FLAC::File *p_ogg_f =
 333         dynamic_cast<Ogg::FLAC::File *>(f.file() ) )
 334     {
 335         long i_ogg_f_length = p_ogg_f->streamLength();
 336         input_thread_t *p_input = (input_thread_t *)
 337                 vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
 338         if( p_input )
 339         {
 340             input_item_t *p_item = input_GetItem( p_input );
 341             if( p_item )
 342                 input_item_SetDuration( p_item,
 343                         (mtime_t) i_ogg_f_length * 1000000 );
 344             vlc_object_release( p_input );
 345         }
 346     }
 347 #endif
 348     else if( FLAC::File *p_flac =
 349         dynamic_cast<FLAC::File *>(f.file() ) )
 350     {
 351         long i_flac_length = p_flac->audioProperties()->length();
 352         input_thread_t *p_input = (input_thread_t *)
 353                 vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
 354         if( p_input )
 355         {
 356             input_item_t *p_item = input_GetItem( p_input );
 357             if( p_item )
 358                 input_item_SetDuration( p_item,
 359                         (mtime_t) i_flac_length * 1000000 );
 360             vlc_object_release( p_input );
 361         }
 362     }
 363
 364 #define SET( foo, bar ) vlc_meta_Set##foo( p_meta, p_tag->bar ().toCString(true))
 365 #define SETINT( foo, bar ) { \
 366         char psz_tmp[10]; \
 367         snprintf( (char*)psz_tmp, 10, "%d", p_tag->bar() ); \
 368         vlc_meta_Set##foo( p_meta, (char*)psz_tmp ); \
 369     }
 370
 371     SET( Title, title );
 372     SET( Artist, artist );
 373     SET( Album, album );
 374     SET( Description, comment );
 375     SET( Genre, genre );
 376     SETINT( Date, year );
 377     SETINT( Tracknum , track );
 378 #undef SET
 379 #undef SETINT
 380
 381     DetectImage( f, p_demux );
 382
 383     return VLC_SUCCESS;
 384 }
 385
 386 static int WriteMeta( vlc_object_t *p_this )
 387 {
 388     playlist_t *p_playlist = (playlist_t *)p_this;
 389     meta_export_t *p_export = (meta_export_t *)p_playlist->p_private;
 390     input_item_t *p_item = p_export->p_item;
 391
 392     if( p_item == NULL )
 393     {
 394         msg_Err( p_this, "Can't save meta data of an empty input" );
 395         return VLC_EGENERIC;
 396     }
 397
 398     FileRef f( p_export->psz_file );
 399     if( f.isNull() || !f.tag() || f.file()->readOnly() )
 400     {
 401         msg_Err( p_this, "File %s can't be opened for tag writing\n",
 402             p_export->psz_file );
 403         return VLC_EGENERIC;
 404     }
 405
 406     msg_Dbg( p_this, "Writing metadata for %s", p_export->psz_file );
 407
 408     Tag *p_tag = f.tag();
 409
 410     char *psz_meta;
 411
 412 #define SET(a,b) \
 413         if(b) { \
 414             String *psz_##a = new String( b, \
 415                 String::UTF8 ); \
 416             p_tag->set##a( *psz_##a ); \
 417             delete psz_##a; \
 418         }
 419
 420
 421     psz_meta = input_item_GetArtist( p_item );
 422     SET( Artist, psz_meta );
 423     free( psz_meta );
 424
 425     psz_meta = input_item_GetTitle( p_item );
 426     if( !psz_meta ) psz_meta = input_item_GetName( p_item );
 427     String *psz_title = new String( psz_meta,
 428         String::UTF8 );
 429     p_tag->setTitle( *psz_title );
 430     delete psz_title;
 431     free( psz_meta );
 432
 433     psz_meta = input_item_GetAlbum( p_item );
 434     SET( Album, psz_meta );
 435     free( psz_meta );
 436
 437     psz_meta = input_item_GetGenre( p_item );
 438     SET( Genre, psz_meta );
 439     free( psz_meta );
 440
 441 #undef SET
 442
 443     psz_meta = input_item_GetDate( p_item );
 444     if( psz_meta ) p_tag->setYear( atoi( psz_meta ) );
 445     free( psz_meta );
 446
 447     psz_meta = input_item_GetTrackNum( p_item );
 448     if( psz_meta ) p_tag->setTrack( atoi( psz_meta ) );
 449     free( psz_meta );
 450
 451     if( ID3v2::Tag *p_id3tag =
 452         dynamic_cast<ID3v2::Tag *>(p_tag) )
 453     {
 454 #define WRITE( foo, bar ) \
 455         psz_meta = input_item_Get##foo( p_item ); \
 456         if( psz_meta ) \
 457         { \
 458             ByteVector p_byte( bar, 4 ); \
 459             ID3v2::TextIdentificationFrame p_frame( p_byte ); \
 460             p_frame.setText( psz_meta ); \
 461             p_id3tag->addFrame( &p_frame ); \
 462             free( psz_meta ); \
 463         } \
 464
 465         WRITE( Publisher, "TPUB" );
 466         WRITE( Copyright, "TCOP" );
 467         WRITE( EncodedBy, "TENC" );
 468         WRITE( Language, "TLAN" );
 469
 470 #undef WRITE
 471     }
 472
 473     f.save();
 474     return VLC_SUCCESS;
 475 }
 476
 477 static int DownloadArt( vlc_object_t *p_this )
 478 {
 479     /* We need to be passed the file name
 480      * Fetch the thing from the file, save it to the cache folder
 481      */
 482     return VLC_EGENERIC;
 483 }
 484