vlc_input_item.h File Reference
This file defines functions, structures and enums for input items in vlc. More...
Go to the source code of this file.
Data Structures | |
| struct | info_t |
| struct | info_category_t |
| struct | input_item_t |
| struct | input_stats_t |
Defines | |
| #define | VLC__INPUT_ITEM_H 1 |
| #define | input_item_SetTitle(item, b) input_item_SetMeta( item, vlc_meta_Title, b ) |
| #define | input_item_SetArtist(item, b) input_item_SetMeta( item, vlc_meta_Artist, b ) |
| #define | input_item_SetGenre(item, b) input_item_SetMeta( item, vlc_meta_Genre, b ) |
| #define | input_item_SetCopyright(item, b) input_item_SetMeta( item, vlc_meta_Copyright, b ) |
| #define | input_item_SetAlbum(item, b) input_item_SetMeta( item, vlc_meta_Album, b ) |
| #define | input_item_SetTrackNum(item, b) input_item_SetMeta( item, vlc_meta_TrackNumber, b ) |
| #define | input_item_SetDescription(item, b) input_item_SetMeta( item, vlc_meta_Description, b ) |
| #define | input_item_SetRating(item, b) input_item_SetMeta( item, vlc_meta_Rating, b ) |
| #define | input_item_SetDate(item, b) input_item_SetMeta( item, vlc_meta_Date, b ) |
| #define | input_item_SetSetting(item, b) input_item_SetMeta( item, vlc_meta_Setting, b ) |
| #define | input_item_SetURL(item, b) input_item_SetMeta( item, vlc_meta_URL, b ) |
| #define | input_item_SetLanguage(item, b) input_item_SetMeta( item, vlc_meta_Language, b ) |
| #define | input_item_SetNowPlaying(item, b) input_item_SetMeta( item, vlc_meta_NowPlaying, b ) |
| #define | input_item_SetPublisher(item, b) input_item_SetMeta( item, vlc_meta_Publisher, b ) |
| #define | input_item_SetEncodedBy(item, b) input_item_SetMeta( item, vlc_meta_EncodedBy, b ) |
| #define | input_item_SetArtURL(item, b) input_item_SetMeta( item, vlc_meta_ArtworkURL, b ) |
| #define | input_item_SetTrackID(item, b) input_item_SetMeta( item, vlc_meta_TrackID, b ) |
| #define | input_item_GetTitle(item) input_item_GetMeta( item, vlc_meta_Title ) |
| #define | input_item_GetArtist(item) input_item_GetMeta( item, vlc_meta_Artist ) |
| #define | input_item_GetGenre(item) input_item_GetMeta( item, vlc_meta_Genre ) |
| #define | input_item_GetCopyright(item) input_item_GetMeta( item, vlc_meta_Copyright ) |
| #define | input_item_GetAlbum(item) input_item_GetMeta( item, vlc_meta_Album ) |
| #define | input_item_GetTrackNum(item) input_item_GetMeta( item, vlc_meta_TrackNumber ) |
| #define | input_item_GetDescription(item) input_item_GetMeta( item, vlc_meta_Description ) |
| #define | input_item_GetRating(item) input_item_GetMeta( item, vlc_meta_Rating ) |
| #define | input_item_GetDate(item) input_item_GetMeta( item, vlc_meta_Date ) |
| #define | input_item_GetGetting(item) input_item_GetMeta( item, vlc_meta_Getting ) |
| #define | input_item_GetURL(item) input_item_GetMeta( item, vlc_meta_URL ) |
| #define | input_item_GetLanguage(item) input_item_GetMeta( item, vlc_meta_Language ) |
| #define | input_item_GetNowPlaying(item) input_item_GetMeta( item, vlc_meta_NowPlaying ) |
| #define | input_item_GetPublisher(item) input_item_GetMeta( item, vlc_meta_Publisher ) |
| #define | input_item_GetEncodedBy(item) input_item_GetMeta( item, vlc_meta_EncodedBy ) |
| #define | input_item_GetArtURL(item) input_item_GetMeta( item, vlc_meta_ArtworkURL ) |
| #define | input_item_GetTrackID(item) input_item_GetMeta( item, vlc_meta_TrackID ) |
| #define | input_item_GetSetting(item) input_item_GetMeta( item, vlc_meta_Setting ) |
| #define | input_item_NewExt(a, b, c, d, e, f, g) __input_item_NewExt( VLC_OBJECT(a),b,c,d,e,f,g) |
| This function creates a new input_item_t with the provided informations. | |
| #define | input_item_New(a, b, c) input_item_NewExt( a, b, c, 0, NULL, 0, -1 ) |
| This function creates a new input_item_t with the provided informations. | |
Enumerations | |
| enum | input_item_type_e { ITEM_TYPE_UNKNOWN, ITEM_TYPE_FILE, ITEM_TYPE_DIRECTORY, ITEM_TYPE_DISC, ITEM_TYPE_CDDA, ITEM_TYPE_CARD, ITEM_TYPE_NET, ITEM_TYPE_PLAYLIST, ITEM_TYPE_NODE, ITEM_TYPE_NUMBER } |
| enum | input_item_option_e { VLC_INPUT_OPTION_TRUSTED = 0x2, VLC_INPUT_OPTION_UNIQUE = 0x100 } |
| Option flags. More... | |
Functions | |
| void | input_item_CopyOptions (input_item_t *p_parent, input_item_t *p_child) |
| void | input_item_SetName (input_item_t *p_item, const char *psz_name) |
| void | input_item_AddSubItem (input_item_t *p_parent, input_item_t *p_child) |
| int | input_item_AddOption (input_item_t *, const char *, unsigned i_flags) |
| This function allows to add an option to an existing input_item_t. | |
| bool | input_item_HasErrorWhenReading (input_item_t *) |
| void | input_item_SetMeta (input_item_t *, vlc_meta_type_t meta_type, const char *psz_val) |
| bool | input_item_MetaMatch (input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz) |
| char * | input_item_GetMeta (input_item_t *p_i, vlc_meta_type_t meta_type) |
| char * | input_item_GetName (input_item_t *p_i) |
| char * | input_item_GetTitleFbName (input_item_t *p_i) |
| char * | input_item_GetURI (input_item_t *p_i) |
| void | input_item_SetURI (input_item_t *p_i, const char *psz_uri) |
| mtime_t | input_item_GetDuration (input_item_t *p_i) |
| void | input_item_SetDuration (input_item_t *p_i, mtime_t i_duration) |
| bool | input_item_IsPreparsed (input_item_t *p_i) |
| bool | input_item_IsArtFetched (input_item_t *p_i) |
| char * | input_item_GetInfo (input_item_t *p_i, const char *psz_cat, const char *psz_name) |
| Get a info item from a given category in a given input item. | |
| int | input_item_AddInfo (input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format,...) |
| int | input_item_DelInfo (input_item_t *p_i, const char *psz_cat, const char *psz_name) |
| input_item_t * | input_item_NewWithType (vlc_object_t *, const char *psz_uri, const char *psz_name, int i_options, const char *const *ppsz_options, unsigned i_option_flags, mtime_t i_duration, int i_type) |
| This function creates a new input_item_t with the provided informations. | |
| input_item_t * | __input_item_NewExt (vlc_object_t *, const char *psz_uri, const char *psz_name, int i_options, const char *const *ppsz_options, unsigned i_option_flags, mtime_t i_duration) |
Detailed Description
This file defines functions, structures and enums for input items in vlc.
Define Documentation
Referenced by __str_format_meta(), EvaluateRPN(), and PlaylistListNode().
Referenced by __str_format_meta(), EvaluateRPN(), PlaylistListNode(), and WriteMeta().
Referenced by __str_format_meta(), EvaluateRPN(), PlaylistListNode(), psz_column_meta(), WriteMeta(), and xspf_export_item().
Referenced by __str_format_meta(), EvaluateRPN(), and PlaylistListNode().
Referenced by __str_format_meta(), EvaluateRPN(), PlaylistListNode(), psz_column_meta(), and WriteMeta().
Referenced by __str_format_meta(), EvaluateRPN(), and PlaylistListNode().
Referenced by __str_format_meta(), EvaluateRPN(), and PlaylistListNode().
Referenced by __str_format_meta(), EvaluateRPN(), and PlaylistListNode().
Referenced by EvaluateRPN(), and PlaylistListNode().
Referenced by __str_format_meta(), EvaluateRPN(), PlaylistListNode(), psz_column_meta(), WriteMeta(), and xspf_export_item().
Referenced by __str_format_meta(), EvaluateRPN(), Timer::Notify(), PlaylistListNode(), and MetaPanel::update().
| #define input_item_New | ( | a, | |||
| b, | |||||
| c | ) | input_item_NewExt( a, b, c, 0, NULL, 0, -1 ) |
This function creates a new input_item_t with the provided informations.
Provided for convenience.
Referenced by MediaServerList::addServer(), AddTrack(), CreateInputItemFromShoutItem(), Demux(), DemuxGenre(), DemuxStation(), libvlc_media_new(), libvlc_media_new_as_node(), MMSHOpen(), MRLParse(), VLCWizard::nextTab:, onNewFileAdded(), open_address_cb(), open_cb(), open_webcam_cb(), openDirectory(), parse_MRL(), parse_track_dict(), parse_track_node(), ParseUrls(), pl_row_activated_cb(), resolve_callback(), Run(), DialogsProvider::streamingDialog(), vlm_ControlMediaAdd(), vlm_MediaInstanceNew(), and vlm_OnMediaUpdate().
| #define input_item_NewExt | ( | a, | |||
| b, | |||||
| c, | |||||
| d, | |||||
| e, | |||||
| f, | |||||
| g | ) | __input_item_NewExt( VLC_OBJECT(a),b,c,d,e,f,g) |
This function creates a new input_item_t with the provided informations.
Provided for convenience.
Referenced by __vlclua_playlist_add_internal(), Demux(), libvlc_media_list_add_file_content(), playlist_AddExt(), playlist_Import(), and playlist_MLLoad().
Referenced by AddTrack(), Demux(), GetTracks(), MetaPanel::saveMeta(), VLCInfo::saveMetaData:, and set_item_info().
Referenced by AddTrack(), Demux(), GetTracks(), MetaPanel::saveMeta(), VLCInfo::saveMetaData:, and set_item_info().
Referenced by Demux(), EsOutMeta(), fetch_art(), FindArt(), FindMeta(), formatSnapshotItem(), playlist_FindArtInCache(), playlist_SaveArt(), and set_item_info().
Referenced by Demux(), MetaPanel::saveMeta(), and VLCInfo::saveMetaData:.
Referenced by AddTrack(), Demux(), GetTracks(), MetaPanel::saveMeta(), and VLCInfo::saveMetaData:.
Referenced by Demux(), GetTracks(), MetaPanel::saveMeta(), VLCInfo::saveMetaData:, and set_item_info().
Referenced by AddTrack(), Demux(), DemuxStation(), GetTracks(), MetaPanel::saveMeta(), and VLCInfo::saveMetaData:.
Referenced by VLCInfo::saveMetaData:.
Referenced by Create(), Demux(), DemuxStation(), EsOutProgramEpg(), and EsOutProgramSelect().
Referenced by Demux(), EsOutProgramMeta(), EsOutProgramSelect(), MetaPanel::saveMeta(), and VLCInfo::saveMetaData:.
Referenced by AddTrack(), and DemuxStation().
Referenced by Demux(), GetTracks(), MetaPanel::saveMeta(), VLCInfo::saveMetaData:, and set_item_info().
Referenced by AddTrack(), Demux(), GetTracks(), MetaPanel::saveMeta(), VLCInfo::saveMetaData:, and set_item_info().
Referenced by Demux().
| #define VLC__INPUT_ITEM_H 1 |
Enumeration Type Documentation
| enum input_item_option_e |
| enum input_item_type_e |
Function Documentation
| input_item_t* __input_item_NewExt | ( | vlc_object_t * | , | |
| const char * | psz_uri, | |||
| const char * | psz_name, | |||
| int | i_options, | |||
| const char *const * | ppsz_options, | |||
| unsigned | i_option_flags, | |||
| mtime_t | i_duration | |||
| ) |
References input_item_NewWithType(), and ITEM_TYPE_UNKNOWN.
| int input_item_AddInfo | ( | input_item_t * | p_i, | |
| const char * | psz_cat, | |||
| const char * | psz_name, | |||
| const char * | psz_format, | |||
| ... | ||||
| ) |
References input_item_t::event_manager, InputItemVaAddInfo(), input_item_t::lock, vlc_event_send(), vlc_InputItemInfoChanged, vlc_mutex_lock(), and vlc_mutex_unlock().
Referenced by __vlclua_read_custom_meta_data(), CreateAnnounce(), Demux(), and input_vaControl().
| int input_item_AddOption | ( | input_item_t * | , | |
| const char * | , | |||
| unsigned | i_flags | |||
| ) |
This function allows to add an option to an existing input_item_t.
References err, i, input_item_t::i_options, INSERT_ELEM, input_item_t::lock, input_item_t::optflagc, input_item_t::optflagv, input_item_t::ppsz_options, strdup(), VLC_EGENERIC, VLC_ENOMEM, VLC_INPUT_OPTION_UNIQUE, vlc_mutex_lock(), vlc_mutex_unlock(), and VLC_SUCCESS.
Referenced by CreateAnnounce(), CreateInputItemFromShoutItem(), Demux(), GetTracks(), input_item_CopyOptions(), input_item_NewWithType(), input_vaControl(), ItemAdded(), libvlc_media_add_option(), libvlc_media_add_option_flag(), MRLParse(), VLCWizard::nextTab:, parse_MRL(), ParseUrls(), Run(), set_option(), DialogsProvider::streamingDialog(), UpdateBookmarksOption(), vlm_ControlMediaInstanceStart(), and vlm_OnMediaUpdate().
| void input_item_AddSubItem | ( | input_item_t * | p_parent, | |
| input_item_t * | p_child | |||
| ) |
References input_item_t::event_manager, input_item_t::i_type, ITEM_TYPE_PLAYLIST, input_item_t::lock, vlc_event_send(), vlc_InputItemSubItemAdded, vlc_mutex_lock(), and vlc_mutex_unlock().
Referenced by __vlclua_playlist_add_internal(), CDDAFixupPlaylist(), Demux(), DemuxGenre(), DemuxStation(), GetTracks(), MMSHOpen(), parse_extension_node(), parse_extitem_node(), parse_track_dict(), and parse_track_node().
| void input_item_CopyOptions | ( | input_item_t * | p_parent, | |
| input_item_t * | p_child | |||
| ) |
References i, input_item_t::i_options, input_item_AddOption(), input_item_t::lock, input_item_t::optflagv, input_item_t::ppsz_options, vlc_mutex_lock(), and vlc_mutex_unlock().
Referenced by CDDAFixupPlaylist(), Demux(), DemuxGenre(), DemuxStation(), GetTracks(), and parse_track_node().
| int input_item_DelInfo | ( | input_item_t * | p_i, | |
| const char * | psz_cat, | |||
| const char * | psz_name | |||
| ) |
References input_item_t::event_manager, i, i_cat, input_item_t::i_categories, info_category_t::i_infos, input_item_t::lock, input_item_t::pp_categories, info_category_t::pp_infos, info_t::psz_name, info_category_t::psz_name, info_t::psz_value, REMOVE_ELEM, VLC_EGENERIC, vlc_event_send(), vlc_InputItemInfoChanged, vlc_mutex_lock(), vlc_mutex_unlock(), and VLC_SUCCESS.
Referenced by input_item_SetEpg(), input_item_SetEpgOffline(), and input_vaControl().
| mtime_t input_item_GetDuration | ( | input_item_t * | p_i | ) |
References input_item_t::i_duration, input_item_t::lock, vlc_mutex_lock(), and vlc_mutex_unlock().
Referenced by __str_format_meta(), DoChildren(), GetInputMeta(), Init(), libvlc_media_get_duration(), VLCMain::manageIntf:, MediaNew(), PlaylistListNode(), proto_SORT_DURATION(), psz_column_meta(), ReadMetaData(), Run(), VLCMain::timesliderUpdate:, Playlist::UpdateItem(), and xspf_export_item().
| char* input_item_GetInfo | ( | input_item_t * | p_i, | |
| const char * | psz_cat, | |||
| const char * | psz_name | |||
| ) |
Get a info item from a given category in a given input item.
- Parameters:
-
p_i The input item to get info from psz_cat String representing the category for the info psz_name String representing the name of the desired info
- Returns:
- A pointer to the string with the given info if found, or an empty string otherwise. The caller should free the returned pointer.
References i, input_item_t::i_categories, info_category_t::i_infos, input_item_t::lock, input_item_t::pp_categories, info_category_t::pp_infos, info_t::psz_name, info_category_t::psz_name, info_t::psz_value, strdup(), vlc_mutex_lock(), and vlc_mutex_unlock().
Referenced by input_vaControl(), and Playlist::UpdateItem().
| char* input_item_GetMeta | ( | input_item_t * | p_i, | |
| vlc_meta_type_t | meta_type | |||
| ) |
References input_item_t::lock, input_item_t::p_meta, strdup(), vlc_meta_Get(), vlc_mutex_lock(), and vlc_mutex_unlock().
Referenced by libvlc_media_get_meta(), and meta_sort().
| char* input_item_GetName | ( | input_item_t * | p_i | ) |
References input_item_t::lock, input_item_t::psz_name, psz_name, strdup(), vlc_mutex_lock(), and vlc_mutex_unlock().
Referenced by __str_format_meta(), Create(), Demux(), Destructor(), DisplayVoutTitle(), DoChildren(), EvaluateRPN(), CmdUpdateItem::execute(), FindArt(), ItemChange(), VLCMain::manageIntf:, PlayItem(), PlaylistListNode(), StandardPLPanel::setRoot(), Thread(), FileInfo::UpdateFileInfo(), VLCInfo::updatePanelWithItem:, VLCVoutView::updateTitle, and vlclua_meta_init().
| char* input_item_GetTitleFbName | ( | input_item_t * | p_i | ) |
References EMPTY_STR, input_item_t::lock, input_item_t::p_meta, input_item_t::psz_name, strdup(), vlc_meta_Get(), vlc_meta_Title, vlc_mutex_lock(), and vlc_mutex_unlock().
Referenced by ItemChange(), meta_strcasecmp_title(), PlaylistAddNode(), proto_SORT_TITLE_NUMERIC(), psz_column_meta(), MetaPanel::update(), and WriteMeta().
| char* input_item_GetURI | ( | input_item_t * | p_i | ) |
References input_item_t::lock, input_item_t::psz_uri, strdup(), vlc_mutex_lock(), and vlc_mutex_unlock().
Referenced by __str_format_meta(), VLCControls::addSubtitleFile:, DoChildren(), EvaluateRPN(), CmdUpdateItem::execute(), VLCBookmarks::extract:, FindMeta(), formatSnapshotItem(), GetTimedURLFromPlaylistItem(), input_item_WriteMeta(), libvlc_media_get_mrl(), DialogsProvider::loadSubtitlesFile(), MacroDo(), VLCWizard::nextTab:, Open(), parse_track_node(), PlayBookmark(), PlayItem(), Playlist(), PlaylistListNode(), proto_SORT_URI(), psz_column_meta(), ActionsManager::record(), Redraw(), VLCPlaylist::revealItemInFinder:, Run(), PLModel::selectedURIs(), SetBookmark(), MetaPanel::update(), VLCInfo::updatePanelWithItem:, VLCVoutView::updateTitle, ItemInfoDialog::WndProc(), and xspf_export_item().
| bool input_item_HasErrorWhenReading | ( | input_item_t * | ) |
References input_item_t::b_error_when_reading, input_item_t::lock, vlc_mutex_lock(), and vlc_mutex_unlock().
| bool input_item_IsArtFetched | ( | input_item_t * | p_i | ) |
References vlc_meta_t::i_status, ITEM_ART_FETCHED, input_item_t::lock, input_item_t::p_meta, vlc_mutex_lock(), and vlc_mutex_unlock().
Referenced by input_ExtractAttachmentAndCacheArt().
| bool input_item_IsPreparsed | ( | input_item_t * | p_i | ) |
References vlc_meta_t::i_status, ITEM_PREPARSED, input_item_t::lock, input_item_t::p_meta, vlc_mutex_lock(), and vlc_mutex_unlock().
Referenced by ItemChange(), libvlc_media_is_preparsed(), Preparse(), TrackChange(), VLCInfo::updatePanelWithItem:, vlm_OnMediaUpdate(), and WaitPreparsed().
| bool input_item_MetaMatch | ( | input_item_t * | p_i, | |
| vlc_meta_type_t | meta_type, | |||
| const char * | psz | |||
| ) |
References input_item_t::lock, input_item_t::p_meta, strcasestr(), vlc_meta_Get(), vlc_mutex_lock(), and vlc_mutex_unlock().
| input_item_t* input_item_NewWithType | ( | vlc_object_t * | , | |
| const char * | psz_uri, | |||
| const char * | psz_name, | |||
| int | i_options, | |||
| const char *const * | ppsz_options, | |||
| unsigned | i_option_flags, | |||
| mtime_t | i_duration, | |||
| int | i_type | |||
| ) |
This function creates a new input_item_t with the provided informations.
XXX You may also use input_item_New or input_item_NewExt as they need less arguments.
References input_item_t::b_fixed_name, input_item_t::b_prefers_tree, i, input_item_t::i_duration, input_item_t::i_id, libvlc_priv_t::i_last_input_id, input_item_t::i_type, input_item_AddOption(), input_item_Destroy(), input_item_Init(), input_item_SetName(), input_item_SetURI(), ITEM_TYPE_UNKNOWN, libvlc_priv(), vlc_object_t::p_libvlc, vlc_gc_init, vlc_mutex_lock(), vlc_mutex_unlock(), and VLC_STATIC_MUTEX.
Referenced by __input_item_NewExt(), AddDevice(), AddItem(), CDDAFixupPlaylist(), CreateAnnounce(), Demux(), GetTracks(), parse_extension_node(), and playlist_NodeCreate().
| void input_item_SetDuration | ( | input_item_t * | p_i, | |
| mtime_t | i_duration | |||
| ) |
References input_item_t::event_manager, input_item_t::i_duration, input_item_t::lock, vlc_event_send(), vlc_InputItemDurationChanged, vlc_mutex_lock(), and vlc_mutex_unlock().
Referenced by AddTrack(), CDDAFixupPlaylist(), Demux(), GetTracks(), input_SendEventLength(), and set_item_info().
| void input_item_SetMeta | ( | input_item_t * | , | |
| vlc_meta_type_t | meta_type, | |||
| const char * | psz_val | |||
| ) |
| void input_item_SetName | ( | input_item_t * | p_item, | |
| const char * | psz_name | |||
| ) |
References input_item_t::lock, input_item_t::psz_name, strdup(), vlc_mutex_lock(), and vlc_mutex_unlock().
Referenced by Demux(), EsOutMeta(), GetTracks(), input_item_NewWithType(), input_vaControl(), ItemInfoDialog::OnOk(), and VLCInfo::saveMetaData:.
| void input_item_SetURI | ( | input_item_t * | p_i, | |
| const char * | psz_uri | |||
| ) |
References asprintf(), decode_URI(), GuessType(), vlc_url_t::i_port, input_item_t::i_type, ITEM_TYPE_DIRECTORY, ITEM_TYPE_FILE, input_item_t::lock, vlc_url_t::psz_host, input_item_t::psz_name, vlc_url_t::psz_path, vlc_url_t::psz_protocol, input_item_t::psz_uri, strdup(), vlc_mutex_lock(), vlc_mutex_unlock(), vlc_UrlClean(), and vlc_UrlParse().
Referenced by CDDAFixupPlaylist(), Demux(), formatSnapshotItem(), input_item_NewWithType(), ItemInfoDialog::OnOk(), parse_track_node(), and vlm_ControlMediaInstanceStart().
