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