vlc_meta.h File Reference

This file defines functions and structures for stream meta-data in vlc. More...

Include dependency graph for vlc_meta.h:

Go to the source code of this file.

Data Structures
struct	vlc_meta_t
struct	meta_export_t
Defines
#define	VLC_META_H   1
#define	VLC_META_TYPE_COUNT   17
#define	ITEM_PREPARSED   0x01
#define	ITEM_ARTURL_FETCHED   0x02
#define	ITEM_ART_FETCHED   0x04
#define	ITEM_ART_NOTFOUND   0x08
#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   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 )
Enumerations
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 }
enum	{ ALBUM_ART_WHEN_ASKED, ALBUM_ART_WHEN_PLAYED, ALBUM_ART_ALL }
Functions
const char *	input_MetaTypeToLocalizedString (vlc_meta_type_t meta_type)
static void	vlc_meta_FreeExtraKey (void *p_data, void *p_obj)
static void	vlc_meta_Set (vlc_meta_t *p_meta, vlc_meta_type_t meta_type, const char *psz_val)
static const char *	vlc_meta_Get (const vlc_meta_t *p_meta, vlc_meta_type_t meta_type)
static vlc_meta_t *	vlc_meta_New (void)
static void	vlc_meta_Delete (vlc_meta_t *m)
static void	vlc_meta_AddExtra (vlc_meta_t *m, const char *psz_name, const char *psz_value)
static void	vlc_meta_Merge (vlc_meta_t *dst, const vlc_meta_t *src)
int	input_item_WriteMeta (vlc_object_t *, input_item_t *)

---

Detailed Description

This file defines functions and structures for stream meta-data in vlc.

---

Define Documentation

#define ITEM_ART_FETCHED   0x04

Referenced by input_item_IsArtFetched(), and input_item_SetArtFetched().

#define ITEM_ART_NOTFOUND   0x08

Referenced by input_item_SetArtNotFound().

#define ITEM_ARTURL_FETCHED   0x02

#define ITEM_PREPARSED   0x01

Referenced by input_item_IsPreparsed(), and input_item_SetPreparsed().

#define VLC_META_ALBUM   input_MetaTypeToLocalizedString( vlc_meta_Album )

Referenced by MetaPanel::MetaPanel(), psz_column_title(), and Redraw().

#define VLC_META_ART_URL   input_MetaTypeToLocalizedString( vlc_meta_ArtworkURL )

Referenced by Redraw().

#define VLC_META_ARTIST   input_MetaTypeToLocalizedString( vlc_meta_Artist )

Referenced by MetaPanel::MetaPanel(), psz_column_title(), and Redraw().

#define VLC_META_COPYRIGHT   input_MetaTypeToLocalizedString( vlc_meta_Copyright )

Referenced by MetaPanel::MetaPanel(), and Redraw().

#define VLC_META_DATE   input_MetaTypeToLocalizedString( vlc_meta_Date )

Referenced by MetaPanel::MetaPanel(), and Redraw().

#define VLC_META_DESCRIPTION   input_MetaTypeToLocalizedString( vlc_meta_Description )

Referenced by psz_column_title(), and Redraw().

#define VLC_META_ENCODED_BY   input_MetaTypeToLocalizedString( vlc_meta_EncodedBy )

Referenced by Redraw().

#define VLC_META_GENRE   input_MetaTypeToLocalizedString( vlc_meta_Genre )

Referenced by MetaPanel::MetaPanel(), psz_column_title(), and Redraw().

#define VLC_META_H   1

#define VLC_META_LANGUAGE   input_MetaTypeToLocalizedString( vlc_meta_Language )

Referenced by MetaPanel::MetaPanel(), and Redraw().

#define VLC_META_NOW_PLAYING   input_MetaTypeToLocalizedString( vlc_meta_NowPlaying )

Referenced by MetaPanel::MetaPanel(), and Redraw().

#define VLC_META_PUBLISHER   input_MetaTypeToLocalizedString( vlc_meta_Publisher )

Referenced by MetaPanel::MetaPanel(), and Redraw().

#define VLC_META_RATING   input_MetaTypeToLocalizedString( vlc_meta_Rating )

Referenced by Redraw().

#define vlc_meta_SetAlbum	(	meta,
		b		)	vlc_meta_Set( meta, vlc_meta_Album, b )

Referenced by CdTextParse(), Control(), ParseAPEvXTag(), and ParseID3Tag().

#define vlc_meta_SetArtist	(	meta,
		b		)	vlc_meta_Set( meta, vlc_meta_Artist, b )

Referenced by CdTextParse(), Control(), DemuxInit(), ParseAPEvXTag(), and ParseID3Tag().

