vlc_playlist.h 6.69 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, 2000, 2001, 2002 VideoLAN
5
 * $Id: vlc_playlist.h,v 1.16 2003/11/12 08:10:21 zorglub Exp $
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 36 37 38 39
/**
 *  \file
 *  This file contain structures and function prototypes related
 *  to the playlist in vlc
 */

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

/**
 * playlist item
 * \see playlist_t
 */
40
struct playlist_item_t
Sam Hocevar's avatar
 
Sam Hocevar committed
41
{
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
42 43 44 45 46 47 48 49 50
    char *     psz_name;       /**< text describing this item */
    char *     psz_uri;        /**< mrl of this item */
    mtime_t    i_duration;     /**< A hint about the duration of this
                                * item, in miliseconds*/
    char **    ppsz_options;   /**< options passed with the :foo=bar syntax */
    int        i_options;      /**< number of items in the
                                * ppsz_options array */
    int        i_type;         /**< unused yet */
    int        i_status;       /**< unused yet */
Clément Stenac's avatar
Clément Stenac committed
51
    vlc_bool_t b_autodeletion; /**< Indicates whther this item is to
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
52 53 54
                                * 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
55 56 57 58 59
    vlc_bool_t b_enabled;      /**< Indicates whether this item is to be
                                * played or skipped */

    int        i_group;         /**< unused yet */
    char *     psz_author;     /**< Author */
60
};
Sam Hocevar's avatar
 
Sam Hocevar committed
61

62 63 64 65 66 67
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
68 69 70 71 72 73 74 75
/**
 * Playlist status
 */
typedef enum { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;

/**
 * Structure containing information about the playlist
 */
76
struct playlist_t
Sam Hocevar's avatar
 
Sam Hocevar committed
77
{
78
    VLC_COMMON_MEMBERS
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
79 80 81 82 83 84 85 86
/**
   \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
87
    int                   i_enabled; /**< How many items are enabled ? */
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
88 89
    playlist_item_t **    pp_items; /**< array of pointers to the
                                     * playlist items */
90 91 92 93
    int                   i_groups; /**< How many groups are in the playlist */
    playlist_group_t **   pp_groups;/**< array of pointers to the playlist
                                     * groups */
    int                   i_max_id; /**< Maximal group id given */
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
94 95 96
    input_thread_t *      p_input;  /**< the input thread ascosiated
                                     * with the current item */
    /*@}*/
97
};
Sam Hocevar's avatar
 
Sam Hocevar committed
98

Clément Stenac's avatar
Clément Stenac committed
99 100 101
#define SORT_NORMAL 0
#define SORT_REVERSE 1

102 103
#define PLAYLIST_TYPE_MANUAL 1
#define PLAYLIST_TYPE_SAP 2
Clément Stenac's avatar
Clément Stenac committed
104

Sam Hocevar's avatar
 
Sam Hocevar committed
105 106 107
/*****************************************************************************
 * Prototypes
 *****************************************************************************/
108
#define playlist_Create(a) __playlist_Create(VLC_OBJECT(a))
109 110
playlist_t * __playlist_Create   ( vlc_object_t * );
void           playlist_Destroy  ( playlist_t * );
111 112 113 114 115 116 117 118

#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)
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
119
VLC_EXPORT( void, playlist_Command, ( playlist_t *, playlist_command_t, int ) );
120

Gildas Bazin's avatar
 
Gildas Bazin committed
121
VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char **, int, int, int ) );
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
122
VLC_EXPORT( int,  playlist_AddExt,    ( playlist_t *, const char *, const char *, mtime_t, const char **, int, int, int ) );
123
VLC_EXPORT( int,  playlist_AddItem, ( playlist_t *, playlist_item_t *, int, int ) );
Sam Hocevar's avatar
Sam Hocevar committed
124
VLC_EXPORT( int,  playlist_Delete, ( playlist_t *, int ) );
Clément Stenac's avatar
Clément Stenac committed
125 126 127 128
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 ) );
129 130 131 132

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 ) );
133
VLC_EXPORT( int, playlist_GroupToId, (playlist_t *, char * ) );
134 135 136 137 138

VLC_EXPORT( int,  playlist_SortTitle, ( playlist_t *, int) );
VLC_EXPORT( int,  playlist_SortAuthor, ( playlist_t *, int) );
VLC_EXPORT( int,  playlist_SortGroup, ( playlist_t *, int) );

Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
139
VLC_EXPORT( int,  playlist_Move, ( playlist_t *, int, int ) );
140 141
VLC_EXPORT( int,  playlist_LoadFile, ( playlist_t *, const char * ) );
VLC_EXPORT( int,  playlist_SaveFile, ( playlist_t *, const char * ) );
142

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
143 144 145 146 147
/**
 *  tell if a playlist is currently playing.
 *  \param p_playlist the playlist to check
 *  \return true if playlist is playing, false otherwise
 */
148 149 150 151 152 153 154 155 156 157 158
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; 
    vlc_mutex_unlock( &p_playlist->object_lock );

    return( b_playing );
}

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
159 160 161 162 163
/**
 *  tell if a playlist is currently empty
 *  \param p_playlist the playlist to check
 *  \return true if the playlist is empty, false otherwise
 */
164 165 166 167 168 169 170 171 172 173
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
174 175 176 177

/**
 * @}
 */