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