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 *****************************************************************************/
30 #include <vlc_playlist.h>
32 #include <vlc_demux.h>
33 #include <vlc_strings.h>
39 #include <textidentificationframe.h>
40 #include <tbytevector.h>
43 #include <attachedpictureframe.h>
44 //#include <oggflacfile.h> /* ogg flac files aren't auto-casted by TagLib */
46 #include <flacproperties.h>
47 #include <vorbisfile.h>
48 #include <vorbisproperties.h>
49 #include <xiphcomment.h>
50 #include <uniquefileidentifierframe.h>
51 #include <textidentificationframe.h>
52 //#include <relativevolumeframe.h> /* parse the tags without TagLib helpers? */
54 static int ReadMeta ( vlc_object_t * );
55 static int DownloadArt ( vlc_object_t * );
56 static int WriteMeta ( vlc_object_t * );
59 set_capability( "meta reader", 1000 );
60 set_callbacks( ReadMeta, NULL );
62 set_capability( "art downloader", 50 );
63 set_callbacks( DownloadArt, NULL );
65 set_capability( "meta writer", 50 );
66 set_callbacks( WriteMeta, NULL );
69 using namespace TagLib;
71 /* Try detecting embedded art */
72 static void DetectImage( FileRef f, demux_t *p_demux )
74 demux_meta_t *p_demux_meta = (demux_meta_t *)p_demux->p_private;
75 vlc_meta_t *p_meta = p_demux_meta->p_meta;
78 /* Preferred type of image
79 * The 21 types are defined in id3v2 standard:
80 * http://www.id3.org/id3v2.4.0-frames */
81 static const int pi_cover_score[] = {
83 5, /* 32x32 PNG image that should be used as the file icon */
84 4, /* File icon of a different size or format. */
85 20, /* Front cover image of the album. */
86 19, /* Back cover image of the album. */
87 13, /* Inside leaflet page of the album. */
88 18, /* Image from the album itself. */
89 17, /* Picture of the lead artist or soloist. */
90 16, /* Picture of the artist or performer. */
91 14, /* Picture of the conductor. */
92 15, /* Picture of the band or orchestra. */
93 9, /* Picture of the composer. */
94 8, /* Picture of the lyricist or text writer. */
95 7, /* Picture of the recording location or studio. */
96 10, /* Picture of the artists during recording. */
97 11, /* Picture of the artists during performance. */
98 6, /* Picture from a movie or video related to the track. */
99 1, /* Picture of a large, coloured fish. */
100 12, /* Illustration related to the track. */
101 3, /* Logo of the band or performer. */
102 2 /* Logo of the publisher (record company). */
105 if( MPEG::File *mpeg = dynamic_cast<MPEG::File *>(f.file() ) )
107 ID3v2::Tag *p_tag = mpeg->ID3v2Tag();
110 ID3v2::FrameList list = p_tag->frameListMap()[ "APIC" ];
113 ID3v2::AttachedPictureFrame *p_apic;
115 TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
116 for( ID3v2::FrameList::Iterator iter = list.begin();
117 iter != list.end(); iter++ )
119 p_apic = dynamic_cast<ID3v2::AttachedPictureFrame*>(*iter);
120 input_attachment_t *p_attachment;
122 const char *psz_name, *psz_mime, *psz_description;
123 ByteVector p_data_taglib; const char *p_data; int i_data;
125 psz_mime = p_apic->mimeType().toCString(true);
127 /* some old iTunes version not only sets incorrectly the mime type
128 * but also embeds incorrectly the image.
129 * Recent versions seem to behave correctly */
130 if( !strncmp( psz_mime, "PNG", 3 ) )
133 "%s: Invalid picture embedded by broken iTunes version",
138 psz_description = p_apic->description().toCString(true);
139 psz_name = psz_description;
141 p_data_taglib = p_apic->picture();
142 p_data = p_data_taglib.data();
143 i_data = p_data_taglib.size();
145 msg_Dbg( p_demux, "Found embedded art: %s (%s) is %i bytes",
146 psz_name, psz_mime, i_data );
148 p_attachment = vlc_input_attachment_New( psz_name, psz_mime,
149 psz_description, p_data, i_data );
150 TAB_APPEND_CAST( (input_attachment_t**),
151 p_demux_meta->i_attachments, p_demux_meta->attachments,
154 if( pi_cover_score[p_apic->type()] > i_score )
156 i_score = pi_cover_score[p_apic->type()];
158 if( asprintf( &psz_url, "attachment://%s",
159 p_attachment->psz_name ) == -1 )
161 vlc_meta_SetArtURL( p_meta, psz_url );
167 if( Ogg::Vorbis::File *oggv = dynamic_cast<Ogg::Vorbis::File *>(f.file() ) )
169 Ogg::XiphComment *p_tag = oggv->tag();
173 StringList mime_list = p_tag->fieldListMap()[ "COVERARTMIME" ];
174 StringList art_list = p_tag->fieldListMap()[ "COVERART" ];
176 /* we support only one cover in ogg/vorbis */
177 if( mime_list.size() != 1 || art_list.size() != 1 )
180 input_attachment_t *p_attachment;
182 const char *psz_name, *psz_mime, *psz_description;
187 psz_mime = mime_list[0].toCString(true);
188 psz_description = "cover";
190 i_data = vlc_b64_decode_binary( &p_data, art_list[0].toCString(true) );
192 msg_Dbg( p_demux, "Found embedded art: %s (%s) is %i bytes",
193 psz_name, psz_mime, i_data );
195 TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
196 p_attachment = vlc_input_attachment_New( psz_name, psz_mime,
197 psz_description, p_data, i_data );
200 TAB_APPEND_CAST( (input_attachment_t**),
201 p_demux_meta->i_attachments, p_demux_meta->attachments,
204 vlc_meta_SetArtURL( p_meta, "attachment://cover" );
208 //flac embedded images are extracted in the flac demuxer
209 else if( FLAC::File *flac =
210 dynamic_cast<FLAC::File *>(f.file() ) )
212 p_tag = flac->ID3v2Tag();
215 ID3v2::FrameList l = p_tag->frameListMap()[ "APIC" ];
218 vlc_meta_SetArtURL( p_meta, "APIC" );
222 /* TagLib doesn't support MP4 file yet */
223 else if( MP4::File *mp4 =
224 dynamic_cast<MP4::File *>( f.file() ) )
227 dynamic_cast<MP4::Tag *>( mp4->tag() );
228 if( mp4tag && mp4tag->cover().size() )
229 vlc_meta_SetArtURL( p_meta, "MP4C" );
234 static int ReadMeta( vlc_object_t *p_this )
236 demux_t *p_demux = (demux_t *)p_this;
237 demux_meta_t *p_demux_meta = (demux_meta_t*)p_demux->p_private;
240 TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
241 p_demux_meta->p_meta = NULL;
243 FileRef f( p_demux->psz_path );
247 if ( !f.tag() || f.tag()->isEmpty() )
250 p_demux_meta->p_meta = p_meta = vlc_meta_New();
251 Tag *p_tag = f.tag();
253 if( MPEG::File *p_mpeg =
254 dynamic_cast<MPEG::File *>(f.file() ) )
256 if( p_mpeg->ID3v2Tag() )
258 ID3v2::Tag *p_tag = p_mpeg->ID3v2Tag();
259 ID3v2::FrameList list = p_tag->frameListMap()["UFID"];
260 ID3v2::UniqueFileIdentifierFrame* p_ufid;
261 for( ID3v2::FrameList::Iterator iter = list.begin();
262 iter != list.end(); iter++ )
264 p_ufid = dynamic_cast<ID3v2::UniqueFileIdentifierFrame*>(*iter);
265 const char *owner = p_ufid->owner().toCString();
266 if (!strcmp( owner, "http://musicbrainz.org" ))
268 /* ID3v2 UFID contains up to 64 bytes binary data
269 * but in our case it will be a '\0'
270 * terminated string */
271 char *psz_ufid = (char*) malloc( 64 );
274 ( j < p_ufid->identifier().size() ) )
275 psz_ufid[j] = p_ufid->identifier()[j++];
277 vlc_meta_SetTrackID( p_meta, psz_ufid );
282 list = p_tag->frameListMap()["TXXX"];
283 ID3v2::UserTextIdentificationFrame* p_txxx;
284 for( ID3v2::FrameList::Iterator iter = list.begin();
285 iter != list.end(); iter++ )
287 p_txxx = dynamic_cast<ID3v2::UserTextIdentificationFrame*>(*iter);
288 const char *psz_desc= p_txxx->description().toCString();
289 vlc_meta_AddExtra( p_meta, psz_desc,
290 p_txxx->fieldList().toString().toCString());
293 list = p_tag->frameListMap()["RVA2"];
294 ID3v2::RelativeVolumeFrame* p_rva2;
295 for( ID3v2::FrameList::Iterator iter = list.begin();
296 iter != list.end(); iter++ )
298 p_rva2 = dynamic_cast<ID3v2::RelativeVolumeFrame*>(*iter);
299 /* TODO: process rva2 frames */
302 list = p_tag->frameList();
305 for( ID3v2::FrameList::Iterator iter = list.begin();
306 iter != list.end(); iter++ )
308 p_t = dynamic_cast<ID3v2::Frame*> (*iter);
309 memcpy( psz_tag, p_t->frameID().data(), 4);
311 #define SET( foo, bar ) if( !strncmp( psz_tag, foo, 4 ) ) \
312 vlc_meta_Set##bar( p_meta, p_t->toString().toCString(true))
313 SET( "TPUB", Publisher );
314 SET( "TCOP", Copyright );
315 SET( "TENC", EncodedBy );
316 SET( "TLAN", Language );
317 //SET( "POPM", Rating ); /* rating needs special handling in id3v2 */
318 //if( !strncmp( psz_tag, "RVA2", 4 ) )
325 else if( Ogg::Vorbis::File *p_ogg_v =
326 dynamic_cast<Ogg::Vorbis::File *>(f.file() ) )
328 int i_ogg_v_length = p_ogg_v->audioProperties()->length();
330 input_thread_t *p_input = (input_thread_t *)
331 vlc_object_find( p_demux,VLC_OBJECT_INPUT, FIND_PARENT );
334 input_item_t *p_item = input_GetItem( p_input );
336 input_item_SetDuration( p_item,
337 (mtime_t) i_ogg_v_length * 1000000 );
338 vlc_object_release( p_input );
342 #if 0 /* at this moment, taglib is unable to detect ogg/flac files
343 * becauses type detection is based on file extension:
348 else if( Ogg::FLAC::File *p_ogg_f =
349 dynamic_cast<Ogg::FLAC::File *>(f.file() ) )
351 long i_ogg_f_length = p_ogg_f->streamLength();
352 input_thread_t *p_input = (input_thread_t *)
353 vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
356 input_item_t *p_item = input_GetItem( p_input );
358 input_item_SetDuration( p_item,
359 (mtime_t) i_ogg_f_length * 1000000 );
360 vlc_object_release( p_input );
364 else if( FLAC::File *p_flac =
365 dynamic_cast<FLAC::File *>(f.file() ) )
367 long i_flac_length = p_flac->audioProperties()->length();
368 input_thread_t *p_input = (input_thread_t *)
369 vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
372 input_item_t *p_item = input_GetItem( p_input );
374 input_item_SetDuration( p_item,
375 (mtime_t) i_flac_length * 1000000 );
376 vlc_object_release( p_input );
380 #define SET( foo, bar ) vlc_meta_Set##foo( p_meta, p_tag->bar ().toCString(true))
381 #define SETINT( foo, bar ) { \
383 snprintf( (char*)psz_tmp, 10, "%d", p_tag->bar() ); \
384 vlc_meta_Set##foo( p_meta, (char*)psz_tmp ); \
388 SET( Artist, artist );
390 SET( Description, comment );
392 SETINT( Date, year );
393 SETINT( Tracknum , track );
397 DetectImage( f, p_demux );
402 static int WriteMeta( vlc_object_t *p_this )
404 playlist_t *p_playlist = (playlist_t *)p_this;
405 meta_export_t *p_export = (meta_export_t *)p_playlist->p_private;
406 input_item_t *p_item = p_export->p_item;
410 msg_Err( p_this, "Can't save meta data of an empty input" );
414 FileRef f( p_export->psz_file );
415 if( f.isNull() || !f.tag() || f.file()->readOnly() )
417 msg_Err( p_this, "File %s can't be opened for tag writing\n",
418 p_export->psz_file );
422 msg_Dbg( p_this, "Writing metadata for %s", p_export->psz_file );
424 Tag *p_tag = f.tag();
430 String *psz_##a = new String( b, \
432 p_tag->set##a( *psz_##a ); \
437 psz_meta = input_item_GetArtist( p_item );
438 SET( Artist, psz_meta );
441 psz_meta = input_item_GetTitle( p_item );
442 if( !psz_meta ) psz_meta = input_item_GetName( p_item );
443 String *psz_title = new String( psz_meta,
445 p_tag->setTitle( *psz_title );
449 psz_meta = input_item_GetAlbum( p_item );
450 SET( Album, psz_meta );
453 psz_meta = input_item_GetGenre( p_item );
454 SET( Genre, psz_meta );
459 psz_meta = input_item_GetDate( p_item );
460 if( psz_meta ) p_tag->setYear( atoi( psz_meta ) );
463 psz_meta = input_item_GetTrackNum( p_item );
464 if( psz_meta ) p_tag->setTrack( atoi( psz_meta ) );
467 if( ID3v2::Tag *p_id3tag =
468 dynamic_cast<ID3v2::Tag *>(p_tag) )
470 #define WRITE( foo, bar ) \
471 psz_meta = input_item_Get##foo( p_item ); \
474 ByteVector p_byte( bar, 4 ); \
475 ID3v2::TextIdentificationFrame p_frame( p_byte ); \
476 p_frame.setText( psz_meta ); \
477 p_id3tag->addFrame( &p_frame ); \
481 WRITE( Publisher, "TPUB" );
482 WRITE( Copyright, "TCOP" );
483 WRITE( EncodedBy, "TENC" );
484 WRITE( Language, "TLAN" );
493 static int DownloadArt( vlc_object_t *p_this )
495 /* We need to be passed the file name
496 * Fetch the thing from the file, save it to the cache folder