]> git.sesse.net Git - vlc/blobdiff - include/vlc_playlist.h
THANKS to Stefán Freyr Stefánsson
[vlc] / include / vlc_playlist.h
index 78be38167d839b35f63ac72c373925a30ba81b88..a012fda98b3fe83a8f7192e961dd8c9982b74a34 100644 (file)
@@ -34,6 +34,7 @@ extern "C" {
 
 #include <assert.h>
 #include <vlc_input.h>
+#include <vlc_events.h>
 #include <stdio.h>
 #include <stdlib.h>
 
@@ -69,7 +70,7 @@ TYPEDEF_ARRAY(input_item_t*, input_item_array_t);
  * it only contains "real" items, not nodes
  * For example, if you open a directory, you will have
  *\verbatim
- * Category tree:               Onevelel tree:
+ * Category tree:               Onelevel tree:
  * Playlist                     Playlist
  *  - Dir                         - item1
  *    - Subdir                    - item2
@@ -93,7 +94,7 @@ TYPEDEF_ARRAY(input_item_t*, input_item_array_t);
  *  - input 1 -> name = foo 1 uri = ...
  *  - input 2 -> name = foo 2 uri = ...
  *
- * Category tree                        Onlevel tree
+ * Category tree                        Onelevel tree
  * - playlist (id 1)                    - playlist (id 3)
  *    - category 1 (id 2)                - foo 2 (id 8 - input 2)
  *      - foo 2 (id 6 - input 2)       - media library (id 4)
@@ -143,6 +144,7 @@ struct playlist_item_t
 
     int                    i_id;        /**< Playlist item specific id */
     uint8_t                i_flags;     /**< Flags */
+    playlist_t            *p_playlist;  /**< Parent playlist */
 };
 
 #define PLAYLIST_SAVE_FLAG      0x0001    /**< Must it be saved */
@@ -160,9 +162,11 @@ typedef enum
 struct services_discovery_t
 {
     VLC_COMMON_MEMBERS
-    char *psz_module;
+    char *              psz_module;
+    module_t *          p_module;
 
-    module_t *p_module;
+    char *              psz_localized_name; /* Accessed through Setters for non class function */
+    vlc_event_manager_t event_manager;      /* Accessed through Setters for non class function */
 
     services_discovery_sys_t *p_sys;
     void (*pf_run) ( services_discovery_t *);
@@ -172,6 +176,8 @@ struct services_discovery_t
 struct playlist_t
 {
     VLC_COMMON_MEMBERS
+    struct playlist_internal_t * p_internal; /**< Internal members */
+
     int                   i_enabled; /**< How many items are enabled ? */
 
     playlist_item_array_t items; /**< Arrays of items */
@@ -188,22 +194,19 @@ struct playlist_t
     int                   i_last_playlist_id; /**< Last id to an item */
     int                   i_last_input_id ; /**< Last id on an input */
 
-    services_discovery_t **pp_sds; /**< Loaded service discovery modules */
-    int                   i_sds;   /**< Number of service discovery modules */
-
     /* Predefined items */
     playlist_item_t *     p_root_category; /**< Root of category tree */
     playlist_item_t *     p_root_onelevel; /**< Root of onelevel tree */
     playlist_item_t *     p_local_category; /** < "Playlist" in CATEGORY view */
     playlist_item_t *     p_ml_category; /** < "Library" in CATEGORY view */
     playlist_item_t *     p_local_onelevel; /** < "Playlist" in ONELEVEL view */
-    playlist_item_t *     p_ml_onelevel; /** < "Library" in ONELEVEL iew */
+    playlist_item_t *     p_ml_onelevel; /** < "Library" in ONELEVEL view */
 
     vlc_bool_t            b_always_tree;/**< Always display as tree */
     vlc_bool_t            b_never_tree;/**< Never display as tree */
 
-    vlc_bool_t            b_doing_ml; /**< Doing media library stuff, */
-                                      /*get quicker */
+    vlc_bool_t            b_doing_ml; /**< Doing media library stuff,
+                                       * get quicker */
     vlc_bool_t            b_auto_preparse;
 
     /* Runtime */
@@ -363,16 +366,17 @@ VLC_EXPORT( playlist_item_t *, __playlist_ItemNewFromInput, ( vlc_object_t *p_ob
 
 /*************************** Item deletion **************************/
 VLC_EXPORT( int,  playlist_DeleteFromInput, ( playlist_t *, int, vlc_bool_t ) );
+VLC_EXPORT( int,  playlist_DeleteInputInParent, ( playlist_t *, int, playlist_item_t *, vlc_bool_t ) );
 
 /*************************** Item fields accessors **************************/
 VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, const char * ) );
 
 /******************** Item addition ********************/
-VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int, vlc_bool_t ) );
-VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char *const *,int, vlc_bool_t ) );
-VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *,int , int, vlc_bool_t ) );
-VLC_EXPORT( playlist_item_t *, playlist_NodeAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int ) );
-VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, int*, int* ) );
+VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int, vlc_bool_t, vlc_bool_t ) );
+VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char *const *,int, vlc_bool_t, vlc_bool_t ) );
+VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *, int, int, vlc_bool_t, vlc_bool_t ) );
+VLC_EXPORT( playlist_item_t *, playlist_NodeAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, vlc_bool_t ) );
+VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, int*, int*, vlc_bool_t ) );
 
 /********************** Misc item operations **********************/
 VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *, vlc_bool_t) );
