taglib.cpp 11.8 KB
Newer Older
1
2
3
4
/*****************************************************************************
 * taglib.cpp: Taglib tag parser/writer
 *****************************************************************************
 * Copyright (C) 2003-2006 the VideoLAN team
dionoea's avatar
dionoea committed
5
 * $Id$
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 *
 * Authors: Clément Stenac <zorglub@videolan.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/
23

24
#include <vlc/vlc.h>
25
#include <vlc_playlist.h>
26
#include <vlc_meta.h>
zorglub's avatar
zorglub committed
27
#include <vlc_demux.h>
28
29
30

#include <fileref.h>
#include <tag.h>
31
#include <tstring.h>
zorglub's avatar
zorglub committed
32
33
#include <id3v2tag.h>
#include <mpegfile.h>
34
#include <flacfile.h>
35
36
37
38
39
40
41
#if 0
#include <oggflacfile.h>
#endif
#include <flacfile.h>
#include <flacproperties.h>
#include <vorbisfile.h>
#include <vorbisproperties.h>
42
43
#include <uniquefileidentifierframe.h>
#include <textidentificationframe.h>
Rafaël Carré's avatar
Rafaël Carré committed
44
45
46
#if 0 /* parse the tags without taglib helpers? */
#include <relativevolumeframe.h>
#endif
47

48
49
50
static int  ReadMeta    ( vlc_object_t * );
static int  DownloadArt ( vlc_object_t * );
static int  WriteMeta   ( vlc_object_t * );
51
52
53
54

vlc_module_begin();
    set_capability( "meta reader", 1000 );
    set_callbacks( ReadMeta, NULL );
55
56
57
58
59
60
    add_submodule();
        set_capability( "art downloader", 50 );
        set_callbacks( DownloadArt, NULL );
    add_submodule();
        set_capability( "meta writer", 50 );
        set_callbacks( WriteMeta, NULL );
61
vlc_module_end();
zorglub's avatar
zorglub committed
62

63
static bool checkID3Image( const TagLib::ID3v2::Tag *tag )
zorglub's avatar
zorglub committed
64
65
66
67
68
{
    TagLib::ID3v2::FrameList l = tag->frameListMap()[ "APIC" ];
    return !l.isEmpty();
}

69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
/* Try detecting embedded art */
static void DetectImage( TagLib::FileRef f, vlc_meta_t *p_meta )
{
    if( TagLib::MPEG::File *mpeg =
               dynamic_cast<TagLib::MPEG::File *>(f.file() ) )
    {
        if( mpeg->ID3v2Tag() && checkID3Image( mpeg->ID3v2Tag() ) )
            vlc_meta_SetArtURL( p_meta, "APIC" );
    }
    else if( TagLib::FLAC::File *flac =
             dynamic_cast<TagLib::FLAC::File *>(f.file() ) )
    {
        if( flac->ID3v2Tag() && checkID3Image( flac->ID3v2Tag() ) )
            vlc_meta_SetArtURL( p_meta, "APIC" );
    }
#if 0
/* This needs special additions to taglib */
 * else if( TagLib::MP4::File *mp4 =
               dynamic_cast<TagLib::MP4::File *>( f.file() ) )
    {
        TagLib::MP4::Tag *mp4tag =
                dynamic_cast<TagLib::MP4::Tag *>( mp4->tag() );
        if( mp4tag && mp4tag->cover().size() )
            vlc_meta_SetArtURL( p_meta, "MP4C" );
    }
#endif
}
zorglub's avatar
zorglub committed
96