#define vlc_meta_SetArtURL	(	meta,
		b		)	vlc_meta_Set( meta, vlc_meta_ArtworkURL, b )

Referenced by ReadMetaFromId3v2(), and ReadMetaFromXiph().

#define vlc_meta_SetCopyright	(	meta,
		b		)	vlc_meta_Set( meta, vlc_meta_Copyright, b )

Referenced by Control(), DemuxInit(), ParseAPEvXTag(), and ParseID3Tag().

#define vlc_meta_SetDate	(	meta,
		b		)	vlc_meta_Set( meta, vlc_meta_Date, b )

Referenced by Control(), matroska_segment_c::InformationCreate(), ParseAPEvXTag(), and ParseID3Tag().

#define vlc_meta_SetDescription	(	meta,
		b		)	vlc_meta_Set( meta, vlc_meta_Description, b )

Referenced by CdTextParse(), Control(), DemuxInit(), ParseAPEvXTag(), and ParseID3Tag().

#define vlc_meta_SetEncodedBy	(	meta,
		b		)	vlc_meta_Set( meta, vlc_meta_EncodedBy, b )

Referenced by Control(), and ParseID3Tag().

#define vlc_meta_SetGenre	(	meta,
		b		)	vlc_meta_Set( meta, vlc_meta_Genre, b )

Referenced by CdTextParse(), Control(), ParseAPEvXTag(), and ParseID3Tag().

#define vlc_meta_SetLanguage	(	meta,
		b		)	vlc_meta_Set( meta, vlc_meta_Language, b )

Referenced by ParseAPEvXTag().

#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 )

Referenced by DemuxDecodeXds(), ParseAPEvXTag(), and ParseID3Tag().

#define vlc_meta_SetRating	(	meta,
		b		)	vlc_meta_Set( meta, vlc_meta_Rating, b )

Referenced by DemuxInit().

#define vlc_meta_SetSetting	(	meta,
		b		)	vlc_meta_Set( meta, vlc_meta_Setting, b )

#define VLC_META_SETTING   input_MetaTypeToLocalizedString( vlc_meta_Setting )

Referenced by Redraw().

#define vlc_meta_SetTitle	(	meta,
		b		)	vlc_meta_Set( meta, vlc_meta_Title, b )

Referenced by CdTextParse(), Control(), DemuxDecodeXds(), DemuxInit(), matroska_segment_c::InformationCreate(), ParseAPEvXTag(), and ParseID3Tag().

#define vlc_meta_SetTrackID	(	meta,
		b		)	vlc_meta_Set( meta, vlc_meta_TrackID, b )

Referenced by ParseID3Tag(), and ReadMetaFromId3v2().

#define vlc_meta_SetTrackNum	(	meta,
		b		)	vlc_meta_Set( meta, vlc_meta_TrackNumber, b )

Referenced by Control(), ParseAPEvXTag(), and ParseID3Tag().

#define vlc_meta_SetURL	(	meta,
		b		)	vlc_meta_Set( meta, vlc_meta_URL, b )

Referenced by Control().

#define VLC_META_TITLE   input_MetaTypeToLocalizedString( vlc_meta_Title )

Referenced by MetaPanel::MetaPanel(), psz_column_title(), and Redraw().

#define VLC_META_TRACK_NUMBER   input_MetaTypeToLocalizedString( vlc_meta_TrackNumber )

Referenced by MetaPanel::MetaPanel(), psz_column_title(), and Redraw().

#define VLC_META_TRACKID   input_MetaTypeToLocalizedString( vlc_meta_TrackID )

Referenced by Redraw().

#define VLC_META_TYPE_COUNT   17

Referenced by Redraw(), vlc_meta_Delete(), and vlc_meta_Merge().

#define VLC_META_URL   input_MetaTypeToLocalizedString( vlc_meta_URL )

Referenced by Redraw().

---

Enumeration Type Documentation

anonymous enum

Enumerator:

ALBUM_ART_WHEN_ASKED
ALBUM_ART_WHEN_PLAYED
ALBUM_ART_ALL

enum vlc_meta_type_t

Enumerator:

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

---

Function Documentation

int input_item_WriteMeta	(	vlc_object_t *	,
		input_item_t *
	)

References decode_URI(), input_item_t::i_type, input_item_GetURI(), ITEM_TYPE_FILE, input_item_t::lock, module_need, module_unneed, meta_export_t::p_item, meta_export_t::psz_file, strdup(), vlc_custom_create, VLC_EGENERIC, VLC_ENOMEM, vlc_mutex_lock(), vlc_mutex_unlock(), vlc_object_attach, VLC_OBJECT_GENERIC, vlc_object_release, and VLC_SUCCESS.

Referenced by MetaPanel::saveMeta(), and VLCInfo::saveMetaData:.

