X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_playlist.h;h=1af23587075c2366490f13418fa7968dc55e7c39;hb=502a2fa8050ae47d34c5635dd0f6ee6fd4ce8242;hp=65c7b20f1def0c5fc71579520defe8939071f8e4;hpb=11c77e08233859756d2ae41cb2a9e72e856a1f3d;p=vlc diff --git a/include/vlc_playlist.h b/include/vlc_playlist.h index 65c7b20f1d..1af2358707 100644 --- a/include/vlc_playlist.h +++ b/include/vlc_playlist.h @@ -16,9 +16,9 @@ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ #ifndef VLC_PLAYLIST_H_ @@ -30,11 +30,8 @@ extern "C" { #include #include -#include -#include -#include -TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t); +TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t) /** * \file @@ -59,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 * @@ -89,53 +71,72 @@ 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) + * 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. + * + * + * The playlist defines the following event variables: + * + * - "item-change": It will contain the input_item_t->i_id of a changed input + * item monitored by the playlist. + * - "item-current": It will contain a input_item_t->i_id of the current + * item being played. + * + * - "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. * - * Generally speaking, playlist_NodeAddInput should not be used in newer code, it - * will maybe become useful again when we merge VLM; + * - "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. * - * To delete an item, use playlist_DeleteFromInput( input_id ) which will - * remove all occurrences of the input in both trees + * + * 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. * * @{ */ /** Helper structure to export to file part of the playlist */ -struct playlist_export_t +typedef struct playlist_export_t { - char *psz_filename; + VLC_COMMON_MEMBERS + const char *psz_filename; FILE *p_file; playlist_item_t *p_root; -}; +} playlist_export_t; /** playlist item / node */ 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 */ @@ -148,6 +149,7 @@ struct playlist_item_t #define PLAYLIST_RO_FLAG 0x0008 /**< Write-enabled ? */ #define PLAYLIST_REMOVE_FLAG 0x0010 /**< Remove this item at the end */ #define PLAYLIST_EXPANDED_FLAG 0x0020 /**< Expanded node */ +#define PLAYLIST_SUBITEM_STOP_FLAG 0x0040 /**< Must playlist stop if the item gets subitems ?*/ /** Playlist status */ typedef enum @@ -163,54 +165,63 @@ struct playlist_t playlist_item_array_t current; /**< Items currently being played */ int i_current_index; /**< Index in current array */ - /** Reset current item array */ - bool b_reset_currently_playing; - mtime_t last_rebuild_date; - - int i_last_playlist_id; /**< Last id to an item */ /* Predefined items */ + playlist_item_t * p_root; + playlist_item_t * p_playing; + playlist_item_t * p_media_library; + + //Phony ones, point to those above; 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 view */ - - bool b_auto_preparse; - - /* Runtime */ - int i_sort; /**< Last sorting applied to the playlist */ - int i_order; /**< Last ordering applied to the playlist */ - mtime_t gc_date; - bool b_cant_sleep; - }; /** Helper to add an item */ struct playlist_add_t { - int i_node; - int i_item; - int i_position; + int i_node; /**< Playist id of the parent node */ + int i_item; /**< Playist id of the playlist_item_t */ }; -#define SORT_ID 0 -#define SORT_TITLE 1 -#define SORT_TITLE_NODES_FIRST 2 -#define SORT_ARTIST 3 -#define SORT_GENRE 4 -#define SORT_RANDOM 5 -#define SORT_DURATION 6 -#define SORT_TITLE_NUMERIC 7 -#define SORT_ALBUM 8 -#define SORT_TRACK_NUMBER 9 -#define SORT_DESCRIPTION 10 -#define SORT_RATING 11 -#define SORT_URI 12 - -#define ORDER_NORMAL 0 -#define ORDER_REVERSE 1 +/* A bit of macro magic to generate an enum out of the following list, + * and later, to generate a list of static functions out of the same list. + * There is also SORT_RANDOM, which is always last and handled specially. + */ +#define VLC_DEFINE_SORT_FUNCTIONS \ + DEF( SORT_ID )\ + DEF( SORT_TITLE )\ + DEF( SORT_TITLE_NODES_FIRST )\ + DEF( SORT_ARTIST )\ + DEF( SORT_GENRE )\ + DEF( SORT_DURATION )\ + DEF( SORT_TITLE_NUMERIC )\ + DEF( SORT_ALBUM )\ + DEF( SORT_TRACK_NUMBER )\ + DEF( SORT_DESCRIPTION )\ + DEF( SORT_RATING )\ + DEF( SORT_URI ) + +#define DEF( s ) s, +enum +{ + VLC_DEFINE_SORT_FUNCTIONS + SORT_RANDOM, + NUM_SORT_FNS=SORT_RANDOM +}; +#undef DEF +#ifndef VLC_INTERNAL_PLAYLIST_SORT_FUNCTIONS +#undef VLC_DEFINE_SORT_FUNCTIONS +#endif + +enum +{ + ORDER_NORMAL = 0, + ORDER_REVERSE = 1, +}; /* Used by playlist_Import */ #define PLAYLIST_INSERT 0x0001 @@ -233,14 +244,12 @@ enum pl_locked_state *****************************************************************************/ /* Helpers */ -#define PL_LOCK vlc_object_lock( p_playlist ) -#define PL_UNLOCK vlc_object_unlock( p_playlist ) +#define PL_LOCK playlist_Lock( p_playlist ) +#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 ) @@ -248,7 +257,11 @@ VLC_EXPORT( void, __pl_Release, ( vlc_object_t * ) ); #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, pl_Unlocked ) #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1) #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1) -#define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, i) +#define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, (i) ) + +VLC_EXPORT( void, playlist_Lock, ( playlist_t * ) ); +VLC_EXPORT( void, playlist_Unlock, ( playlist_t * ) ); +VLC_EXPORT( void, playlist_AssertLocked, ( playlist_t * ) ); /** * Do a playlist action. @@ -264,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 @@ -272,20 +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 *) ); +VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t * ) ); -/** Enqueue a playlist item and all of its children if any for preparsing */ -VLC_EXPORT( int, playlist_PreparseEnqueueItem, (playlist_t *, playlist_item_t *) ); /** Request the art for an input item to be fetched */ -VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *) ); +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( int, playlist_CurrentId, ( playlist_t * ) ); -VLC_EXPORT( bool, playlist_IsPlaying, ( playlist_t * ) ); +VLC_EXPORT( playlist_item_t *, playlist_CurrentPlayingItem, ( playlist_t * ) LIBVLC_USED ); VLC_EXPORT( int, playlist_Status, ( playlist_t * ) ); /** @@ -298,6 +308,11 @@ VLC_EXPORT( int, playlist_Status, ( playlist_t * ) ); */ VLC_EXPORT( int, playlist_Export, ( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type ) ); +/** + * Open a playlist file, add its content to the current playlist + */ +VLC_EXPORT( int, playlist_Import, ( playlist_t *p_playlist, const char *psz_file ) ); + /********************** Services discovery ***********************/ /** Add a list of comma-separated service discovery modules */ @@ -313,98 +328,59 @@ VLC_EXPORT( bool, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char * Item management ********************************************************/ -/*************************** Item creation **************************/ - -VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( playlist_t *,const char *,const char *, int , const char *const *, int, int) ); - -/** Create a new item, without adding it to the playlist - * \param p_obj a vlc object (anyone will do) - * \param psz_uri the mrl of the item - * \param psz_name a text giving a name or description of the item - * \return the new item or NULL on failure - */ -#define playlist_ItemNew( a , b, c ) \ - playlist_ItemNewWithType( VLC_OBJECT(a) , b , c, 0, NULL, -1, 0 ) - - /*************************** Item deletion **************************/ -VLC_EXPORT( int, playlist_DeleteFromInput, ( playlist_t *, int, bool ) ); - -/*************************** Item fields accessors **************************/ -VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, const char * ) ); +VLC_EXPORT( int, playlist_DeleteFromInput, ( playlist_t *, input_item_t *, bool ) ); /******************** Item addition ********************/ VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char *, int, int, bool, bool ) ); -VLC_EXPORT( int, playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char *const *,int, bool, bool ) ); +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( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, int*, int*, bool ) ); - -/********************** Misc item operations **********************/ -VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *, 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, bool ) ); -VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t *, bool ) ); -VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInputId, (playlist_t *, int, playlist_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 ********************************************************/ -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, 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( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, bool ) ); -VLC_EXPORT( void, playlist_NodesPairCreate, (playlist_t *, const char *, playlist_item_t **, playlist_item_t **, bool ) ); -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, 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_GetLastLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root ) ); + +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 ***********************************************************************/ -/** Open a playlist file, add its content to the current playlist */ -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 ); - const char *const psz_option = "meta-file"; - p_input = input_item_NewExt( p_playlist, psz_uri, psz_file, - 1, &psz_option, -1 ); - playlist_AddInput( p_playlist, p_input, PLAYLIST_APPEND, PLAYLIST_END, - true, false ); - input_Read( p_playlist, p_input, true ); - return VLC_SUCCESS; -} - /** Small helper tp get current playing input or NULL. Release the input after use. */ #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 */ -#define playlist_IsEmpty( pl ) ( pl->items.i_size == 0 ) +static inline bool playlist_IsEmpty( playlist_t *p_playlist ) +{ + PL_ASSERT_LOCKED; + return p_playlist->items.i_size == 0; +} /** Tell the number of items in the current playing context */ -#define playlist_CurrentSize( pl ) pl->current.i_size - -/** Ask the playlist to do some work */ -#define playlist_Signal( p_playlist ) vlc_object_signal( p_playlist ) +static inline int playlist_CurrentSize( playlist_t *p_playlist ) +{ + PL_ASSERT_LOCKED; + return p_playlist->current.i_size; +} /** @} */ # ifdef __cplusplus