Fix doxycomment for VLC_AddTarget. It returns the item id.
[vlc.git] / include / vlc / vlc.h
1 /*****************************************************************************
2  * vlc.h: global header for libvlc (old-style)
3  *****************************************************************************
4  * Copyright (C) 1998-2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
8  *          Samuel Hocevar <sam@zoy.org>
9  *          Gildas Bazin <gbazin@netcourrier.com>
10  *          Derk-Jan Hartman <hartman at videolan dot org>
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 /**
28  * \defgroup libvlc_old Libvlc Old
29  * This is libvlc, the base library of the VLC program.
30  * This is the legacy API. Please consider using the new libvlc API
31  *
32  * @{
33  */
34
35
36 #ifndef _VLC_VLC_H
37 #define _VLC_VLC_H 1
38
39 # ifdef __cplusplus
40 extern "C" {
41 # endif
42
43 /*****************************************************************************
44  * Our custom types
45  *****************************************************************************/
46 typedef int vlc_bool_t;
47 typedef struct vlc_list_t vlc_list_t;
48 typedef struct vlc_object_t vlc_object_t;
49
50 #if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( __MINGW32__ )
51 typedef signed __int64 vlc_int64_t;
52 # else
53 typedef signed long long vlc_int64_t;
54 #endif
55
56 /**
57  * \defgroup var_type Variable types
58  * These are the different types a vlc variable can have.
59  * @{
60  */
61 #define VLC_VAR_VOID      0x0010
62 #define VLC_VAR_BOOL      0x0020
63 #define VLC_VAR_INTEGER   0x0030
64 #define VLC_VAR_HOTKEY    0x0031
65 #define VLC_VAR_STRING    0x0040
66 #define VLC_VAR_MODULE    0x0041
67 #define VLC_VAR_FILE      0x0042
68 #define VLC_VAR_DIRECTORY 0x0043
69 #define VLC_VAR_VARIABLE  0x0044
70 #define VLC_VAR_FLOAT     0x0050
71 #define VLC_VAR_TIME      0x0060
72 #define VLC_VAR_ADDRESS   0x0070
73 #define VLC_VAR_MUTEX     0x0080
74 #define VLC_VAR_LIST      0x0090
75 /**@}*/
76
77 /**
78  * VLC value structure
79  */
80 typedef union
81 {
82     int             i_int;
83     vlc_bool_t      b_bool;
84     float           f_float;
85     char *          psz_string;
86     void *          p_address;
87     vlc_object_t *  p_object;
88     vlc_list_t *    p_list;
89     vlc_int64_t     i_time;
90
91     struct { char *psz_name; int i_object_id; } var;
92
93    /* Make sure the structure is at least 64bits */
94     struct { char a, b, c, d, e, f, g, h; } padding;
95
96 } vlc_value_t;
97
98 /**
99  * VLC list structure
100  */
101 struct vlc_list_t
102 {
103     int             i_count;
104     vlc_value_t *   p_values;
105     int *           pi_types;
106
107 };
108
109 /*****************************************************************************
110  * Error values
111  *****************************************************************************/
112 #define VLC_SUCCESS         -0                                   /* No error */
113 #define VLC_ENOMEM          -1                          /* Not enough memory */
114 #define VLC_ETHREAD         -2                               /* Thread error */
115 #define VLC_ETIMEOUT        -3                                    /* Timeout */
116
117 #define VLC_ENOMOD         -10                           /* Module not found */
118
119 #define VLC_ENOOBJ         -20                           /* Object not found */
120 #define VLC_EBADOBJ        -21                            /* Bad object type */
121
122 #define VLC_ENOVAR         -30                         /* Variable not found */
123 #define VLC_EBADVAR        -31                         /* Bad variable value */
124
125 #define VLC_ENOITEM        -40                           /**< Item not found */
126
127 #define VLC_EEXIT         -255                             /* Program exited */
128 #define VLC_EEXITSUCCESS  -999                /* Program exited successfully */
129 #define VLC_EGENERIC      -666                              /* Generic error */
130
131 /*****************************************************************************
132  * Booleans
133  *****************************************************************************/
134 #define VLC_FALSE 0
135 #define VLC_TRUE  1
136
137 /*****************************************************************************
138  * Playlist
139  *****************************************************************************/
140
141 /* Used by VLC_AddTarget() */
142 #define PLAYLIST_INSERT          0x0001
143 #define PLAYLIST_APPEND          0x0002
144 #define PLAYLIST_GO              0x0004
145 #define PLAYLIST_PREPARSE        0x0008
146 #define PLAYLIST_SPREPARSE       0x0010
147 #define PLAYLIST_NO_REBUILD      0x0020
148
149 #define PLAYLIST_END           -666
150
151 /*****************************************************************************
152  * Required internal headers
153  *****************************************************************************/
154 #if defined( __LIBVLC__ )
155 #   include "vlc_common.h"
156 #endif
157
158 /*****************************************************************************
159  * Shared library Export macros
160  *****************************************************************************/
161 #ifndef VLC_PUBLIC_API
162 #  define VLC_PUBLIC_API extern
163 #endif
164
165 /*****************************************************************************
166  * Exported libvlc API
167  *****************************************************************************/
168 #if !defined( __LIBVLC__ )
169 /* Otherwise they are declared and exported in vlc_common.h */
170 /**
171  * Retrieve libvlc version
172  *
173  * \return a string containing the libvlc version
174  */
175 VLC_PUBLIC_API char const * VLC_Version ( void );
176
177 /**
178  * Retrieve libvlc compile time
179  *
180  * \return a string containing the libvlc compile time
181  */
182 VLC_PUBLIC_API char const * VLC_CompileTime ( void );
183
184 /**
185  * Retrieve the username of the libvlc builder
186  *
187  * \return a string containing the username of the libvlc builder
188  */
189 VLC_PUBLIC_API char const * VLC_CompileBy ( void );
190
191 /**
192  * Retrieve the host of the libvlc builder
193  *
194  * \return a string containing the host of the libvlc builder
195  */
196 VLC_PUBLIC_API char const * VLC_CompileHost ( void );
197
198 /**
199  * Retrieve the domain name of the host of the libvlc builder
200  *
201  * \return a string containing the domain name of the host of the libvlc builder
202  */
203 VLC_PUBLIC_API char const * VLC_CompileDomain ( void );
204
205 /**
206  * Retrieve libvlc compiler version
207  *
208  * \return a string containing the libvlc compiler version
209  */
210 VLC_PUBLIC_API char const * VLC_Compiler ( void );
211
212 /**
213  * Retrieve libvlc changeset
214  *
215  * \return a string containing the libvlc subversion changeset
216  */
217 VLC_PUBLIC_API char const * VLC_Changeset ( void );
218
219 /**
220  * Return an error string
221  *
222  * \param i_err an error code
223  * \return an error string
224  */
225 VLC_PUBLIC_API char const * VLC_Error ( int i_err );
226
227 #endif /* __LIBVLC__ */
228
229 /**
230  * Initialize libvlc
231  *
232  * This function allocates a vlc_t structure and returns a negative value
233  * in case of failure. Also, the thread system is initialized
234  *
235  * \return vlc object id or an error code
236  */
237 VLC_PUBLIC_API int     VLC_Create( void );
238
239 /**
240  * Initialize a vlc_t structure
241  *
242  * This function initializes a previously allocated vlc_t structure:
243  *  - CPU detection
244  *  - gettext initialization
245  *  - message queue, module bank and playlist initialization
246  *  - configuration and commandline parsing
247  *
248  *  \param i_object a vlc object id
249  *  \param i_argc the number of arguments
250  *  \param ppsz_argv an array of arguments
251  *  \return VLC_SUCCESS on success
252  */
253 VLC_PUBLIC_API int     VLC_Init( int, int, char *[] );
254
255 /**
256  * Add an interface
257  *
258  * This function opens an interface plugin and runs it. If b_block is set
259  * to 0, VLC_AddIntf will return immediately and let the interface run in a
260  * separate thread. If b_block is set to 1, VLC_AddIntf will continue until
261  * user requests to quit.
262  *
263  * \param i_object a vlc object id
264  * \param psz_module a vlc module name of an interface
265  * \param b_block make this interface blocking
266  * \param b_play start playing when the interface is done loading
267  * \return VLC_SUCCESS on success
268  */
269 VLC_PUBLIC_API int     VLC_AddIntf( int, char const *, vlc_bool_t, vlc_bool_t );
270
271 /**
272  * Ask vlc to die
273  *
274  * This function sets p_vlc->b_die to VLC_TRUE, but does not do any other
275  * task. It is your duty to call VLC_CleanUp and VLC_Destroy afterwards.
276  *
277  * \param i_object a vlc object id
278  * \return VLC_SUCCESS on success
279  */
280 VLC_PUBLIC_API int     VLC_Die( int );
281
282 /**
283  * Clean up all the intf, playlist, vout and aout
284  *
285  * This function requests all intf, playlist, vout and aout objects to finish
286  * and CleanUp. Only a blank VLC object should remain after this.
287  *
288  * \note This function was previously called VLC_Stop
289  *
290  * \param i_object a vlc object id
291  * \return VLC_SUCCESS on success
292  */
293 VLC_PUBLIC_API int     VLC_CleanUp( int );
294
295 /**
296  * Destroy all threads and the VLC object
297  *
298  * This function requests the running threads to finish, waits for their
299  * termination, and destroys their structure.
300  * Then it will de-init all VLC object initializations.
301  *
302  * \param i_object a vlc object id
303  * \return VLC_SUCCESS on success
304  */
305 VLC_PUBLIC_API int     VLC_Destroy( int );
306
307 /**
308  * Set a VLC variable
309  *
310  * This function sets a variable of VLC
311  *
312  * \note Was previously called VLC_Set
313  *
314  * \param i_object a vlc object id
315  * \param psz_var a vlc variable name
316  * \param value a vlc_value_t structure
317  * \return VLC_SUCCESS on success
318  */
319 VLC_PUBLIC_API int     VLC_VariableSet( int, char const *, vlc_value_t );
320
321 /**
322  * Get a VLC variable
323  *
324  * This function gets the value of a variable of VLC
325  * It stores it in the p_value argument
326  *
327  * \note Was previously called VLC_Get
328  *
329  * \param i_object a vlc object id
330  * \param psz_var a vlc variable name
331  * \param p_value a pointer to a vlc_value_t structure
332  * \return VLC_SUCCESS on success
333  */
334 VLC_PUBLIC_API int     VLC_VariableGet( int, char const *, vlc_value_t * );
335
336 /**
337  * Get a VLC variable type
338  *
339  * This function gets the type of a variable of VLC
340  * It stores it in the p_type argument
341  *
342  * \param i_object a vlc object id
343  * \param psz_var a vlc variable name
344  * \param pi_type a pointer to an integer
345  * \return VLC_SUCCESS on success
346  */
347 VLC_PUBLIC_API int     VLC_VariableType( int, char const *, int * );
348
349 /**
350  * Add a target to the current playlist
351  *
352  * This funtion will add a target to the current playlist. If a playlist does
353  * not exist, it will be created.
354  *
355  * \param i_object a vlc object id
356  * \param psz_target the URI of the target to play
357  * \param ppsz_options an array of strings with input options (ie. :input-repeat)
358  * \param i_options the amount of options in the ppsz_options array
359  * \param i_mode the insert mode to insert the target into the playlist (PLAYLIST_* defines)
360  * \param i_pos the position at which to add the new target (PLAYLIST_END for end)
361  * \return the item id on success and -1 on error
362  */
363 VLC_PUBLIC_API int     VLC_AddTarget( int, char const *, const char **, int, int, int );
364
365 /**
366  * Start the playlist and play the currently selected playlist item
367  *
368  * If there is something in the playlist, and the playlist is not running,
369  * then start the playlist and play the currently selected playlist item.
370  * If an item is currently paused, then resume it.
371  *
372  * \param i_object a vlc object id
373  * \return VLC_SUCCESS on success
374  */
375 VLC_PUBLIC_API int     VLC_Play( int );
376
377 /**
378  * Pause the currently playing item. Resume it if already paused
379  *
380  * If an item is currently playing then pause it.
381  * If the item is already paused, then resume playback.
382  *
383  * \param i_object a vlc object id
384  * \return VLC_SUCCESS on success
385  */
386 VLC_PUBLIC_API int     VLC_Pause( int );
387
388 /**
389  * Stop the playlist
390  *
391  * If an item is currently playing then stop it.
392  * Set the playlist to a stopped state.
393  *
394  * \note This function is new. The old VLC_Stop is now called VLC_CleanUp
395  *
396  * \param i_object a vlc object id
397  * \return VLC_SUCCESS on success
398  */
399 VLC_PUBLIC_API int             VLC_Stop( int );
400
401 /**
402  * Tell if VLC is playing
403  *
404  * If an item is currently playing, it returns
405  * VLC_TRUE, else VLC_FALSE
406  *
407  * \param i_object a vlc object id
408  * \return VLC_TRUE or VLC_FALSE
409  */
410 VLC_PUBLIC_API vlc_bool_t      VLC_IsPlaying( int );
411
412 /**
413  * Get the current position in a input
414  *
415  * Return the current position as a float
416  * This method should be used for time sliders etc
417  * \note For some inputs, this will be unknown.
418  *
419  * \param i_object a vlc object id
420  * \return a float in the range of 0.0 - 1.0
421  */
422 VLC_PUBLIC_API float           VLC_PositionGet( int );
423
424 /**
425  * Set the current position in a input
426  *
427  * Set the current position as a float
428  * This method should be used for time sliders etc
429  * \note For some inputs, this will be unknown.
430  *
431  * \param i_object a vlc object id
432  * \param i_position a float in the range of 0.0 - 1.0
433  * \return a float in the range of 0.0 - 1.0
434  */
435 VLC_PUBLIC_API float           VLC_PositionSet( int, float );
436
437 /**
438  * Get the current position in a input
439  *
440  * Return the current position in seconds from the start.
441  * \note For some inputs, this will be unknown.
442  *
443  * \param i_object a vlc object id
444  * \return the offset from 0:00 in seconds
445  */
446 VLC_PUBLIC_API int             VLC_TimeGet( int );
447
448 /**
449  * Seek to a position in the current input
450  *
451  * Seek i_seconds in the current input. If b_relative is set,
452  * then the seek will be relative to the current position, otherwise
453  * it will seek to i_seconds from the beginning of the input.
454  * \note For some inputs, this will be unknown.
455  *
456  * \param i_object a vlc object id
457  * \param i_seconds seconds from current position or from beginning of input
458  * \param b_relative seek relative from current position
459  * \return VLC_SUCCESS on success
460  */
461 VLC_PUBLIC_API int             VLC_TimeSet( int, int, vlc_bool_t );
462
463 /**
464  * Get the total length of a input
465  *
466  * Return the total length in seconds from the current input.
467  * \note For some inputs, this will be unknown.
468  *
469  * \param i_object a vlc object id
470  * \return the length in seconds
471  */
472 VLC_PUBLIC_API int             VLC_LengthGet( int );
473
474 /**
475  * Play the input faster than realtime
476  *
477  * 2x, 4x, 8x faster than realtime
478  * \note For some inputs, this will be impossible.
479  *
480  * \param i_object a vlc object id
481  * \return the current speedrate
482  */
483 VLC_PUBLIC_API float           VLC_SpeedFaster( int );
484
485 /**
486  * Play the input slower than realtime
487  *
488  * 1/2x, 1/4x, 1/8x slower than realtime
489  * \note For some inputs, this will be impossible.
490  *
491  * \param i_object a vlc object id
492  * \return the current speedrate
493  */
494 VLC_PUBLIC_API float           VLC_SpeedSlower( int );
495
496 /**
497  * Return the current playlist item
498  *
499  * \param i_object a vlc object id
500  * \return the index of the playlistitem that is currently selected for play
501  */
502 VLC_PUBLIC_API int             VLC_PlaylistIndex( int );
503
504 /**
505  * Total amount of items in the playlist
506  *
507  * \param i_object a vlc object id
508  * \return amount of playlist items
509  */
510 VLC_PUBLIC_API int             VLC_PlaylistNumberOfItems( int );
511
512 /**
513  * Next playlist item
514  *
515  * Skip to the next playlistitem and play it.
516  *
517  * \param i_object a vlc object id
518  * \return VLC_SUCCESS on success
519  */
520 VLC_PUBLIC_API int             VLC_PlaylistNext( int );
521
522 /**
523  * Previous playlist item
524  *
525  * Skip to the previous playlistitem and play it.
526  *
527  * \param i_object a vlc object id
528  * \return VLC_SUCCESS on success
529  */
530 VLC_PUBLIC_API int             VLC_PlaylistPrev( int );
531
532 /**
533  * Clear the contents of the playlist
534  *
535  * Completly empty the entire playlist.
536  *
537  * \note Was previously called VLC_ClearPlaylist
538  *
539  * \param i_object a vlc object id
540  * \return VLC_SUCCESS on success
541  */
542 VLC_PUBLIC_API int             VLC_PlaylistClear( int );
543
544 /**
545  * Change the volume
546  *
547  * \param i_object a vlc object id
548  * \param i_volume something in a range from 0-200
549  * \return the new volume (range 0-200 %)
550  */
551 VLC_PUBLIC_API int             VLC_VolumeSet( int, int );
552
553 /**
554  * Get the current volume
555  *
556  * Retrieve the current volume.
557  *
558  * \param i_object a vlc object id
559  * \return the current volume (range 0-200 %)
560  */
561 VLC_PUBLIC_API int             VLC_VolumeGet( int );
562
563 /**
564  * Mute/Unmute the volume
565  *
566  * \param i_object a vlc object id
567  * \return VLC_SUCCESS on success
568  */
569 VLC_PUBLIC_API int            VLC_VolumeMute( int );
570
571 /**
572  * Toggle Fullscreen mode
573  *
574  * Switch between normal and fullscreen video
575  *
576  * \param i_object a vlc object id
577  * \return VLC_SUCCESS on success
578  */
579 VLC_PUBLIC_API int             VLC_FullScreen( int );
580
581
582 # ifdef __cplusplus
583 }
584 # endif
585
586 #define LICENSE_MSG \
587   _("This program comes with NO WARRANTY, to the extent permitted by " \
588     "law.\nYou may redistribute it under the terms of the GNU General " \
589     "Public License;\nsee the file named COPYING for details.\n" \
590     "Written by the VideoLAN team; see the AUTHORS file.\n")
591
592 #endif /* <vlc/vlc.h> */