1 /*****************************************************************************
2 * vlc.h: global header for libvlc (old-style)
3 *****************************************************************************
4 * Copyright (C) 1998-2004 the VideoLAN team
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>
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.
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.
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 *****************************************************************************/
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
43 /*****************************************************************************
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;
50 #if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( __MINGW32__ )
51 typedef signed __int64 vlc_int64_t;
53 typedef signed long long vlc_int64_t;
57 * \defgroup var_type Variable types
58 * These are the different types a vlc variable can have.
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
87 vlc_object_t * p_object;
91 struct { char *psz_name; int i_object_id; } var;
93 /* Make sure the structure is at least 64bits */
94 struct { char a, b, c, d, e, f, g, h; } padding;
104 vlc_value_t * p_values;
109 /*****************************************************************************
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 */
117 #define VLC_ENOMOD -10 /* Module not found */
119 #define VLC_ENOOBJ -20 /* Object not found */
120 #define VLC_EBADOBJ -21 /* Bad object type */
122 #define VLC_ENOVAR -30 /* Variable not found */
123 #define VLC_EBADVAR -31 /* Bad variable value */
125 #define VLC_EEXIT -255 /* Program exited */
126 #define VLC_EEXITSUCCESS -999 /* Program exited successfully */
127 #define VLC_EGENERIC -666 /* Generic error */
129 /*****************************************************************************
131 *****************************************************************************/
135 /*****************************************************************************
137 *****************************************************************************/
139 /* Used by VLC_AddTarget() */
140 #define PLAYLIST_INSERT 0x0001
141 #define PLAYLIST_APPEND 0x0002
142 #define PLAYLIST_GO 0x0004
143 #define PLAYLIST_PREPARSE 0x0008
145 #define PLAYLIST_END -666
147 /*****************************************************************************
148 * Required internal headers
149 *****************************************************************************/
150 #if defined( __VLC__ )
151 # include "vlc_common.h"
154 /*****************************************************************************
155 * Exported libvlc API
156 *****************************************************************************/
157 #if !defined( __VLC__ )
158 /* Otherwise they are declared and exported in vlc_common.h */
160 * Retrieve libvlc version
162 * \return a string containing the libvlc version
164 char const * VLC_Version ( void );
167 * Retrieve libvlc compile time
169 * \return a string containing the libvlc compile time
171 char const * VLC_CompileTime ( void );
174 * Retrieve the username of the libvlc builder
176 * \return a string containing the username of the libvlc builder
178 char const * VLC_CompileBy ( void );
181 * Retrieve the host of the libvlc builder
183 * \return a string containing the host of the libvlc builder
185 char const * VLC_CompileHost ( void );
188 * Retrieve the domain name of the host of the libvlc builder
190 * \return a string containing the domain name of the host of the libvlc builder
192 char const * VLC_CompileDomain ( void );
195 * Retrieve libvlc compiler version
197 * \return a string containing the libvlc compiler version
199 char const * VLC_Compiler ( void );
202 * Retrieve libvlc changeset
204 * \return a string containing the libvlc subversion changeset
206 char const * VLC_Changeset ( void );
209 * Return an error string
211 * \param i_err an error code
212 * \return an error string
214 char const * VLC_Error ( int i_err );
221 * This function allocates a vlc_t structure and returns a negative value
222 * in case of failure. Also, the thread system is initialized
224 * \return vlc object id or an error code
226 int VLC_Create( void );
229 * Initialize a vlc_t structure
231 * This function initializes a previously allocated vlc_t structure:
233 * - gettext initialization
234 * - message queue, module bank and playlist initialization
235 * - configuration and commandline parsing
237 * \param i_object a vlc object id
238 * \param i_argc the number of arguments
239 * \param ppsz_argv an array of arguments
240 * \return VLC_SUCCESS on success
242 int VLC_Init( int, int, char *[] );
247 * This function opens an interface plugin and runs it. If b_block is set
248 * to 0, VLC_AddIntf will return immediately and let the interface run in a
249 * separate thread. If b_block is set to 1, VLC_AddIntf will continue until
250 * user requests to quit.
252 * \param i_object a vlc object id
253 * \param psz_module a vlc module name of an interface
254 * \param b_block make this interface blocking
255 * \param b_play start playing when the interface is done loading
256 * \return VLC_SUCCESS on success
258 int VLC_AddIntf( int, char const *, vlc_bool_t, vlc_bool_t );
263 * This function sets p_vlc->b_die to VLC_TRUE, but does not do any other
264 * task. It is your duty to call VLC_CleanUp and VLC_Destroy afterwards.
266 * \param i_object a vlc object id
267 * \return VLC_SUCCESS on success
272 * Clean up all the intf, playlist, vout and aout
274 * This function requests all intf, playlist, vout and aout objects to finish
275 * and CleanUp. Only a blank VLC object should remain after this.
277 * \note This function was previously called VLC_Stop
279 * \param i_object a vlc object id
280 * \return VLC_SUCCESS on success
282 int VLC_CleanUp( int );
285 * Destroy all threads and the VLC object
287 * This function requests the running threads to finish, waits for their
288 * termination, and destroys their structure.
289 * Then it will de-init all VLC object initializations.
291 * \param i_object a vlc object id
292 * \return VLC_SUCCESS on success
294 int VLC_Destroy( int );
299 * This function sets a variable of VLC
301 * \note Was previously called VLC_Set
303 * \param i_object a vlc object id
304 * \param psz_var a vlc variable name
305 * \param value a vlc_value_t structure
306 * \return VLC_SUCCESS on success
308 int VLC_VariableSet( int, char const *, vlc_value_t );
313 * This function gets the value of a variable of VLC
314 * It stores it in the p_value argument
316 * \note Was previously called VLC_Get
318 * \param i_object a vlc object id
319 * \param psz_var a vlc variable name
320 * \param p_value a pointer to a vlc_value_t structure
321 * \return VLC_SUCCESS on success
323 int VLC_VariableGet( int, char const *, vlc_value_t * );
326 * Get a VLC variable type
328 * This function gets the type of a variable of VLC
329 * It stores it in the p_type argument
331 * \param i_object a vlc object id
332 * \param psz_var a vlc variable name
333 * \param pi_type a pointer to an integer
334 * \return VLC_SUCCESS on success
336 int VLC_VariableType( int, char const *, int * );
339 * Add a target to the current playlist
341 * This funtion will add a target to the current playlist. If a playlist does
342 * not exist, it will be created.
344 * \param i_object a vlc object id
345 * \param psz_target the URI of the target to play
346 * \param ppsz_options an array of strings with input options (ie. :input-repeat)
347 * \param i_options the amount of options in the ppsz_options array
348 * \param i_mode the insert mode to insert the target into the playlist (PLAYLIST_* defines)
349 * \param i_pos the position at which to add the new target (PLAYLIST_END for end)
350 * \return VLC_SUCCESS on success
352 int VLC_AddTarget( int, char const *, const char **, int, int, int );
355 * Start the playlist and play the currently selected playlist item
357 * If there is something in the playlist, and the playlist is not running,
358 * then start the playlist and play the currently selected playlist item.
359 * If an item is currently paused, then resume it.
361 * \param i_object a vlc object id
362 * \return VLC_SUCCESS on success
367 * Pause the currently playing item. Resume it if already paused
369 * If an item is currently playing then pause it.
370 * If the item is already paused, then resume playback.
372 * \param i_object a vlc object id
373 * \return VLC_SUCCESS on success
375 int VLC_Pause( int );
380 * If an item is currently playing then stop it.
381 * Set the playlist to a stopped state.
383 * \note This function is new. The old VLC_Stop is now called VLC_CleanUp
385 * \param i_object a vlc object id
386 * \return VLC_SUCCESS on success
391 * Tell if VLC is playing
393 * If an item is currently playing, it returns
394 * VLC_TRUE, else VLC_FALSE
396 * \param i_object a vlc object id
397 * \return VLC_TRUE or VLC_FALSE
399 vlc_bool_t VLC_IsPlaying( int );
402 * Get the current position in a input
404 * Return the current position as a float
405 * This method should be used for time sliders etc
406 * \note For some inputs, this will be unknown.
408 * \param i_object a vlc object id
409 * \return a float in the range of 0.0 - 1.0
411 float VLC_PositionGet( int );
414 * Set the current position in a input
416 * Set the current position as a float
417 * This method should be used for time sliders etc
418 * \note For some inputs, this will be unknown.
420 * \param i_object a vlc object id
421 * \param i_position a float in the range of 0.0 - 1.0
422 * \return a float in the range of 0.0 - 1.0
424 float VLC_PositionSet( int, float );
427 * Get the current position in a input
429 * Return the current position in seconds from the start.
430 * \note For some inputs, this will be unknown.
432 * \param i_object a vlc object id
433 * \return the offset from 0:00 in seconds
435 int VLC_TimeGet( int );
438 * Seek to a position in the current input
440 * Seek i_seconds in the current input. If b_relative is set,
441 * then the seek will be relative to the current position, otherwise
442 * it will seek to i_seconds from the beginning of the input.
443 * \note For some inputs, this will be unknown.
445 * \param i_object a vlc object id
446 * \param i_seconds seconds from current position or from beginning of input
447 * \param b_relative seek relative from current position
448 * \return VLC_SUCCESS on success
450 int VLC_TimeSet( int, int, vlc_bool_t );
453 * Get the total length of a input
455 * Return the total length in seconds from the current input.
456 * \note For some inputs, this will be unknown.
458 * \param i_object a vlc object id
459 * \return the length in seconds
461 int VLC_LengthGet( int );
464 * Play the input faster than realtime
466 * 2x, 4x, 8x faster than realtime
467 * \note For some inputs, this will be impossible.
469 * \param i_object a vlc object id
470 * \return the current speedrate
472 float VLC_SpeedFaster( int );
475 * Play the input slower than realtime
477 * 1/2x, 1/4x, 1/8x slower than realtime
478 * \note For some inputs, this will be impossible.
480 * \param i_object a vlc object id
481 * \return the current speedrate
483 float VLC_SpeedSlower( int );
486 * Return the current playlist item
488 * \param i_object a vlc object id
489 * \return the index of the playlistitem that is currently selected for play
491 int VLC_PlaylistIndex( int );
494 * Total amount of items in the playlist
496 * \param i_object a vlc object id
497 * \return amount of playlist items
499 int VLC_PlaylistNumberOfItems( int );
504 * Skip to the next playlistitem and play it.
506 * \param i_object a vlc object id
507 * \return VLC_SUCCESS on success
509 int VLC_PlaylistNext( int );
512 * Previous playlist item
514 * Skip to the previous playlistitem and play it.
516 * \param i_object a vlc object id
517 * \return VLC_SUCCESS on success
519 int VLC_PlaylistPrev( int );
522 * Clear the contents of the playlist
524 * Completly empty the entire playlist.
526 * \note Was previously called VLC_ClearPlaylist
528 * \param i_object a vlc object id
529 * \return VLC_SUCCESS on success
531 int VLC_PlaylistClear( int );
536 * \param i_object a vlc object id
537 * \param i_volume something in a range from 0-200
538 * \return the new volume (range 0-200 %)
540 int VLC_VolumeSet( int, int );
543 * Get the current volume
545 * Retrieve the current volume.
547 * \param i_object a vlc object id
548 * \return the current volume (range 0-200 %)
550 int VLC_VolumeGet( int );
553 * Mute/Unmute the volume
555 * \param i_object a vlc object id
556 * \return VLC_SUCCESS on success
558 int VLC_VolumeMute( int );
561 * Toggle Fullscreen mode
563 * Switch between normal and fullscreen video
565 * \param i_object a vlc object id
566 * \return VLC_SUCCESS on success
568 int VLC_FullScreen( int );
575 #define LICENSE_MSG \
576 _("This program comes with NO WARRANTY, to the extent permitted by " \
577 "law.\nYou may redistribute it under the terms of the GNU General " \
578 "Public License;\nsee the file named COPYING for details.\n" \
579 "Written by the VideoLAN team; see the AUTHORS file.\n")
581 #endif /* <vlc/vlc.h> */