1 /*****************************************************************************
2 * id3tag.c: id3/ape tag parser/skipper based on libid3tag
3 *****************************************************************************
4 * Copyright (C) 2002-2004 the VideoLAN team
7 * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
31 #include <vlc_interface.h>
32 #include <vlc_demux.h>
33 #include <vlc_playlist.h>
34 #include <vlc_charset.h>
36 #include <sys/types.h>
41 #include "id3genres.h"
43 /*****************************************************************************
45 *****************************************************************************/
46 static int ParseTags ( vlc_object_t * );
48 /*****************************************************************************
50 *****************************************************************************/
52 set_description( _("ID3v1/2 and APEv1/2 tags parser" ) );
53 set_capability( "meta reader", 70 );
54 set_callbacks( ParseTags, NULL );
57 /*****************************************************************************
58 * ParseID3Tag : parse an id3tag into the info structures
59 *****************************************************************************/
60 static void ParseID3Tag( demux_t *p_demux, uint8_t *p_data, int i_size )
62 struct id3_tag *p_id3_tag;
63 struct id3_frame *p_frame;
64 demux_meta_t *p_demux_meta = (demux_meta_t*)p_demux->p_private;
68 p_id3_tag = id3_tag_parse( p_data, i_size );
72 if( !p_demux_meta->p_meta )
73 p_demux_meta->p_meta = vlc_meta_New();
74 p_meta = p_demux_meta->p_meta;
76 #define ID_IS( a ) (!strcmp( p_frame->id, a ))
77 #define DESCR_IS( a) strstr( (char*)p_frame->description, a )
78 #define GET_STRING(frame,fidx) id3_ucs4_latin1duplicate( id3_field_getstring( &(frame)->fields[fidx] ) )
81 for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "UFID", i )) != NULL; i++ )
83 const char *psz_owner = id3_field_getlatin1( &p_frame->fields[0] );
85 if( !strncmp( psz_owner, "http://musicbrainz.org", 22 ) )
87 id3_byte_t const * p_ufid;
88 id3_length_t i_ufidlen;
90 p_ufid = (id3_byte_t const *)
91 id3_field_getbinarydata(
94 char *psz_ufid = strndup( p_ufid, i_ufidlen );
96 vlc_meta_SetTrackID( p_meta, psz_ufid );
101 /* User defined text (TXXX) */
102 for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "TXXX", i )) != NULL; i++ )
104 /* 3 fields: 'encoding', 'description', 'value' */
105 char *psz_name = GET_STRING( p_frame, 1 );
106 char *psz_value = GET_STRING( p_frame, 2 );
108 vlc_meta_AddExtra( p_meta, psz_name, psz_value );
110 if( !strncmp( psz_name, "MusicBrainz Artist Id", 21 ) )
111 vlc_meta_SetArtistID( p_meta, psz_value );
112 if( !strncmp( psz_desc, "MusicBrainz Album Id", 20 ) )
113 vlc_meta_SetAlbumID( p_meta, psz_value );
119 /* Relative volume adjustment */
120 for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "RVA2", i )) != NULL; i++ )
122 /* 2 fields: 'latin1', 'binary' */
123 const char *psz_type = id3_field_getlatin1( &p_frame->fields[0] );
124 if( !strcasecmp( psz_type, "track" ) || !strcasecmp( psz_type, "album" ) ||
125 !strcasecmp( psz_type, "normalize" ) )
127 id3_byte_t const * p_data;
130 p_data = id3_field_getbinarydata( &p_frame->fields[1], &i_data );
133 const unsigned int i_peak_size = p_data[3];
134 const float f_gain = (float)GetWBE( &p_data[1] ) / 512.0;
137 if( i_data < i_peak_size + 4 )
139 /* only master volume */
140 if( p_data[0] == 0x01 )
142 snprintf( psz_value, sizeof(psz_value), "%f", f_gain );
143 if( !strcasecmp( psz_type, "album" ) )
144 vlc_meta_AddExtra( p_meta, "REPLAYGAIN_ALBUM_GAIN", psz_value );
146 vlc_meta_AddExtra( p_meta, "REPLAYGAIN_TRACK_GAIN", psz_value );
147 /* XXX I have no idea what peak unit is ... */
149 i_data -= 4+i_peak_size;
154 /* TODO 'RGAD' if it is used somewhere */
156 /* T--- Text informations */
157 for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "T", i )) != NULL; i++ )
161 /* Special case TXXX is not the same beast */
162 if( ID_IS( "TXXX" ) )
165 i_strings = id3_field_getnstrings( &p_frame->fields[1] );
166 while( i_strings > 0 )
168 char *psz_temp = id3_ucs4_utf8duplicate(
169 id3_field_getstrings( &p_frame->fields[1], --i_strings ) );
171 if( ID_IS( ID3_FRAME_GENRE ) )
174 int i_genre = strtol( psz_temp, &psz_endptr, 10 );
176 if( psz_temp != psz_endptr &&
177 i_genre >= 0 && i_genre < NUM_GENRES )
179 vlc_meta_SetGenre( p_meta, ppsz_genres[atoi(psz_temp)]);
184 vlc_meta_SetGenre( p_meta,psz_temp );
187 else if( ID_IS( ID3_FRAME_TITLE ) )
189 vlc_meta_SetTitle( p_meta, psz_temp );
191 else if( ID_IS( ID3_FRAME_ARTIST ) )
193 vlc_meta_SetArtist( p_meta, psz_temp );
195 else if( ID_IS( ID3_FRAME_YEAR ) )
197 vlc_meta_SetDate( p_meta, psz_temp );
199 else if( ID_IS( ID3_FRAME_COMMENT ) )
201 vlc_meta_SetDescription( p_meta, psz_temp );
203 else if( DESCR_IS( "Copyright" ) )
205 vlc_meta_SetCopyright( p_meta, psz_temp );
207 else if( DESCR_IS( "Publisher" ) )
209 vlc_meta_SetPublisher( p_meta, psz_temp );
211 else if( DESCR_IS( "Track number/position in set" ) )
213 vlc_meta_SetTracknum( p_meta, psz_temp );
215 else if( DESCR_IS( "Album/movie/show title" ) )
217 vlc_meta_SetAlbum( p_meta, psz_temp );
219 else if( DESCR_IS( "Encoded by" ) )
221 vlc_meta_SetEncodedBy( p_meta, psz_temp );
223 else if( ID_IS ( "APIC" ) )
225 msg_Dbg( p_demux, "** Has APIC **" );
227 else if( p_frame->description )
230 vlc_meta_AddExtra( p_meta, (char*)p_frame->description, psz_temp );
235 id3_tag_delete( p_id3_tag );
240 /*****************************************************************************
242 *****************************************************************************/
243 #define APE_TAG_HEADERSIZE (32)
244 static int GetAPEvXSize( const uint8_t *p_data, int i_data )
249 if( i_data < APE_TAG_HEADERSIZE ||
250 ( GetDWLE( &p_data[8] ) != 1000 && GetDWLE( &p_data[8] ) != 2000 ) || /* v1/v2 only */
251 strncmp( (char*)p_data, "APETAGEX", 8 ) ||
252 GetDWLE( &p_data[8+4+4] ) <= 0 )
255 i_body = GetDWLE( &p_data[8+4] );
256 flags = GetDWLE( &p_data[8+4+4] );
258 /* is it the header */
259 if( flags & (1<<29) )
260 return i_body + ( (flags&(1<<30)) ? APE_TAG_HEADERSIZE : 0 );
262 /* it is the footer */
263 return i_body + ( (flags&(1<<31)) ? APE_TAG_HEADERSIZE : 0 );
265 static void ParseAPEvXTag( demux_t *p_demux, uint8_t *p_data, int i_data )
267 demux_meta_t *p_demux_meta = (demux_meta_t*)p_demux->p_private;
271 uint8_t *p_header = NULL;
274 if( i_data < APE_TAG_HEADERSIZE )
277 b_start = !strncmp( (char*)&p_data[0], "APETAGEX", 8 );
278 b_end = !strncmp( (char*)&p_data[i_data-APE_TAG_HEADERSIZE], "APETAGEX", 8 );
279 if( !b_end && !b_start )
282 if( !p_demux_meta->p_meta )
283 p_demux_meta->p_meta = vlc_meta_New();
284 p_meta = p_demux_meta->p_meta;
288 p_header = &p_data[0];
289 p_data += APE_TAG_HEADERSIZE;
290 i_data -= APE_TAG_HEADERSIZE;
294 p_header = &p_data[i_data-APE_TAG_HEADERSIZE];
295 i_data -= APE_TAG_HEADERSIZE;
300 i_entry = GetDWLE( &p_header[8+4+4] );
304 while( i_entry > 0 && i_data >= 10 )
306 const int i_size = GetDWLE( &p_data[0] );
307 const uint32_t flags = GetDWLE( &p_data[4] );
311 strlcpy( psz_name, (char*)&p_data[8], sizeof(psz_name) );
312 n = strlen( psz_name );
318 if( i_data < i_size )
321 /* Retreive UTF-8 fields only */
322 if( ((flags>>1) & 0x03) == 0x00 )
324 /* FIXME list are separated by '\0' */
325 char *psz_value = strndup( (char*)&p_data[0], i_size );
327 EnsureUTF8( psz_name );
328 EnsureUTF8( psz_value );
329 #define IS(s) (!strcasecmp( psz_name, s ) )
331 vlc_meta_SetTitle( p_meta, psz_value );
332 else if( IS( "Artist" ) )
333 vlc_meta_SetArtist( p_meta, psz_value );
334 else if( IS( "Album" ) )
335 vlc_meta_SetAlbum( p_meta, psz_value );
336 else if( IS( "Publisher" ) )
337 vlc_meta_SetPublisher( p_meta, psz_value );
338 else if( IS( "Track" ) )
340 char *p = strchr( psz_value, '/' );
343 vlc_meta_SetTracknum( p_meta, psz_value );
345 else if( IS( "Comment" ) )
346 vlc_meta_SetDescription( p_meta, psz_value );
347 else if( IS( "Copyright" ) )
348 vlc_meta_SetCopyright( p_meta, psz_value );
349 else if( IS( "Year" ) )
350 vlc_meta_SetDate( p_meta, psz_value );
351 else if( IS( "Genre" ) )
352 vlc_meta_SetGenre( p_meta, psz_value );
353 else if( IS( "Language" ) )
354 vlc_meta_SetLanguage( p_meta, psz_value );
356 vlc_meta_AddExtra( p_meta, psz_name, psz_value );
367 /*****************************************************************************
368 * CheckFooter: check for ID3/APE at the end of the file
369 * CheckHeader: check for ID3/APE at the begining of the file
370 *****************************************************************************/
371 static void CheckFooter( demux_t *p_demux )
373 const int64_t i_pos = stream_Size( p_demux->s );
374 const int i_peek = 128+APE_TAG_HEADERSIZE;
377 int64_t i_id3v2_pos = -1;
378 int64_t i_apevx_pos = -1;
385 if( stream_Seek( p_demux->s, i_pos - i_peek ) )
388 if( stream_Peek( p_demux->s, &p_peek, i_peek ) < i_peek )
390 p_peek_id3 = &p_peek[APE_TAG_HEADERSIZE];
392 /* Check/Parse ID3v1 */
393 i_id3v1_size = id3_tag_query( p_peek_id3, ID3_TAG_QUERYSIZE );
394 if( i_id3v1_size == 128 )
396 msg_Dbg( p_demux, "found ID3v1 tag" );
397 ParseID3Tag( p_demux, p_peek_id3, i_id3v1_size );
400 /* Compute ID3v2 position */
401 i_id3v2_size = -id3_tag_query( &p_peek_id3[128-ID3_TAG_QUERYSIZE], ID3_TAG_QUERYSIZE );
402 if( i_id3v2_size > 0 )
403 i_id3v2_pos = i_pos - i_id3v2_size;
405 /* Compute APE2v2 position */
406 i_apevx_size = GetAPEvXSize( &p_peek[128+0], APE_TAG_HEADERSIZE );
407 if( i_apevx_size > 0 )
409 i_apevx_pos = i_pos - i_apevx_size;
411 else if( i_id3v1_size > 0 )
413 /* it can be before ID3v1 */
414 i_apevx_size = GetAPEvXSize( p_peek, APE_TAG_HEADERSIZE );
415 if( i_apevx_size > 0 )
416 i_apevx_pos = i_pos - 128 - i_apevx_size;
419 if( i_id3v2_pos > 0 && i_apevx_pos > 0 )
422 "Both ID3v2 and APEv1/2 at the end of file, ignoring APEv1/2" );
427 if( i_id3v2_pos > 0 )
429 if( !stream_Seek( p_demux->s, i_id3v2_pos ) &&
430 stream_Peek( p_demux->s, &p_peek, i_id3v2_size ) == i_id3v2_size )
432 msg_Dbg( p_demux, "found ID3v2 tag at end of file" );
433 ParseID3Tag( p_demux, p_peek, i_id3v2_size );
438 if( i_apevx_pos > 0 )
440 if( !stream_Seek( p_demux->s, i_apevx_pos ) &&
441 stream_Peek( p_demux->s, &p_peek, i_apevx_size ) == i_apevx_size )
443 msg_Dbg( p_demux, "found APEvx tag at end of file" );
444 ParseAPEvXTag( p_demux, p_peek, i_apevx_size );
448 static void CheckHeader( demux_t *p_demux )
453 if( stream_Seek( p_demux->s, 0 ) )
456 /* Test ID3v2 first */
457 if( stream_Peek( p_demux->s, &p_peek, ID3_TAG_QUERYSIZE ) != ID3_TAG_QUERYSIZE )
459 i_size = id3_tag_query( p_peek, ID3_TAG_QUERYSIZE );
461 stream_Peek( p_demux->s, &p_peek, i_size ) == i_size )
463 msg_Dbg( p_demux, "found ID3v2 tag" );
464 ParseID3Tag( p_demux, p_peek, i_size );
469 if( stream_Peek( p_demux->s, &p_peek, APE_TAG_HEADERSIZE ) != APE_TAG_HEADERSIZE )
471 i_size = GetAPEvXSize( p_peek, APE_TAG_HEADERSIZE );
473 stream_Peek( p_demux->s, &p_peek, i_size ) == i_size )
475 msg_Dbg( p_demux, "found APEv1/2 tag" );
476 ParseAPEvXTag( p_demux, p_peek, i_size );
480 /*****************************************************************************
481 * ParseTags: check if ID3/APE tags at common locations.
482 ****************************************************************************/
483 static int ParseTags( vlc_object_t *p_this )
485 demux_t *p_demux = (demux_t *)p_this;
486 demux_meta_t *p_demux_meta = (demux_meta_t*)p_demux->p_private;
487 vlc_bool_t b_seekable;
490 msg_Dbg( p_demux, "checking for ID3v1/2 and APEv1/2 tags" );
491 stream_Control( p_demux->s, STREAM_CAN_FASTSEEK, &b_seekable );
495 i_init = stream_Tell( p_demux->s );
497 TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
498 p_demux_meta->p_meta = NULL;
501 CheckFooter( p_demux );
504 CheckHeader( p_demux );
507 * Demuxer will not see tags at the start as src/input/demux.c skips it
510 stream_Seek( p_demux->s, i_init );
511 if( !p_demux_meta->p_meta && p_demux_meta->i_attachments <= 0 )