const char* input_MetaTypeToLocalizedString

(

vlc_meta_type_t

meta_type

)

References _, vlc_meta_Album, vlc_meta_Artist, vlc_meta_ArtworkURL, vlc_meta_Copyright, vlc_meta_Date, vlc_meta_Description, vlc_meta_EncodedBy, vlc_meta_Genre, vlc_meta_Language, vlc_meta_NowPlaying, vlc_meta_Publisher, vlc_meta_Rating, vlc_meta_Setting, vlc_meta_Title, vlc_meta_TrackID, vlc_meta_TrackNumber, and vlc_meta_URL.

Referenced by add_meta_val(), EsOutProgramEpg(), and EsOutProgramMeta().

static void vlc_meta_AddExtra	(	vlc_meta_t *	m,
		const char *	psz_name,
		const char *	psz_value
	)			[inline, static]

References vlc_meta_t::extra_tags, kVLCDictionaryNotFound, strdup(), vlc_dictionary_insert(), vlc_dictionary_remove_value_for_key(), vlc_dictionary_value_for_key(), and vlc_meta_FreeExtraKey().

Referenced by Control(), DecodeBlock(), DemuxDecodeXds(), ParseAPEvXTag(), ParseID3Tag(), ParseKateComments(), ParseSpeexComments(), ParseTheoraComments(), ParseVorbisComments(), ReadMetaFromId3v2(), and vorbis_ParseComment().

static void vlc_meta_Delete

(

vlc_meta_t *

m

)

[inline, static]

References vlc_meta_t::extra_tags, i, vlc_meta_t::ppsz_meta, vlc_dictionary_clear(), vlc_meta_FreeExtraKey(), and VLC_META_TYPE_COUNT.

Referenced by CmdCleanControl(), DecoderUpdateFormatLocked(), Del(), DeleteDecoder(), demux_PacketizerDestroy(), DemuxDecodeXds(), DemuxEnd(), EsOutSend(), GetTracks(), input_item_Clean(), InputSourceMeta(), InputUpdateMeta(), Ogg_EndOfStream(), sout_DeleteInstance(), transcode_video_close(), and demux_sys_t::~demux_sys_t().

static void vlc_meta_FreeExtraKey	(	void *	p_data,
		void *	p_obj
	)			[inline, static]

References VLC_UNUSED.

Referenced by vlc_meta_AddExtra(), vlc_meta_Delete(), and vlc_meta_Merge().

static const char* vlc_meta_Get	(	const vlc_meta_t *	p_meta,
		vlc_meta_type_t	meta_type
	)			[inline, static]

References vlc_meta_t::ppsz_meta.

Referenced by Art(), ArtCachePath(), EsOutMeta(), EsOutProgramMeta(), GetTracks(), input_item_GetMeta(), input_item_GetTitleFbName(), input_item_MetaMatch(), and playlist_LiveSearchUpdateInternal().

static void vlc_meta_Merge	(	vlc_meta_t *	dst,
		const vlc_meta_t *	src
	)			[inline, static]

References vlc_meta_t::extra_tags, i, vlc_meta_t::ppsz_meta, strdup(), vlc_dictionary_all_keys(), vlc_dictionary_insert(), vlc_dictionary_remove_value_for_key(), vlc_dictionary_value_for_key(), vlc_meta_FreeExtraKey(), and VLC_META_TYPE_COUNT.

Referenced by Control(), EsOutMeta(), input_DecoderHasFormatChanged(), and InputSourceMeta().

static vlc_meta_t* vlc_meta_New

(

void

)

[inline, static]

References vlc_meta_t::extra_tags, vlc_meta_t::i_status, vlc_meta_t::ppsz_meta, and vlc_dictionary_init().

Referenced by ArtCachePath(), CDDAMetaInfoInit(), CdTextParse(), Control(), DecodeBlock(), DemuxDecodeXds(), DemuxInit(), formatSnapshotItem(), matroska_segment_c::InformationCreate(), Init(), input_DecoderHasFormatChanged(), input_item_SetArtFetched(), input_item_SetArtNotFound(), input_item_SetMeta(), input_item_SetPreparsed(), ParseAPEvXTag(), ParseID3Tag(), ParseKateComments(), ParseSpeexComments(), ParseTheoraComments(), ParseVorbisComments(), ReadMeta(), UpdateGenericFromAccess(), UpdateGenericFromDemux(), and vorbis_ParseComment().

static void vlc_meta_Set	(	vlc_meta_t *	p_meta,
		vlc_meta_type_t	meta_type,
		const char *	psz_val
	)			[inline, static]

References vlc_meta_t::ppsz_meta, and strdup().

Referenced by Control(), input_item_SetMeta(), and InputMetaUser().