src/libvlc.h

   1 /*****************************************************************************
   2  * libvlc.h: Internal libvlc generic/misc declaration
   3  *****************************************************************************
   4  * Copyright (C) 1999, 2000, 2001, 2002 VLC authors and VideoLAN
   5  * Copyright © 2006-2007 Rémi Denis-Courmont
   6  * $Id$
   7  *
   8  * Authors: Vincent Seguin <seguin@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef LIBVLC_LIBVLC_H
  26 # define LIBVLC_LIBVLC_H 1
  27
  28 extern const char psz_vlc_changeset[];
  29
  30 typedef struct variable_t variable_t;
  31
  32 /*
  33  * OS-specific initialization
  34  */
  35 void system_Init      ( void );
  36 void system_Configure ( libvlc_int_t *, int, const char *const [] );
  37 #if defined(_WIN32) || defined(__OS2__)
  38 void system_End(void);
  39 #ifndef __OS2__
  40 size_t EnumClockSource( vlc_object_t *, const char *, char ***, char *** );
  41 #endif
  42 #endif
  43 void vlc_CPU_init(void);
  44 void vlc_CPU_dump(vlc_object_t *);
  45
  46 /*
  47  * Threads subsystem
  48  */
  49
  50 /* This cannot be used as is from plugins yet: */
  51 int vlc_clone_detach (vlc_thread_t *, void *(*)(void *), void *, int);
  52
  53 int vlc_set_priority( vlc_thread_t, int );
  54
  55 void vlc_threads_setup (libvlc_int_t *);
  56
  57 void vlc_trace (const char *fn, const char *file, unsigned line);
  58 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
  59
  60 #if (defined (LIBVLC_USE_PTHREAD) || defined(__ANDROID__)) && !defined (NDEBUG)
  61 void vlc_assert_locked (vlc_mutex_t *);
  62 #else
  63 # define vlc_assert_locked( m ) (void)m
  64 #endif
  65
  66 /*
  67  * Logging
  68  */
  69 typedef struct vlc_logger_t vlc_logger_t;
  70
  71 int vlc_LogPreinit(libvlc_int_t *);
  72 int vlc_LogInit(libvlc_int_t *);
  73 void vlc_LogDeinit(libvlc_int_t *);
  74
  75 /*
  76  * LibVLC exit event handling
  77  */
  78 typedef struct vlc_exit
  79 {
  80     vlc_mutex_t lock;
  81     void (*handler) (void *);
  82     void *opaque;
  83 } vlc_exit_t;
  84
  85 void vlc_ExitInit( vlc_exit_t * );
  86 void vlc_ExitDestroy( vlc_exit_t * );
  87
  88 /*
  89  * LibVLC objects stuff
  90  */
  91
  92 /**
  93  * Creates a VLC object.
  94  *
  95  * Note that because the object name pointer must remain valid, potentially
  96  * even after the destruction of the object (through the message queues), this
  97  * function CANNOT be exported to plugins as is. In this case, the old
  98  * vlc_object_create() must be used instead.
  99  *
 100  * @param p_this an existing VLC object
 101  * @param i_size byte size of the object structure
 102  * @param psz_type object type name
 103  * @return the created object, or NULL.
 104  */
 105 extern void *
 106 vlc_custom_create (vlc_object_t *p_this, size_t i_size, const char *psz_type);
 107 #define vlc_custom_create(o, s, n) \
 108         vlc_custom_create(VLC_OBJECT(o), s, n)
 109
 110 /**
 111  * Assign a name to an object for vlc_object_find_name().
 112  */
 113 extern int vlc_object_set_name(vlc_object_t *, const char *);
 114 #define vlc_object_set_name(o, n) vlc_object_set_name(VLC_OBJECT(o), n)
 115
 116 /* Types */
 117 typedef void (*vlc_destructor_t) (struct vlc_object_t *);
 118 void vlc_object_set_destructor (vlc_object_t *, vlc_destructor_t);
 119 #define vlc_object_set_destructor(a,b) \
 120         vlc_object_set_destructor (VLC_OBJECT(a), b)
 121
 122 /**
 123  * Allocates an object resource.
 124  *
 125  * @param size storage size in bytes of the resource data
 126  * @param release callback to release the resource
 127  *
 128  * @return a pointer to the (uninitialized) storage space, or NULL on error
 129  */
 130 void *vlc_objres_new(size_t size, void (*release)(void *));
 131
 132 /**
 133  * Pushes an object resource on the object resources stack.
 134  *
 135  * @param obj object to allocate the resource for
 136  * @param data resource base address (as returned by vlc_objres_new())
 137  */
 138 void vlc_objres_push(vlc_object_t *obj, void *data);
 139
 140 /**
 141  * Releases all resources of an object.
 142  *
 143  * All resources added with vlc_objres_add() are released in reverse order.
 144  * The resource list is reset to empty.
 145  *
 146  * @param obj object whose resources to release
 147  */
 148 void vlc_objres_clear(vlc_object_t *obj);
 149
 150 /**
 151  * Releases one object resource explicitly.
 152  *
 153  * If a resource associated with an object needs to be released explicitly
 154  * earlier than normal, call this function. This is relatively slow and should
 155  * be avoided.
 156  *
 157  * @param obj object whose resource to release
 158  * @param data private data for the comparison function
 159  * @param match comparison function to match the targeted resource
 160  */
 161 void vlc_objres_remove(vlc_object_t *obj, void *data,
 162                        bool (*match)(void *, void *));
 163
 164 #define ZOOM_SECTION N_("Zoom")
 165 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
 166 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
 167 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
 168 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 169
 170 /**
 171  * Private LibVLC instance data.
 172  */
 173 typedef struct vlc_dialog_provider vlc_dialog_provider;
 174 typedef struct vlc_keystore vlc_keystore;
 175 typedef struct vlc_actions_t vlc_actions_t;
 176
 177 typedef struct libvlc_priv_t
 178 {
 179     libvlc_int_t       public_data;
 180
 181     /* Singleton objects */
 182     vlc_logger_t      *logger;
 183     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
 184     vlc_dialog_provider *p_dialog_provider; ///< dialog provider
 185     vlc_keystore      *p_memory_keystore; ///< memory keystore
 186     struct playlist_t *playlist; ///< Playlist for interfaces
 187     struct playlist_preparser_t *parser; ///< Input item meta data handler
 188     vlc_actions_t *actions; ///< Hotkeys handler
 189
 190     /* Exit callback */
 191     vlc_exit_t       exit;
 192 } libvlc_priv_t;
 193
 194 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
 195 {
 196     return container_of(libvlc, libvlc_priv_t, public_data);
 197 }
 198
 199 int intf_InsertItem(libvlc_int_t *, const char *mrl, unsigned optc,
 200                     const char * const *optv, unsigned flags);
 201 void intf_DestroyAll( libvlc_int_t * );
 202
 203 /*
 204  * Variables stuff
 205  */
 206 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
 207
 208 #endif