vlc_playlist.h 4.4 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
zorglub's avatar
 
zorglub committed
5
 * $Id: vlc_playlist.h,v 1.10 2003/06/27 10:31:02 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 13 14 15 16 17 18 19 20 21 22 23
 *
 * 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.
 * 
 * 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.
 *****************************************************************************/

Sam Hocevar's avatar
 
Sam Hocevar committed
24 25 26
/*****************************************************************************
 * playlist_item_t: playlist item
 *****************************************************************************/
27
struct playlist_item_t
Sam Hocevar's avatar
 
Sam Hocevar committed
28
{
gbazin's avatar
 
gbazin committed
29
    char *     psz_name;
30
    char *     psz_uri; 
gbazin's avatar
 
gbazin committed
31 32 33
    int        i_type;   /* unused yet */
    int        i_status; /* unused yet */
    vlc_bool_t b_autodeletion;
34
};
Sam Hocevar's avatar
 
Sam Hocevar committed
35

Sam Hocevar's avatar
 
Sam Hocevar committed
36 37 38 39 40 41 42
/*****************************************************************************
 * 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.
 *****************************************************************************/
43
struct playlist_t
Sam Hocevar's avatar
 
Sam Hocevar committed
44
{
45 46
    VLC_COMMON_MEMBERS

Sam Hocevar's avatar
 
Sam Hocevar committed
47
    int                   i_index;                          /* current index */
48
    int                   i_status;
Sam Hocevar's avatar
 
Sam Hocevar committed
49 50
    int                   i_size;                              /* total size */

51
    playlist_item_t **    pp_items;
Sam Hocevar's avatar
 
Sam Hocevar committed
52

53 54
    input_thread_t *      p_input;
};
Sam Hocevar's avatar
 
Sam Hocevar committed
55

56 57 58 59 60 61 62
/*****************************************************************************
 * Playlist status
 *****************************************************************************/
#define PLAYLIST_STOPPED 0
#define PLAYLIST_RUNNING 1
#define PLAYLIST_PAUSED  2

Sam Hocevar's avatar
 
Sam Hocevar committed
63 64 65
/*****************************************************************************
 * Prototypes
 *****************************************************************************/
66
#define playlist_Create(a) __playlist_Create(VLC_OBJECT(a))
67 68
playlist_t * __playlist_Create   ( vlc_object_t * );
void           playlist_Destroy  ( playlist_t * );
69 70 71 72 73 74 75 76

#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)
77
VLC_EXPORT( void, playlist_Command, ( playlist_t *, int, int ) );
78

79
VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, int, int ) );
zorglub's avatar
 
zorglub committed
80
VLC_EXPORT( int,  playlist_AddName, (playlist_t *,const char *,const char *, int,int ) );
81
VLC_EXPORT( int,  playlist_AddItem, ( playlist_t *, playlist_item_t *, int, int ) );
Sam Hocevar's avatar
Sam Hocevar committed
82
VLC_EXPORT( int,  playlist_Delete, ( playlist_t *, int ) );
hartman's avatar
hartman committed
83
VLC_EXPORT( int,  playlist_Move, ( playlist_t *, int, int ) );
84 85
VLC_EXPORT( int,  playlist_LoadFile, ( playlist_t *, const char * ) );
VLC_EXPORT( int,  playlist_SaveFile, ( playlist_t *, const char * ) );
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107

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 );
}

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 );
}