git.sesse.net Git - vlc/blob - 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
  80     int  i_extra;
  81     char **ppsz_extra_name;
  82     char **ppsz_extra_value;
  83
  84     int i_status;
  85
  86 };
  87
  88 #define vlc_meta_Set( meta,var,val ) do { \
  89     if( meta->psz_##var ) free( meta->psz_##var ); \
  90     meta->psz_##var = (val) ? strdup( val ) : NULL; } while(0)
  91
  92 #define vlc_meta_SetTitle( meta, b ) vlc_meta_Set( meta, title, b );
  93 #define vlc_meta_SetArtist( meta, b ) vlc_meta_Set( meta, artist, b );
  94 #define vlc_meta_SetGenre( meta, b ) vlc_meta_Set( meta, genre, b );
  95 #define vlc_meta_SetCopyright( meta, b ) vlc_meta_Set( meta, copyright, b );
  96 #define vlc_meta_SetAlbum( meta, b ) vlc_meta_Set( meta, album, b );
  97 #define vlc_meta_SetTracknum( meta, b ) vlc_meta_Set( meta, tracknum, b );
  98 #define vlc_meta_SetDescription( meta, b ) vlc_meta_Set( meta, description, b );
  99 #define vlc_meta_SetRating( meta, b ) vlc_meta_Set( meta, rating, b );
 100 #define vlc_meta_SetDate( meta, b ) vlc_meta_Set( meta, date, b );
 101 #define vlc_meta_SetSetting( meta, b ) vlc_meta_Set( meta, setting, b );
 102 #define vlc_meta_SetURL( meta, b ) vlc_meta_Set( meta, url, b );
 103 #define vlc_meta_SetLanguage( meta, b ) vlc_meta_Set( meta, language, b );
 104 #define vlc_meta_SetNowPlaying( meta, b ) vlc_meta_Set( meta, nowplaying, b );
 105 #define vlc_meta_SetPublisher( meta, b ) vlc_meta_Set( meta, publisher, b );
 106 #define vlc_meta_SetEncodedBy( meta, b ) vlc_meta_Set( meta, encodedby, b );
 107 #define vlc_meta_SetArtURL( meta, b ) vlc_meta_Set( meta, arturl, b );
 108 #define vlc_meta_SetTrackID( meta, b ) vlc_meta_Set( meta, trackid, b );
 109
 110 static inline vlc_meta_t *vlc_meta_New( void )
 111 {
 112     vlc_meta_t *m = (vlc_meta_t*)malloc( sizeof( vlc_meta_t ) );
 113     if( !m ) return NULL;
 114     m->psz_title = NULL;
 115     m->psz_artist = NULL;
 116     m->psz_genre = NULL;
 117     m->psz_copyright = NULL;
 118     m->psz_album = NULL;
 119     m->psz_tracknum = NULL;
 120     m->psz_description = NULL;
 121     m->psz_rating = NULL;
 122     m->psz_date = NULL;
 123     m->psz_setting = NULL;
 124     m->psz_url = NULL;
 125     m->psz_language = NULL;
 126     m->psz_nowplaying = NULL;
 127     m->psz_publisher = NULL;
 128     m->psz_encodedby = NULL;
 129     m->psz_arturl = NULL;
 130     m->psz_trackid = NULL;
 131
 132     m->i_extra = 0;
 133     m->ppsz_extra_name = NULL;
 134     m->ppsz_extra_value = NULL;
 135
 136     m->i_status = 0;
 137     return m;
 138 }
 139
 140 static inline void vlc_meta_Delete( vlc_meta_t *m )
 141 {
 142     int i;
 143
 144     free( m->psz_title );
 145     free( m->psz_artist );
 146     free( m->psz_genre );
 147     free( m->psz_copyright );
 148     free( m->psz_album );
 149     free( m->psz_tracknum );
 150     free( m->psz_description );
 151     free( m->psz_rating );
 152     free( m->psz_date );
 153     free( m->psz_setting );
 154     free( m->psz_url );
 155     free( m->psz_language );
 156     free( m->psz_nowplaying );
 157     free( m->psz_publisher );
 158     free( m->psz_encodedby );
 159     free( m->psz_trackid );
 160     free( m->psz_arturl );
 161     for( i = 0; i < m->i_extra; i++ )
 162     {
 163         free( m->ppsz_extra_name[i] );
 164         free( m->ppsz_extra_value[i] );
 165     }
 166     free( m->ppsz_extra_name );
 167     free( m->ppsz_extra_value );
 168
 169     free( m );
 170 }
 171 static inline void vlc_meta_AddExtra( vlc_meta_t *m, const char *psz_name, const char *psz_value )
 172 {
 173     int i_extra = m->i_extra;
 174     TAB_APPEND_CPP( char, m->i_extra, m->ppsz_extra_name,  strdup(psz_name) );
 175     TAB_APPEND_CPP( char, i_extra,    m->ppsz_extra_value, strdup(psz_value) );
 176 }
 177
 178 static inline void vlc_meta_Merge( vlc_meta_t *dst, const vlc_meta_t *src )
 179 {
 180     int i;
 181     if( !dst || !src ) return;
 182 #define COPY_FIELD( a ) \
 183     if( src->psz_ ## a ) { \
 184         if( dst->psz_ ## a ) free( dst->psz_## a ); \
 185         dst->psz_##a = strdup( src->psz_##a ); \
 186     }
 187     COPY_FIELD( title );
 188     COPY_FIELD( artist );
 189     COPY_FIELD( genre );
 190     COPY_FIELD( copyright );
 191     COPY_FIELD( album );
 192     COPY_FIELD( tracknum );
 193     COPY_FIELD( description );
 194     COPY_FIELD( rating );
 195     COPY_FIELD( date );
 196     COPY_FIELD( setting );
 197     COPY_FIELD( url );
 198     COPY_FIELD( language );
 199     COPY_FIELD( nowplaying );
 200     COPY_FIELD( publisher );
 201     COPY_FIELD( encodedby );
 202     COPY_FIELD( trackid );
 203     COPY_FIELD( arturl );
 204 #undef COPY_FIELD
 205
 206     for( i = 0; i < src->i_extra; i++ )
 207     {
 208         int j;
 209         for( j = 0; j < dst->i_extra; j++ )
 210         {
 211             if( !strcmp( dst->ppsz_extra_name[i], src->ppsz_extra_name[i] ) )
 212             {
 213                 free( dst->ppsz_extra_value[i] );
 214                 dst->ppsz_extra_value[i] = strdup( src->ppsz_extra_value[i] );
 215                 break;
 216             }
 217             if( j >= dst->i_extra )
 218                 vlc_meta_AddExtra( dst, src->ppsz_extra_name[i], src->ppsz_extra_value[i] );
 219         }
 220     }
 221 }
 222
 223 enum {
 224     ALBUM_ART_WHEN_ASKED,
 225     ALBUM_ART_WHEN_PLAYED,
 226     ALBUM_ART_ALL
 227 };
 228
 229 struct meta_export_t
 230 {
 231     input_item_t *p_item;
 232     const char *psz_file;
 233 };
 234
 235 #define VLC_META_ENGINE_TITLE           0x00000001
 236 #define VLC_META_ENGINE_ARTIST          0x00000004
 237 #define VLC_META_ENGINE_GENRE           0x00000008
 238 #define VLC_META_ENGINE_COPYRIGHT       0x00000010
 239 #define VLC_META_ENGINE_COLLECTION      0x00000020
 240 #define VLC_META_ENGINE_SEQ_NUM         0x00000040
 241 #define VLC_META_ENGINE_DESCRIPTION     0x00000080
 242 #define VLC_META_ENGINE_RATING          0x00000100
 243 #define VLC_META_ENGINE_DATE            0x00000200
 244 #define VLC_META_ENGINE_URL             0x00000400
 245 #define VLC_META_ENGINE_LANGUAGE        0x00000800
 246
 247 #define VLC_META_ENGINE_ART_URL         0x00001000
 248
 249 #define VLC_META_ENGINE_MB_ARTIST_ID    0x00002000
 250 #define VLC_META_ENGINE_MB_RELEASE_ID   0x00004000
 251 #define VLC_META_ENGINE_MB_TRACK_ID     0x00008000
 252 #define VLC_META_ENGINE_MB_TRM_ID       0x00010000
 253
 254 typedef struct meta_engine_sys_t meta_engine_sys_t;
 255
 256 struct meta_engine_t
 257 {
 258     VLC_COMMON_MEMBERS
 259
 260     module_t *p_module;
 261
 262     uint32_t i_mandatory; /**< Stuff which we really need to get */
 263     uint32_t i_optional; /**< Stuff which we'd like to have */
 264
 265     input_item_t *p_item;
 266 };
 267
 268 VLC_EXPORT(uint32_t, input_CurrentMetaFlags,( vlc_meta_t *p_meta ) );
 269
 270 #endif