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_plugin.h>
31 #include <vlc_playlist.h>
33 #include <vlc_demux.h>
34 #include <vlc_strings.h>
40 #include <textidentificationframe.h>
41 #include <tbytevector.h>
44 #include <attachedpictureframe.h>
45 //#include <oggflacfile.h> /* ogg flac files aren't auto-casted by TagLib */
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? */
55 static int ReadMeta ( vlc_object_t * );
56 static int DownloadArt ( vlc_object_t * );
57 static int WriteMeta ( vlc_object_t * );
60 set_capability( "meta reader", 1000 );
61 set_callbacks( ReadMeta, NULL );
63 set_capability( "art downloader", 50 );
64 set_callbacks( DownloadArt, NULL );
66 set_capability( "meta writer", 50 );
67 set_callbacks( WriteMeta, NULL );
70 using namespace TagLib;
72 /* Try detecting embedded art */
73 static void DetectImage( FileRef f, demux_t *p_demux )
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;
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[] = {
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). */
106 if( MPEG::File *mpeg = dynamic_cast<MPEG::File *>(f.file() ) )
108 ID3v2::Tag *p_tag = mpeg->ID3v2Tag();
111 ID3v2::FrameList list = p_tag->frameListMap()[ "APIC" ];
114 ID3v2::AttachedPictureFrame *p_apic;
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++ )
120 p_apic = dynamic_cast<ID3v2::AttachedPictureFrame*>(*iter);
121 input_attachment_t *p_attachment;
123 const char *psz_name, *psz_mime, *psz_description;
124 ByteVector p_data_taglib; const char *p_data; int i_data;
126 psz_mime = p_apic->mimeType().toCString(true);
128 /* some old iTunes version not only sets incorrectly the mime type
129 * but also embeds incorrectly the image.
130 * Recent versions seem to behave correctly */
131 if( !strncmp( psz_mime, "PNG", 3 ) )
134 "%s: Invalid picture embedded by broken iTunes version",
139 psz_description = p_apic->description().toCString(true);
140 psz_name = psz_description;
142 p_data_taglib = p_apic->picture();
143 p_data = p_data_taglib.data();
144 i_data = p_data_taglib.size();
146 msg_Dbg( p_demux, "Found embedded art: %s (%s) is %i bytes",
147 psz_name, psz_mime, i_data );
149 p_attachment = vlc_input_attachment_New( psz_name, psz_mime,
150 psz_description, p_data, i_data );
151 TAB_APPEND_CAST( (input_attachment_t**),
152 p_demux_meta->i_attachments, p_demux_meta->attachments,
155 if( pi_cover_score[p_apic->type()] > i_score )
157 i_score = pi_cover_score[p_apic->type()];
159 if( asprintf( &psz_url, "attachment://%s",
160 p_attachment->psz_name ) == -1 )
162 vlc_meta_SetArtURL( p_meta, psz_url );
168 if( Ogg::Vorbis::File *oggv = dynamic_cast<Ogg::Vorbis::File *>(f.file() ) )
170 Ogg::XiphComment *p_tag = oggv->tag();
174 StringList mime_list = p_tag->fieldListMap()[ "COVERARTMIME" ];
175 StringList art_list = p_tag->fieldListMap()[ "COVERART" ];
177 /* we support only one cover in ogg/vorbis */
178 if( mime_list.size() != 1 || art_list.size() != 1 )
181 input_attachment_t *p_attachment;
183 const char *psz_name, *psz_mime, *psz_description;
188 psz_mime = mime_list[0].toCString(true);
189 psz_description = "cover";
191 i_data = vlc_b64_decode_binary( &p_data, art_list[0].toCString(true) );
193 msg_Dbg( p_demux, "Found embedded art: %s (%s) is %i bytes",
194 psz_name, psz_mime, i_data );
196 TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
197 p_attachment = vlc_input_attachment_New( psz_name, psz_mime,
198 psz_description, p_data, i_data );
201 TAB_APPEND_CAST( (input_attachment_t**),
202 p_demux_meta->i_attachments, p_demux_meta->attachments,
205 vlc_meta_SetArtURL( p_meta, "attachment://cover" );
209 //flac embedded images are extracted in the flac demuxer
210 else if( FLAC::File *flac =
211 dynamic_cast<FLAC::File *>(f.file() ) )
213 p_tag = flac->ID3v2Tag();
216 ID3v2::FrameList l = p_tag->frameListMap()[ "APIC" ];
219 vlc_meta_SetArtURL( p_meta, "APIC" );
223 /* TagLib doesn't support MP4 file yet */
224 else if( MP4::File *mp4 =
225 dynamic_cast<MP4::File *>( f.file() ) )
228 dynamic_cast<MP4::Tag *>( mp4->tag() );
229 if( mp4tag && mp4tag->cover().size() )
230 vlc_meta_SetArtURL( p_meta, "MP4C" );
235 static int ReadMeta( vlc_object_t *p_this )
237 demux_t *p_demux = (demux_t *)p_this;
238 demux_meta_t *p_demux_meta = (demux_meta_t*)p_demux->p_private;
241 TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
242 p_demux_meta->p_meta = NULL;
244 FileRef f( p_demux->psz_path );
248 if ( !f.tag() || f.tag()->isEmpty() )
251 p_demux_meta->p_meta = p_meta = vlc_meta_New();
252 Tag *p_tag = f.tag();
254 if( MPEG::File *p_mpeg =
255 dynamic_cast<MPEG::File *>(f.file() ) )
257 if( p_mpeg->ID3v2Tag() )
259 ID3v2::Tag *p_tag = p_mpeg->ID3v2Tag();
260 ID3v2::FrameList list = p_tag->frameListMap()["UFID"];
261 ID3v2::UniqueFileIdentifierFrame* p_ufid;
262 for( ID3v2::FrameList::Iterator iter = list.begin();
263 iter != list.end(); iter++ )
265 p_ufid = dynamic_cast<ID3v2::UniqueFileIdentifierFrame*>(*iter);
266 const char *owner = p_ufid->owner().toCString();
267 if (!strcmp( owner, "http://musicbrainz.org" ))
269 /* ID3v2 UFID contains up to 64 bytes binary data
270 * but in our case it will be a '\0'
271 * terminated string */
272 char *psz_ufid = (char*) malloc( 64 );
275 ( j < p_ufid->identifier().size() ) )
276 psz_ufid[j] = p_ufid->identifier()[j++];
278 vlc_meta_SetTrackID( p_meta, psz_ufid );
283 list = p_tag->frameListMap()["TXXX"];
284 ID3v2::UserTextIdentificationFrame* p_txxx;
285 for( ID3v2::FrameList::Iterator iter = list.begin();
286 iter != list.end(); iter++ )
288 p_txxx = dynamic_cast<ID3v2::UserTextIdentificationFrame*>(*iter);
289 const char *psz_desc= p_txxx->description().toCString();
290 vlc_meta_AddExtra( p_meta, psz_desc,
291 p_txxx->fieldList().toString().toCString());
294 list = p_tag->frameListMap()["RVA2"];
295 ID3v2::RelativeVolumeFrame* p_rva2;
296 for( ID3v2::FrameList::Iterator iter = list.begin();
297 iter != list.end(); iter++ )
299 p_rva2 = dynamic_cast<ID3v2::RelativeVolumeFrame*>(*iter);
300 /* TODO: process rva2 frames */
303 list = p_tag->frameList();
306 for( ID3v2::FrameList::Iterator iter = list.begin();
307 iter != list.end(); iter++ )
309 p_t = dynamic_cast<ID3v2::Frame*> (*iter);
310 memcpy( psz_tag, p_t->frameID().data(), 4);
312 #define SET( foo, bar ) if( !strncmp( psz_tag, foo, 4 ) ) \
313 vlc_meta_Set##bar( p_meta, p_t->toString().toCString(true))
314 SET( "TPUB", Publisher );
315 SET( "TCOP", Copyright );
316 SET( "TENC", EncodedBy );
317 SET( "TLAN", Language );
318 //SET( "POPM", Rating ); /* rating needs special handling in id3v2 */
319 //if( !strncmp( psz_tag, "RVA2", 4 ) )
326 else if( Ogg::Vorbis::File *p_ogg_v =
327 dynamic_cast<Ogg::Vorbis::File *>(f.file() ) )
329 int i_ogg_v_length = p_ogg_v->audioProperties()->length();
331 input_thread_t *p_input = (input_thread_t *)
332 vlc_object_find( p_demux,VLC_OBJECT_INPUT, FIND_PARENT );
335 input_item_t *p_item = input_GetItem( p_input );
337 input_item_SetDuration( p_item,
338 (mtime_t) i_ogg_v_length * 1000000 );
339 vlc_object_release( p_input );
343 #if 0 /* at this moment, taglib is unable to detect ogg/flac files
344 * becauses type detection is based on file extension:
349 else if( Ogg::FLAC::File *p_ogg_f =
350 dynamic_cast<Ogg::FLAC::File *>(f.file() ) )
352 long i_ogg_f_length = p_ogg_f->streamLength();
353 input_thread_t *p_input = (input_thread_t *)
354 vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
357 input_item_t *p_item = input_GetItem( p_input );
359 input_item_SetDuration( p_item,
360 (mtime_t) i_ogg_f_length * 1000000 );
361 vlc_object_release( p_input );
365 else if( FLAC::File *p_flac =
366 dynamic_cast<FLAC::File *>(f.file() ) )
368 long i_flac_length = p_flac->audioProperties()->length();
369 input_thread_t *p_input = (input_thread_t *)
370 vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
373 input_item_t *p_item = input_GetItem( p_input );
375 input_item_SetDuration( p_item,
376 (mtime_t) i_flac_length * 1000000 );
377 vlc_object_release( p_input );
381 #define SET( foo, bar ) vlc_meta_Set##foo( p_meta, p_tag->bar ().toCString(true))
382 #define SETINT( foo, bar ) { \
384 snprintf( (char*)psz_tmp, 10, "%d", p_tag->bar() ); \
385 vlc_meta_Set##foo( p_meta, (char*)psz_tmp ); \
389 SET( Artist, artist );
391 SET( Description, comment );
393 SETINT( Date, year );
394 SETINT( Tracknum , track );
398 DetectImage( f, p_demux );
403 static int WriteMeta( vlc_object_t *p_this )
405 playlist_t *p_playlist = (playlist_t *)p_this;
406 meta_export_t *p_export = (meta_export_t *)p_playlist->p_private;
407 input_item_t *p_item = p_export->p_item;
411 msg_Err( p_this, "Can't save meta data of an empty input" );
415 FileRef f( p_export->psz_file );
416 if( f.isNull() || !f.tag() || f.file()->readOnly() )
418 msg_Err( p_this, "File %s can't be opened for tag writing\n",
419 p_export->psz_file );
423 msg_Dbg( p_this, "Writing metadata for %s", p_export->psz_file );
425 Tag *p_tag = f.tag();
431 String *psz_##a = new String( b, \
433 p_tag->set##a( *psz_##a ); \
438 psz_meta = input_item_GetArtist( p_item );
439 SET( Artist, psz_meta );
442 psz_meta = input_item_GetTitle( p_item );
443 if( !psz_meta ) psz_meta = input_item_GetName( p_item );
444 String *psz_title = new String( psz_meta,
446 p_tag->setTitle( *psz_title );
450 psz_meta = input_item_GetAlbum( p_item );
451 SET( Album, psz_meta );
454 psz_meta = input_item_GetGenre( p_item );
455 SET( Genre, psz_meta );
460 psz_meta = input_item_GetDate( p_item );
461 if( psz_meta ) p_tag->setYear( atoi( psz_meta ) );
464 psz_meta = input_item_GetTrackNum( p_item );
465 if( psz_meta ) p_tag->setTrack( atoi( psz_meta ) );
468 if( ID3v2::Tag *p_id3tag =
469 dynamic_cast<ID3v2::Tag *>(p_tag) )
471 #define WRITE( foo, bar ) \
472 psz_meta = input_item_Get##foo( p_item ); \
475 ByteVector p_byte( bar, 4 ); \
476 ID3v2::TextIdentificationFrame p_frame( p_byte ); \
477 p_frame.setText( psz_meta ); \
478 p_id3tag->addFrame( &p_frame ); \
482 WRITE( Publisher, "TPUB" );
483 WRITE( Copyright, "TCOP" );
484 WRITE( EncodedBy, "TENC" );
485 WRITE( Language, "TLAN" );
494 static int DownloadArt( vlc_object_t *p_this )
496 /* We need to be passed the file name
497 * Fetch the thing from the file, save it to the cache folder