vlc_meta.h 8.53 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_meta.h: Stream meta-data
3
 *****************************************************************************
4
 * Copyright (C) 2004 the VideoLAN team
5
 * $Id$
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23
 *****************************************************************************/

24 25 26 27
#if !defined( __LIBVLC__ )
  #error You are not libvlc or one of its plugins. You cannot include this file
#endif

28 29 30
#ifndef _VLC_META_H
#define _VLC_META_H 1

31 32
#include <vlc_arrays.h>

33
/* VLC meta name */
34
#define VLC_META_INFO_CAT           N_("Meta-information")
35 36 37 38
#define VLC_META_TITLE              N_("Title")
#define VLC_META_ARTIST             N_("Artist")
#define VLC_META_GENRE              N_("Genre")
#define VLC_META_COPYRIGHT          N_("Copyright")
39 40
#define VLC_META_COLLECTION         N_("Album/movie/show title")
#define VLC_META_SEQ_NUM            N_("Track number/position in set")
41 42 43 44
#define VLC_META_DESCRIPTION        N_("Description")
#define VLC_META_RATING             N_("Rating")
#define VLC_META_DATE               N_("Date")
#define VLC_META_SETTING            N_("Setting")
45
#define VLC_META_URL                N_("URL")
46
#define VLC_META_LANGUAGE           N_("Language")
47
#define VLC_META_NOW_PLAYING        N_("Now Playing")
48
#define VLC_META_PUBLISHER          N_("Publisher")
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
49
#define VLC_META_ENCODED_BY         N_("Encoded by")
50

51 52
#define VLC_META_ART_URL            N_("Art URL")

53 54 55
#define VLC_META_CODEC_NAME         N_("Codec Name")
#define VLC_META_CODEC_DESCRIPTION  N_("Codec Description")

56 57 58 59
#define ITEM_PREPARSED      0x01
#define ITEM_META_FETCHED   0x02
#define ITEM_ARTURL_FETCHED 0x04
#define ITEM_ART_FETCHED    0x08
60
#define ITEM_ART_NOTFOUND   0x10
61

62 63
struct vlc_meta_t
{
64 65 66 67 68 69 70 71 72 73 74 75 76 77
    char *psz_title;
    char *psz_artist;
    char *psz_genre;
    char *psz_copyright;
    char *psz_album;
    char *psz_tracknum;
    char *psz_description;
    char *psz_rating;
    char *psz_date;
    char *psz_setting;
    char *psz_url;
    char *psz_language;
    char *psz_nowplaying;
    char *psz_publisher;
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
78
    char *psz_encodedby;
79
    char *psz_arturl;
80
    char *psz_trackid;
Laurent Aimar's avatar
Laurent Aimar committed
81

82
    vlc_dictionary_t extra_tags;
83 84

    int i_status;
Laurent Aimar's avatar
Laurent Aimar committed
85

86 87
};

Laurent Aimar's avatar
Laurent Aimar committed
88
#define vlc_meta_Set( meta,var,val ) do { \
89
    const char *str = val; \
