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 #include <vlc_arrays.h>
  32
  33 typedef enum vlc_meta_type_t
  34 {
  35     vlc_meta_Title,
  36     vlc_meta_Artist,
  37     vlc_meta_Genre,
  38     vlc_meta_Copyright,
  39     vlc_meta_Album,
  40     vlc_meta_TrackNumber,
  41     vlc_meta_Description,
  42     vlc_meta_Rating,
  43     vlc_meta_Date,
  44     vlc_meta_Setting,
  45     vlc_meta_URL,
  46     vlc_meta_Language,
  47     vlc_meta_NowPlaying,
  48     vlc_meta_Publisher,
  49     vlc_meta_EncodedBy,
  50     vlc_meta_ArtworkURL,
  51     vlc_meta_TrackID
  52 } vlc_meta_type_t;
  53
  54 #define VLC_META_TYPE_COUNT 17
  55
  56 /* Returns a localizes string describing the meta */
  57 VLC_EXPORT(const char *, input_MetaTypeToLocalizedString, ( vlc_meta_type_t meta_type ) );
  58
  59 #define ITEM_PREPARSED      0x01
  60 #define ITEM_ARTURL_FETCHED 0x02
  61 #define ITEM_ART_FETCHED    0x04
  62 #define ITEM_ART_NOTFOUND   0x08
  63
  64 struct vlc_meta_t
  65 {
  66     char * ppsz_meta[VLC_META_TYPE_COUNT];
  67
  68     vlc_dictionary_t extra_tags;
  69
  70     int i_status;
  71 };
  72
  73 /* Setters for meta.
  74  * Warning: Make sure to use the input_item meta setters (defined in vlc_input.h)
  75  * instead of those one. */
  76 #define vlc_meta_SetTitle( meta, b )       vlc_meta_Set( meta, vlc_meta_Title, b )
  77 #define vlc_meta_SetArtist( meta, b )      vlc_meta_Set( meta, vlc_meta_Artist, b )
  78 #define vlc_meta_SetGenre( meta, b )       vlc_meta_Set( meta, vlc_meta_Genre, b )
  79 #define vlc_meta_SetCopyright( meta, b )   vlc_meta_Set( meta, vlc_meta_Copyright, b )
  80 #define vlc_meta_SetAlbum( meta, b )       vlc_meta_Set( meta, vlc_meta_Album, b )
  81 #define vlc_meta_SetTracknum( meta, b )    vlc_meta_Set( meta, vlc_meta_TrackNumber, b )
  82 #define vlc_meta_SetDescription( meta, b ) vlc_meta_Set( meta, vlc_meta_Description, b )
  83 #define vlc_meta_SetRating( meta, b )      vlc_meta_Set( meta, vlc_meta_Rating, b )
  84 #define vlc_meta_SetDate( meta, b )        vlc_meta_Set( meta, vlc_meta_Date, b )
  85 #define vlc_meta_SetSetting( meta, b )     vlc_meta_Set( meta, vlc_meta_Setting, b )
  86 #define vlc_meta_SetURL( meta, b )         vlc_meta_Set( meta, vlc_meta_URL, b )
  87 #define vlc_meta_SetLanguage( meta, b )    vlc_meta_Set( meta, vlc_meta_Language, b )
  88 #define vlc_meta_SetNowPlaying( meta, b )  vlc_meta_Set( meta, vlc_meta_NowPlaying, b )
  89 #define vlc_meta_SetPublisher( meta, b )   vlc_meta_Set( meta, vlc_meta_Publisher, b )
  90 #define vlc_meta_SetEncodedBy( meta, b )   vlc_meta_Set( meta, vlc_meta_EncodedBy, b )
  91 #define vlc_meta_SetArtURL( meta, b )      vlc_meta_Set( meta, vlc_meta_ArtworkURL, b )
  92 #define vlc_meta_SetTrackID( meta, b )     vlc_meta_Set( meta, vlc_meta_TrackID, b )
  93
  94 static inline void vlc_meta_Set( vlc_meta_t * p_meta, vlc_meta_type_t meta_type, const char * psz_val )
  95 {
  96     free( p_meta->ppsz_meta[meta_type] );
  97     p_meta->ppsz_meta[meta_type] = psz_val ? strdup( psz_val ) : NULL;
  98 }
  99
 100 static inline const char * vlc_meta_Get( const vlc_meta_t * p_meta, vlc_meta_type_t meta_type )
 101 {
 102     return p_meta->ppsz_meta[meta_type];
 103 }
 104
 105 static inline vlc_meta_t *vlc_meta_New( void )
 106 {
 107     vlc_meta_t *m = (vlc_meta_t*)malloc( sizeof( vlc_meta_t ) );
 108     if( !m ) return NULL;
 109     memset( m->ppsz_meta, 0, sizeof(m->ppsz_meta) );
 110     m->i_status = 0;
 111     vlc_dictionary_init( &m->extra_tags, 0 );
 112     return m;
 113 }
 114
 115 static inline void vlc_meta_Delete( vlc_meta_t *m )
 116 {
 117     int i;
 118     for( i = 0; i < VLC_META_TYPE_COUNT ; i++ )
 119         free( m->ppsz_meta[i] );
 120     vlc_dictionary_clear( &m->extra_tags );
 121     free( m );
 122 }
 123
 124 static inline void vlc_meta_AddExtra( vlc_meta_t *m, const char *psz_name, const char *psz_value )
 125 {
 126     char * psz_oldvalue = (char *)vlc_dictionary_value_for_key( &m->extra_tags, psz_name );
 127     if( psz_oldvalue != kVLCDictionaryNotFound )
 128     {
 129         free( psz_oldvalue );
 130         vlc_dictionary_remove_value_for_key( &m->extra_tags, psz_name );
 131     }
 132     vlc_dictionary_insert( &m->extra_tags, psz_name, strdup(psz_value) );
 133 }
 134
 135 static inline void vlc_meta_Merge( vlc_meta_t *dst, const vlc_meta_t *src )
 136 {
 137     char ** ppsz_all_keys;
 138     int i;
 139
 140     if( !dst || !src ) return;
 141
 142     for( i = 0; i < VLC_META_TYPE_COUNT; i++ )
 143     {
 144         if( src->ppsz_meta[i] )
 145         {
 146             free( dst->ppsz_meta[i] );
 147             dst->ppsz_meta[i] = strdup( src->ppsz_meta[i] );
 148         }
 149     }
 150
 151     /* XXX: If speed up are needed, it is possible */
 152     ppsz_all_keys = vlc_dictionary_all_keys( &src->extra_tags );
 153     for( i = 0; ppsz_all_keys[i]; i++ )
 154     {
 155         /* Always try to remove the previous value */
 156         vlc_dictionary_remove_value_for_key( &dst->extra_tags, ppsz_all_keys[i] );
 157         void * p_value = vlc_dictionary_value_for_key( &src->extra_tags, ppsz_all_keys[i] );
 158         vlc_dictionary_insert( &dst->extra_tags, ppsz_all_keys[i], p_value );
 159         free( ppsz_all_keys[i] );
 160     }
 161     free( ppsz_all_keys );
 162 }
 163
 164 #define VLC_META_TITLE              input_MetaTypeToLocalizedString( vlc_meta_Title )
 165 #define VLC_META_ARTIST             input_MetaTypeToLocalizedString( vlc_meta_Artist )
 166 #define VLC_META_GENRE              input_MetaTypeToLocalizedString( vlc_meta_Genre )
 167 #define VLC_META_COPYRIGHT          input_MetaTypeToLocalizedString( vlc_meta_Copyright )
 168 #define VLC_META_ALBUM              input_MetaTypeToLocalizedString( vlc_meta_Album )
 169 #define VLC_META_TRACK_NUMBER       input_MetaTypeToLocalizedString( vlc_meta_TrackNumber )
 170 #define VLC_META_DESCRIPTION        input_MetaTypeToLocalizedString( vlc_meta_Description )
 171 #define VLC_META_RATING             input_MetaTypeToLocalizedString( vlc_meta_Rating )
 172 #define VLC_META_DATE               input_MetaTypeToLocalizedString( vlc_meta_Date )
 173 #define VLC_META_SETTING            input_MetaTypeToLocalizedString( vlc_meta_Setting )
 174 #define VLC_META_URL                input_MetaTypeToLocalizedString( vlc_meta_URL )
 175 #define VLC_META_LANGUAGE           input_MetaTypeToLocalizedString( vlc_meta_Language )
 176 #define VLC_META_NOW_PLAYING        input_MetaTypeToLocalizedString( vlc_meta_NowPlaying )
 177 #define VLC_META_PUBLISHER          input_MetaTypeToLocalizedString( vlc_meta_Publisher )
 178 #define VLC_META_ENCODED_BY         input_MetaTypeToLocalizedString( vlc_meta_EncodedBy )
 179 #define VLC_META_ART_URL            input_MetaTypeToLocalizedString( vlc_meta_ArtworkURL )
 180 #define VLC_META_TRACKID            input_MetaTypeToLocalizedString( vlc_meta_TrackID )
 181
 182 enum {
 183     ALBUM_ART_WHEN_ASKED,
 184     ALBUM_ART_WHEN_PLAYED,
 185     ALBUM_ART_ALL
 186 };
 187
 188 struct meta_export_t
 189 {
 190     input_item_t *p_item;
 191     const char *psz_file;
 192 };
 193
 194 #endif