vlc_meta.h

Go to the documentation of this file.
00001 /*****************************************************************************
00002  * vlc_meta.h: Stream meta-data
00003  *****************************************************************************
00004  * Copyright (C) 2004 the VideoLAN team
00005  * $Id$
00006  *
00007  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
00008  *
00009  * This program is free software; you can redistribute it and/or modify
00010  * it under the terms of the GNU General Public License as published by
00011  * the Free Software Foundation; either version 2 of the License, or
00012  * (at your option) any later version.
00013  *
00014  * This program is distributed in the hope that it will be useful,
00015  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00017  * GNU General Public License for more details.
00018  *
00019  * You should have received a copy of the GNU General Public License
00020  * along with this program; if not, write to the Free Software
00021  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
00022  *****************************************************************************/
00023 
00024 #ifndef VLC_META_H
00025 #define VLC_META_H 1
00026 
00027 #include <vlc_arrays.h>
00028 
00029 typedef enum vlc_meta_type_t
00030 {
00031     vlc_meta_Title,
00032     vlc_meta_Artist,
00033     vlc_meta_Genre,
00034     vlc_meta_Copyright,
00035     vlc_meta_Album,
00036     vlc_meta_TrackNumber,
00037     vlc_meta_Description,
00038     vlc_meta_Rating,
00039     vlc_meta_Date,
00040     vlc_meta_Setting,
00041     vlc_meta_URL,
00042     vlc_meta_Language,
00043     vlc_meta_NowPlaying,
00044     vlc_meta_Publisher,
00045     vlc_meta_EncodedBy,
00046     vlc_meta_ArtworkURL,
00047     vlc_meta_TrackID
00048 } vlc_meta_type_t;
00049 
00050 #define VLC_META_TYPE_COUNT 17
00051 
00052 /* Returns a localizes string describing the meta */
00053 VLC_EXPORT(const char *, input_MetaTypeToLocalizedString, ( vlc_meta_type_t meta_type ) );
00054 
00055 #define ITEM_PREPARSED      0x01
00056 #define ITEM_ARTURL_FETCHED 0x02
00057 #define ITEM_ART_FETCHED    0x04
00058 #define ITEM_ART_NOTFOUND   0x08
00059 
00060 struct vlc_meta_t
00061 {
00062     char * ppsz_meta[VLC_META_TYPE_COUNT];
00063 
00064     vlc_dictionary_t extra_tags;
00065 
00066     int i_status;
00067 };
00068 
00069 /* Setters for meta.
00070  * Warning: Make sure to use the input_item meta setters (defined in vlc_input.h)
00071  * instead of those one. */
00072 #define vlc_meta_SetTitle( meta, b )       vlc_meta_Set( meta, vlc_meta_Title, b )
00073 #define vlc_meta_SetArtist( meta, b )      vlc_meta_Set( meta, vlc_meta_Artist, b )
00074 #define vlc_meta_SetGenre( meta, b )       vlc_meta_Set( meta, vlc_meta_Genre, b )
00075 #define vlc_meta_SetCopyright( meta, b )   vlc_meta_Set( meta, vlc_meta_Copyright, b )
00076 #define vlc_meta_SetAlbum( meta, b )       vlc_meta_Set( meta, vlc_meta_Album, b )
00077 #define vlc_meta_SetTracknum( meta, b )    vlc_meta_Set( meta, vlc_meta_TrackNumber, b )
00078 #define vlc_meta_SetDescription( meta, b ) vlc_meta_Set( meta, vlc_meta_Description, b )
00079 #define vlc_meta_SetRating( meta, b )      vlc_meta_Set( meta, vlc_meta_Rating, b )
00080 #define vlc_meta_SetDate( meta, b )        vlc_meta_Set( meta, vlc_meta_Date, b )
00081 #define vlc_meta_SetSetting( meta, b )     vlc_meta_Set( meta, vlc_meta_Setting, b )
00082 #define vlc_meta_SetURL( meta, b )         vlc_meta_Set( meta, vlc_meta_URL, b )
00083 #define vlc_meta_SetLanguage( meta, b )    vlc_meta_Set( meta, vlc_meta_Language, b )
00084 #define vlc_meta_SetNowPlaying( meta, b )  vlc_meta_Set( meta, vlc_meta_NowPlaying, b )
00085 #define vlc_meta_SetPublisher( meta, b )   vlc_meta_Set( meta, vlc_meta_Publisher, b )
00086 #define vlc_meta_SetEncodedBy( meta, b )   vlc_meta_Set( meta, vlc_meta_EncodedBy, b )
00087 #define vlc_meta_SetArtURL( meta, b )      vlc_meta_Set( meta, vlc_meta_ArtworkURL, b )
00088 #define vlc_meta_SetTrackID( meta, b )     vlc_meta_Set( meta, vlc_meta_TrackID, b )
00089 
00090 static inline void vlc_meta_Set( vlc_meta_t * p_meta, vlc_meta_type_t meta_type, const char * psz_val )
00091 {
00092     free( p_meta->ppsz_meta[meta_type] );
00093     p_meta->ppsz_meta[meta_type] = psz_val ? strdup( psz_val ) : NULL;
00094 }
00095 
00096 static inline const char * vlc_meta_Get( const vlc_meta_t * p_meta, vlc_meta_type_t meta_type )
00097 {
00098     return p_meta->ppsz_meta[meta_type];
00099 }
00100 
00101 static inline vlc_meta_t *vlc_meta_New( void )
00102 {
00103     vlc_meta_t *m = (vlc_meta_t*)malloc( sizeof( vlc_meta_t ) );
00104     if( !m ) return NULL;
00105     memset( m->ppsz_meta, 0, sizeof(m->ppsz_meta) );
00106     m->i_status = 0;
00107     vlc_dictionary_init( &m->extra_tags, 0 );
00108     return m;
00109 }
00110 
00111 static inline void vlc_meta_Delete( vlc_meta_t *m )
00112 {
00113     int i;
00114     for( i = 0; i < VLC_META_TYPE_COUNT ; i++ )
00115         free( m->ppsz_meta[i] );
00116     vlc_dictionary_clear( &m->extra_tags );
00117     free( m );
00118 }
00119 
00120 static inline void vlc_meta_AddExtra( vlc_meta_t *m, const char *psz_name, const char *psz_value )
00121 {
00122     char * psz_oldvalue = (char *)vlc_dictionary_value_for_key( &m->extra_tags, psz_name );
00123     if( psz_oldvalue != kVLCDictionaryNotFound )
00124     {
00125         free( psz_oldvalue );
00126         vlc_dictionary_remove_value_for_key( &m->extra_tags, psz_name );
00127     }
00128     vlc_dictionary_insert( &m->extra_tags, psz_name, strdup(psz_value) );
00129 }
00130 
00131 static inline void vlc_meta_Merge( vlc_meta_t *dst, const vlc_meta_t *src )
00132 {
00133     char ** ppsz_all_keys;
00134     int i;
00135 
00136     if( !dst || !src ) return;
00137 
00138     for( i = 0; i < VLC_META_TYPE_COUNT; i++ )
00139     {
00140         if( src->ppsz_meta[i] )
00141         {
00142             free( dst->ppsz_meta[i] );
00143             dst->ppsz_meta[i] = strdup( src->ppsz_meta[i] );
00144         }
00145     }
00146 
00147     /* XXX: If speed up are needed, it is possible */
00148     ppsz_all_keys = vlc_dictionary_all_keys( &src->extra_tags );
00149     for( i = 0; ppsz_all_keys[i]; i++ )
00150     {
00151         /* Always try to remove the previous value */
00152         vlc_dictionary_remove_value_for_key( &dst->extra_tags, ppsz_all_keys[i] );
00153         void * p_value = vlc_dictionary_value_for_key( &src->extra_tags, ppsz_all_keys[i] );
00154         vlc_dictionary_insert( &dst->extra_tags, ppsz_all_keys[i], p_value );
00155         free( ppsz_all_keys[i] );
00156     }
00157     free( ppsz_all_keys );
00158 }
00159 
00160 #define VLC_META_TITLE              input_MetaTypeToLocalizedString( vlc_meta_Title )
00161 #define VLC_META_ARTIST             input_MetaTypeToLocalizedString( vlc_meta_Artist )
00162 #define VLC_META_GENRE              input_MetaTypeToLocalizedString( vlc_meta_Genre )
00163 #define VLC_META_COPYRIGHT          input_MetaTypeToLocalizedString( vlc_meta_Copyright )
00164 #define VLC_META_ALBUM              input_MetaTypeToLocalizedString( vlc_meta_Album )
00165 #define VLC_META_TRACK_NUMBER       input_MetaTypeToLocalizedString( vlc_meta_TrackNumber )
00166 #define VLC_META_DESCRIPTION        input_MetaTypeToLocalizedString( vlc_meta_Description )
00167 #define VLC_META_RATING             input_MetaTypeToLocalizedString( vlc_meta_Rating )
00168 #define VLC_META_DATE               input_MetaTypeToLocalizedString( vlc_meta_Date )
00169 #define VLC_META_SETTING            input_MetaTypeToLocalizedString( vlc_meta_Setting )
00170 #define VLC_META_URL                input_MetaTypeToLocalizedString( vlc_meta_URL )
00171 #define VLC_META_LANGUAGE           input_MetaTypeToLocalizedString( vlc_meta_Language )
00172 #define VLC_META_NOW_PLAYING        input_MetaTypeToLocalizedString( vlc_meta_NowPlaying )
00173 #define VLC_META_PUBLISHER          input_MetaTypeToLocalizedString( vlc_meta_Publisher )
00174 #define VLC_META_ENCODED_BY         input_MetaTypeToLocalizedString( vlc_meta_EncodedBy )
00175 #define VLC_META_ART_URL            input_MetaTypeToLocalizedString( vlc_meta_ArtworkURL )
00176 #define VLC_META_TRACKID            input_MetaTypeToLocalizedString( vlc_meta_TrackID )
00177 
00178 enum {
00179     ALBUM_ART_WHEN_ASKED,
00180     ALBUM_ART_WHEN_PLAYED,
00181     ALBUM_ART_ALL
00182 };
00183 
00184 struct meta_export_t
00185 {
00186     input_item_t *p_item;
00187     const char *psz_file;
00188 };
00189 
00190 #endif

Generated on Wed Aug 13 08:02:37 2008 for VLC by  doxygen 1.5.1