git.sesse.net Git - vlc/blob - 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.13 2002/08/26 23:36:20 sam 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 struct vlc_t vlc_t;
  33 typedef struct vlc_list_t vlc_list_t;
  34 typedef struct vlc_object_t vlc_object_t;
  35
  36 typedef signed int vlc_error_t;
  37 typedef int        vlc_bool_t;
  38 typedef int        vlc_status_t;
  39
  40 /*****************************************************************************
  41  * Error values
  42  *****************************************************************************/
  43 #define VLC_SUCCESS         -0                                   /* No error */
  44 #define VLC_ENOMEM          -1                          /* Not enough memory */
  45 #define VLC_EMODULE         -2                           /* Module not found */
  46 #define VLC_ESTATUS         -3                             /* Invalid status */
  47 #define VLC_ETHREAD         -4                     /* Could not spawn thread */
  48 #define VLC_EEXIT         -255                             /* Program exited */
  49 #define VLC_EGENERIC      -666                              /* Generic error */
  50
  51 /*****************************************************************************
  52  * Booleans
  53  *****************************************************************************/
  54 #define VLC_FALSE 0
  55 #define VLC_TRUE  1
  56
  57 /*****************************************************************************
  58  * Main structure status
  59  *****************************************************************************/
  60 #define VLC_STATUS_NONE     0x00000000
  61 #define VLC_STATUS_CREATED  0x02020202
  62 #define VLC_STATUS_STOPPED  0x12121212
  63 #define VLC_STATUS_RUNNING  0x42424242
  64
  65 /*****************************************************************************
  66  * Playlist
  67  *****************************************************************************/
  68
  69 /* Used by playlist_Add */
  70 #define PLAYLIST_INSERT      0x0001
  71 #define PLAYLIST_REPLACE     0x0002
  72 #define PLAYLIST_APPEND      0x0004
  73 #define PLAYLIST_GO          0x0008
  74
  75 #define PLAYLIST_END           -666
  76
  77 /* Playlist parsing mode */
  78 #define PLAYLIST_REPEAT_CURRENT   0             /* Keep playing current item */
  79 #define PLAYLIST_FORWARD          1              /* Parse playlist until end */
  80 #define PLAYLIST_BACKWARD        -1                       /* Parse backwards */
  81 #define PLAYLIST_FORWARD_LOOP     2               /* Parse playlist and loop */
  82 #define PLAYLIST_BACKWARD_LOOP   -2              /* Parse backwards and loop */
  83 #define PLAYLIST_RANDOM           3                          /* Shuffle play */
  84 #define PLAYLIST_REVERSE_RANDOM  -3                  /* Reverse shuffle play */
  85
  86 /* Playlist commands */
  87 #define PLAYLIST_PLAY   1                         /* Starts playing. No arg. */
  88 #define PLAYLIST_PAUSE  2                 /* Toggles playlist pause. No arg. */
  89 #define PLAYLIST_STOP   3                          /* Stops playing. No arg. */
  90 #define PLAYLIST_SKIP   4                          /* Skip X items and play. */
  91 #define PLAYLIST_GOTO   5                                  /* Goto Xth item. */
  92 #define PLAYLIST_MODE   6                          /* Set playlist mode. ??? */
  93
  94 /*****************************************************************************
  95  * Required internal headers
  96  *****************************************************************************/
  97 #if defined( __VLC__ )
  98 #   include "vlc_common.h"
  99 #endif
 100
 101 /*****************************************************************************
 102  * Exported libvlc API
 103  *****************************************************************************/
 104 vlc_status_t    vlc_status       ( void );
 105
 106 vlc_error_t     vlc_create       ( void );
 107 vlc_error_t     vlc_init         ( int, char *[] );
 108 vlc_error_t     vlc_run          ( void );
 109 vlc_error_t     vlc_die          ( void );
 110 vlc_error_t     vlc_destroy      ( void );
 111
 112 vlc_error_t     vlc_set          ( const char *, const char * );
 113 vlc_error_t     vlc_add_intf     ( const char *, vlc_bool_t );
 114 vlc_error_t     vlc_add_target   ( const char *, int, int );
 115
 116 /*****************************************************************************
 117  * Exported libvlc reentrant API
 118  *****************************************************************************/
 119 vlc_status_t    vlc_status_r     ( vlc_t * );
 120
 121 vlc_t *         vlc_create_r     ( void );
 122 vlc_error_t     vlc_init_r       ( vlc_t *, int, char *[] );
 123 vlc_error_t     vlc_run_r        ( vlc_t * );
 124 vlc_error_t     vlc_die_r        ( vlc_t * );
 125 vlc_error_t     vlc_destroy_r    ( vlc_t * );
 126
 127 vlc_error_t     vlc_set_r        ( vlc_t *, const char *, const char * );
 128 vlc_error_t     vlc_add_intf_r   ( vlc_t *, const char *, vlc_bool_t );
 129 vlc_error_t     vlc_add_target_r ( vlc_t *, const char *, int, int );
 130
 131 # ifdef __cplusplus
 132 }
 133 # endif
 134
 135 #endif /* <vlc/vlc.h> */