vlc_playlist.h 8.82 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1
/*****************************************************************************
2
 * vlc_playlist.h : Playlist functions
Sam Hocevar's avatar
 
Sam Hocevar committed
3
 *****************************************************************************
4
 * Copyright (C) 1999-2004 VideoLAN
5
 * $Id$
Sam Hocevar's avatar
 
Sam Hocevar committed
6
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
7
 * Authors: Samuel Hocevar <sam@zoy.org>
Sam Hocevar's avatar
 
Sam Hocevar committed
8 9 10 11 12
 *
 * This program is free software; you can redistribute it and/or modify
 * 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.
Clément Stenac's avatar
Clément Stenac committed
13
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
14 15 16 17 18 19 20 21 22 23
 * 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
 * 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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
24 25 26 27 28 29 30 31 32 33 34 35
/**
 *  \file
 *  This file contain structures and function prototypes related
 *  to the playlist in vlc
 */

/**
 * \defgroup vlc_playlist Playlist
 * Brief description. Longer description
 * @{
 */

36 37 38 39 40 41 42 43 44
/**
 * playlist export helper structure
 */
struct playlist_export_t
{
    char *psz_filename;
    FILE *p_file;
};

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
45 46 47 48
/**
 * playlist item
 * \see playlist_t
 */
49
struct playlist_item_t
Sam Hocevar's avatar
 
Sam Hocevar committed
50
{
51 52
    input_item_t input;        /**< input item descriptor */

53
    int        i_nb_played;    /**< How many times was this item played ? */
Clément Stenac's avatar
Clément Stenac committed
54
    vlc_bool_t b_autodeletion; /**< Indicates whther this item is to
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
55 56 57
                                * be deleted after playback. True mean
                                * that this item is to be deleted
                                * after playback, false otherwise */
Clément Stenac's avatar
Clément Stenac committed
58 59
    vlc_bool_t b_enabled;      /**< Indicates whether this item is to be
                                * played or skipped */
60
    int        i_group;        /**< Which group does this item belongs to ? */
61
    int        i_id;           /**< Unique id to track this item */
62
};
Sam Hocevar's avatar
 
Sam Hocevar committed
63

64 65 66 67
/**
 * playlist group
 * \see playlist_t
 */
68 69 70 71 72 73
struct playlist_group_t
{
    char *   psz_name;        /**< name of the group */
    int      i_id;            /**< Identifier for the group */
};

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
74 75 76 77 78 79 80 81
/**
 * Playlist status
 */
typedef enum { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;

/**
 * Structure containing information about the playlist
 */
82
struct playlist_t
Sam Hocevar's avatar
 
Sam Hocevar committed
83
{
84
    VLC_COMMON_MEMBERS
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
85 86 87 88 89 90 91 92
/**
   \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 */
Clément Stenac's avatar
Clément Stenac committed
93
    int                   i_enabled; /**< How many items are enabled ? */
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
94 95
    playlist_item_t **    pp_items; /**< array of pointers to the
                                     * playlist items */
96 97 98
    int                   i_groups; /**< How many groups are in the playlist */
    playlist_group_t **   pp_groups;/**< array of pointers to the playlist
                                     * groups */
99
    int                   i_last_group; /**< Maximal group id given */
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
100 101
    input_thread_t *      p_input;  /**< the input thread ascosiated
                                     * with the current item */
102
    int                   i_last_id; /**< Last id to an item */
103 104
    int                   i_sort; /**< Last sorting applied to the playlist */
    int                   i_order; /**< Last ordering applied to the playlist */
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
105
    /*@}*/
106
};
Sam Hocevar's avatar
 
Sam Hocevar committed
107

108 109 110 111 112
#define SORT_ID 0
#define SORT_TITLE 1
#define SORT_AUTHOR 2
#define SORT_GROUP 3
#define SORT_RANDOM 4
Clément Stenac's avatar
Clément Stenac committed
113
#define SORT_DURATION 5
Clément Stenac's avatar
Clément Stenac committed
114

115 116
#define ORDER_NORMAL 0
#define ORDER_REVERSE 1
Clément Stenac's avatar
Clément Stenac committed
117

118 119
#define PLAYLIST_TYPE_MANUAL 1
#define PLAYLIST_TYPE_SAP 2
Clément Stenac's avatar
Clément Stenac committed
120

Sam Hocevar's avatar
 
Sam Hocevar committed
121 122 123
/*****************************************************************************
 * Prototypes
 *****************************************************************************/
124
#define playlist_Create(a) __playlist_Create(VLC_OBJECT(a))
125 126
playlist_t * __playlist_Create   ( vlc_object_t * );
void           playlist_Destroy  ( playlist_t * );
127 128 129 130 131 132 133 134

#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)
135

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
136
VLC_EXPORT( void, playlist_Command, ( playlist_t *, playlist_command_t, int ) );
137

138

139 140 141 142 143 144 145 146
/* 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 */
147
VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int ) );
148 149 150
VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char **,int ) );


