ed4308be79460c2b48d22bc4a9fb94654d3777cf
[vlc.git] / modules / meta_engine / id3tag.c
1 /*****************************************************************************
2  * id3tag.c: id3 tag parser/skipper based on libid3tag
3  *****************************************************************************
4  * Copyright (C) 2002-2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <stdlib.h>                                      /* malloc(), free() */
28 #include <string.h>
29
30 #include <vlc/vlc.h>
31 #include <vlc/intf.h>
32 #include <vlc/input.h>
33
34 #include <sys/types.h>
35
36 #include "vlc_meta.h"
37
38 #include <id3tag.h>
39 #include "id3genres.h"
40
41 /*****************************************************************************
42  * Local prototypes
43  *****************************************************************************/
44 static int  ParseID3Tags ( vlc_object_t * );
45
46 /*****************************************************************************
47  * Module descriptor
48  *****************************************************************************/
49 vlc_module_begin();
50     set_description( _("ID3 tags parser" ) );
51     set_capability( "meta reader", 70 );
52     set_callbacks( ParseID3Tags, NULL );
53 vlc_module_end();
54
55 /*****************************************************************************
56  * Definitions of structures  and functions used by this plugins
57  *****************************************************************************/
58
59 /*****************************************************************************
60  * ParseID3Tag : parse an id3tag into the info structures
61  *****************************************************************************/
62 static void ParseID3Tag( demux_t *p_demux, uint8_t *p_data, int i_size )
63 {
64     struct id3_tag   *p_id3_tag;
65     struct id3_frame *p_frame;
66     int i = 0;
67
68     p_id3_tag = id3_tag_parse( p_data, i_size );
69     if( !p_id3_tag ) return;
70
71     if( !p_demux->p_private ) p_demux->p_private = (void *)vlc_meta_New();
72
73 #define ID_IS( a ) (!strcmp(  p_frame->id, a ))
74 #define DESCR_IS( a) strstr( (char*)p_frame->description, a )
75
76     while( ( p_frame = id3_tag_findframe( p_id3_tag , "T", i ) ) )
77     {
78         int i_strings = id3_field_getnstrings( &p_frame->fields[1] );
79
80         while( i_strings > 0 )
81         {
82             vlc_meta_t *p_meta = (vlc_meta_t *)(p_demux->p_private);
83
84             char *psz_temp = id3_ucs4_utf8duplicate(
85                 id3_field_getstrings( &p_frame->fields[1], --i_strings ) );
86
87             if( ID_IS( ID3_FRAME_GENRE ) )
88             {
89                 char *psz_endptr;
90                 int i_genre = strtol( psz_temp, &psz_endptr, 10 );
91
92                 if( psz_temp != psz_endptr &&
93                     i_genre >= 0 && i_genre < NUM_GENRES )
94                 {
95                     vlc_meta_SetGenre( p_meta, ppsz_genres[atoi(psz_temp)]);
96                 }
97                 else
98                 {
99                     /* Unknown genre */
100                     vlc_meta_SetGenre( p_meta,psz_temp );
101                 }
102             }
103             else if( ID_IS( ID3_FRAME_TITLE ) )
104             {
105                 vlc_meta_SetTitle( p_meta, psz_temp );
106             }
107             else if( ID_IS( ID3_FRAME_ARTIST ) )
108             {
109                 vlc_meta_SetArtist( p_meta, psz_temp );
110             }
111             else if( ID_IS( ID3_FRAME_YEAR ) )
112             {
113                 vlc_meta_SetDate( p_meta, psz_temp );
114             }
115             else if( ID_IS( ID3_FRAME_COMMENT ) )
116             {
117                 vlc_meta_SetDescription( p_meta, psz_temp );
118             }
119             else if( DESCR_IS( "Copyright" ) )
120             {
121                 vlc_meta_SetCopyright( p_meta, psz_temp );
122             }
123             else if( DESCR_IS( "Publisher" ) )
124             {
125                 vlc_meta_SetPublisher( p_meta, psz_temp );
126             }
127             else if( DESCR_IS( "Track number/position in set" ) )
128             {
129                 vlc_meta_SetTracknum( p_meta, psz_temp );
130             }
131             else if( DESCR_IS( "Album/movie/show title" ) )
132             {
133                 vlc_meta_SetAlbum( p_meta, psz_temp );
134             }
135             else if( DESCR_IS( "Encoded by" ) )
136             {
137                 vlc_meta_SetEncodedBy( p_meta, psz_temp );
138             }
139             else if( ID_IS ( "APIC" ) )
140             {
141                 msg_Dbg( p_demux, "** Has APIC **" );
142             }
143             else if( p_frame->description )
144             { /* Unhandled meta*/
145                 msg_Warn( p_demux, "Fixme: unhandled ID3 metatag, %s", p_frame->description );
146             }
147             free( psz_temp );
148         }
149         i++;
150     }
151     id3_tag_delete( p_id3_tag );
152 }
153
154 /*****************************************************************************
155  * ParseID3Tags: check if ID3 tags at common locations. Parse them and skip it
156  * if it's at the start of the file
157  ****************************************************************************/
158 static int ParseID3Tags( vlc_object_t *p_this )
159 {
160     demux_t *p_demux = (demux_t *)p_this;
161     uint8_t *p_peek;
162     vlc_bool_t b_seekable;
163     int64_t i_init, i_pos;
164     int i_size;
165
166     p_demux->p_private = NULL;
167
168     msg_Dbg( p_demux, "checking for ID3 tag" );
169
170     stream_Control( p_demux->s, STREAM_CAN_FASTSEEK, &b_seekable );
171     if( !b_seekable ) return VLC_SUCCESS;
172
173     i_init = stream_Tell( p_demux->s );
174
175     /*
176      * Look for a ID3v1 tag at the end of the file
177      */
178     i_init = stream_Tell( p_demux->s );
179     i_pos = stream_Size( p_demux->s );
180
181     while( i_pos > 128 ) /* while used so we can break; */
182     {
183         stream_Seek( p_demux->s, i_pos - 128 );
184
185         /* get 10 byte id3 header */
186         if( stream_Peek( p_demux->s, &p_peek, 10 ) < 10 ) break;
187
188         i_size = id3_tag_query( p_peek, 10 );
189         if( i_size == 128 )
190         {
191             /* peek the entire tag */
192             if( stream_Peek( p_demux->s, &p_peek, i_size ) < i_size ) break;
193
194             msg_Dbg( p_demux, "found ID3v1 tag" );
195             ParseID3Tag( p_demux, p_peek, i_size );
196         }
197
198         /* look for ID3v2.4 tag at end of file */
199         /* get 10 byte ID3 footer */
200         if( stream_Peek( p_demux->s, &p_peek, 128 ) < 128 ) break;
201
202         i_size = id3_tag_query( p_peek + 118, 10 );
203         if( i_size < 0  && i_pos > -i_size )
204         {
205             /* id3v2.4 footer found */
206             stream_Seek( p_demux->s , i_pos + i_size );
207             /* peek the entire tag */
208             if( stream_Peek( p_demux->s, &p_peek, i_size ) < i_size ) break;
209
210             msg_Dbg( p_demux, "found ID3v2 tag at end of file" );
211             ParseID3Tag( p_demux, p_peek, i_size );
212         }
213         break;
214     }
215
216     /*
217      * Get 10 byte id3 header
218      */
219     stream_Seek( p_demux->s, 0 );
220     if( stream_Peek( p_demux->s, &p_peek, 10 ) < 10 ) goto end;
221
222     if( (i_size = id3_tag_query( p_peek, 10 )) <= 0 ) goto end;
223
224     if( stream_Peek( p_demux->s, &p_peek, i_size ) < i_size ) goto end;
225
226     msg_Dbg( p_demux, "found ID3v2 tag" );
227     ParseID3Tag( p_demux, p_peek, i_size );
228
229  end:
230     stream_Seek( p_demux->s, i_init );
231     return VLC_SUCCESS;
232 }