1 /*****************************************************************************
2 * vlc.h: global header for vlc
3 *****************************************************************************
4 * Copyright (C) 1998, 1999, 2000 VideoLAN
5 * $Id: vlc.h,v 1.6 2002/07/20 18:01:42 sam Exp $
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
20 *****************************************************************************/
29 /*****************************************************************************
31 *****************************************************************************/
32 #define VLC_DECLARE_STRUCT( name ) struct name; typedef struct name name;
34 VLC_DECLARE_STRUCT(vlc_t)
35 VLC_DECLARE_STRUCT(vlc_object_t)
37 typedef signed int vlc_error_t;
38 typedef int vlc_bool_t;
39 typedef int vlc_status_t;
41 /*****************************************************************************
43 *****************************************************************************/
44 #define VLC_SUCCESS -0 /* No error */
45 #define VLC_EGENERIC -1 /* Generic error */
46 #define VLC_ENOMEM -2 /* Not enough memory */
47 #define VLC_ESTATUS -3 /* Invalid status */
48 #define VLC_EEXIT -255 /* Program exited */
50 /*****************************************************************************
52 *****************************************************************************/
56 /*****************************************************************************
57 * Main structure status
58 *****************************************************************************/
59 #define VLC_STATUS_NONE 0x00000000
60 #define VLC_STATUS_CREATED 0x02020202
61 #define VLC_STATUS_STOPPED 0x12121212
62 #define VLC_STATUS_RUNNING 0x42424242
64 /*****************************************************************************
66 *****************************************************************************/
68 /* Used by playlist_Add */
69 #define PLAYLIST_INSERT 0x0001
70 #define PLAYLIST_REPLACE 0x0002
71 #define PLAYLIST_APPEND 0x0004
72 #define PLAYLIST_GO 0x0008
74 #define PLAYLIST_END -666
76 /* Playlist parsing mode */
77 #define PLAYLIST_REPEAT_CURRENT 0 /* Keep playing current item */
78 #define PLAYLIST_FORWARD 1 /* Parse playlist until end */
79 #define PLAYLIST_BACKWARD -1 /* Parse backwards */
80 #define PLAYLIST_FORWARD_LOOP 2 /* Parse playlist and loop */
81 #define PLAYLIST_BACKWARD_LOOP -2 /* Parse backwards and loop */
82 #define PLAYLIST_RANDOM 3 /* Shuffle play */
83 #define PLAYLIST_REVERSE_RANDOM -3 /* Reverse shuffle play */
85 /* Playlist commands */
86 #define PLAYLIST_PLAY 1 /* Starts playing. No arg. */
87 #define PLAYLIST_PAUSE 2 /* Toggles playlist pause. No arg. */
88 #define PLAYLIST_STOP 3 /* Stops playing. No arg. */
89 #define PLAYLIST_SKIP 4 /* Skip X items and play. */
90 #define PLAYLIST_GOTO 5 /* Goto Xth item. */
91 #define PLAYLIST_MODE 6 /* Set playlist mode. ??? */
93 /*****************************************************************************
94 * Required internal headers
95 *****************************************************************************/
96 #if defined( __VLC__ )
99 # include "modules_inner.h"
100 # include "vlc_common.h"
101 # include "os_specific.h"
102 # include "vlc_messages.h"
104 # include "modules.h"
106 # include "configuration.h"
107 # include "vlc_objects.h"
110 /*****************************************************************************
111 * Exported libvlc API
112 *****************************************************************************/
113 vlc_status_t vlc_status ( void );
115 vlc_error_t vlc_create ( void );
116 vlc_error_t vlc_init ( int, char *[] );
117 vlc_error_t vlc_run ( void );
118 vlc_error_t vlc_stop ( void );
119 vlc_error_t vlc_end ( void );
120 vlc_error_t vlc_destroy ( void );
122 vlc_error_t vlc_add_intf ( const char *, vlc_bool_t );
123 vlc_error_t vlc_add_target ( const char *, int, int );
125 /*****************************************************************************
126 * Exported libvlc reentrant API
127 *****************************************************************************/
128 vlc_status_t vlc_status_r ( vlc_t * );
130 vlc_t * vlc_create_r ( void );
131 vlc_error_t vlc_init_r ( vlc_t *, int, char *[] );
132 vlc_error_t vlc_run_r ( vlc_t * );
133 vlc_error_t vlc_stop_r ( vlc_t * );
134 vlc_error_t vlc_end_r ( vlc_t * );
135 vlc_error_t vlc_destroy_r ( vlc_t * );
137 vlc_error_t vlc_add_intf_r ( vlc_t *, const char *, vlc_bool_t );
138 vlc_error_t vlc_add_target_r ( vlc_t *, const char *, int, int );
144 #endif /* <vlc/vlc.h> */