media_tree.c File Reference

Include dependency graph for media_tree.c:

Data Structures
struct	vlc_media_tree_listener_id
struct	media_tree_private_t

Macros
#define	mt_priv(mt)   container_of(mt, media_tree_private_t, public_data)
#define	vlc_media_tree_listener_foreach(listener, tree)    vlc_list_foreach(listener, &mt_priv(tree)->listeners, node)
#define	vlc_media_tree_NotifyListener(tree, listener, event, ...)
#define	vlc_media_tree_Notify(tree, event, ...)

Functions
vlc_media_tree_t *	vlc_media_tree_New (void)
	Create an empty media tree.
static void	vlc_media_tree_AssertLocked (vlc_media_tree_t *tree)
static bool	vlc_media_tree_FindNodeByMedia (input_item_node_t *parent, const input_item_t *media, input_item_node_t **result, input_item_node_t **result_parent)
static input_item_node_t *	vlc_media_tree_AddChild (input_item_node_t *parent, input_item_t *media)
static void	vlc_media_tree_AddSubtree (input_item_node_t *to, input_item_node_t *from)
static void	vlc_media_tree_ClearChildren (input_item_node_t *root)
static void	media_subtree_changed (input_item_t *media, input_item_node_t *node, void *userdata)
static void	media_subtree_preparse_ended (input_item_t *media, int status, void *user_data)
static void	vlc_media_tree_DestroyRootNode (vlc_media_tree_t *tree)
static void	vlc_media_tree_Delete (vlc_media_tree_t *tree)
void	vlc_media_tree_Hold (vlc_media_tree_t *tree)
	Increase the media tree reference count.
void	vlc_media_tree_Release (vlc_media_tree_t *tree)
	Decrease the media tree reference count.
void	vlc_media_tree_Lock (vlc_media_tree_t *tree)
	Lock the media tree (non-recursive).
void	vlc_media_tree_Unlock (vlc_media_tree_t *tree)
	Unlock the media tree.
static void	vlc_media_tree_NotifyCurrentState (vlc_media_tree_t *tree, vlc_media_tree_listener_id *listener)
vlc_media_tree_listener_id *	vlc_media_tree_AddListener (vlc_media_tree_t *tree, const struct vlc_media_tree_callbacks *cbs, void *userdata, bool notify_current_state)
	Add a listener.
void	vlc_media_tree_RemoveListener (vlc_media_tree_t *tree, vlc_media_tree_listener_id *listener)
	Remove a listener.
input_item_node_t *	vlc_media_tree_Add (vlc_media_tree_t *tree, input_item_node_t *parent, input_item_t *media)
	Add an item to the media tree.
bool	vlc_media_tree_Find (vlc_media_tree_t *tree, const input_item_t *media, input_item_node_t **result, input_item_node_t **result_parent)
	Find the node containing the requested input item (and its parent).
bool	vlc_media_tree_Remove (vlc_media_tree_t *tree, input_item_t *media)
	Remove an item from the media tree.
vlc_preparser_req_id	vlc_media_tree_Preparse (vlc_media_tree_t *tree, vlc_preparser_t *parser, input_item_t *media)
	Preparse a media, and expand it in the media tree on subitems added.

Variables
static const input_item_parser_cbs_t	preparser_callbacks

Macro Definition Documentation

mt_priv

#define mt_priv

(

mt

)

container_of(mt, media_tree_private_t, public_data)

vlc_media_tree_listener_foreach

#define vlc_media_tree_listener_foreach	(		listener,
			tree
	)		vlc_list_foreach(listener, &mt_priv(tree)->listeners, node)

vlc_media_tree_Notify

#define vlc_media_tree_Notify	(		tree,
			event,
			...
	)

Value:

do { \
    vlc_media_tree_AssertLocked(tree); \
    vlc_media_tree_listener_id *listener; \
    vlc_media_tree_listener_foreach(listener, tree) \
        vlc_media_tree_NotifyListener(tree, listener, event, ##__VA_ARGS__); \
} while (0)

vlc_media_tree_NotifyListener

#define vlc_media_tree_NotifyListener	(		tree,
			listener,
			event,
			...
	)

