alsa: fix a memory leak.

[vlc] / include / vlc_input_item.h

diff --git a/include/vlc_input_item.h b/include/vlc_input_item.h
index 57ea28346d49e34ec80a1081aace97f69ffb49e3..8bf825f870000d7350fa03d378dc82e44a7acd2c 100644 (file)
--- a/include/vlc_input_item.h
+++ b/include/vlc_input_item.h
@@ -22,8 +22,8 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-#ifndef VLC__INPUT_ITEM_H
-#define VLC__INPUT_ITEM_H 1
+#ifndef VLC_INPUT_ITEM_H
+#define VLC_INPUT_ITEM_H 1
 
 /**
  * \file
@@ -32,6 +32,7 @@
 
 #include <vlc_meta.h>
 #include <vlc_epg.h>
+#include <vlc_events.h>
 
 #include <string.h>
 
@@ -86,7 +87,6 @@ struct input_item_t
     vlc_mutex_t lock;                 /**< Lock for the item */
 
     uint8_t     i_type;              /**< Type (file, disc, ... see input_item_type_e) */
-    bool        b_prefers_tree;      /**< Do we prefer being displayed as tree*/
     bool        b_fixed_name;        /**< Can the interface change the name ?*/
     bool        b_error_when_reading;/**< Error When Reading */
 };
@@ -118,16 +118,52 @@ struct input_item_node_t
 VLC_EXPORT( void, input_item_CopyOptions, ( input_item_t *p_parent, input_item_t *p_child ) );
 VLC_EXPORT( void, input_item_SetName, ( input_item_t *p_item, const char *psz_name ) );
 
-/* This won't hold the item, but can tell to interested third parties
+/**
+ * Add one subitem to this item
+ *
+ * This won't hold the item, but can tell to interested third parties
  * Like the playlist, that there is a new sub item. With this design
  * It is not the input item's responsability to keep all the ref of
- * the input item children. */
-VLC_EXPORT( void, input_item_AddSubItem, ( input_item_t *p_parent, input_item_t *p_child ) );
+ * the input item children.
+ *
+ * Sends a vlc_InputItemSubItemTreeAdded and a vlc_InputItemSubItemAdded event
+ */
+VLC_EXPORT( void, input_item_PostSubItem, ( input_item_t *p_parent, input_item_t *p_child ) );
 
-VLC_EXPORT( void, input_item_AddSubItemTree, ( input_item_node_t *p_root ) );
+/**
+ * Start adding multiple subitems.
+ *
+ * Create a root node to hold a tree of subitems for given item
+ */
+VLC_EXPORT( input_item_node_t *, input_item_node_Create, ( input_item_t *p_input ) );
 
-/* Will send vlc_InputItemSubItemTreeAdded event, just as input_item_AddSubItemTree */
-VLC_EXPORT( void, input_item_AddSubItem2, ( input_item_t *p_parent, input_item_t *p_child ) );
+/**
+ * Add a new child node to this parent node that will point to this subitem.
+ */
+VLC_EXPORT( input_item_node_t *, input_item_node_AppendItem, ( input_item_node_t *p_node, input_item_t *p_item ) );
+
+/**
+ * Add an already created node to children of this parent node.
+ */
+VLC_EXPORT( void, input_item_node_AppendNode, ( input_item_node_t *p_parent, input_item_node_t *p_child ) );
+
+/**
+ * Delete a node created with input_item_node_Create() and all its children.
+ */
+VLC_EXPORT( void, input_item_node_Delete, ( input_item_node_t *p_node ) );
+
+/**
+ * End adding multiple subitems.
+ *
+ * Sends a vlc_InputItemSubItemTreeAdded event to notify that the item pointed to
+ * by the given root node has created new subitems that are pointed to by all the
+ * children of the node.
+ *
+ * Also sends vlc_InputItemSubItemAdded event for every child under the given root node;
+ *
+ * In the end deletes the node and all its children nodes.
+ */
+VLC_EXPORT( void, input_item_node_PostAndDelete, ( input_item_node_t *p_node ) );
 
 
 /**
@@ -201,6 +237,8 @@ INPUT_META(TrackID)
 VLC_EXPORT( char *, input_item_GetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
 VLC_EXPORT( int, input_item_AddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) LIBVLC_FORMAT( 4, 5 ) );
 VLC_EXPORT( int, input_item_DelInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name ) );
+VLC_EXPORT( void, input_item_ReplaceInfos, ( input_item_t *, info_category_t * ) );
+VLC_EXPORT( void, input_item_MergeInfos, ( input_item_t *, info_category_t * ) );
 
 /**
  * This function creates a new input_item_t with the provided informations.
@@ -215,8 +253,8 @@ VLC_EXPORT( input_item_t *, input_item_NewWithType, ( vlc_object_t *, const char
  *
  * Provided for convenience.
  */
-#define input_item_NewExt(a,b,c,d,e,f,g) __input_item_NewExt( VLC_OBJECT(a),b,c,d,e,f,g)
-VLC_EXPORT( 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 ) );
+VLC_EXPORT( 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 ) );
+#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.
@@ -225,13 +263,11 @@ VLC_EXPORT( input_item_t *, __input_item_NewExt, (vlc_object_t *, const char *ps
  */
 #define input_item_New( a,b,c ) input_item_NewExt( a, b, c, 0, NULL, 0, -1 )
 
-VLC_EXPORT( input_item_node_t *, input_item_node_Create, ( input_item_t *p_input ) );
-
-VLC_EXPORT( void, input_item_node_Delete, ( input_item_node_t *p_node ) );
-
-VLC_EXPORT( input_item_node_t *, input_item_node_AppendItem, ( input_item_node_t *p_node, input_item_t *p_item ) );
+/**
+ * This function creates a new input_item_t as a copy of another.
+ */
+VLC_EXPORT( input_item_t *, input_item_Copy, (vlc_object_t *, input_item_t * ) );
 
-VLC_EXPORT( void, input_item_node_AppendNode, ( input_item_node_t *p_node, input_item_node_t *p_item ) );
 
 /******************
  * Input stats