adff93cac62c0e5d1b12649c3e4ed73786caeef4
[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.19 2002/12/13 01:56:29 gbazin 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
45     /* Make sure the structure is at least 64bits */
46     struct { char a, b, c, d, e, f, g, h; } padding;
47
48 } vlc_value_t;
49
50 struct vlc_list_t
51 {
52     int             i_count;
53     vlc_value_t *   p_values;
54
55 };
56
57 /*****************************************************************************
58  * Error values
59  *****************************************************************************/
60 #define VLC_SUCCESS         -0                                   /* No error */
61 #define VLC_ENOMEM          -1                          /* Not enough memory */
62 #define VLC_ETHREAD         -2                               /* Thread error */
63 #define VLC_ETIMEOUT        -3                                    /* Timeout */
64
65 #define VLC_ENOMOD         -10                           /* Module not found */
66
67 #define VLC_ENOOBJ         -20                           /* Object not found */
68 #define VLC_EBADOBJ        -21                            /* Bad object type */
69
70 #define VLC_ENOVAR         -30                         /* Variable not found */
71 #define VLC_EBADVAR        -31                         /* Bad variable value */
72
73 #define VLC_EEXIT         -255                             /* Program exited */
74 #define VLC_EGENERIC      -666                              /* Generic error */
75
76 /*****************************************************************************
77  * Booleans
78  *****************************************************************************/
79 #define VLC_FALSE 0
80 #define VLC_TRUE  1
81
82 /*****************************************************************************
83  * Playlist
84  *****************************************************************************/
85
86 /* Used by playlist_Add */
87 #define PLAYLIST_INSERT          0x0001
88 #define PLAYLIST_REPLACE         0x0002
89 #define PLAYLIST_APPEND          0x0004
90 #define PLAYLIST_GO              0x0008
91 #define PLAYLIST_CHECK_INSERT    0x0010
92
93 #define PLAYLIST_END           -666
94
95 /* Playlist parsing mode */
96 #define PLAYLIST_REPEAT_CURRENT   0             /* Keep playing current item */
97 #define PLAYLIST_FORWARD          1              /* Parse playlist until end */
98 #define PLAYLIST_BACKWARD        -1                       /* Parse backwards */
99 #define PLAYLIST_FORWARD_LOOP     2               /* Parse playlist and loop */
100 #define PLAYLIST_BACKWARD_LOOP   -2              /* Parse backwards and loop */
101 #define PLAYLIST_RANDOM           3                          /* Shuffle play */
102 #define PLAYLIST_REVERSE_RANDOM  -3                  /* Reverse shuffle play */
103
104 /* Playlist commands */
105 #define PLAYLIST_PLAY   1                         /* Starts playing. No arg. */
106 #define PLAYLIST_PAUSE  2                 /* Toggles playlist pause. No arg. */
107 #define PLAYLIST_STOP   3                          /* Stops playing. No arg. */
108 #define PLAYLIST_SKIP   4                          /* Skip X items and play. */
109 #define PLAYLIST_GOTO   5                                  /* Goto Xth item. */
110 #define PLAYLIST_MODE   6                          /* Set playlist mode. ??? */
111
112 /*****************************************************************************
113  * Required internal headers
114  *****************************************************************************/
115 #if defined( __VLC__ )
116 #   include "vlc_common.h"
117 #endif
118
119 /*****************************************************************************
120  * Exported libvlc API
121  *****************************************************************************/
122 char const * VLC_Version ( void );
123 char const * VLC_Error   ( int );
124
125 int     VLC_Create       ( void );
126 int     VLC_Init         ( int, int, char *[] );
127 int     VLC_Die          ( int );
128 int     VLC_Destroy      ( int );
129
130 int     VLC_Set          ( int, char const *, vlc_value_t );
131 int     VLC_Get          ( int, char const *, vlc_value_t * );
132 int     VLC_AddIntf      ( int, char const *, vlc_bool_t );
133 int     VLC_AddTarget    ( int, char const *, int, int );
134
135 int     VLC_Play         ( int );
136 int     VLC_Pause        ( int );
137 int     VLC_Stop         ( int );
138 int     VLC_FullScreen   ( int );
139
140 # ifdef __cplusplus
141 }
142 # endif
143
144 #endif /* <vlc/vlc.h> */