Value:

do { \
    if (listener->cbs->event) \
        listener->cbs->event(tree, ##__VA_ARGS__, listener->userdata); \
} while(0)

Function Documentation

media_subtree_changed()

static void media_subtree_changed ( input_item_t *  media, input_item_node_t *  node, void *  userdata  )

static

References on_children_reset(), vlc_media_tree::root, vlc_media_tree_AddSubtree(), vlc_media_tree_ClearChildren(), vlc_media_tree_FindNodeByMedia(), vlc_media_tree_Lock(), vlc_media_tree_Notify, and vlc_media_tree_Unlock().

media_subtree_preparse_ended()

static void media_subtree_preparse_ended ( input_item_t *  media, int  status, void *  user_data  )

static

References vlc_media_tree::root, vlc_media_tree_FindNodeByMedia(), vlc_media_tree_Lock(), vlc_media_tree_Notify, and vlc_media_tree_Unlock().

vlc_media_tree_AddChild()

static input_item_node_t * vlc_media_tree_AddChild ( input_item_node_t *  parent, input_item_t *  media  )

static

References input_item_node_AppendNode(), input_item_node_Create(), and unlikely.

Referenced by vlc_media_tree_Add(), and vlc_media_tree_AddSubtree().

vlc_media_tree_AddSubtree()

static void vlc_media_tree_AddSubtree ( input_item_node_t *  to, input_item_node_t *  from  )

static

References input_item_node_t::p_item, unlikely, vlc_media_tree_AddChild(), and vlc_media_tree_AddSubtree().

Referenced by media_subtree_changed(), and vlc_media_tree_AddSubtree().

vlc_media_tree_AssertLocked()

static void vlc_media_tree_AssertLocked ( vlc_media_tree_t *  tree )

inlinestatic

References media_tree_private_t::lock, mt_priv, and vlc_mutex_assert.

Referenced by vlc_media_tree_Add(), vlc_media_tree_Find(), and vlc_media_tree_Remove().

vlc_media_tree_ClearChildren()

static void vlc_media_tree_ClearChildren ( input_item_node_t *  root )

static

References input_item_node_t::i_children, input_item_node_Delete(), and input_item_node_t::pp_children.

Referenced by media_subtree_changed(), and vlc_media_tree_DestroyRootNode().

vlc_media_tree_Delete()

static void vlc_media_tree_Delete ( vlc_media_tree_t *  tree )

static

References media_tree_private_t::listeners, mt_priv, vlc_list_foreach, vlc_list_init(), and vlc_media_tree_DestroyRootNode().

Referenced by vlc_media_tree_Release().

vlc_media_tree_DestroyRootNode()

static void vlc_media_tree_DestroyRootNode ( vlc_media_tree_t *  tree )

inlinestatic

References vlc_media_tree::root, and vlc_media_tree_ClearChildren().

Referenced by vlc_media_tree_Delete().

vlc_media_tree_FindNodeByMedia()

static bool vlc_media_tree_FindNodeByMedia ( input_item_node_t *  parent, const input_item_t *  media, input_item_node_t **  result, input_item_node_t **  result_parent  )

static

References input_item_node_t::i_children, input_item_node_t::p_item, input_item_node_t::pp_children, and vlc_media_tree_FindNodeByMedia().

Referenced by media_subtree_changed(), media_subtree_preparse_ended(), vlc_media_tree_Find(), vlc_media_tree_FindNodeByMedia(), and vlc_media_tree_Remove().

vlc_media_tree_NotifyCurrentState()

static void vlc_media_tree_NotifyCurrentState ( vlc_media_tree_t *  tree, vlc_media_tree_listener_id *  listener  )

static

References on_children_reset(), vlc_media_tree::root, and vlc_media_tree_NotifyListener.

Referenced by vlc_media_tree_AddListener().

Variable Documentation

preparser_callbacks

const input_item_parser_cbs_t preparser_callbacks

static

Initial value:

= {
    .on_ended = media_subtree_preparse_ended,
    .on_subtree_added = media_subtree_changed,
}

Referenced by vlc_media_tree_Preparse().