1 /*****************************************************************************
2 * taglib.cpp: Taglib tag parser/writer
3 *****************************************************************************
4 * Copyright (C) 2003-2006 the VideoLAN team
7 * Authors: Clément Stenac <zorglub@videolan.org>
8 * Rafaël Carré <funman@videolanorg>
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.
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.
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 *****************************************************************************/
29 #include <vlc_common.h>
30 #include <vlc_plugin.h>
31 #include <vlc_playlist.h>
33 #include <vlc_demux.h>
34 #include <vlc_strings.h>
35 #include <vlc_charset.h>
47 #include <textidentificationframe.h>
48 #include <tbytevector.h>
51 #include <attachedpictureframe.h>
52 //#include <oggflacfile.h> /* ogg flac files aren't auto-casted by TagLib */
54 #include <flacproperties.h>
55 #include <vorbisfile.h>
56 #include <vorbisproperties.h>
57 #include <xiphcomment.h>
58 #include <uniquefileidentifierframe.h>
59 #include <textidentificationframe.h>
60 //#include <relativevolumeframe.h> /* parse the tags without TagLib helpers? */
62 static int ReadMeta ( vlc_object_t * );
63 static int DownloadArt ( vlc_object_t * );
64 static int WriteMeta ( vlc_object_t * );
67 set_capability( "meta reader", 1000 );
68 set_callbacks( ReadMeta, NULL );
70 set_capability( "art downloader", 50 );
71 set_callbacks( DownloadArt, NULL );
73 set_capability( "meta writer", 50 );
74 set_callbacks( WriteMeta, NULL );
77 using namespace TagLib;
79 /* Try detecting embedded art */
80 static void DetectImage( FileRef f, demux_t *p_demux )
82 demux_meta_t *p_demux_meta = (demux_meta_t *)p_demux->p_private;
83 vlc_meta_t *p_meta = p_demux_meta->p_meta;
86 /* Preferred type of image
87 * The 21 types are defined in id3v2 standard:
88 * http://www.id3.org/id3v2.4.0-frames */
89 static const int pi_cover_score[] = {
91 5, /* 32x32 PNG image that should be used as the file icon */
92 4, /* File icon of a different size or format. */
93 20, /* Front cover image of the album. */
94 19, /* Back cover image of the album. */
95 13, /* Inside leaflet page of the album. */
96 18, /* Image from the album itself. */
97 17, /* Picture of the lead artist or soloist. */
98 16, /* Picture of the artist or performer. */
99 14, /* Picture of the conductor. */
100 15, /* Picture of the band or orchestra. */
101 9, /* Picture of the composer. */
102 8, /* Picture of the lyricist or text writer. */
103 7, /* Picture of the recording location or studio. */
104 10, /* Picture of the artists during recording. */
105 11, /* Picture of the artists during performance. */
106 6, /* Picture from a movie or video related to the track. */
107 1, /* Picture of a large, coloured fish. */
108 12, /* Illustration related to the track. */
109 3, /* Logo of the band or performer. */
110 2 /* Logo of the publisher (record company). */
113 if( MPEG::File *mpeg = dynamic_cast<MPEG::File *>(f.file() ) )
115 ID3v2::Tag *p_tag = mpeg->ID3v2Tag();
118 ID3v2::FrameList list = p_tag->frameListMap()[ "APIC" ];
121 ID3v2::AttachedPictureFrame *p_apic;
123 TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
124 for( ID3v2::FrameList::Iterator iter = list.begin();
125 iter != list.end(); iter++ )
127 p_apic = dynamic_cast<ID3v2::AttachedPictureFrame*>(*iter);
128 input_attachment_t *p_attachment;
130 const char *psz_name, *psz_mime, *psz_description;
131 ByteVector p_data_taglib; const char *p_data; int i_data;
133 psz_mime = p_apic->mimeType().toCString(true);
134 psz_description = psz_name = p_apic->description().toCString(true);
136 /* some old iTunes version not only sets incorrectly the mime type
137 * or the description of the image,
138 * but also embeds incorrectly the image.
139 * Recent versions seem to behave correctly */
140 if( !strncmp( psz_mime, "PNG", 3 ) ||
141 !strncmp( psz_name, "\xC2\x89PNG", 5 ) )
144 "%s: Invalid picture embedded by broken iTunes version, "
145 "you really shouldn't use this crappy software.",
146 (const char *)f.file()->name() );
150 p_data_taglib = p_apic->picture();
151 p_data = p_data_taglib.data();
152 i_data = p_data_taglib.size();
154 msg_Dbg( p_demux, "Found embedded art: %s (%s) is %i bytes",
155 psz_name, psz_mime, i_data );
157 p_attachment = vlc_input_attachment_New( psz_name, psz_mime,
158 psz_description, p_data, i_data );
159 TAB_APPEND_CAST( (input_attachment_t**),
160 p_demux_meta->i_attachments, p_demux_meta->attachments,
163 if( pi_cover_score[p_apic->type()] > i_score )
165 i_score = pi_cover_score[p_apic->type()];
167 if( asprintf( &psz_url, "attachment://%s",
168 p_attachment->psz_name ) == -1 )
170 vlc_meta_SetArtURL( p_meta, psz_url );
176 if( Ogg::Vorbis::File *oggv = dynamic_cast<Ogg::Vorbis::File *>(f.file() ) )
178 Ogg::XiphComment *p_tag = oggv->tag();
182 StringList mime_list = p_tag->fieldListMap()[ "COVERARTMIME" ];
183 StringList art_list = p_tag->fieldListMap()[ "COVERART" ];
185 /* we support only one cover in ogg/vorbis */
186 if( mime_list.size() != 1 || art_list.size() != 1 )
189 input_attachment_t *p_attachment;
191 const char *psz_name, *psz_mime, *psz_description;
196 psz_mime = mime_list[0].toCString(true);
197 psz_description = "cover";
199 i_data = vlc_b64_decode_binary( &p_data, art_list[0].toCString(true) );
201 msg_Dbg( p_demux, "Found embedded art: %s (%s) is %i bytes",
202 psz_name, psz_mime, i_data );
204 TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
205 p_attachment = vlc_input_attachment_New( psz_name, psz_mime,
206 psz_description, p_data, i_data );
209 TAB_APPEND_CAST( (input_attachment_t**),
210 p_demux_meta->i_attachments, p_demux_meta->attachments,
213 vlc_meta_SetArtURL( p_meta, "attachment://cover" );
217 //flac embedded images are extracted in the flac demuxer
218 else if( FLAC::File *flac =
219 dynamic_cast<FLAC::File *>(f.file() ) )
221 p_tag = flac->ID3v2Tag();
224 ID3v2::FrameList l = p_tag->frameListMap()[ "APIC" ];
227 vlc_meta_SetArtURL( p_meta, "APIC" );
231 /* TagLib doesn't support MP4 file yet */
232 else if( MP4::File *mp4 =
233 dynamic_cast<MP4::File *>( f.file() ) )
236 dynamic_cast<MP4::Tag *>( mp4->tag() );
237 if( mp4tag && mp4tag->cover().size() )
238 vlc_meta_SetArtURL( p_meta, "MP4C" );
243 static int ReadMeta( vlc_object_t *p_this )
245 demux_t *p_demux = (demux_t *)p_this;
246 demux_meta_t *p_demux_meta = (demux_meta_t*)p_demux->p_private;
250 TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
251 p_demux_meta->p_meta = NULL;
253 #if defined(WIN32) || defined (UNDER_CE)
254 if(GetVersion() < 0x80000000)
256 wchar_t wpath[MAX_PATH + 1];
257 if( !MultiByteToWideChar( CP_UTF8, 0, p_demux->psz_path, -1, wpath, MAX_PATH) )
260 wpath[MAX_PATH] = L'0';
261 f = FileRef( wpath );
263 else return VLC_EGENERIC;
265 const char *local_name = ToLocale( p_demux->psz_path );
267 if( local_name == NULL )
270 f = FileRef( local_name );
271 LocaleFree( local_name );
277 if ( !f.tag() || f.tag()->isEmpty() )
280 p_demux_meta->p_meta = p_meta = vlc_meta_New();
281 Tag *p_tag = f.tag();
283 if( MPEG::File *p_mpeg =
284 dynamic_cast<MPEG::File *>(f.file() ) )
286 if( p_mpeg->ID3v2Tag() )
288 ID3v2::Tag *p_tag = p_mpeg->ID3v2Tag();
289 ID3v2::FrameList list = p_tag->frameListMap()["UFID"];
290 ID3v2::UniqueFileIdentifierFrame* p_ufid;
291 for( ID3v2::FrameList::Iterator iter = list.begin();
292 iter != list.end(); iter++ )
294 p_ufid = dynamic_cast<ID3v2::UniqueFileIdentifierFrame*>(*iter);
295 const char *owner = p_ufid->owner().toCString();
296 if (!strcmp( owner, "http://musicbrainz.org" ))
298 /* ID3v2 UFID contains up to 64 bytes binary data
299 * but in our case it will be a '\0'
300 * terminated string */
301 char *psz_ufid = (char*) malloc( 64 );
304 ( j < p_ufid->identifier().size() ) )
305 psz_ufid[j] = p_ufid->identifier()[j++];
307 vlc_meta_SetTrackID( p_meta, psz_ufid );
312 list = p_tag->frameListMap()["TXXX"];
313 ID3v2::UserTextIdentificationFrame* p_txxx;
314 for( ID3v2::FrameList::Iterator iter = list.begin();
315 iter != list.end(); iter++ )
317 p_txxx = dynamic_cast<ID3v2::UserTextIdentificationFrame*>(*iter);
318 const char *psz_desc= p_txxx->description().toCString();
319 vlc_meta_AddExtra( p_meta, psz_desc,
320 p_txxx->fieldList().toString().toCString());
323 list = p_tag->frameListMap()["RVA2"];
324 ID3v2::RelativeVolumeFrame* p_rva2;
325 for( ID3v2::FrameList::Iterator iter = list.begin();
326 iter != list.end(); iter++ )
328 p_rva2 = dynamic_cast<ID3v2::RelativeVolumeFrame*>(*iter);
329 /* TODO: process rva2 frames */
332 list = p_tag->frameList();
335 for( ID3v2::FrameList::Iterator iter = list.begin();
336 iter != list.end(); iter++ )
338 p_t = dynamic_cast<ID3v2::Frame*> (*iter);
339 memcpy( psz_tag, p_t->frameID().data(), 4);
341 #define SET( foo, bar ) if( !strncmp( psz_tag, foo, 4 ) ) \
342 vlc_meta_Set##bar( p_meta, p_t->toString().toCString(true))
343 SET( "TPUB", Publisher );
344 SET( "TCOP", Copyright );
345 SET( "TENC", EncodedBy );
346 SET( "TLAN", Language );
347 //SET( "POPM", Rating ); /* rating needs special handling in id3v2 */
348 //if( !strncmp( psz_tag, "RVA2", 4 ) )
355 else if( Ogg::Vorbis::File *p_ogg_v =
356 dynamic_cast<Ogg::Vorbis::File *>(f.file() ) )
358 int i_ogg_v_length = p_ogg_v->audioProperties()->length();
360 input_thread_t *p_input = (input_thread_t *)
361 vlc_object_find( p_demux,VLC_OBJECT_INPUT, FIND_PARENT );
364 input_item_t *p_item = input_GetItem( p_input );
366 input_item_SetDuration( p_item,
367 (mtime_t) i_ogg_v_length * 1000000 );
368 vlc_object_release( p_input );
372 #if 0 /* at this moment, taglib is unable to detect ogg/flac files
373 * becauses type detection is based on file extension:
378 else if( Ogg::FLAC::File *p_ogg_f =
379 dynamic_cast<Ogg::FLAC::File *>(f.file() ) )
381 long i_ogg_f_length = p_ogg_f->streamLength();
382 input_thread_t *p_input = (input_thread_t *)
383 vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
386 input_item_t *p_item = input_GetItem( p_input );
388 input_item_SetDuration( p_item,
389 (mtime_t) i_ogg_f_length * 1000000 );
390 vlc_object_release( p_input );
394 else if( FLAC::File *p_flac =
395 dynamic_cast<FLAC::File *>(f.file() ) )
397 long i_flac_length = p_flac->audioProperties()->length();
398 input_thread_t *p_input = (input_thread_t *)
399 vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
402 input_item_t *p_item = input_GetItem( p_input );
404 input_item_SetDuration( p_item,
405 (mtime_t) i_flac_length * 1000000 );
406 vlc_object_release( p_input );
410 #define SET( foo, bar ) vlc_meta_Set##foo( p_meta, p_tag->bar ().toCString(true))
411 #define SETINT( foo, bar ) { \
413 snprintf( (char*)psz_tmp, 10, "%d", p_tag->bar() ); \
414 vlc_meta_Set##foo( p_meta, (char*)psz_tmp ); \
418 SET( Artist, artist );
420 SET( Description, comment );
422 SETINT( Date, year );
423 SETINT( Tracknum , track );
427 DetectImage( f, p_demux );
432 static int WriteMeta( vlc_object_t *p_this )
434 playlist_t *p_playlist = (playlist_t *)p_this;
435 meta_export_t *p_export = (meta_export_t *)p_playlist->p_private;
436 input_item_t *p_item = p_export->p_item;
440 msg_Err( p_this, "Can't save meta data of an empty input" );
444 FileRef f( p_export->psz_file );
445 if( f.isNull() || !f.tag() || f.file()->readOnly() )
447 msg_Err( p_this, "File %s can't be opened for tag writing\n",
448 p_export->psz_file );
452 msg_Dbg( p_this, "Writing metadata for %s", p_export->psz_file );
454 Tag *p_tag = f.tag();
460 String *psz_##a = new String( b, \
462 p_tag->set##a( *psz_##a ); \
467 psz_meta = input_item_GetArtist( p_item );
468 SET( Artist, psz_meta );
471 psz_meta = input_item_GetTitle( p_item );
472 if( !psz_meta ) psz_meta = input_item_GetName( p_item );
473 String *psz_title = new String( psz_meta,
475 p_tag->setTitle( *psz_title );
479 psz_meta = input_item_GetAlbum( p_item );
480 SET( Album, psz_meta );
483 psz_meta = input_item_GetGenre( p_item );
484 SET( Genre, psz_meta );
489 psz_meta = input_item_GetDate( p_item );
490 if( psz_meta ) p_tag->setYear( atoi( psz_meta ) );
493 psz_meta = input_item_GetTrackNum( p_item );
494 if( psz_meta ) p_tag->setTrack( atoi( psz_meta ) );
497 if( ID3v2::Tag *p_id3tag =
498 dynamic_cast<ID3v2::Tag *>(p_tag) )
500 #define WRITE( foo, bar ) \
501 psz_meta = input_item_Get##foo( p_item ); \
504 ByteVector p_byte( bar, 4 ); \
505 ID3v2::TextIdentificationFrame p_frame( p_byte ); \
506 p_frame.setText( psz_meta ); \
507 p_id3tag->addFrame( &p_frame ); \
511 WRITE( Publisher, "TPUB" );
512 WRITE( Copyright, "TCOP" );
513 WRITE( EncodedBy, "TENC" );
514 WRITE( Language, "TLAN" );
523 static int DownloadArt( vlc_object_t *p_this )
525 /* We need to be passed the file name
526 * Fetch the thing from the file, save it to the cache folder