97
98
99
100
static int ReadMeta( vlc_object_t *p_this )
{
    demux_t *p_demux = (demux_t *)p_this;

Rafaël Carré's avatar
Rafaël Carré committed
101
102
103
104
105
106
107
108
109
    if( strncmp( p_demux->psz_access, "file", 4 ) )
        return VLC_EGENERIC;

    TagLib::FileRef f( p_demux->psz_path );
    if( f.isNull() )
        return VLC_EGENERIC;

    if ( !f.tag() || f.tag()->isEmpty() )
        return VLC_EGENERIC;
110

Rafaël Carré's avatar
Rafaël Carré committed
111
112
113
114
115
116
117
118
119
    if( !p_demux->p_private )
        p_demux->p_private = (void*)vlc_meta_New();
    vlc_meta_t *p_meta = (vlc_meta_t *)(p_demux->p_private );
    TagLib::Tag *tag = f.tag();

    if( TagLib::MPEG::File *p_mpeg =
        dynamic_cast<TagLib::MPEG::File *>(f.file() ) )
    {
        if( p_mpeg->ID3v2Tag() )
120
        {
Rafaël Carré's avatar
Rafaël Carré committed
121
122
123
124
125
            TagLib::ID3v2::Tag *tag = p_mpeg->ID3v2Tag();
            TagLib::ID3v2::FrameList list = tag->frameListMap()["UFID"];
            TagLib::ID3v2::UniqueFileIdentifierFrame* p_ufid;
            for( TagLib::ID3v2::FrameList::Iterator iter = list.begin();
                    iter != list.end(); iter++ )
126
            {
Rafaël Carré's avatar
Rafaël Carré committed
127
128
129
                p_ufid = dynamic_cast<TagLib::ID3v2::UniqueFileIdentifierFrame*>(*iter);
                const char *owner = p_ufid->owner().toCString();
                if (!strcmp( owner, "http://musicbrainz.org" ))
130
                {
Rafaël Carré's avatar
Rafaël Carré committed
131
132
133
134
135
136
137
138
139
140
141
                    /* ID3v2 UFID contains up to 64 bytes binary data
                        * but in our case it will be a '\0' 
                        * terminated string */
                    char *psz_ufid = (char*) malloc( 64 );
                    int j = 0;
                    while( ( j < 63 ) &&
                            ( j < p_ufid->identifier().size() ) )
                        psz_ufid[j] = p_ufid->identifier()[j++];
                    psz_ufid[j] = '\0';
                    vlc_meta_SetTrackID( p_meta, psz_ufid );
                    free( psz_ufid );
142
143
                }
            }
Rafaël Carré's avatar
Rafaël Carré committed
144
145
146
147
148

            list = tag->frameListMap()["TXXX"];
            TagLib::ID3v2::UserTextIdentificationFrame* p_txxx;
            for( TagLib::ID3v2::FrameList::Iterator iter = list.begin();
                    iter != list.end(); iter++ )
149
            {
Rafaël Carré's avatar
Rafaël Carré committed
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
                p_txxx = dynamic_cast<TagLib::ID3v2::UserTextIdentificationFrame*>(*iter);
                const char *psz_desc= p_txxx->description().toCString();
#if 0 /* musicbrainz artist and album id: not useful (yet?) */
                if( !strncmp( psz_desc, "MusicBrainz Artist Id", 21 ) )
                    vlc_meta_SetArtistID( p_meta,
                            p_txxx->fieldList().toString().toCString());
                if( !strncmp( psz_desc, "MusicBrainz Album Id", 20 ) )
                    vlc_meta_SetAlbumID( p_meta,
                            p_txxx->fieldList().toString().toCString());
#endif
                vlc_meta_AddExtra( p_meta, psz_desc, 
                            p_txxx->fieldList().toString().toCString());
            }
#if 0
            list = tag->frameListMap()["RVA2"];
            TagLib::ID3v2::RelativeVolumeFrame* p_rva2;
            for( TagLib::ID3v2::FrameList::Iterator iter = list.begin();
                    iter != list.end(); iter++ )
            {
                p_rva2 = dynamic_cast<TagLib::ID3v2::RelativeVolumeFrame*>(*iter);
                /* TODO: process rva2 frames */
171
172
            }
#endif
Rafaël Carré's avatar
Rafaël Carré committed
173
174
175
176
177
            list = tag->frameList();
            TagLib::ID3v2::Frame* p_t;
            char psz_tag[4];
            for( TagLib::ID3v2::FrameList::Iterator iter = list.begin();
                    iter != list.end(); iter++ )
178
            {
Rafaël Carré's avatar
Rafaël Carré committed
179
180
181
182
183
184
185
186
187
188
189
190
191
                p_t = dynamic_cast<TagLib::ID3v2::Frame*> (*iter);
                memcpy( psz_tag, p_t->frameID().data(), 4);

#define SET( foo, bar ) if( !strncmp( psz_tag, foo, 4 ) ) \
vlc_meta_Set##bar( p_meta, p_t->toString().toCString(true))
                SET( "TPUB", Publisher );
                SET( "TCOP", Copyright );
                SET( "TENC", EncodedBy );
                SET( "TLAN", Language );
                //SET( "POPM", Rating ); /* rating needs special handling in id3v2 */
                //if( !strncmp( psz_tag, "RVA2", 4 ) )
                    /* TODO */
#undef SET
192
193
            }
        }
Rafaël Carré's avatar
Rafaël Carré committed
194
    }
195

Rafaël Carré's avatar
Rafaël Carré committed
196
197
198
199
200
201
202
203
    else if( TagLib::Ogg::Vorbis::File *p_ogg_v =
        dynamic_cast<TagLib::Ogg::Vorbis::File *>(f.file() ) )
    {
        int i_ogg_v_length = p_ogg_v->audioProperties()->length();

        input_thread_t *p_input = (input_thread_t *)
                vlc_object_find( p_demux,VLC_OBJECT_INPUT, FIND_PARENT );
        if( p_input )
204
        {
Rafaël Carré's avatar
Rafaël Carré committed
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
            input_item_t *p_item = input_GetItem( p_input );
            if( p_item )
            {
                vlc_mutex_lock( &p_item->lock );
                p_item->i_duration = i_ogg_v_length * 1000000;
                vlc_mutex_unlock( &p_item->lock );
            }
            vlc_object_release( p_input );
        }
        
    }
#if 0 /* at this moment, taglib is unable to detect ogg/flac files
* becauses type detection is based on file extension:
* ogg = ogg/vorbis
* flac = flac
* ø = ogg/flac
*/
    else if( TagLib::Ogg::FLAC::File *p_ogg_f =
        dynamic_cast<TagLib::Ogg::FLAC::File *>(f.file() ) )
    {
        long i_ogg_f_length = p_ogg_f->streamLength();
        input_thread_t *p_input = (input_thread_t *)
                vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
        if( p_input )
        {
            input_item_t *p_item = input_GetItem( p_input );
            if( p_item )
            {
                vlc_mutex_lock( &p_item->lock );
                p_item->i_duration = i_ogg_f_length * 1000000;
                vlc_mutex_unlock( &p_item->lock );
            }
            vlc_object_release( p_input );
        }
    }
#endif
    else if( TagLib::FLAC::File *p_flac =
        dynamic_cast<TagLib::FLAC::File *>(f.file() ) )
    {
        long i_flac_length = p_flac->audioProperties()->length();
        input_thread_t *p_input = (input_thread_t *)
                vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
        if( p_input )
        {
            input_item_t *p_item = input_GetItem( p_input );
            if( p_item )
            {
                vlc_mutex_lock( &p_item->lock );
                p_item->i_duration = i_flac_length * 1000000;
                vlc_mutex_unlock( &p_item->lock );
            }
            vlc_object_release( p_input );
        }
    }
259

260
#define SET( foo, bar ) vlc_meta_Set##foo( p_meta, tag->bar ().toCString(true))
261
#define SETINT( foo, bar ) { \
Rafaël Carré's avatar
Rafaël Carré committed
262
263
264
265
    char psz_tmp[10]; \
    snprintf( (char*)psz_tmp, 10, "%d", tag->bar() ); \
    vlc_meta_Set##foo( p_meta, (char*)psz_tmp ); \
}
266

