]> git.sesse.net Git - vlc/blobdiff - include/vlc_meta.h
jvlc: libvlcState enum index comment added for reference
[vlc] / include / vlc_meta.h
index ca59563cda8fc93c6ce240f87991c4c2b9d7c7bf..a8f2ab7120649a6ccedf3bdd7c87e9b6a035cd4d 100644 (file)
 #ifndef _VLC_META_H
 #define _VLC_META_H 1
 
-/* VLC meta name */
-#define VLC_META_INFO_CAT           N_("Meta-information")
-#define VLC_META_TITLE              N_("Title")
-#define VLC_META_AUTHOR             N_("Author")
-#define VLC_META_ARTIST             N_("Artist")
-#define VLC_META_GENRE              N_("Genre")
-#define VLC_META_COPYRIGHT          N_("Copyright")
-#define VLC_META_COLLECTION         N_("Album/movie/show title")
-#define VLC_META_SEQ_NUM            N_("Track number/position in set")
-#define VLC_META_DESCRIPTION        N_("Description")
-#define VLC_META_RATING             N_("Rating")
-#define VLC_META_DATE               N_("Date")
-#define VLC_META_SETTING            N_("Setting")
-#define VLC_META_URL                N_("URL")
-#define VLC_META_LANGUAGE           N_("Language")
-#define VLC_META_NOW_PLAYING        N_("Now Playing")
-#define VLC_META_PUBLISHER          N_("Publisher")
-#define VLC_META_ENCODED_BY         N_("Encoded by")
-
-#define VLC_META_ART_URL            N_("Art URL")
-
-#define VLC_META_CODEC_NAME         N_("Codec Name")
-#define VLC_META_CODEC_DESCRIPTION  N_("Codec Description")
+#include <vlc_arrays.h>
+
+typedef enum vlc_meta_type_t
+{
+    vlc_meta_Title,
+    vlc_meta_Artist,
+    vlc_meta_Genre,
+    vlc_meta_Copyright,
+    vlc_meta_Album,
+    vlc_meta_TrackNumber,
+    vlc_meta_Description,
+    vlc_meta_Rating,
+    vlc_meta_Date,
+    vlc_meta_Setting,
+    vlc_meta_URL,
+    vlc_meta_Language,
+    vlc_meta_NowPlaying,
+    vlc_meta_Publisher,
+    vlc_meta_EncodedBy,
+    vlc_meta_ArtworkURL,
+    vlc_meta_TrackID
+} vlc_meta_type_t;
+
+#define VLC_META_TYPE_COUNT 17
+
+/* Returns a localizes string describing the meta */
+VLC_EXPORT(const char *, input_MetaTypeToLocalizedString, ( vlc_meta_type_t meta_type ) );
 
 #define ITEM_PREPARSED      0x01
-#define ITEM_META_FETCHED   0x02
-#define ITEM_ARTURL_FETCHED 0x04
-#define ITEM_ART_FETCHED    0x08
+#define ITEM_ARTURL_FETCHED 0x02
+#define ITEM_ART_FETCHED    0x04
+#define ITEM_ART_NOTFOUND   0x08
 
 struct vlc_meta_t
 {
-    char *psz_title;
-    char *psz_author;
-    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;
-    char *psz_encodedby;
-    char *psz_arturl;
+    char * ppsz_meta[VLC_META_TYPE_COUNT];
+
+    vlc_dictionary_t extra_tags;
 
     int i_status;
-#if 0
-    /* track meta information */
-    int         i_track;
-    vlc_meta_t  **track;
-#endif
 };
 