151
VLC_EXPORT( int,  playlist_Clear, ( playlist_t * ) );
Sam Hocevar's avatar
Sam Hocevar committed
152
VLC_EXPORT( int,  playlist_Delete, ( playlist_t *, int ) );
Clément Stenac's avatar
Clément Stenac committed
153 154 155 156
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 ) );
157

158
/* Basic item information accessors */
159 160 161 162 163 164 165
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 ) );
166 167 168

/* Item search functions */
VLC_EXPORT( int, playlist_GetPositionById, (playlist_t *, int) );
169 170
VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int) );
VLC_EXPORT( playlist_item_t *, playlist_ItemGetByPos, (playlist_t *, int) );
171 172 173


/* Group management functions */
174 175 176
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 ) );
177
VLC_EXPORT( int, playlist_GroupToId, (playlist_t *, char * ) );
178

179 180
/* Info functions */
VLC_EXPORT( char * , playlist_GetInfo, ( playlist_t * , int, const char *, const char *) );
181
VLC_EXPORT( char * , playlist_ItemGetInfo, ( playlist_item_t * , const char *, const char *) );
182

183
VLC_EXPORT( info_category_t*, playlist_ItemGetCategory, ( playlist_item_t *, const char *) );
184

185
VLC_EXPORT( info_category_t*, playlist_ItemCreateCategory, ( playlist_item_t *, const char *) );
186 187

VLC_EXPORT( int, playlist_AddInfo, (playlist_t *, int, const char * , const char *, const char *, ...) );
188
VLC_EXPORT( int, playlist_ItemAddInfo, (playlist_item_t *, const char * , const char *, const char *, ...) );
189 190

/* Option functions */
191
VLC_EXPORT( int, playlist_ItemAddOption, (playlist_item_t *, const char *) );
192 193

/* Playlist sorting */
194
#define playlist_SortID(p, i) playlist_Sort( p, SORT_ID, i)
Clément Stenac's avatar
Clément Stenac committed
195 196 197 198
#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) );
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
199
VLC_EXPORT( int,  playlist_Move, ( playlist_t *, int, int ) );
200 201

/* Load/Save */
202 203
VLC_EXPORT( int,  playlist_Import, ( playlist_t *, const char * ) );
VLC_EXPORT( int,  playlist_Export, ( playlist_t *, const char *, const char * ) );
204

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
205 206 207 208 209
/**
 *  tell if a playlist is currently playing.
 *  \param p_playlist the playlist to check
 *  \return true if playlist is playing, false otherwise
 */
210 211 212 213 214
static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
{
    vlc_bool_t b_playing;

    vlc_mutex_lock( &p_playlist->object_lock );
Clément Stenac's avatar
Clément Stenac committed
215
    b_playing = p_playlist->i_status == PLAYLIST_RUNNING;
216 217 218 219 220
    vlc_mutex_unlock( &p_playlist->object_lock );

    return( b_playing );
}

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
221 222 223 224 225
/**
 *  tell if a playlist is currently empty
 *  \param p_playlist the playlist to check
 *  \return true if the playlist is empty, false otherwise
 */
226 227 228 229 230 231 232 233 234 235
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 );
}
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
236 237 238 239

/**
 * @}
 */