Rafaël Carré's avatar
Rafaël Carré committed
267
268
269
270
271
272
273
    SET( Title, title );
    SET( Artist, artist );
    SET( Album, album );
    SET( Description, comment );
    SET( Genre, genre );
    SETINT( Date, year );
    SETINT( Tracknum , track );
274
#undef SET
275
#undef SETINT
276

Rafaël Carré's avatar
Rafaël Carré committed
277
    DetectImage( f, p_meta );
Rafaël Carré's avatar
Rafaël Carré committed
278

Rafaël Carré's avatar
Rafaël Carré committed
279
    return VLC_SUCCESS;
280
}
281

282
283
284
285
286
287
#define SET(a,b) if(b) { \
        TagLib::String *psz_##a = new TagLib::String( b, \
            TagLib::String::UTF8 ); \
        tag->set##a( *psz_##a ); \
        delete psz_##a; \
    }
Rafaël Carré's avatar
Rafaël Carré committed
288

289
290
static int WriteMeta( vlc_object_t *p_this )
{
Rafaël Carré's avatar
Rafaël Carré committed
291
292
293
    playlist_t *p_playlist = (playlist_t *)p_this;
    meta_export_t *p_export = (meta_export_t *)p_playlist->p_private;
    input_item_t *p_item = p_export->p_item;
294
295
296
297
298
299
    
    if( p_item == NULL )
    {
        msg_Err( p_this, "Can't save meta data of an empty input" );
        return VLC_EGENERIC;
    }
Rafaël Carré's avatar
Rafaël Carré committed
300

Rafaël Carré's avatar
Rafaël Carré committed
301
    TagLib::FileRef f( p_export->psz_file );
302
303
    if( !f.isNull() && f.tag() )
    {
304
        msg_Dbg( p_this, "Updating metadata for %s", p_export->psz_file );
305

306
        TagLib::Tag *tag = f.tag();
307

308
        char *psz_meta;
309

310
311
312
313
314
315
316
        psz_meta = input_item_GetArtist( p_item );
        SET( Artist, psz_meta );
        free( psz_meta );

        psz_meta = input_item_GetTitle( p_item );
        if( !psz_meta ) psz_meta = input_item_GetName( p_item );
        TagLib::String *psz_title = new TagLib::String( psz_meta,
317
318
319
            TagLib::String::UTF8 );
        tag->setTitle( *psz_title );
        delete psz_title;
320
321
322
323
324
325
326
327
328
        free( psz_meta );

        psz_meta = input_item_GetAlbum( p_item );
        SET( Album, psz_meta );
        free( psz_meta );

        psz_meta = input_item_GetGenre( p_item );
        SET( Genre, psz_meta );
        free( psz_meta );
329

330
331
332
        psz_meta = input_item_GetDate( p_item );
        if( psz_meta ) tag->setYear( atoi( psz_meta ) );
        free( psz_meta );
333

334
335
336
        psz_meta = input_item_GetTrackNum( p_item );
        if( psz_meta ) tag->setTrack( atoi( psz_meta ) );
        free( psz_meta );
337

338
339
340
        f.save();
        return VLC_SUCCESS;
    }
Rafaël Carré's avatar
Rafaël Carré committed
341
342
    msg_Err( p_this, "File %s can't be opened for tag writing\n",
        p_export->psz_file );
343
344
345
346
347
348
349
350
351
352
    return VLC_EGENERIC;
}

static int DownloadArt( vlc_object_t *p_this )
{
    /* We need to be passed the file name
     * Fetch the thing from the file, save it to the cache folder
     */
    return VLC_EGENERIC;
}