vlc.h

/*****************************************************************************
 * vlc.h: global header for vlc
 *****************************************************************************
 * Copyright (C) 1998-2004 the VideoLAN team
 * $Id: vlc.h 12455 2005-09-03 09:16:11Z gbazin $
 *
 * Authors: Vincent Seguin <[email protected]>
 *          Samuel Hocevar <[email protected]>
 *          Gildas Bazin <[email protected]>
 *          Derk-Jan Hartman <hartman at videolan dot org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

#ifndef _VLC_VLC_H
#define _VLC_VLC_H 1

# ifdef __cplusplus
extern "C" {
# endif

/*****************************************************************************
 * Our custom types
 *****************************************************************************/
typedef int vlc_bool_t;
typedef struct vlc_list_t vlc_list_t;
typedef struct vlc_object_t vlc_object_t;

#if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( __MINGW32__ )
typedef signed __int64 vlc_int64_t;
# else
typedef signed long long vlc_int64_t;
#endif

#define VLC_VAR_VOID      0x0010
#define VLC_VAR_BOOL      0x0020
#define VLC_VAR_INTEGER   0x0030
#define VLC_VAR_HOTKEY    0x0031
#define VLC_VAR_STRING    0x0040
#define VLC_VAR_MODULE    0x0041
#define VLC_VAR_FILE      0x0042
#define VLC_VAR_DIRECTORY 0x0043
#define VLC_VAR_VARIABLE  0x0044
#define VLC_VAR_FLOAT     0x0050
#define VLC_VAR_TIME      0x0060
#define VLC_VAR_ADDRESS   0x0070
#define VLC_VAR_MUTEX     0x0080
#define VLC_VAR_LIST      0x0090

typedef union
{
    int             i_int;
    vlc_bool_t      b_bool;
    float           f_float;
    char *          psz_string;
    void *          p_address;
    vlc_object_t *  p_object;
    vlc_list_t *    p_list;
    vlc_int64_t     i_time;

    struct { char *psz_name; int i_object_id; } var;

   /* Make sure the structure is at least 64bits */
    struct { char a, b, c, d, e, f, g, h; } padding;

} vlc_value_t;

struct vlc_list_t
{
    int             i_count;
    vlc_value_t *   p_values;
    int *           pi_types;

};

/*****************************************************************************
 * Error values
 *****************************************************************************/
#define VLC_SUCCESS         -0                                   /* No error */
#define VLC_ENOMEM          -1                          /* Not enough memory */
#define VLC_ETHREAD         -2                               /* Thread error */
#define VLC_ETIMEOUT        -3                                    /* Timeout */

#define VLC_ENOMOD         -10                           /* Module not found */

#define VLC_ENOOBJ         -20                           /* Object not found */
#define VLC_EBADOBJ        -21                            /* Bad object type */

#define VLC_ENOVAR         -30                         /* Variable not found */
#define VLC_EBADVAR        -31                         /* Bad variable value */

#define VLC_EEXIT         -255                             /* Program exited */
#define VLC_EGENERIC      -666                              /* Generic error */

/*****************************************************************************
 * Booleans
 *****************************************************************************/
#define VLC_FALSE 0
#define VLC_TRUE  1

/*****************************************************************************
 * Playlist
 *****************************************************************************/

/* Used by VLC_AddTarget() */
#define PLAYLIST_INSERT          0x0001
#define PLAYLIST_REPLACE         0x0002
#define PLAYLIST_APPEND          0x0004
#define PLAYLIST_GO              0x0008
#define PLAYLIST_CHECK_INSERT    0x0010

#define PLAYLIST_END           -666

/*****************************************************************************
 * Required internal headers
 *****************************************************************************/
#if defined( __VLC__ )
#   include "vlc_common.h"
#endif

/*****************************************************************************
 * Exported libvlc API
 *****************************************************************************/
#if !defined( __VLC__ )
/* Otherwise they are declared and exported in vlc_common.h */
char const * VLC_Version ( void );

char const * VLC_CompileTime ( void );

char const * VLC_CompileBy ( void );

char const * VLC_CompileHost ( void );

char const * VLC_CompileDomain ( void );

char const * VLC_Compiler ( void );

char const * VLC_Changeset ( void );

char const * VLC_Error ( int i_err );

#endif /* __VLC__ */

int     VLC_Create( void );

int     VLC_Init( int, int, char *[] );

int     VLC_AddIntf( int, char const *, vlc_bool_t, vlc_bool_t );

int     VLC_Die( int );

int     VLC_CleanUp( int );

int     VLC_Destroy( int );

int     VLC_VariableSet( int, char const *, vlc_value_t );

int     VLC_VariableGet( int, char const *, vlc_value_t * );

int     VLC_VariableType( int, char const *, int * );

int     VLC_AddTarget( int, char const *, const char **, int, int, int );

int     VLC_Play( int );

int     VLC_Pause( int );

int             VLC_Stop( int );

vlc_bool_t      VLC_IsPlaying( int );

float           VLC_PositionGet( int );

float           VLC_PositionSet( int, float );

int             VLC_TimeGet( int );

int             VLC_TimeSet( int, int, vlc_bool_t );

int             VLC_LengthGet( int );

float           VLC_SpeedFaster( int );

float           VLC_SpeedSlower( int );

int             VLC_PlaylistIndex( int );

int             VLC_PlaylistNumberOfItems( int );

int             VLC_PlaylistNext( int );

int             VLC_PlaylistPrev( int );

int             VLC_PlaylistClear( int );

int             VLC_VolumeSet( int, int );

int             VLC_VolumeGet( int );

int            VLC_VolumeMute( int );

int             VLC_FullScreen( int );


# ifdef __cplusplus
}
# endif

#endif /* <vlc/vlc.h> */

---