/*****************************************************************************
* vlc_playlist.h : Playlist functions
*****************************************************************************
- * Copyright (C) 1999, 2000, 2001, 2002 VideoLAN
- * $Id: vlc_playlist.h,v 1.9 2003/03/17 17:10:21 hartman Exp $
+ * Copyright (C) 1999-2004 VideoLAN
+ * $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
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
*****************************************************************************/
-/*****************************************************************************
- * playlist_item_t: playlist item
- *****************************************************************************/
+/**
+ * \file
+ * This file contain structures and function prototypes related
+ * to the playlist in vlc
+ */
+
+/**
+ * \defgroup vlc_playlist Playlist
+ * Brief description. Longer description
+ * @{
+ */
+
+/**
+ * playlist export helper structure
+ */
+struct playlist_export_t
+{
+ char *psz_filename;
+ FILE *p_file;
+};
+
+/**
+ * playlist item
+ * \see playlist_t
+ */
struct playlist_item_t
{
- char * psz_name;
- char * psz_uri;
- int i_type; /* unused yet */
- int i_status; /* unused yet */
- vlc_bool_t b_autodeletion;
+ input_item_t input; /**< input item descriptor */
+
+ int i_nb_played; /**< How many times was this item played ? */
+ vlc_bool_t b_autodeletion; /**< Indicates whther this item is to
+ * be deleted after playback. True mean
+ * that this item is to be deleted
+ * after playback, false otherwise */
+ vlc_bool_t b_enabled; /**< Indicates whether this item is to be
+ * played or skipped */
+ int i_group; /**< Which group does this item belongs to ? */
+ int i_id; /**< Unique id to track this item */
};
-/*****************************************************************************
- * 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.
- *****************************************************************************/
+/**
+ * playlist group
+ * \see playlist_t
+ */
+struct playlist_group_t
+{
+ char * psz_name; /**< name of the group */
+ int i_id; /**< Identifier for the group */
+};
+
+/**
+ * Playlist status
+ */
+typedef enum { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
+
+/**
+ * Structure containing information about the playlist
+ */
struct playlist_t
{
VLC_COMMON_MEMBERS
+/**
+ \name playlist_t
+ These members are uniq to playlist_t
+*/
+/*@{*/
+ int i_index; /**< current index into the playlist */
+ playlist_status_t i_status; /**< current status of playlist */
+ int i_size; /**< total size of the list */
+ int i_enabled; /**< How many items are enabled ? */
+ playlist_item_t ** pp_items; /**< array of pointers to the
+ * playlist items */
+ int i_groups; /**< How many groups are in the playlist */
+ playlist_group_t ** pp_groups;/**< array of pointers to the playlist
+ * groups */
+ int i_last_group; /**< Maximal group id given */
+ input_thread_t * p_input; /**< the input thread ascosiated
+ * with the current item */
+ int i_last_id; /**< Last id to an item */
+ int i_sort; /**< Last sorting applied to the playlist */
+ int i_order; /**< Last ordering applied to the playlist */
+ /*@}*/
+};
- int i_index; /* current index */
- int i_status;
- int i_size; /* total size */
+#define SORT_ID 0
+#define SORT_TITLE 1
+#define SORT_AUTHOR 2
+#define SORT_GROUP 3
+#define SORT_RANDOM 4
+#define SORT_DURATION 5
- playlist_item_t ** pp_items;
+#define ORDER_NORMAL 0
+#define ORDER_REVERSE 1
- input_thread_t * p_input;
-};
-
-/*****************************************************************************
- * Playlist status
- *****************************************************************************/
-#define PLAYLIST_STOPPED 0
-#define PLAYLIST_RUNNING 1
-#define PLAYLIST_PAUSED 2
+#define PLAYLIST_TYPE_MANUAL 1
+#define PLAYLIST_TYPE_SAP 2
/*****************************************************************************
* Prototypes
#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_AddItem, ( playlist_t *, playlist_item_t *, int, int ) );
+VLC_EXPORT( void, playlist_Command, ( playlist_t *, playlist_command_t, int ) );
+
+
+/* Item management functions */
+#define playlist_AddItem(p,pi,i1,i2) playlist_ItemAdd(p,pi,i1,i2)
+#define playlist_ItemNew( a , b, c ) __playlist_ItemNew(VLC_OBJECT(a) , b , c )
+VLC_EXPORT( playlist_item_t* , __playlist_ItemNew, ( vlc_object_t *,const char *,const char * ) );
+VLC_EXPORT( void, playlist_ItemDelete, ( playlist_item_t * ) );
+VLC_EXPORT( int, playlist_ItemAdd, ( playlist_t *, playlist_item_t *, int, int ) );
+
+/* Simple add/remove funcctions */
+VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char *, int, int ) );
+VLC_EXPORT( int, playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char **,int ) );
+
+
+VLC_EXPORT( int, playlist_Clear, ( playlist_t * ) );
VLC_EXPORT( int, playlist_Delete, ( playlist_t *, int ) );
+VLC_EXPORT( int, playlist_Disable, ( playlist_t *, int ) );
+VLC_EXPORT( int, playlist_Enable, ( playlist_t *, int ) );
+VLC_EXPORT( int, playlist_DisableGroup, ( playlist_t *, int ) );
+VLC_EXPORT( int, playlist_EnableGroup, ( playlist_t *, int ) );
+
+/* Basic item information accessors */
+VLC_EXPORT( int, playlist_ItemSetGroup, (playlist_item_t *, int ) );
+VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *, char * ) );
+VLC_EXPORT( int, playlist_ItemSetDuration, (playlist_item_t *, mtime_t ) );
+
+VLC_EXPORT( int, playlist_SetGroup, (playlist_t * , int , int ) );
+VLC_EXPORT( int, playlist_SetName, (playlist_t *, int , char * ) );
+VLC_EXPORT( int, playlist_SetDuration, (playlist_t *, int , mtime_t ) );
+
+/* Item search functions */
+VLC_EXPORT( int, playlist_GetPositionById, (playlist_t *, int) );
+VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int) );
+VLC_EXPORT( playlist_item_t *, playlist_ItemGetByPos, (playlist_t *, int) );
+
+
+/* Group management functions */
+VLC_EXPORT( playlist_group_t *, playlist_CreateGroup, (playlist_t *, char* ) );
+VLC_EXPORT( int, playlist_DeleteGroup, (playlist_t *, int ) );
+VLC_EXPORT( char *, playlist_FindGroup, (playlist_t *, int ) );
+VLC_EXPORT( int, playlist_GroupToId, (playlist_t *, char * ) );
+
+/* Info functions */
+VLC_EXPORT( char * , playlist_GetInfo, ( playlist_t * , int, const char *, const char *) );
+VLC_EXPORT( char * , playlist_ItemGetInfo, ( playlist_item_t * , const char *, const char *) );
+
+VLC_EXPORT( info_category_t*, playlist_ItemGetCategory, ( playlist_item_t *, const char *) );
+
+VLC_EXPORT( info_category_t*, playlist_ItemCreateCategory, ( playlist_item_t *, const char *) );
+
+VLC_EXPORT( int, playlist_AddInfo, (playlist_t *, int, const char * , const char *, const char *, ...) );
+VLC_EXPORT( int, playlist_ItemAddInfo, (playlist_item_t *, const char * , const char *, const char *, ...) );
+
+/* Option functions */
+VLC_EXPORT( int, playlist_ItemAddOption, (playlist_item_t *, const char *) );
+
+/* Playlist sorting */
+#define playlist_SortID(p, i) playlist_Sort( p, SORT_ID, i)
+#define playlist_SortTitle(p, i) playlist_Sort( p, SORT_TITLE, i)
+#define playlist_SortAuthor(p, i) playlist_Sort( p, SORT_AUTHOR, i)
+#define playlist_SortGroup(p, i) playlist_Sort( p, SORT_GROUP, i)
+VLC_EXPORT( int, playlist_Sort, ( playlist_t *, int, int) );
VLC_EXPORT( int, playlist_Move, ( playlist_t *, int, int ) );
-VLC_EXPORT( int, playlist_LoadFile, ( playlist_t *, const char * ) );
-VLC_EXPORT( int, playlist_SaveFile, ( playlist_t *, const char * ) );
+/* Load/Save */
+VLC_EXPORT( int, playlist_Import, ( playlist_t *, const char * ) );
+VLC_EXPORT( int, playlist_Export, ( playlist_t *, const char *, const char * ) );
+
+/**
+ * tell if a playlist is currently playing.
+ * \param p_playlist the playlist to check
+ * \return true if playlist is playing, false otherwise
+ */
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->i_status == PLAYLIST_RUNNING;
+ b_playing = p_playlist->i_status == PLAYLIST_RUNNING;
vlc_mutex_unlock( &p_playlist->object_lock );
return( b_playing );
}
+/**
+ * tell if a playlist is currently empty
+ * \param p_playlist the playlist to check
+ * \return true if the playlist is empty, false otherwise
+ */
static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist )
{
vlc_bool_t b_empty;
return( b_empty );
}
+
+/**
+ * @}
+ */
projects / vlc / blobdiff