]> git.sesse.net Git - vlc/blobdiff - include/vlc_meta.h
Use var_InheritString for --decklink-video-connection.
[vlc] / include / vlc_meta.h
index fd50877d923cf30357e4e3375afb11914889258e..b225bf88a3c516a9b3e0f28bc42835152abee214 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-#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")
-
-#define ITEM_PREPARSED      0x01
-#define ITEM_META_FETCHED   0x02
-#define ITEM_ARTURL_FETCHED 0x04
-#define ITEM_ART_FETCHED    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;
-
-    int i_status;
-#if 0
-    /* track meta information */
-    int         i_track;
-    vlc_meta_t  **track;
-#endif
-};
+#ifndef VLC_META_H
+#define VLC_META_H 1
 
-#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 );
-
-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;
-    m->i_status = 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 );
-
-    free( m );
-}
-
-static inline void vlc_meta_Merge( vlc_meta_t *dst, vlc_meta_t *src )
+/**
+ * \file
+ * This file defines functions and structures for stream meta-data in vlc
+ *
+ */
+
+typedef enum vlc_meta_type_t
 {
-    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 ); \
-    }
-    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 );
-}
-    /** \todo Track meta */
+    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
+
+#define ITEM_PREPARSED       1
+#define ITEM_ARTURL_FETCHED  2
+#define ITEM_ART_FETCHED     4
+#define ITEM_ART_NOTFOUND    8
+
+/**
+ * Basic function to deal with meta
+ */
+struct vlc_meta_t;
+
+VLC_EXPORT(vlc_meta_t *, vlc_meta_New, ( void ) LIBVLC_USED );
+VLC_EXPORT(void,         vlc_meta_Delete, ( vlc_meta_t *m ));
+VLC_EXPORT(void,         vlc_meta_Set, ( vlc_meta_t *p_meta, vlc_meta_type_t meta_type, const char *psz_val ));
+VLC_EXPORT(const char *, vlc_meta_Get, ( const vlc_meta_t *p_meta, vlc_meta_type_t meta_type ));
+
+VLC_EXPORT(void,         vlc_meta_AddExtra, ( vlc_meta_t *m, const char *psz_name, const char *psz_value ));
+VLC_EXPORT(const char *, vlc_meta_GetExtra, ( const vlc_meta_t *m, const char *psz_name ));
+VLC_EXPORT(unsigned,     vlc_meta_GetExtraCount, ( const vlc_meta_t *m ));
+
+/**
+ * Allocate a copy of all extra meta names and a table with it.
+ * Be sure to free both the returned pointers and its name.
+ */
+VLC_EXPORT(char **,      vlc_meta_CopyExtraNames, ( const vlc_meta_t *m ) LIBVLC_USED );
+
+VLC_EXPORT(void,         vlc_meta_Merge, ( vlc_meta_t *dst, const vlc_meta_t *src ));
+
+VLC_EXPORT(int,  vlc_meta_GetStatus, ( vlc_meta_t *m ));
+VLC_EXPORT(void, vlc_meta_SetStatus, ( vlc_meta_t *m, int status ));
+
+/**
+ * Returns a localizes string describing the meta
+ */
+VLC_EXPORT(const char *, vlc_meta_TypeToLocalizedString, ( vlc_meta_type_t meta_type ) );
 
 enum {
-    ALBUM_ART_NEVER,
     ALBUM_ART_WHEN_ASKED,
     ALBUM_ART_WHEN_PLAYED,
-    ALBUM_ART_ALL };
-
-struct meta_export_t
-{
-    input_item_t *p_item;
-    const char *psz_file;
+    ALBUM_ART_ALL
 };
 
-#define VLC_META_ENGINE_TITLE           0x00000001
-#define VLC_META_ENGINE_AUTHOR          0x00000002
-#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
+
+typedef struct meta_export_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;
-};
+    const char *psz_file;
+} meta_export_t;
+
+VLC_EXPORT( int, input_item_WriteMeta, (vlc_object_t *, input_item_t *) );
+
+/* 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 )
+
+#define VLC_META_TITLE              vlc_meta_TypeToLocalizedString( vlc_meta_Title )
+#define VLC_META_ARTIST             vlc_meta_TypeToLocalizedString( vlc_meta_Artist )
+#define VLC_META_GENRE              vlc_meta_TypeToLocalizedString( vlc_meta_Genre )
+#define VLC_META_COPYRIGHT          vlc_meta_TypeToLocalizedString( vlc_meta_Copyright )
+#define VLC_META_ALBUM              vlc_meta_TypeToLocalizedString( vlc_meta_Album )
+#define VLC_META_TRACK_NUMBER       vlc_meta_TypeToLocalizedString( vlc_meta_TrackNumber )
+#define VLC_META_DESCRIPTION        vlc_meta_TypeToLocalizedString( vlc_meta_Description )
+#define VLC_META_RATING             vlc_meta_TypeToLocalizedString( vlc_meta_Rating )
+#define VLC_META_DATE               vlc_meta_TypeToLocalizedString( vlc_meta_Date )
+#define VLC_META_SETTING            vlc_meta_TypeToLocalizedString( vlc_meta_Setting )
+#define VLC_META_URL                vlc_meta_TypeToLocalizedString( vlc_meta_URL )
+#define VLC_META_LANGUAGE           vlc_meta_TypeToLocalizedString( vlc_meta_Language )
+#define VLC_META_NOW_PLAYING        vlc_meta_TypeToLocalizedString( vlc_meta_NowPlaying )
+#define VLC_META_PUBLISHER          vlc_meta_TypeToLocalizedString( vlc_meta_Publisher )
+#define VLC_META_ENCODED_BY         vlc_meta_TypeToLocalizedString( vlc_meta_EncodedBy )
+#define VLC_META_ART_URL            vlc_meta_TypeToLocalizedString( vlc_meta_ArtworkURL )
+#define VLC_META_TRACKID            vlc_meta_TypeToLocalizedString( vlc_meta_TrackID )
 
-VLC_EXPORT( uint32_t, input_GetMetaEngineFlags, ( vlc_meta_t *p_meta ) );
 
 #endif