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  *
   7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef LIBVLC_LIBVLC_H
  25 # define LIBVLC_LIBVLC_H 1
  26
  27 #include <vlc_input_item.h>
  28
  29 extern const char psz_vlc_changeset[];
  30
  31 typedef struct variable_t variable_t;
  32
  33 /*
  34  * OS-specific initialization
  35  */
  36 void system_Init      ( void );
  37 void system_Configure ( libvlc_int_t *, int, const char *const [] );
  38 #if defined(_WIN32) || defined(__OS2__)
  39 void system_End(void);
  40 #ifndef __OS2__
  41 int EnumClockSource( const char *, char ***, char *** );
  42 #endif
  43 #endif
  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 #ifndef NDEBUG
  61 /**
  62  * Marks a mutex locked.
  63  */
  64 void vlc_mutex_mark(const vlc_mutex_t *);
  65
  66 /**
  67  * Unmarks a mutex.
  68  */
  69 void vlc_mutex_unmark(const vlc_mutex_t *);
  70 #else
  71 # define vlc_mutex_mark(m) ((void)(m))
  72 # define vlc_mutex_unmark(m) ((void)(m))
  73 #endif
  74
  75 /*
  76  * Logging
  77  */
  78 typedef struct vlc_logger vlc_logger_t;
  79
  80 int vlc_LogPreinit(libvlc_int_t *) VLC_USED;
  81 void vlc_LogInit(libvlc_int_t *);
  82
  83 /*
  84  * LibVLC exit event handling
  85  */
  86 typedef struct vlc_exit
  87 {
  88     vlc_mutex_t lock;
  89     void (*handler) (void *);
  90     void *opaque;
  91 } vlc_exit_t;
  92
  93 void vlc_ExitInit( vlc_exit_t * );
  94 void vlc_ExitDestroy( vlc_exit_t * );
  95
  96 /*
  97  * LibVLC objects stuff
  98  */
  99
 100 /**
 101  * Initializes a VLC object.
 102  *
 103  * @param obj storage space for object to initialize [OUT]
 104  * @param parent parent object (or NULL to initialize the root) [IN]
 105  * @param type_name object type name
 106  *
 107  * @note The type name pointer must remain valid even after the object is
 108  * deinitialized, as it might be passed by address to log message queue.
 109  * Using constant string literals is appropriate.
 110  *
 111  * @retval 0 on success
 112  * @retval -1 on (out of memory) error
 113  */
 114 int vlc_object_init(vlc_object_t *obj, vlc_object_t *parent,
 115                     const char *type_name);
 116
 117 /**
 118  * Deinitializes a VLC object.
 119  *
 120  * This frees resources allocated by vlc_object_init().
 121  */
 122 void vlc_object_deinit(vlc_object_t *obj);
 123
 124 /**
 125  * Creates a VLC object.
 126  *
 127  * Note that because the object name pointer must remain valid, potentially
 128  * even after the destruction of the object (through the message queues), this
 129  * function CANNOT be exported to plugins as is. In this case, the old
 130  * vlc_object_create() must be used instead.
 131  *
 132  * @param p_this an existing VLC object
 133  * @param i_size byte size of the object structure
 134  * @param psz_type object type name
 135  * @return the created object, or NULL.
 136  */
 137 extern void *
 138 vlc_custom_create (vlc_object_t *p_this, size_t i_size, const char *psz_type);
 139 #define vlc_custom_create(o, s, n) \
 140         vlc_custom_create(VLC_OBJECT(o), s, n)
 141
 142 /**
 143  * Allocates an object resource.
 144  *
 145  * @param size storage size in bytes of the resource data
 146  * @param release callback to release the resource
 147  *
 148  * @return a pointer to the (uninitialized) storage space, or NULL on error
 149  */
 150 void *vlc_objres_new(size_t size, void (*release)(void *));
 151
 152 /**
 153  * Pushes an object resource on the object resources stack.
 154  *
 155  * @param obj object to allocate the resource for
 156  * @param data resource base address (as returned by vlc_objres_new())
 157  */
 158 void vlc_objres_push(vlc_object_t *obj, void *data);
 159
 160 /**
 161  * Releases all resources of an object.
 162  *
 163  * All resources added with vlc_objres_add() are released in reverse order.
 164  * The resource list is reset to empty.
 165  *
 166  * @param obj object whose resources to release
 167  */
 168 void vlc_objres_clear(vlc_object_t *obj);
 169
 170 /**
 171  * Releases one object resource explicitly.
 172  *
 173  * If a resource associated with an object needs to be released explicitly
 174  * earlier than normal, call this function. This is relatively slow and should
 175  * be avoided.
 176  *
 177  * @param obj object whose resource to release
 178  * @param data private data for the comparison function
 179  * @param match comparison function to match the targeted resource
 180  */
 181 void vlc_objres_remove(vlc_object_t *obj, void *data,
 182                        bool (*match)(void *, void *));
 183
 184 #define ZOOM_SECTION N_("Zoom")
 185 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
 186 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
 187 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
 188 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 189
 190 /**
 191  * Private LibVLC instance data.
 192  */
 193 typedef struct vlc_dialog_provider vlc_dialog_provider;
 194 typedef struct vlc_keystore vlc_keystore;
 195 typedef struct vlc_actions_t vlc_actions_t;
 196 typedef struct vlc_playlist vlc_playlist_t;
 197 typedef struct vlc_media_source_provider_t vlc_media_source_provider_t;
 198 typedef struct intf_thread_t intf_thread_t;
 199
 200 typedef struct libvlc_priv_t
 201 {
 202     libvlc_int_t       public_data;
 203
 204     /* Singleton objects */
 205     vlc_mutex_t lock; ///< protect playlist and interfaces
 206     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
 207     vlc_dialog_provider *p_dialog_provider; ///< dialog provider
 208     vlc_keystore      *p_memory_keystore; ///< memory keystore
 209     intf_thread_t *interfaces;  ///< Linked-list of interfaces
 210     vlc_playlist_t *main_playlist;
 211     struct input_preparser_t *parser; ///< Input item meta data handler
 212     vlc_media_source_provider_t *media_source_provider;
 213     vlc_actions_t *actions; ///< Hotkeys handler
 214     struct vlc_medialibrary_t *p_media_library; ///< Media library instance
 215     struct vlc_thumbnailer_t *p_thumbnailer; ///< Lazily instantiated media thumbnailer
 216
 217     /* Exit callback */
 218     vlc_exit_t       exit;
 219 } libvlc_priv_t;
 220
 221 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
 222 {
 223     return container_of(libvlc, libvlc_priv_t, public_data);
 224 }
 225
 226 int intf_InsertItem(libvlc_int_t *, const char *mrl, unsigned optc,
 227                     const char * const *optv, unsigned flags);
 228 void intf_DestroyAll( libvlc_int_t * );
 229
 230 int vlc_MetadataRequest(libvlc_int_t *libvlc, input_item_t *item,
 231                         input_item_meta_request_option_t i_options,
 232                         const input_preparser_callbacks_t *cbs,
 233                         void *cbs_userdata,
 234                         int timeout, void *id);
 235
 236 /*
 237  * Variables stuff
 238  */
 239 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
 240
 241 #endif