Include vlc_plugin.h as needed
[vlc.git] / 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
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 ) )
132             {
133                 msg_Warn( p_demux,
134                     "%s: Invalid picture embedded by broken iTunes version",
135                     f.file()->name() );
136                 break;
137             }
138
139             psz_description = p_apic->description().toCString(true);
140             psz_name = psz_description;
141
142             p_data_taglib = p_apic->picture();
143             p_data = p_data_taglib.data();
144             i_data = p_data_taglib.size();
145
146             msg_Dbg( p_demux, "Found embedded art: %s (%s) is %i bytes",
147                     psz_name, psz_mime, i_data );
148
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,
153                     p_attachment );
154
155             if( pi_cover_score[p_apic->type()] > i_score )
156             {
157                 i_score = pi_cover_score[p_apic->type()];
158                 char *psz_url;
159                 if( asprintf( &psz_url, "attachment://%s",
160                         p_attachment->psz_name ) == -1 )
161                     return;
162                 vlc_meta_SetArtURL( p_meta, psz_url );
163                 free( psz_url );
164             }
165         }
166     }
167     else
168     if( Ogg::Vorbis::File *oggv = dynamic_cast<Ogg::Vorbis::File *>(f.file() ) )
169     {
170         Ogg::XiphComment *p_tag = oggv->tag();
171         if( !p_tag )
172             return;
173
174         StringList mime_list = p_tag->fieldListMap()[ "COVERARTMIME" ];
175         StringList art_list = p_tag->fieldListMap()[ "COVERART" ];
176
177         /* we support only one cover in ogg/vorbis */
178         if( mime_list.size() != 1 || art_list.size() != 1 )
179             return;
180
181         input_attachment_t *p_attachment;
182
183         const char *psz_name, *psz_mime, *psz_description;
184         uint8_t *p_data;
185         int i_data;
186
187         psz_name = "cover";
188         psz_mime = mime_list[0].toCString(true);
189         psz_description = "cover";
190
191         i_data = vlc_b64_decode_binary( &p_data, art_list[0].toCString(true) );
192
193         msg_Dbg( p_demux, "Found embedded art: %s (%s) is %i bytes",
194                     psz_name, psz_mime, i_data );
195
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 );
199         free( p_data );
200
201         TAB_APPEND_CAST( (input_attachment_t**),
202                 p_demux_meta->i_attachments, p_demux_meta->attachments,
203                 p_attachment );
204
205         vlc_meta_SetArtURL( p_meta, "attachment://cover" );
206     }
207
208 #if 0
209     //flac embedded images are extracted in the flac demuxer
210     else if( FLAC::File *flac =
211              dynamic_cast<FLAC::File *>(f.file() ) )
212     {
213         p_tag = flac->ID3v2Tag();
214         if( p_tag )
215             return;
216         ID3v2::FrameList l = p_tag->frameListMap()[ "APIC" ];
217         if( l.isEmpty() )
218             return;
219             vlc_meta_SetArtURL( p_meta, "APIC" );
220     }
221 #endif
222 #if 0
223 /* TagLib doesn't support MP4 file yet */
224     else if( MP4::File *mp4 =
225                dynamic_cast<MP4::File *>( f.file() ) )
226     {
227         MP4::Tag *mp4tag =
228                 dynamic_cast<MP4::Tag *>( mp4->tag() );
229         if( mp4tag && mp4tag->cover().size() )
230             vlc_meta_SetArtURL( p_meta, "MP4C" );
231     }
232 #endif
233 }
234
235 static int ReadMeta( vlc_object_t *p_this )
236 {
237     demux_t         *p_demux = (demux_t *)p_this;
238     demux_meta_t    *p_demux_meta = (demux_meta_t*)p_demux->p_private;
239     vlc_meta_t      *p_meta;
240
241     TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
242     p_demux_meta->p_meta = NULL;
243
244     FileRef f( p_demux->psz_path );
245     if( f.isNull() )
246         return VLC_EGENERIC;
247
248     if ( !f.tag() || f.tag()->isEmpty() )
249         return VLC_EGENERIC;
250
251     p_demux_meta->p_meta = p_meta = vlc_meta_New();
252     Tag *p_tag = f.tag();
253
254     if( MPEG::File *p_mpeg =
255         dynamic_cast<MPEG::File *>(f.file() ) )
256     {
257         if( p_mpeg->ID3v2Tag() )
258         {
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++ )
264             {
265                 p_ufid = dynamic_cast<ID3v2::UniqueFileIdentifierFrame*>(*iter);
266                 const char *owner = p_ufid->owner().toCString();
267                 if (!strcmp( owner, "http://musicbrainz.org" ))
268                 {
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 );
273                     int j = 0;
274                     while( ( j < 63 ) &&
275                             ( j < p_ufid->identifier().size() ) )
276                         psz_ufid[j] = p_ufid->identifier()[j++];
277                     psz_ufid[j] = '\0';
278                     vlc_meta_SetTrackID( p_meta, psz_ufid );
279                     free( psz_ufid );
280                 }
281             }
282
283             list = p_tag->frameListMap()["TXXX"];
284             ID3v2::UserTextIdentificationFrame* p_txxx;
285             for( ID3v2::FrameList::Iterator iter = list.begin();
286                     iter != list.end(); iter++ )
287             {
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());
292             }
293 #if 0
294             list = p_tag->frameListMap()["RVA2"];
295             ID3v2::RelativeVolumeFrame* p_rva2;
296             for( ID3v2::FrameList::Iterator iter = list.begin();
297                     iter != list.end(); iter++ )
298             {
299                 p_rva2 = dynamic_cast<ID3v2::RelativeVolumeFrame*>(*iter);
300                 /* TODO: process rva2 frames */
301             }
302 #endif
303             list = p_tag->frameList();
304             ID3v2::Frame* p_t;
305             char psz_tag[4];
306             for( ID3v2::FrameList::Iterator iter = list.begin();
307                     iter != list.end(); iter++ )
308             {
309                 p_t = dynamic_cast<ID3v2::Frame*> (*iter);
310                 memcpy( psz_tag, p_t->frameID().data(), 4);
311
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 ) )
320                     /* TODO */
321 #undef SET
322             }
323         }
324     }
325
326     else if( Ogg::Vorbis::File *p_ogg_v =
327         dynamic_cast<Ogg::Vorbis::File *>(f.file() ) )
328     {
329         int i_ogg_v_length = p_ogg_v->audioProperties()->length();
330
331         input_thread_t *p_input = (input_thread_t *)
332                 vlc_object_find( p_demux,VLC_OBJECT_INPUT, FIND_PARENT );
333         if( p_input )
334         {
335             input_item_t *p_item = input_GetItem( p_input );
336             if( p_item )
337                 input_item_SetDuration( p_item,
338                         (mtime_t) i_ogg_v_length * 1000000 );
339             vlc_object_release( p_input );
340         }
341
342     }
343 #if 0 /* at this moment, taglib is unable to detect ogg/flac files
344 * becauses type detection is based on file extension:
345 * ogg = ogg/vorbis
346 * flac = flac
347 * ø = ogg/flac
348 */
349     else if( Ogg::FLAC::File *p_ogg_f =
350         dynamic_cast<Ogg::FLAC::File *>(f.file() ) )
351     {
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 );
355         if( p_input )
356         {
357             input_item_t *p_item = input_GetItem( p_input );
358             if( p_item )
359                 input_item_SetDuration( p_item,
360                         (mtime_t) i_ogg_f_length * 1000000 );
361             vlc_object_release( p_input );
362         }
363     }
364 #endif
365     else if( FLAC::File *p_flac =
366         dynamic_cast<FLAC::File *>(f.file() ) )
367     {
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 );
371         if( p_input )
372         {
373             input_item_t *p_item = input_GetItem( p_input );
374             if( p_item )
375                 input_item_SetDuration( p_item,
376                         (mtime_t) i_flac_length * 1000000 );
377             vlc_object_release( p_input );
378         }
379     }
380
381 #define SET( foo, bar ) vlc_meta_Set##foo( p_meta, p_tag->bar ().toCString(true))
382 #define SETINT( foo, bar ) { \
383         char psz_tmp[10]; \
384         snprintf( (char*)psz_tmp, 10, "%d", p_tag->bar() ); \
385         vlc_meta_Set##foo( p_meta, (char*)psz_tmp ); \
386     }
387
388     SET( Title, title );
389     SET( Artist, artist );
390     SET( Album, album );
391     SET( Description, comment );
392     SET( Genre, genre );
393     SETINT( Date, year );
394     SETINT( Tracknum , track );
395 #undef SET
396 #undef SETINT
397
398     DetectImage( f, p_demux );
399
400     return VLC_SUCCESS;
401 }
402
403 static int WriteMeta( vlc_object_t *p_this )
404 {
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;
408
409     if( p_item == NULL )
410     {
411         msg_Err( p_this, "Can't save meta data of an empty input" );
412         return VLC_EGENERIC;
413     }
414
415     FileRef f( p_export->psz_file );
416     if( f.isNull() || !f.tag() || f.file()->readOnly() )
417     {
418         msg_Err( p_this, "File %s can't be opened for tag writing\n",
419             p_export->psz_file );
420         return VLC_EGENERIC;
421     }
422
423     msg_Dbg( p_this, "Writing metadata for %s", p_export->psz_file );
424
425     Tag *p_tag = f.tag();
426
427     char *psz_meta;
428
429 #define SET(a,b) \
430         if(b) { \
431             String *psz_##a = new String( b, \
432                 String::UTF8 ); \
433             p_tag->set##a( *psz_##a ); \
434             delete psz_##a; \
435         }
436
437
438     psz_meta = input_item_GetArtist( p_item );
439     SET( Artist, psz_meta );
440     free( psz_meta );
441
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,
445         String::UTF8 );
446     p_tag->setTitle( *psz_title );
447     delete psz_title;
448     free( psz_meta );
449
450     psz_meta = input_item_GetAlbum( p_item );
451     SET( Album, psz_meta );
452     free( psz_meta );
453
454     psz_meta = input_item_GetGenre( p_item );
455     SET( Genre, psz_meta );
456     free( psz_meta );
457
458 #undef SET
459
460     psz_meta = input_item_GetDate( p_item );
461     if( psz_meta ) p_tag->setYear( atoi( psz_meta ) );
462     free( psz_meta );
463
464     psz_meta = input_item_GetTrackNum( p_item );
465     if( psz_meta ) p_tag->setTrack( atoi( psz_meta ) );
466     free( psz_meta );
467
468     if( ID3v2::Tag *p_id3tag =
469         dynamic_cast<ID3v2::Tag *>(p_tag) )
470     {
471 #define WRITE( foo, bar ) \
472         psz_meta = input_item_Get##foo( p_item ); \
473         if( psz_meta ) \
474         { \
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 ); \
479             free( psz_meta ); \
480         } \
481
482         WRITE( Publisher, "TPUB" );
483         WRITE( Copyright, "TCOP" );
484         WRITE( EncodedBy, "TENC" );
485         WRITE( Language, "TLAN" );
486
487 #undef WRITE
488     }
489
490     f.save();
491     return VLC_SUCCESS;
492 }
493
494 static int DownloadArt( vlc_object_t *p_this )
495 {
496     /* We need to be passed the file name
497      * Fetch the thing from the file, save it to the cache folder
498      */
499     return VLC_EGENERIC;
500 }
501