/*****************************************************************************
* vlc_playlist.h : Playlist functions
*****************************************************************************
- * Copyright (C) 1999, 2000, 2001, 2002 VideoLAN
- * $Id: vlc_playlist.h,v 1.2 2002/07/03 19:40:49 sam Exp $
+ * Copyright (C) 1999-2004 the VideoLAN team
+ * $Id$
*
* Authors: Samuel Hocevar <sam@zoy.org>
*
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
- *
+ *
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
*
* 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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
-/*****************************************************************************
- * playlist_item_t: playlist item
- *****************************************************************************/
-struct playlist_item_s
+#ifndef _VLC_PLAYLIST_H_
+#define _VLC_PLAYLIST_H_
+
+#include <assert.h>
+
+/**
+ * \file
+ * This file contain structures and function prototypes related
+ * to the playlist in vlc
+ */
+
+/**
+ * \defgroup vlc_playlist Playlist
+ * @{
+ */
+
+/**
+ * playlist export helper structure
+ */
+struct playlist_export_t
{
- char * psz_name;
- int i_type; /* unused yet */
- int i_status; /* unused yet */
+ char *psz_filename;
+ FILE *p_file;
+ playlist_item_t *p_root;
};
-/*****************************************************************************
- * playlist_t: playlist structure
- *****************************************************************************
- * The structure contains information about the size and browsing mode of
- * the playlist, a change lock, a dynamic array of playlist items, and a
- * current item which is an exact copy of one of the array members.
- *****************************************************************************/
-struct playlist_s
+/**
+ * playlist item / node
+ * \see playlist_t
+ */
+struct playlist_item_t
+{
+ input_item_t *p_input; /**< input item descriptor */
+
+ /* Tree specific fields */
+ int i_children; /**< Number of children
+ -1 if not a node */
+ playlist_item_t **pp_children; /**< Children nodes/items */
+ playlist_item_t *p_parent; /**< Item parent */
+
+ int i_id; /**< Playlist item specific id */
+
+ uint8_t i_flags; /**< Flags */
+};
+
+#define PLAYLIST_SAVE_FLAG 0x0001 /**< Must it be saved */
+#define PLAYLIST_SKIP_FLAG 0x0002 /**< Must playlist skip after it ? */
+#define PLAYLIST_DBL_FLAG 0x0004 /**< Is it disabled ? */
+#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 */
+
+/**
+ * Playlist status
+ */
+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;
- int i_index; /* current index */
- int i_status;
- int i_size; /* total size */
+ services_discovery_sys_t *p_sys;
+ void (*pf_run) ( services_discovery_t *);
+};
- playlist_item_t ** pp_items;
+/** Structure containing information about the playlist */
+struct playlist_t
+{
+ VLC_COMMON_MEMBERS
+/**
+ \name playlist_t
+ These members are uniq to playlist_t
+*/
+/*@{*/
+ int i_enabled; /**< How many items are enabled ? */
- input_thread_t * p_input;
+ /* Arrays of items */
+ int i_size; /**< total size of the list */
+ playlist_item_t ** pp_items; /**< array of pointers to the
+ * playlist items */
+ int i_all_size; /**< size of list of items and nodes */
+ playlist_item_t ** pp_all_items; /**< array of pointers to the
+ * playlist items and nodes */
+ int i_input_items;
+ input_item_t ** pp_input_items;
+
+ int i_random; /**< Number of candidates for random */
+ playlist_item_t ** pp_random; /**< Random candidate items */
+ int i_random_index; /**< Current random item */
+ vlc_bool_t b_reset_random; /**< Recreate random array ?*/
+
+ 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;
+ int i_sds;
+
+ /* Predefined items */
+ playlist_item_t * p_root_category;
+ playlist_item_t * p_root_onelevel;
+ 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 */
+
+ 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 */
+
+ /* 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 i_vout_destroyed_date;
+ mtime_t i_sout_destroyed_date;
+ playlist_preparse_t *p_preparse; /**< Preparser object */
+ playlist_secondary_preparse_t *p_secondary_preparse;/**< Preparser 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 */
+ /** The input thread computing stats */
+ input_thread_t *p_stats_computer;
+ global_stats_t *p_stats; /**< Global statistics */
+ /*@}*/
+};
+
+/* Helper to add an item */
+struct playlist_add_t
+{
+ int i_node;
+ int i_item;
+ int i_position;
};
+#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 ORDER_NORMAL 0
+#define ORDER_REVERSE 1
+
/*****************************************************************************
* Prototypes
*****************************************************************************/
-#define playlist_Create(a) __playlist_Create(CAST_TO_VLC_OBJECT(a))
-playlist_t * __playlist_Create ( vlc_object_t * );
-void playlist_Destroy ( playlist_t * );
-
-#define playlist_Play(p) playlist_Command(p,PLAYLIST_PLAY,0)
-#define playlist_Pause(p) playlist_Command(p,PLAYLIST_PAUSE,0)
-#define playlist_Stop(p) playlist_Command(p,PLAYLIST_STOP,0)
-#define playlist_Next(p) playlist_Command(p,PLAYLIST_SKIP,1)
-#define playlist_Prev(p) playlist_Command(p,PLAYLIST_SKIP,-1)
-#define playlist_Skip(p,i) playlist_Command(p,PLAYLIST_SKIP,i)
-#define playlist_Goto(p,i) playlist_Command(p,PLAYLIST_GOTO,i)
-VLC_EXPORT( void, playlist_Command, ( playlist_t *, int, int ) );
-
-VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, int, int ) );
-VLC_EXPORT( int, playlist_Delete, ( playlist_t *, int ) );
+/* Global thread */
+#define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
+void __playlist_ThreadCreate ( vlc_object_t * );
+int playlist_ThreadDestroy ( playlist_t * );
+
+/* Helpers */
+#define PL_LOCK vlc_mutex_lock( &p_playlist->object_lock );
+#define PL_UNLOCK vlc_mutex_unlock( &p_playlist->object_lock );
+
+#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 );
+
+/* Playlist control */
+#define playlist_Play(p) playlist_LockControl(p,PLAYLIST_PLAY )
+#define playlist_Pause(p) playlist_LockControl(p,PLAYLIST_PAUSE )
+#define playlist_Stop(p) playlist_LockControl(p,PLAYLIST_STOP )
+#define playlist_Next(p) playlist_LockControl(p,PLAYLIST_SKIP, 1)
+#define playlist_Prev(p) playlist_LockControl(p,PLAYLIST_SKIP, -1)
+#define playlist_Skip(p,i) playlist_LockControl(p,PLAYLIST_SKIP, i)
+
+VLC_EXPORT( int, playlist_Control, ( playlist_t *, int, ... ) );
+VLC_EXPORT( int, playlist_LockControl, ( playlist_t *, int, ... ) );
+
+VLC_EXPORT( void, playlist_Clear, ( playlist_t * ) );
+VLC_EXPORT( void, playlist_LockClear, ( playlist_t * ) );
+
+VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *) );
+VLC_EXPORT( int, playlist_PreparseEnqueueItem, (playlist_t *, playlist_item_t *) );
+VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *) );
+
+/* Services discovery */
+
+VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
+VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
+VLC_EXPORT( int, playlist_AddSDModules, (playlist_t *, char *));
+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_NodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
+VLC_EXPORT( int, playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
+
+/* Load/Save */
+VLC_EXPORT( int, playlist_Import, ( playlist_t *, const char *, playlist_item_t *, vlc_bool_t ) );
+VLC_EXPORT( int, playlist_Export, ( playlist_t *, const char *, playlist_item_t *, const char * ) );
+
+/********************************************************
+ * Item management
+ ********************************************************/
+
+/*************************** Item creation **************************/
+
+VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( vlc_object_t *,const char *,const char *, int , const char **, int, int) );
+
+#define playlist_ItemNew( a , b, c ) __playlist_ItemNew(VLC_OBJECT(a) , b , c )
+/** 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
+ */
+static inline playlist_item_t * __playlist_ItemNew( vlc_object_t *p_obj,
+ const char *psz_uri, const char *psz_name )
+{
+ /* 0 = ITEM_TYPE_UNKNOWN */
+ return playlist_ItemNewWithType( p_obj, psz_uri, psz_name, 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_ItemDelete, ( playlist_item_t * ) );
+VLC_EXPORT( int, playlist_DeleteAllFromInput, ( playlist_t *, int ) );
+VLC_EXPORT( int, playlist_DeleteFromInput, ( playlist_t *, int, playlist_item_t *, vlc_bool_t ) );
+VLC_EXPORT( int, playlist_DeleteFromItemId, ( playlist_t *, int ) );
+VLC_EXPORT( int, playlist_LockDelete, ( playlist_t *, int ) );
+VLC_EXPORT( int, playlist_LockDeleteAllFromInput, ( playlist_t *, int ) );
+
+/*************************** Item fields accessors **************************/
+VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, 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 **,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( void, playlist_NodeAddItem, ( playlist_t *, playlist_item_t *, playlist_item_t *,int , int ) );
+VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int ) );
+VLC_EXPORT( void, playlist_AddWhereverNeeded, (playlist_t* , input_item_t*, playlist_item_t*,playlist_item_t*,vlc_bool_t, int ) );
+
+/** Add a MRL into the playlist.
+ * \see playlist_Add
+ */
+static inline int playlist_PlaylistAdd( playlist_t *p_playlist,
+ const char *psz_uri, const char *psz_name,
+ int i_mode, int i_pos )
+{
+ return playlist_Add( p_playlist, psz_uri, psz_name, i_mode, i_pos,
+ VLC_TRUE);
+}
+
+/** Add a MRL to the media library
+ * \see playlist_Add
+ */
+static inline int playlist_MLAdd( playlist_t *p_playlist, const char *psz_uri,
+ const char *psz_name, int i_mode, int i_pos )
+{
+ return playlist_Add( p_playlist, psz_uri, psz_name, i_mode, i_pos,
+ VLC_FALSE );
+}
+
+/** Add a MRL to the playlist, with duration and options given
+ * \see playlist_AddExt
+ */
+static inline int playlist_PlaylistAddExt( playlist_t *p_playlist,
+ const char * psz_uri, const char *psz_name, int i_mode, int i_pos,
+ mtime_t i_duration, const char **ppsz_options, int i_options )
+{
+ return playlist_AddExt( p_playlist, psz_uri, psz_name, i_mode, i_pos,
+ i_duration, ppsz_options, i_options, VLC_TRUE );
+}
+
+/** Add a MRL to the media library, with duration and options given
+ * \see playlist_AddExt
+ */
+static inline int playlist_MLAddExt( playlist_t *p_playlist,
+ const char * psz_uri, const char *psz_name, int i_mode, int i_pos,
+ mtime_t i_duration, const char **ppsz_options, int i_options )
+{
+ return playlist_AddExt( p_playlist, psz_uri, psz_name, i_mode, i_pos,
+ i_duration, ppsz_options, i_options, VLC_FALSE );
+}
+
+/** Add an input item to the playlist node
+ * \see playlist_AddInput
+ */
+static inline int playlist_PlaylistAddInput( playlist_t* p_playlist,
+ input_item_t *p_input, int i_mode, int i_pos )
+{
+ return playlist_AddInput( p_playlist, p_input, i_mode, i_pos, VLC_TRUE );
+}
+
+/** Add an input item to the media library
+ * \see playlist_AddInput
+ */
+static inline int playlist_MLAddInput( playlist_t* p_playlist,
+ input_item_t *p_input, int i_mode, int i_pos )
+{
+ return playlist_AddInput( p_playlist, p_input, i_mode, i_pos, VLC_FALSE );
+}
+
+/********************** Misc item operations **********************/
+VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *) );
+VLC_EXPORT( playlist_item_t*, playlist_LockItemToNode, (playlist_t *,playlist_item_t *) );
+
+playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
+ int i_input_id, playlist_item_t *p_root,
+ vlc_bool_t );
+
+/********************************** Item search *************************/
+VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int) );
+VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) );
+
+static inline playlist_item_t *playlist_LockItemGetById( playlist_t *p_playlist,
+ int i_id)
+{
+ playlist_item_t *p_ret;
+ vlc_mutex_lock( &p_playlist->object_lock );
+ p_ret = playlist_ItemGetById( p_playlist, i_id );
+ vlc_mutex_unlock( &p_playlist->object_lock );
+ return p_ret;
+}
+
+static inline playlist_item_t *playlist_LockItemGetByInput(
+ playlist_t *p_playlist, input_item_t *p_item )
+{
+ playlist_item_t *p_ret;
+ vlc_mutex_lock( &p_playlist->object_lock );
+ p_ret = playlist_ItemGetByInput( p_playlist, p_item );
+ vlc_mutex_unlock( &p_playlist->object_lock );
+ return p_ret;
+}
+
+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 *, char *, playlist_item_t * p_parent ) );
+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 *, 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 ) );
+
+/***********************************************************************
+ * Inline functions
+ ***********************************************************************/
+
+/** Tell if the playlist is currently running */
+static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
+{
+ vlc_bool_t b_playing;
+ vlc_mutex_lock( &p_playlist->object_lock );
+ b_playing = p_playlist->status.i_status == PLAYLIST_RUNNING;
+ vlc_mutex_unlock( &p_playlist->object_lock );
+ return( b_playing );
+}
+
+/** Tell if the playlist is empty */
+static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist )
+{
+ vlc_bool_t b_empty;
+ vlc_mutex_lock( &p_playlist->object_lock );
+ b_empty = p_playlist->i_size == 0;
+ vlc_mutex_unlock( &p_playlist->object_lock );
+ return( b_empty );
+}
+
+/**
+ * @}
+ */
+
+#endif
projects / vlc / blobdiff