include/vlc/vlc.h:
[vlc.git] / include / vlc / vlc.h
1 /*****************************************************************************
2  * vlc.h: global header for vlc
3  *****************************************************************************
4  * Copyright (C) 1998, 1999, 2000 VideoLAN
5  * $Id: vlc.h,v 1.25 2003/08/14 13:09:42 sigmunau Exp $
6  *
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.
11  *
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.
16  *
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  *****************************************************************************/
21
22 #ifndef _VLC_VLC_H
23 #define _VLC_VLC_H 1
24
25 # ifdef __cplusplus
26 extern "C" {
27 # endif
28
29 /*****************************************************************************
30  * Our custom types
31  *****************************************************************************/
32 typedef int vlc_bool_t;
33 typedef struct vlc_list_t vlc_list_t;
34 typedef struct vlc_object_t vlc_object_t;
35
36 typedef union
37 {
38     int             i_int;
39     vlc_bool_t      b_bool;
40     float           f_float;
41     char *          psz_string;
42     void *          p_address;
43     vlc_object_t *  p_object;
44     vlc_list_t *    p_list;
45
46     struct { int i_low, i_high; } time;
47     struct { char *psz_name; int i_object_id; } var;
48
49    /* Make sure the structure is at least 64bits */
50     struct { char a, b, c, d, e, f, g, h; } padding;
51
52 } vlc_value_t;
53
54 struct vlc_list_t
55 {
56     int             i_count;
57     vlc_value_t *   p_values;
58     int *           pi_types;
59
60 };
61
62 /*****************************************************************************
63  * Error values
64  *****************************************************************************/
65 #define VLC_SUCCESS         -0                                   /* No error */
66 #define VLC_ENOMEM          -1                          /* Not enough memory */
67 #define VLC_ETHREAD         -2                               /* Thread error */
68 #define VLC_ETIMEOUT        -3                                    /* Timeout */
69
70 #define VLC_ENOMOD         -10                           /* Module not found */
71
72 #define VLC_ENOOBJ         -20                           /* Object not found */
73 #define VLC_EBADOBJ        -21                            /* Bad object type */
74
75 #define VLC_ENOVAR         -30                         /* Variable not found */
76 #define VLC_EBADVAR        -31                         /* Bad variable value */
77
78 #define VLC_EEXIT         -255                             /* Program exited */
79 #define VLC_EGENERIC      -666                              /* Generic error */
80
81 /*****************************************************************************
82  * Booleans
83  *****************************************************************************/
84 #define VLC_FALSE 0
85 #define VLC_TRUE  1
86
87 /*****************************************************************************
88  * Playlist
89  *****************************************************************************/
90
91 /* Used by playlist_Add */
92 #define PLAYLIST_INSERT          0x0001
93 #define PLAYLIST_REPLACE         0x0002
94 #define PLAYLIST_APPEND          0x0004
95 #define PLAYLIST_GO              0x0008
96 #define PLAYLIST_CHECK_INSERT    0x0010
97
98 #define PLAYLIST_END           -666
99
100 /* Playlist parsing mode */
101 #define PLAYLIST_REPEAT_CURRENT   0             /* Keep playing current item */
102 #define PLAYLIST_FORWARD          1              /* Parse playlist until end */
103 #define PLAYLIST_BACKWARD        -1                       /* Parse backwards */
104 #define PLAYLIST_FORWARD_LOOP     2               /* Parse playlist and loop */
105 #define PLAYLIST_BACKWARD_LOOP   -2              /* Parse backwards and loop */
106 #define PLAYLIST_RANDOM           3                          /* Shuffle play */
107 #define PLAYLIST_REVERSE_RANDOM  -3                  /* Reverse shuffle play */
108
109 /** Playlist commands */
110 typedef enum {
111     PLAYLIST_PLAY,                              /**< Starts playing. No arg. */
112     PLAYLIST_PAUSE,                     /**< Toggles playlist pause. No arg. */
113     PLAYLIST_STOP,                               /**< Stops playing. No arg. */
114     PLAYLIST_SKIP,                               /**< Skip X items and play. */
115     PLAYLIST_GOTO,                                       /**< Goto Xth item. */
116     PLAYLIST_MODE                                /**< Set playlist mode. ??? */
117 } playlist_command_t;
118
119 /*****************************************************************************
120  * Required internal headers
121  *****************************************************************************/
122 #if defined( __VLC__ )
123 #   include "vlc_common.h"
124 #endif
125
126 /*****************************************************************************
127  * Exported libvlc API
128  *****************************************************************************/
129 char const * VLC_Version ( void );
130 char const * VLC_Error   ( int );
131
132 int     VLC_Create       ( void );
133 int     VLC_Init         ( int, int, char *[] );
134 int     VLC_Die          ( int );
135 int     VLC_Destroy      ( int );
136
137 int     VLC_Set          ( int, char const *, vlc_value_t );
138 int     VLC_Get          ( int, char const *, vlc_value_t * );
139 int     VLC_AddIntf      ( int, char const *, vlc_bool_t );
140 int     VLC_AddTarget    ( int, char const *, const char **, int, int, int );
141
142 int     VLC_Play         ( int );
143 int     VLC_Pause        ( int );
144 int     VLC_Stop         ( int );
145 int     VLC_FullScreen   ( int );
146
147 # ifdef __cplusplus
148 }
149 # endif
150
151 #endif /* <vlc/vlc.h> */