90
    if( meta->psz_##var ) free( meta->psz_##var ); \
91
    meta->psz_##var = str ? strdup( str ) : NULL; } while(0)
92

Laurent Aimar's avatar
Laurent Aimar committed
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
#define vlc_meta_SetTitle( meta, b ) vlc_meta_Set( meta, title, b )
#define vlc_meta_SetArtist( meta, b ) vlc_meta_Set( meta, artist, b )
#define vlc_meta_SetGenre( meta, b ) vlc_meta_Set( meta, genre, b )
#define vlc_meta_SetCopyright( meta, b ) vlc_meta_Set( meta, copyright, b )
#define vlc_meta_SetAlbum( meta, b ) vlc_meta_Set( meta, album, b )
#define vlc_meta_SetTracknum( meta, b ) vlc_meta_Set( meta, tracknum, b )
#define vlc_meta_SetDescription( meta, b ) vlc_meta_Set( meta, description, b )
#define vlc_meta_SetRating( meta, b ) vlc_meta_Set( meta, rating, b )
#define vlc_meta_SetDate( meta, b ) vlc_meta_Set( meta, date, b )
#define vlc_meta_SetSetting( meta, b ) vlc_meta_Set( meta, setting, b )
#define vlc_meta_SetURL( meta, b ) vlc_meta_Set( meta, url, b )
#define vlc_meta_SetLanguage( meta, b ) vlc_meta_Set( meta, language, b )
#define vlc_meta_SetNowPlaying( meta, b ) vlc_meta_Set( meta, nowplaying, b )
#define vlc_meta_SetPublisher( meta, b ) vlc_meta_Set( meta, publisher, b )
#define vlc_meta_SetEncodedBy( meta, b ) vlc_meta_Set( meta, encodedby, b )
#define vlc_meta_SetArtURL( meta, b ) vlc_meta_Set( meta, arturl, b )
#define vlc_meta_SetTrackID( meta, b ) vlc_meta_Set( meta, trackid, b )
110

111 112
static inline vlc_meta_t *vlc_meta_New( void )
{
113
    vlc_meta_t *m = (vlc_meta_t*)malloc( sizeof( vlc_meta_t ) );
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
    if( !m ) return NULL;
    m->psz_title = NULL;
    m->psz_artist = NULL;
    m->psz_genre = NULL;
    m->psz_copyright = NULL;
    m->psz_album = NULL;
    m->psz_tracknum = NULL;
    m->psz_description = NULL;
    m->psz_rating = NULL;
    m->psz_date = NULL;
    m->psz_setting = NULL;
    m->psz_url = NULL;
    m->psz_language = NULL;
    m->psz_nowplaying = NULL;
    m->psz_publisher = NULL;
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
129
    m->psz_encodedby = NULL;
130
    m->psz_arturl = NULL;
131
    m->psz_trackid = NULL;
Laurent Aimar's avatar
Laurent Aimar committed
132

133
    m->i_status = 0;
134
    vlc_dictionary_init( &m->extra_tags, 0 );
135 136
    return m;
}
137

138 139
static inline void vlc_meta_Delete( vlc_meta_t *m )
{
140 141 142 143 144 145 146 147 148 149 150 151 152 153
    free( m->psz_title );
    free( m->psz_artist );
    free( m->psz_genre );
    free( m->psz_copyright );
    free( m->psz_album );
    free( m->psz_tracknum );
    free( m->psz_description );
    free( m->psz_rating );
    free( m->psz_date );
    free( m->psz_setting );
    free( m->psz_url );
    free( m->psz_language );
    free( m->psz_nowplaying );
    free( m->psz_publisher );
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
154
    free( m->psz_encodedby );
155
    free( m->psz_trackid );
156
    free( m->psz_arturl );
157
    vlc_dictionary_clear( &m->extra_tags );
158 159
    free( m );
}
Laurent Aimar's avatar
Laurent Aimar committed
160 161
static inline void vlc_meta_AddExtra( vlc_meta_t *m, const char *psz_name, const char *psz_value )
{
162 163 164 165 166 167 168
    char * psz_oldvalue = (char *)vlc_dictionary_value_for_key( &m->extra_tags, psz_name );
    if( psz_oldvalue != kVLCDictionaryNotFound )
    {
        free( psz_oldvalue );
        vlc_dictionary_remove_value_for_key( &m->extra_tags, psz_name );
    }
    vlc_dictionary_insert( &m->extra_tags, psz_name, strdup(psz_value) );
Laurent Aimar's avatar
Laurent Aimar committed
169
}
170

Laurent Aimar's avatar
Laurent Aimar committed
171
static inline void vlc_meta_Merge( vlc_meta_t *dst, const vlc_meta_t *src )
172
{
173 174 175 176 177
    if( !dst || !src ) return;
#define COPY_FIELD( a ) \
    if( src->psz_ ## a ) { \
        if( dst->psz_ ## a ) free( dst->psz_## a ); \
        dst->psz_##a = strdup( src->psz_##a ); \
178
    }
179 180 181 182 183 184 185 186 187 188 189 190 191 192
    COPY_FIELD( title );
    COPY_FIELD( artist );
    COPY_FIELD( genre );
    COPY_FIELD( copyright );
    COPY_FIELD( album );
    COPY_FIELD( tracknum );
    COPY_FIELD( description );
    COPY_FIELD( rating );
    COPY_FIELD( date );
    COPY_FIELD( setting );
    COPY_FIELD( url );
    COPY_FIELD( language );
    COPY_FIELD( nowplaying );
    COPY_FIELD( publisher );
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
193
    COPY_FIELD( encodedby );
194
    COPY_FIELD( trackid );
195
    COPY_FIELD( arturl );
Laurent Aimar's avatar
Laurent Aimar committed
196
#undef COPY_FIELD
197 198 199 200 201
    char ** ppsz_all_keys;
    int i;
    /* XXX: If speed up are needed, it is possible */
    ppsz_all_keys = vlc_dictionary_all_keys( &src->extra_tags );
    for( i = 0; ppsz_all_keys[i]; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
202
    {
203 204 205 206 207
        /* Always try to remove the previous value */
        vlc_dictionary_remove_value_for_key( &dst->extra_tags, ppsz_all_keys[i] );
        void * p_value = vlc_dictionary_value_for_key( &src->extra_tags, ppsz_all_keys[i] );
        vlc_dictionary_insert( &dst->extra_tags, ppsz_all_keys[i], p_value );
        free( ppsz_all_keys[i] );
Laurent Aimar's avatar
Laurent Aimar committed
208
    }
209
    free( ppsz_all_keys );
210 211
}

212 213 214
enum {
    ALBUM_ART_WHEN_ASKED,
    ALBUM_ART_WHEN_PLAYED,
215 216
    ALBUM_ART_ALL
};
217

Rafaël Carré's avatar
Rafaël Carré committed
218 219 220 221 222 223
struct meta_export_t
{
    input_item_t *p_item;
    const char *psz_file;
};

224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
#define VLC_META_ENGINE_TITLE           0x00000001
#define VLC_META_ENGINE_ARTIST          0x00000004
#define VLC_META_ENGINE_GENRE           0x00000008
#define VLC_META_ENGINE_COPYRIGHT       0x00000010
#define VLC_META_ENGINE_COLLECTION      0x00000020
#define VLC_META_ENGINE_SEQ_NUM         0x00000040
#define VLC_META_ENGINE_DESCRIPTION     0x00000080
#define VLC_META_ENGINE_RATING          0x00000100
#define VLC_META_ENGINE_DATE            0x00000200
#define VLC_META_ENGINE_URL             0x00000400
#define VLC_META_ENGINE_LANGUAGE        0x00000800

#define VLC_META_ENGINE_ART_URL         0x00001000

#define VLC_META_ENGINE_MB_ARTIST_ID    0x00002000
#define VLC_META_ENGINE_MB_RELEASE_ID   0x00004000
#define VLC_META_ENGINE_MB_TRACK_ID     0x00008000
#define VLC_META_ENGINE_MB_TRM_ID       0x00010000

typedef struct meta_engine_sys_t meta_engine_sys_t;

struct meta_engine_t
{
    VLC_COMMON_MEMBERS

    module_t *p_module;

    uint32_t i_mandatory; /**< Stuff which we really need to get */
    uint32_t i_optional; /**< Stuff which we'd like to have */

    input_item_t *p_item;
};

Clément Stenac's avatar
Clément Stenac committed
257
VLC_EXPORT(uint32_t, input_CurrentMetaFlags,( vlc_meta_t *p_meta ) );
258

259
#endif