@@ -382,8 +386,9 @@ playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
                                    vlc_bool_t );
 
 /********************************** Item search *************************/
-VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int, vlc_bool_t) );
+VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int, vlc_bool_t ) );
 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t *, vlc_bool_t ) );
+VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInputId, (playlist_t *, int, playlist_item_t *) );
 
 VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) );
 
@@ -394,7 +399,7 @@ VLC_EXPORT(void, playlist_NodeDump, ( playlist_t *p_playlist, playlist_item_t *p
 VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) );
 
 /* Node management */
-VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent ) );
+VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, int i_flags ) );
 VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) );
 VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_item_t *, int) );
 VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
@@ -403,18 +408,49 @@ VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, vlc_boo
 VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, vlc_bool_t ) );
 VLC_EXPORT( void, playlist_NodesPairCreate, (playlist_t *, const char *, playlist_item_t **, playlist_item_t **, vlc_bool_t ) );
 VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) );
+VLC_EXPORT( playlist_item_t *, playlist_GetNextLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, vlc_bool_t b_ena, vlc_bool_t b_unplayed ) ); 
+VLC_EXPORT( playlist_item_t *, playlist_GetPrevLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, vlc_bool_t b_ena, vlc_bool_t b_unplayed ) ); 
+VLC_EXPORT( playlist_item_t *, playlist_GetLastLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root ) );
+
+/***********************************************************************
+ * Service Discovery
+ ***********************************************************************/
+
+/* Get the services discovery modules names to use in Create(), in a null
+ * terminated string array. Array and string must be freed after use. */
+VLC_EXPORT( char **, services_discovery_GetServicesNames, ( vlc_object_t * p_super ) );
+
+/* Creation of a service_discovery object */
+VLC_EXPORT( services_discovery_t *, services_discovery_Create, ( vlc_object_t * p_super, const char * psz_service_name ) );
+VLC_EXPORT( void,                   services_discovery_Destroy, ( services_discovery_t * p_this ) );
+VLC_EXPORT( int,                    services_discovery_Start, ( services_discovery_t * p_this ) );
+VLC_EXPORT( void,                   services_discovery_Stop, ( services_discovery_t * p_this ) );
+
+/* Read info from discovery object */
+VLC_EXPORT( char *,                 services_discovery_GetLocalizedName, ( services_discovery_t * p_this ) );
+
+/* Receive event notification (prefered way to get new items) */
+VLC_EXPORT( vlc_event_manager_t *,  services_discovery_EventManager, ( services_discovery_t * p_this ) );
+
+/* Used by services_discovery to post update about their items */
+VLC_EXPORT( void,                   services_discovery_SetLocalizedName, ( services_discovery_t * p_this, const char * ) );
+    /* About the psz_category, it is a legacy way to add info to the item,
+     * for more options, directly set the (meta) data on the input item */
+VLC_EXPORT( void,                   services_discovery_AddItem, ( services_discovery_t * p_this, input_item_t * p_item, const char * psz_category ) );
+VLC_EXPORT( void,                   services_discovery_RemoveItem, ( services_discovery_t * p_this, input_item_t * p_item ) );
 
 /***********************************************************************
  * Inline functions
  ***********************************************************************/
 /** Open a playlist file, add its content to the current playlist */
-static inline int playlist_Import( playlist_t *p_playlist, const char *psz_file){
+static inline int playlist_Import( playlist_t *p_playlist, const char *psz_file)
+{
     char psz_uri[256+10];
     input_item_t *p_input;
     snprintf( psz_uri, 256+9, "file/://%s", psz_file );
     p_input = input_ItemNewExt( p_playlist, psz_uri, psz_file, 0, NULL, -1 );
     playlist_AddInput( p_playlist, p_input, PLAYLIST_APPEND, PLAYLIST_END,
-                       VLC_TRUE );
+                       VLC_TRUE, VLC_FALSE );
     input_Read( p_playlist, p_input, VLC_TRUE );
     return VLC_SUCCESS;
 }