-#define vlc_meta_Set( meta,var,val ) { \
-    if( meta->psz_##var ) free( meta->psz_##var ); \
-    meta->psz_##var = strdup( val ); }
-
-#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_SetAuthor( meta, b ) vlc_meta_Set( meta, author, 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 );
+/* Setters for meta.
+ * Warning: Make sure to use the input_item meta setters (defined in vlc_input.h)
+ * instead of those one. */
+#define vlc_meta_SetTitle( meta, b )       vlc_meta_Set( meta, vlc_meta_Title, b )
+#define vlc_meta_SetArtist( meta, b )      vlc_meta_Set( meta, vlc_meta_Artist, b )
+#define vlc_meta_SetGenre( meta, b )       vlc_meta_Set( meta, vlc_meta_Genre, b )
+#define vlc_meta_SetCopyright( meta, b )   vlc_meta_Set( meta, vlc_meta_Copyright, b )
+#define vlc_meta_SetAlbum( meta, b )       vlc_meta_Set( meta, vlc_meta_Album, b )
+#define vlc_meta_SetTracknum( meta, b )    vlc_meta_Set( meta, vlc_meta_TrackNumber, b )
+#define vlc_meta_SetDescription( meta, b ) vlc_meta_Set( meta, vlc_meta_Description, b )
+#define vlc_meta_SetRating( meta, b )      vlc_meta_Set( meta, vlc_meta_Rating, b )
+#define vlc_meta_SetDate( meta, b )        vlc_meta_Set( meta, vlc_meta_Date, b )
+#define vlc_meta_SetSetting( meta, b )     vlc_meta_Set( meta, vlc_meta_Setting, b )
+#define vlc_meta_SetURL( meta, b )         vlc_meta_Set( meta, vlc_meta_URL, b )
+#define vlc_meta_SetLanguage( meta, b )    vlc_meta_Set( meta, vlc_meta_Language, b )
+#define vlc_meta_SetNowPlaying( meta, b )  vlc_meta_Set( meta, vlc_meta_NowPlaying, b )
+#define vlc_meta_SetPublisher( meta, b )   vlc_meta_Set( meta, vlc_meta_Publisher, b )
+#define vlc_meta_SetEncodedBy( meta, b )   vlc_meta_Set( meta, vlc_meta_EncodedBy, b )
+#define vlc_meta_SetArtURL( meta, b )      vlc_meta_Set( meta, vlc_meta_ArtworkURL, b )
+#define vlc_meta_SetTrackID( meta, b )     vlc_meta_Set( meta, vlc_meta_TrackID, b )
+
+static inline void vlc_meta_Set( vlc_meta_t * p_meta, vlc_meta_type_t meta_type, const char * psz_val )
+{
+    free( p_meta->ppsz_meta[meta_type] );
+    p_meta->ppsz_meta[meta_type] = psz_val ? strdup( psz_val ) : NULL;
+}
+
+static inline const char * vlc_meta_Get( const vlc_meta_t * p_meta, vlc_meta_type_t meta_type )
+{
+    return p_meta->ppsz_meta[meta_type];
+}
 
 static inline vlc_meta_t *vlc_meta_New( void )
 {
     vlc_meta_t *m = (vlc_meta_t*)malloc( sizeof( vlc_meta_t ) );
     if( !m ) return NULL;
-    m->psz_title = NULL;
-    m->psz_author = 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;
-    m->psz_encodedby = NULL;
-    m->psz_arturl = NULL;
+    memset( m->ppsz_meta, 0, sizeof(m->ppsz_meta) );
     m->i_status = 0;
+    vlc_dictionary_init( &m->extra_tags, 0 );
     return m;
 }
 
 static inline void vlc_meta_Delete( vlc_meta_t *m )
 {
-    free( m->psz_title );
-    free( m->psz_author );
-    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 );
-    free( m->psz_encodedby );
-    free( m->psz_arturl );
-
+    int i;
+    for( i = 0; i < VLC_META_TYPE_COUNT ; i++ )
+        free( m->ppsz_meta[i] );
+    vlc_dictionary_clear( &m->extra_tags );
     free( m );
 }
 
-static inline void vlc_meta_Merge( vlc_meta_t *dst, vlc_meta_t *src )
+static inline void vlc_meta_AddExtra( vlc_meta_t *m, const char *psz_name, const char *psz_value )
 {
+    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) );
+}
+
+static inline void vlc_meta_Merge( vlc_meta_t *dst, const vlc_meta_t *src )
+{
+    char ** ppsz_all_keys;
+    int i;
+
     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 ); \
+
+    for( i = 0; i < VLC_META_TYPE_COUNT; i++ )
+    {
+        if( src->ppsz_meta[i] )
+        {
+            free( dst->ppsz_meta[i] );
+            dst->ppsz_meta[i] = strdup( src->ppsz_meta[i] );
+        }
     }
-    COPY_FIELD( title );
-    COPY_FIELD( author );
-    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 );
-    COPY_FIELD( encodedby );
-    COPY_FIELD( arturl );
+
+    /* 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++ )
+    {
+        /* 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] );
+    }
+    free( ppsz_all_keys );
 }
-    /** \todo Track meta */
+
+#define VLC_META_TITLE              input_MetaTypeToLocalizedString( vlc_meta_Title )
+#define VLC_META_ARTIST             input_MetaTypeToLocalizedString( vlc_meta_Artist )
+#define VLC_META_GENRE              input_MetaTypeToLocalizedString( vlc_meta_Genre )
+#define VLC_META_COPYRIGHT          input_MetaTypeToLocalizedString( vlc_meta_Copyright )
+#define VLC_META_ALBUM              input_MetaTypeToLocalizedString( vlc_meta_Album )
+#define VLC_META_TRACK_NUMBER       input_MetaTypeToLocalizedString( vlc_meta_TrackNumber )
+#define VLC_META_DESCRIPTION        input_MetaTypeToLocalizedString( vlc_meta_Description )
+#define VLC_META_RATING             input_MetaTypeToLocalizedString( vlc_meta_Rating )
+#define VLC_META_DATE               input_MetaTypeToLocalizedString( vlc_meta_Date )
+#define VLC_META_SETTING            input_MetaTypeToLocalizedString( vlc_meta_Setting )
+#define VLC_META_URL                input_MetaTypeToLocalizedString( vlc_meta_URL )
+#define VLC_META_LANGUAGE           input_MetaTypeToLocalizedString( vlc_meta_Language )
+#define VLC_META_NOW_PLAYING        input_MetaTypeToLocalizedString( vlc_meta_NowPlaying )
+#define VLC_META_PUBLISHER          input_MetaTypeToLocalizedString( vlc_meta_Publisher )
+#define VLC_META_ENCODED_BY         input_MetaTypeToLocalizedString( vlc_meta_EncodedBy )
+#define VLC_META_ART_URL            input_MetaTypeToLocalizedString( vlc_meta_ArtworkURL )
+#define VLC_META_TRACKID            input_MetaTypeToLocalizedString( vlc_meta_TrackID )
 
 enum {
-    ALBUM_ART_NEVER,
     ALBUM_ART_WHEN_ASKED,
     ALBUM_ART_WHEN_PLAYED,
-    ALBUM_ART_ALL };
+    ALBUM_ART_ALL
+};
+
+struct meta_export_t
+{
+    input_item_t *p_item;
+    const char *psz_file;
+};
 
 #endif