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