* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
-#if !defined( __LIBVLC__ )
- #error You are not libvlc or one of its plugins. You cannot include this file
-#endif
-
-#ifndef _VLC_PLAYLIST_H_
-#define _VLC_PLAYLIST_H_
+#ifndef VLC_PLAYLIST_H_
+#define VLC_PLAYLIST_H_
# ifdef __cplusplus
extern "C" {
# endif
-#include <assert.h>
#include <vlc_input.h>
#include <vlc_events.h>
+#include <vlc_services_discovery.h>
#include <stdio.h>
#include <stdlib.h>
TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t);
-TYPEDEF_ARRAY(input_item_t*, input_item_array_t);
/**
* \file
* will maybe become useful again when we merge VLM;
*
* To delete an item, use playlist_DeleteFromInput( input_id ) which will
- * remove all occurences of the input in both trees
+ * remove all occurrences of the input in both trees
*
* @{
*/
typedef enum
{ PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
-
-struct services_discovery_t
-{
- VLC_COMMON_MEMBERS
- char * psz_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 *);
-};
-
/** Structure containing information about the playlist */
struct playlist_t
{
VLC_COMMON_MEMBERS
- int i_enabled; /**< How many items are enabled ? */
playlist_item_array_t items; /**< Arrays of items */
playlist_item_array_t all_items; /**< Array of items and nodes */
- input_item_array_t input_items; /**< Array of input items */
-
playlist_item_array_t current; /**< Items currently being played */
int i_current_index; /**< Index in current array */
/** Reset current item array */
- vlc_bool_t b_reset_currently_playing;
+ bool b_reset_currently_playing;
mtime_t last_rebuild_date;
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_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 */
-
- 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_auto_preparse;
-
- /* Runtime */
- input_thread_t * p_input; /**< the input thread associated
- * with the current item */
- int i_sort; /**< Last sorting applied to the playlist */
- int i_order; /**< Last ordering applied to the playlist */
- mtime_t gc_date;
- vlc_bool_t b_cant_sleep;
- playlist_preparse_t *p_preparse; /**< Preparser object */
- playlist_fetcher_t *p_fetcher;/**< Meta and art fetcher object */
-
- vlc_mutex_t gc_lock; /**< Lock to protect the garbage collection */
-
- struct {
- /* Current status. These fields are readonly, only the playlist
- * main loop can touch it*/
- playlist_status_t i_status; /**< Current status of playlist */
- playlist_item_t * p_item; /**< Currently playing/active item */
- playlist_item_t * p_node; /**< Current node to play from */
- } status;
-
- struct {
- /* Request. Use this to give orders to the playlist main loop */
- int i_status; /**< requested playlist status */
- playlist_item_t * p_node; /**< requested node to play from */
- playlist_item_t * p_item; /**< requested item to play in the node */
-
- int i_skip; /**< Number of items to skip */
-
- vlc_bool_t b_request;/**< Set to true by the requester
- The playlist sets it back to false
- when processing the request */
- vlc_mutex_t lock; /**< Lock to protect request */
- } request;
-
- // Playlist-unrelated fields
- interaction_t *p_interaction; /**< Interaction manager */
- input_thread_t *p_stats_computer; /**< Input thread computing stats */
- global_stats_t *p_stats; /**< Global statistics */
};
/** Helper to add an item */
#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
+/* Used by playlist_Import */
+#define PLAYLIST_INSERT 0x0001
+#define PLAYLIST_APPEND 0x0002
+#define PLAYLIST_GO 0x0004
+#define PLAYLIST_PREPARSE 0x0008
+#define PLAYLIST_SPREPARSE 0x0010
+#define PLAYLIST_NO_REBUILD 0x0020
+
+#define PLAYLIST_END -666
+
+enum pl_locked_state
+{
+ pl_Locked = true,
+ pl_Unlocked = false
+};
+
/*****************************************************************************
* Prototypes
*****************************************************************************/
/* Helpers */
-#define PL_LOCK vlc_mutex_lock( &p_playlist->object_lock );
-#define PL_UNLOCK vlc_mutex_unlock( &p_playlist->object_lock );
+#define PL_LOCK vlc_object_lock( p_playlist )
+#define PL_UNLOCK vlc_object_unlock( p_playlist )
-#define pl_Get( a ) a->p_libvlc->p_playlist
-#define pl_Yield( a ) __pl_Yield( VLC_OBJECT(a) )
-static inline playlist_t *__pl_Yield( vlc_object_t *p_this )
-{
- assert( p_this->p_libvlc->p_playlist );
- vlc_object_yield( p_this->p_libvlc->p_playlist );
- return p_this->p_libvlc->p_playlist;
-}
-#define pl_Release(a) vlc_object_release( a->p_libvlc->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) )
/* Playlist control */
-#define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, VLC_FALSE )
-#define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, VLC_FALSE )
-#define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, VLC_FALSE )
-#define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, VLC_FALSE, 1)
-#define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, VLC_FALSE, -1)
-#define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, VLC_FALSE, i)
+#define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
+#define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, pl_Unlocked )
+#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)
/**
* Do a playlist action.
* \param variable number of arguments
* \return VLC_SUCCESS or an error
*/
-VLC_EXPORT( int, playlist_Control, ( playlist_t *p_playlist, int i_query, vlc_bool_t b_locked, ... ) );
+VLC_EXPORT( int, playlist_Control, ( playlist_t *p_playlist, int i_query, bool b_locked, ... ) );
+
+/** Get current playing input. The object is retained.
+ */
+VLC_EXPORT( input_thread_t *, playlist_CurrentInput, ( playlist_t *p_playlist ) );
/** Clear the playlist
* \param b_locked TRUE if playlist is locked when entering this function
*/
-VLC_EXPORT( void, playlist_Clear, ( playlist_t *, vlc_bool_t ) );
+VLC_EXPORT( void, playlist_Clear, ( playlist_t *, bool ) );
/** Enqueue an input item for preparsing */
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 *) );
-/********************** Services discovery ***********************/
-
-/** Add a list of comma-separated service discovery modules */
-VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
-/** Remove a services discovery module by name */
-VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
-/** Check whether a given SD is loaded */
-VLC_EXPORT( vlc_bool_t, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
-
/* Playlist sorting */
VLC_EXPORT( int, playlist_TreeMove, ( playlist_t *, 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( int, playlist_Status, ( playlist_t * ) );
+
/**
* Export a node of the playlist to a certain type of playlistfile
* \param p_playlist the playlist to export
*/
VLC_EXPORT( int, playlist_Export, ( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type ) );
+/********************** Services discovery ***********************/
+
+/** Add a list of comma-separated service discovery modules */
+VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
+/** Remove a services discovery module by name */
+VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
+/** Check whether a given SD is loaded */
+VLC_EXPORT( bool, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
+
+
+
/********************************************************
* Item management
********************************************************/
/*************************** Item creation **************************/
-VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int , const char *const *, int, int) );
+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)
#define playlist_ItemNew( a , b, c ) \
playlist_ItemNewWithType( VLC_OBJECT(a) , b , c, 0, NULL, -1, 0 )
-#define playlist_ItemNewFromInput(a,b) __playlist_ItemNewFromInput(VLC_OBJECT(a),b)
-VLC_EXPORT( playlist_item_t *, __playlist_ItemNewFromInput, ( vlc_object_t *p_obj,input_item_t *p_input ) );
/*************************** Item deletion **************************/
-VLC_EXPORT( int, playlist_DeleteFromInput, ( playlist_t *, int, vlc_bool_t ) );
+VLC_EXPORT( int, playlist_DeleteFromInput, ( playlist_t *, int, bool ) );
/*************************** 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_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 ) );
+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_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 *, vlc_bool_t) );
-
-playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
- int i_input_id, playlist_item_t *p_root,
- vlc_bool_t );
+VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *, bool) );
/********************************** Item search *************************/
-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_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( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) );
/********************************************************
* Tree management
********************************************************/
-VLC_EXPORT(void, playlist_NodeDump, ( playlist_t *p_playlist, playlist_item_t *p_item, int i_level ) );
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 ) );
+VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, 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( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, vlc_bool_t , vlc_bool_t ) );
-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( 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, 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_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 ) );
-/***********************************************************************
- * Service Discovery
- ***********************************************************************/
-/* XXX: no need to inline */
-/* XXX: no need to inline */
-/* Return the number of services_discovery available */
-
-/* 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 ) );
-
-/* 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
***********************************************************************/
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 );
+ 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,
- VLC_TRUE, VLC_FALSE );
- input_Read( p_playlist, p_input, VLC_TRUE );
+ true, false );
+ input_Read( p_playlist, p_input, true );
return VLC_SUCCESS;
}
-/** Tell if the playlist is currently running */
-#define playlist_IsPlaying( pl ) ( pl->status.i_status == PLAYLIST_RUNNING )
+/** 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;
+}
/** Tell if the playlist is empty */
#define playlist_IsEmpty( pl ) ( pl->items.i_size == 0 )
/** Tell the number of items in the current playing context */
-#define playlist_CurrentSize( obj ) obj->p_libvlc->p_playlist->current.i_size
+#define playlist_CurrentSize( pl ) pl->current.i_size
/** Ask the playlist to do some work */
-static inline void playlist_Signal( playlist_t *p_playlist )
-{
- PL_LOCK;
- vlc_cond_signal( &p_playlist->object_wait );
- PL_UNLOCK;
-}
+#define playlist_Signal( p_playlist ) vlc_object_signal( p_playlist )
/** @} */
# ifdef __cplusplus
projects / vlc / blobdiff