]> git.sesse.net Git - vlc/blobdiff - include/vlc_meta.h
include/vlc_meta.h: Use the vlc_dictionary to store extra meta tags.
[vlc] / include / vlc_meta.h
index a5272c709d1ce4d967cad1272278fb0af25e3914..1d5820419de14198b349d1f8d8e1d964a75e83b2 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+#if !defined( __LIBVLC__ )
+  #error You are not libvlc or one of its plugins. You cannot include this file
+#endif
+
 #ifndef _VLC_META_H
 #define _VLC_META_H 1
 
+#include <vlc_arrays.h>
+
 /* 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_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")
 
+#define ITEM_PREPARSED      0x01
+#define ITEM_META_FETCHED   0x02
+#define ITEM_ARTURL_FETCHED 0x04
+#define ITEM_ART_FETCHED    0x08
+#define ITEM_ART_NOTFOUND   0x10
+
 struct vlc_meta_t
 {
     char *psz_title;
-    char *psz_author;
     char *psz_artist;
     char *psz_genre;
     char *psz_copyright;
@@ -64,40 +76,43 @@ struct vlc_meta_t
     char *psz_nowplaying;
     char *psz_publisher;
     char *psz_encodedby;
-#if 0
-    /* track meta information */
-    int         i_track;
-    vlc_meta_t  **track;
-#endif
+    char *psz_arturl;
+    char *psz_trackid;
+
+    vlc_dictionary_t extra_tags;
+
+    int i_status;
+
 };
 
-#define vlc_meta_Set( meta,var,val ) { \
+#define vlc_meta_Set( meta,var,val ) do { \
+    const char *str = 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 );
+    meta->psz_##var = str ? strdup( str ) : NULL; } while(0)
+
+#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 )
 
 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;
@@ -112,13 +127,17 @@ static inline vlc_meta_t *vlc_meta_New( void )
     m->psz_nowplaying = NULL;
     m->psz_publisher = NULL;
     m->psz_encodedby = NULL;
+    m->psz_arturl = NULL;
+    m->psz_trackid = NULL;
+
+    m->i_status = 0;
+    vlc_dictionary_init( &m->extra_tags, 32 /* "ought to be enough for anybody" */ );
     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 );
@@ -133,11 +152,23 @@ static inline void vlc_meta_Delete( vlc_meta_t *m )
     free( m->psz_nowplaying );
     free( m->psz_publisher );
     free( m->psz_encodedby );
-
+    free( m->psz_trackid );
+    free( m->psz_arturl );
+    vlc_dictionary_clear( &m->extra_tags );
     free( m );
 }
+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, vlc_meta_t *src )
+static inline void vlc_meta_Merge( vlc_meta_t *dst, const vlc_meta_t *src )
 {
     if( !dst || !src ) return;
 #define COPY_FIELD( a ) \
@@ -146,7 +177,6 @@ static inline void vlc_meta_Merge( vlc_meta_t *dst, vlc_meta_t *src )
         dst->psz_##a = strdup( src->psz_##a ); \
     }
     COPY_FIELD( title );
-    COPY_FIELD( author );
     COPY_FIELD( artist );
     COPY_FIELD( genre );
     COPY_FIELD( copyright );
@@ -161,7 +191,69 @@ static inline void vlc_meta_Merge( vlc_meta_t *dst, vlc_meta_t *src )
     COPY_FIELD( nowplaying );
     COPY_FIELD( publisher );
     COPY_FIELD( encodedby );
+    COPY_FIELD( trackid );
+    COPY_FIELD( arturl );
+#undef COPY_FIELD
+    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++ )
+    {
+        /* 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 */
+
+enum {
+    ALBUM_ART_WHEN_ASKED,
+    ALBUM_ART_WHEN_PLAYED,
+    ALBUM_ART_ALL
+};
+
+struct meta_export_t
+{
+    input_item_t *p_item;
+    const char *psz_file;
+};
+
+#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;
+};
+
+VLC_EXPORT(uint32_t, input_CurrentMetaFlags,( vlc_meta_t *p_meta ) );
 
 #endif