A bit of vlc/libvlc cleanup:
[vlc.git] / include / vlc_meta.h
1 /*****************************************************************************
2  * vlc_meta.h: Stream meta-data
3  *****************************************************************************
4  * Copyright (C) 2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
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 #if !defined( __LIBVLC__ )
25   #error You are not libvlc or one of its plugins. You cannot include this file
26 #endif
27
28 #ifndef _VLC_META_H
29 #define _VLC_META_H 1
30
31 /* VLC meta name */
32 #define VLC_META_INFO_CAT           N_("Meta-information")
33 #define VLC_META_TITLE              N_("Title")
34 #define VLC_META_ARTIST             N_("Artist")
35 #define VLC_META_GENRE              N_("Genre")
36 #define VLC_META_COPYRIGHT          N_("Copyright")
37 #define VLC_META_COLLECTION         N_("Album/movie/show title")
38 #define VLC_META_SEQ_NUM            N_("Track number/position in set")
39 #define VLC_META_DESCRIPTION        N_("Description")
40 #define VLC_META_RATING             N_("Rating")
41 #define VLC_META_DATE               N_("Date")
42 #define VLC_META_SETTING            N_("Setting")
43 #define VLC_META_URL                N_("URL")
44 #define VLC_META_LANGUAGE           N_("Language")
45 #define VLC_META_NOW_PLAYING        N_("Now Playing")
46 #define VLC_META_PUBLISHER          N_("Publisher")
47 #define VLC_META_ENCODED_BY         N_("Encoded by")
48
49 #define VLC_META_ART_URL            N_("Art URL")
50
51 #define VLC_META_CODEC_NAME         N_("Codec Name")
52 #define VLC_META_CODEC_DESCRIPTION  N_("Codec Description")
53
54 #define ITEM_PREPARSED      0x01
55 #define ITEM_META_FETCHED   0x02
56 #define ITEM_ARTURL_FETCHED 0x04
57 #define ITEM_ART_FETCHED    0x08
58 #define ITEM_ART_NOTFOUND   0x10
59
60 struct vlc_meta_t
61 {
62     char *psz_title;
63     char *psz_artist;
64     char *psz_genre;
65     char *psz_copyright;
66     char *psz_album;
67     char *psz_tracknum;
68     char *psz_description;
69     char *psz_rating;
70     char *psz_date;
71     char *psz_setting;
72     char *psz_url;
73     char *psz_language;
74     char *psz_nowplaying;
75     char *psz_publisher;
76     char *psz_encodedby;
77     char *psz_arturl;
78     char *psz_trackid;
79 #if 0 //not used
80     char *psz_artistid;
81     char *psz_albumid;
82 #endif
83
84     int i_status;
85 #if 0
86     /* track meta information */
87     int         i_track;
88     vlc_meta_t  **track;
89 #endif
90 };
91
92 #define vlc_meta_Set( meta,var,val ) { \
93     if( meta->psz_##var ) free( meta->psz_##var ); \
94     meta->psz_##var = strdup( val ); }
95
96 #define vlc_meta_SetTitle( meta, b ) vlc_meta_Set( meta, title, b );
97 #define vlc_meta_SetArtist( meta, b ) vlc_meta_Set( meta, artist, b );
98 #define vlc_meta_SetGenre( meta, b ) vlc_meta_Set( meta, genre, b );
99 #define vlc_meta_SetCopyright( meta, b ) vlc_meta_Set( meta, copyright, b );
100 #define vlc_meta_SetAlbum( meta, b ) vlc_meta_Set( meta, album, b );
101 #define vlc_meta_SetTracknum( meta, b ) vlc_meta_Set( meta, tracknum, b );
102 #define vlc_meta_SetDescription( meta, b ) vlc_meta_Set( meta, description, b );
103 #define vlc_meta_SetRating( meta, b ) vlc_meta_Set( meta, rating, b );
104 #define vlc_meta_SetDate( meta, b ) vlc_meta_Set( meta, date, b );
105 #define vlc_meta_SetSetting( meta, b ) vlc_meta_Set( meta, setting, b );
106 #define vlc_meta_SetURL( meta, b ) vlc_meta_Set( meta, url, b );
107 #define vlc_meta_SetLanguage( meta, b ) vlc_meta_Set( meta, language, b );
108 #define vlc_meta_SetNowPlaying( meta, b ) vlc_meta_Set( meta, nowplaying, b );
109 #define vlc_meta_SetPublisher( meta, b ) vlc_meta_Set( meta, publisher, b );
110 #define vlc_meta_SetEncodedBy( meta, b ) vlc_meta_Set( meta, encodedby, b );
111 #define vlc_meta_SetArtURL( meta, b ) vlc_meta_Set( meta, arturl, b );
112 #define vlc_meta_SetTrackID( meta, b ) vlc_meta_Set( meta, trackid, b );
113 #if 0 //not used
114 #define vlc_meta_SetArtistID( meta, b ) vlc_meta_Set( meta, artistid, b );
115 #define vlc_meta_SetAlbumID( meta, b ) vlc_meta_Set( meta, albumid, b );
116 #endif
117
118
119 static inline vlc_meta_t *vlc_meta_New( void )
120 {
121     vlc_meta_t *m = (vlc_meta_t*)malloc( sizeof( vlc_meta_t ) );
122     if( !m ) return NULL;
123     m->psz_title = NULL;
124     m->psz_artist = NULL;
125     m->psz_genre = NULL;
126     m->psz_copyright = NULL;
127     m->psz_album = NULL;
128     m->psz_tracknum = NULL;
129     m->psz_description = NULL;
130     m->psz_rating = NULL;
131     m->psz_date = NULL;
132     m->psz_setting = NULL;
133     m->psz_url = NULL;
134     m->psz_language = NULL;
135     m->psz_nowplaying = NULL;
136     m->psz_publisher = NULL;
137     m->psz_encodedby = NULL;
138     m->psz_arturl = NULL;
139     m->psz_trackid = NULL;
140 #if 0 //not used
141     m->psz_artistid = NULL;
142     m->psz_albumid = NULL;
143 #endif
144     m->i_status = 0;
145     return m;
146 }
147
148 static inline void vlc_meta_Delete( vlc_meta_t *m )
149 {
150     free( m->psz_title );
151     free( m->psz_artist );
152     free( m->psz_genre );
153     free( m->psz_copyright );
154     free( m->psz_album );
155     free( m->psz_tracknum );
156     free( m->psz_description );
157     free( m->psz_rating );
158     free( m->psz_date );
159     free( m->psz_setting );
160     free( m->psz_url );
161     free( m->psz_language );
162     free( m->psz_nowplaying );
163     free( m->psz_publisher );
164     free( m->psz_encodedby );
165     free( m->psz_trackid );
166 #if 0 //not used
167     free( m->psz_artistid );
168     free( m->psz_albumid );
169 #endif
170     free( m->psz_arturl );
171
172     free( m );
173 }
174
175 static inline void vlc_meta_Merge( vlc_meta_t *dst, vlc_meta_t *src )
176 {
177     if( !dst || !src ) return;
178 #define COPY_FIELD( a ) \
179     if( src->psz_ ## a ) { \
180         if( dst->psz_ ## a ) free( dst->psz_## a ); \
181         dst->psz_##a = strdup( src->psz_##a ); \
182     }
183     COPY_FIELD( title );
184     COPY_FIELD( artist );
185     COPY_FIELD( genre );
186     COPY_FIELD( copyright );
187     COPY_FIELD( album );
188     COPY_FIELD( tracknum );
189     COPY_FIELD( description );
190     COPY_FIELD( rating );
191     COPY_FIELD( date );
192     COPY_FIELD( setting );
193     COPY_FIELD( url );
194     COPY_FIELD( language );
195     COPY_FIELD( nowplaying );
196     COPY_FIELD( publisher );
197     COPY_FIELD( encodedby );
198     COPY_FIELD( trackid );
199 #if 0 //not used
200     COPY_FIELD( artistid );
201     COPY_FIELD( albumid );
202 #endif
203     COPY_FIELD( arturl );
204 }
205     /** \todo Track meta */
206
207 enum {
208     ALBUM_ART_WHEN_ASKED,
209     ALBUM_ART_WHEN_PLAYED,
210     ALBUM_ART_ALL
211 };
212
213 struct meta_export_t
214 {
215     input_item_t *p_item;
216     const char *psz_file;
217 };
218
219 #define VLC_META_ENGINE_TITLE           0x00000001
220 #define VLC_META_ENGINE_ARTIST          0x00000004
221 #define VLC_META_ENGINE_GENRE           0x00000008
222 #define VLC_META_ENGINE_COPYRIGHT       0x00000010
223 #define VLC_META_ENGINE_COLLECTION      0x00000020
224 #define VLC_META_ENGINE_SEQ_NUM         0x00000040
225 #define VLC_META_ENGINE_DESCRIPTION     0x00000080
226 #define VLC_META_ENGINE_RATING          0x00000100
227 #define VLC_META_ENGINE_DATE            0x00000200
228 #define VLC_META_ENGINE_URL             0x00000400
229 #define VLC_META_ENGINE_LANGUAGE        0x00000800
230
231 #define VLC_META_ENGINE_ART_URL         0x00001000
232
233 #define VLC_META_ENGINE_MB_ARTIST_ID    0x00002000
234 #define VLC_META_ENGINE_MB_RELEASE_ID   0x00004000
235 #define VLC_META_ENGINE_MB_TRACK_ID     0x00008000
236 #define VLC_META_ENGINE_MB_TRM_ID       0x00010000
237
238 typedef struct meta_engine_sys_t meta_engine_sys_t;
239
240 struct meta_engine_t
241 {
242     VLC_COMMON_MEMBERS
243
244     module_t *p_module;
245
246     uint32_t i_mandatory; /**< Stuff which we really need to get */
247     uint32_t i_optional; /**< Stuff which we'd like to have */
248
249     input_item_t *p_item;
250 };
251
252 VLC_EXPORT(uint32_t, input_CurrentMetaFlags,( vlc_meta_t *p_meta ) );
253
254 #endif