X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_playlist.h;h=1af23587075c2366490f13418fa7968dc55e7c39;hb=HEAD;hp=233c73134057288d680e2ce742f164688dee5a59;hpb=d66c25935089b83e752bfe5a16c39c8e8a6bb71d;p=vlc diff --git a/include/vlc_playlist.h b/include/vlc_playlist.h index 233c731340..1af2358707 100644 --- a/include/vlc_playlist.h +++ b/include/vlc_playlist.h @@ -56,23 +56,8 @@ TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t) * item is refcounted and is automatically destroyed when it is not used * anymore. * - * In the playlist itself, there are two trees, that should always be kept - * in sync. The "category" tree contains the whole tree structure with - * several levels, while the onelevel tree contains only one level :), ie - * it only contains "real" items, not nodes - * For example, if you open a directory, you will have - *\verbatim - * Category tree: Onelevel tree: - * Playlist Playlist - * - Dir - item1 - * - Subdir - item2 - * - item1 - * - item2 - *\endverbatim - * The top-level items of both tree are the same, and they are reproduced - * in the left-part of the playlist GUIs, they are the "sources" from the - * source selectors. Top-level items include: playlist, media library, SAP, - * Shoutcast, devices, ... + * The top-level items are the main media sources and include: + * playlist, media library, SAP, Shoutcast, devices, ... * * It is envisioned that a third tree will appear: VLM, but it's not done yet * @@ -86,45 +71,48 @@ TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t) * - input 1 -> name = foo 1 uri = ... * - input 2 -> name = foo 2 uri = ... * - * 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) - * - media library (id 2) - foo 1 (id6 - input 1) + * Playlist items tree + * - playlist (id 1) + * - category 1 (id 2) + * - foo 2 (id 6 - input 2) + * - media library (id 2) * - foo 1 (id 5 - input 1) * \endverbatim - * Sometimes, an item must be transformed to a node. This happens for the - * directory access for example. In that case, the item is removed from - * the onelevel tree, as it is not a real item anymore. + * + * Sometimes, an item creates subitems. This happens for the directory access + * for example. In that case, if the item is under the "playlist" top-level item + * and playlist is configured to be flat then the item will be deleted and + * replaced with new subitems. If the item is under another top-level item, it + * will be transformed to a node and removed from the list of all items without + * nodes. * * For "standard" item addition, you can use playlist_Add, playlist_AddExt * (more options) or playlist_AddInput if you already created your input * item. This will add the item at the root of "Playlist" or of "Media library" * in each of the two trees. * - * If you want more control (like, adding the item as the child of a given - * node in the category tree, use playlist_BothAddInput. You'll have to provide - * the node in the category tree. The item will be added as a child of - * this node in the category tree, and as a child of the matching top-level - * node in the onelevel tree. (Nodes are created with playlist_NodeCreate) - * - * Generally speaking, playlist_NodeAddInput should not be used in newer code, it - * will maybe become useful again when we merge VLM; + * You can create nodes with playlist_NodeCreate and can create items from + * existing input items to be placed under any node with playlist_NodeAddInput. * * To delete an item, use playlist_DeleteFromInput( p_item ) which will - * remove all occurrences of the input in both trees + * remove all occurrences of the input. * * * The playlist defines the following event variables: * - * - "item-change": It will contains the input_item_t->i_id of a changed input + * - "item-change": It will contain the input_item_t->i_id of a changed input * item monitored by the playlist. - * * - "item-current": It will contains a input_item_t->i_id of the current + * - "item-current": It will contain a input_item_t->i_id of the current * item being played. * - * - "playlist-item-append": It will contains a pointer to a playlist_add_t. - * - "playlist-item-deleted": It will contains the playlist_item_t->i_id of a deleted - * playlist_item_t. + * - "playlist-item-append": It will contain a pointer to a playlist_add_t. + * - "playlist-item-deleted": It will contain the playlist_item_t->i_id of a + * deleted playlist_item_t. + * + * - "leaf-to-parent": Set when an item gets subitems and is transformed to a + * node. It will contain a pointer to the input_item_t bound to the transformed + * playlist item. + * * * XXX Be really carefull, playlist_item_t->i_id and input_item_t->i_id are not * the same. Yes, the situation is pretty bad. @@ -146,9 +134,9 @@ struct playlist_item_t { input_item_t *p_input; /**< Linked input item */ /** Number of children, -1 if not a node */ - int i_children; playlist_item_t **pp_children; /**< Children nodes/items */ playlist_item_t *p_parent; /**< Item parent */ + int i_children; int i_id; /**< Playlist item specific id */ uint8_t i_flags; /**< Flags */ @@ -260,11 +248,8 @@ enum pl_locked_state #define PL_UNLOCK playlist_Unlock( p_playlist ) #define PL_ASSERT_LOCKED playlist_AssertLocked( p_playlist ) -VLC_EXPORT( playlist_t *, pl_Hold, ( vlc_object_t * ) ); -#define pl_Hold( a ) pl_Hold( VLC_OBJECT(a) ) - -VLC_EXPORT( void, pl_Release, ( vlc_object_t * ) ); -#define pl_Release(a) pl_Release( VLC_OBJECT(a) ) +VLC_EXPORT( playlist_t *, pl_Get, ( vlc_object_t * ) LIBVLC_USED ); +#define pl_Get( a ) pl_Get( VLC_OBJECT(a) ) /* Playlist control */ #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked ) @@ -292,7 +277,7 @@ VLC_EXPORT( int, playlist_Control, ( playlist_t *p_playlist, int i_query, bool b /** Get current playing input. The object is retained. */ -VLC_EXPORT( input_thread_t *, playlist_CurrentInput, ( playlist_t *p_playlist ) ); +VLC_EXPORT( input_thread_t *, playlist_CurrentInput, ( playlist_t *p_playlist ) LIBVLC_USED ); /** Clear the playlist * \param b_locked TRUE if playlist is locked when entering this function @@ -300,17 +285,17 @@ VLC_EXPORT( input_thread_t *, playlist_CurrentInput, ( playlist_t *p_playlist ) VLC_EXPORT( void, playlist_Clear, ( playlist_t *, bool ) ); /** Enqueue an input item for preparsing */ -VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *, bool b_locked ) ); +VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t * ) ); /** Request the art for an input item to be fetched */ -VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *, bool b_locked ) ); +VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t * ) ); /* Playlist sorting */ VLC_EXPORT( int, playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) ); VLC_EXPORT( int, playlist_TreeMoveMany, ( playlist_t *, int, playlist_item_t **, playlist_item_t *, int ) ); VLC_EXPORT( int, playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) ); -VLC_EXPORT( playlist_item_t *, playlist_CurrentPlayingItem, ( playlist_t * ) ); +VLC_EXPORT( playlist_item_t *, playlist_CurrentPlayingItem, ( playlist_t * ) LIBVLC_USED ); VLC_EXPORT( int, playlist_Status, ( playlist_t * ) ); /** @@ -351,26 +336,27 @@ VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char *, i VLC_EXPORT( int, playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, int, const char *const *, unsigned, bool, bool ) ); VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *, int, int, bool, bool ) ); VLC_EXPORT( playlist_item_t *, playlist_NodeAddInput, ( playlist_t *, input_item_t *, playlist_item_t *, int, int, bool ) ); +VLC_EXPORT( int, playlist_NodeAddCopy, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) ); /********************************** Item search *************************/ -VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int ) ); -VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) ); +VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int ) LIBVLC_USED ); +VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) LIBVLC_USED ); -VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) ); +VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *, bool ) ); /******************************************************** * Tree management ********************************************************/ /* Node management */ -VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, int i_flags, input_item_t * ) ); +VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, int i_pos, int i_flags, input_item_t * ) ); 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 *) ); -VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) ); +VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) LIBVLC_USED ); VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, bool , bool ) ); -VLC_EXPORT( playlist_item_t *, playlist_GetNextLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, bool b_ena, bool b_unplayed ) ); -VLC_EXPORT( playlist_item_t *, playlist_GetPrevLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, bool b_ena, bool b_unplayed ) ); +VLC_EXPORT( playlist_item_t *, playlist_GetNextLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, bool b_ena, bool b_unplayed ) LIBVLC_USED ); +VLC_EXPORT( playlist_item_t *, playlist_GetPrevLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, bool b_ena, bool b_unplayed ) LIBVLC_USED ); /*********************************************************************** * Inline functions @@ -379,11 +365,7 @@ VLC_EXPORT( playlist_item_t *, playlist_GetPrevLeaf, ( playlist_t *p_playlist, p #define pl_CurrentInput(a) __pl_CurrentInput( VLC_OBJECT(a) ) static inline input_thread_t * __pl_CurrentInput( vlc_object_t * p_this ) { - playlist_t * p_playlist = pl_Hold( p_this ); - if( !p_playlist ) return NULL; - input_thread_t * p_input = playlist_CurrentInput( p_playlist ); - pl_Release( p_this ); - return p_input; + return playlist_CurrentInput( pl_Get( p_this ) ); } /** Tell if the playlist is empty */