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 #endif
  41 void vlc_CPU_dump(vlc_object_t *);
  42
  43 /*
  44  * Threads subsystem
  45  */
  46
  47 /* This cannot be used as is from plugins yet: */
  48 int vlc_clone_detach (vlc_thread_t *, void *(*)(void *), void *, int);
  49
  50 int vlc_set_priority( vlc_thread_t, int );
  51
  52 void vlc_threads_setup (libvlc_int_t *);
  53
  54 void vlc_trace (const char *fn, const char *file, unsigned line);
  55 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
  56
  57 #ifndef NDEBUG
  58 /**
  59  * Marks a mutex locked.
  60  */
  61 void vlc_mutex_mark(const vlc_mutex_t *);
  62
  63 /**
  64  * Unmarks a mutex.
  65  */
  66 void vlc_mutex_unmark(const vlc_mutex_t *);
  67 #else
  68 # define vlc_mutex_mark(m) ((void)(m))
  69 # define vlc_mutex_unmark(m) ((void)(m))
  70 #endif
  71
  72 /*
  73  * Logging
  74  */
  75 typedef struct vlc_logger vlc_logger_t;
  76
  77 int vlc_LogPreinit(libvlc_int_t *) VLC_USED;
  78 void vlc_LogInit(libvlc_int_t *);
  79
  80 /*
  81  * LibVLC exit event handling
  82  */
  83 typedef struct vlc_exit
  84 {
  85     vlc_mutex_t lock;
  86     void (*handler) (void *);
  87     void *opaque;
  88 } vlc_exit_t;
  89
  90 void vlc_ExitInit( vlc_exit_t * );
  91 void vlc_ExitDestroy( vlc_exit_t * );
  92
  93 /*
  94  * LibVLC objects stuff
  95  */
  96
  97 /**
  98  * Initializes a VLC object.
  99  *
 100  * @param obj storage space for object to initialize [OUT]
 101  * @param parent parent object (or NULL to initialize the root) [IN]
 102  * @param type_name object type name
 103  *
 104  * @note The type name pointer must remain valid even after the object is
 105  * deinitialized, as it might be passed by address to log message queue.
 106  * Using constant string literals is appropriate.
 107  *
 108  * @retval 0 on success
 109  * @retval -1 on (out of memory) error
 110  */
 111 int vlc_object_init(vlc_object_t *obj, vlc_object_t *parent,
 112                     const char *type_name);
 113
 114 /**
 115  * Deinitializes a VLC object.
 116  *
 117  * This frees resources allocated by vlc_object_init().
 118  */
 119 void vlc_object_deinit(vlc_object_t *obj);
 120
 121 /**
 122  * Creates a VLC object.
 123  *
 124  * Note that because the object name pointer must remain valid, potentially
 125  * even after the destruction of the object (through the message queues), this
 126  * function CANNOT be exported to plugins as is. In this case, the old
 127  * vlc_object_create() must be used instead.
 128  *
 129  * @param p_this an existing VLC object
 130  * @param i_size byte size of the object structure
 131  * @param psz_type object type name
 132  * @return the created object, or NULL.
 133  */
 134 extern void *
 135 vlc_custom_create (vlc_object_t *p_this, size_t i_size, const char *psz_type);
 136 #define vlc_custom_create(o, s, n) \
 137         vlc_custom_create(VLC_OBJECT(o), s, n)
 138
 139 /**
 140  * Allocates an object resource.
 141  *
 142  * @param size storage size in bytes of the resource data
 143  * @param release callback to release the resource
 144  *
 145  * @return a pointer to the (uninitialized) storage space, or NULL on error
 146  */
 147 void *vlc_objres_new(size_t size, void (*release)(void *));
 148
 149 /**
 150  * Pushes an object resource on the object resources stack.
 151  *
 152  * @param obj object to allocate the resource for
 153  * @param data resource base address (as returned by vlc_objres_new())
 154  */
 155 void vlc_objres_push(vlc_object_t *obj, void *data);
 156
 157 /**
 158  * Releases all resources of an object.
 159  *
 160  * All resources added with vlc_objres_add() are released in reverse order.
 161  * The resource list is reset to empty.
 162  *
 163  * @param obj object whose resources to release
 164  */
 165 void vlc_objres_clear(vlc_object_t *obj);
 166
 167 /**
 168  * Releases one object resource explicitly.
 169  *
 170  * If a resource associated with an object needs to be released explicitly
 171  * earlier than normal, call this function. This is relatively slow and should
 172  * be avoided.
 173  *
 174  * @param obj object whose resource to release
 175  * @param data private data for the comparison function
 176  * @param match comparison function to match the targeted resource
 177  */
 178 void vlc_objres_remove(vlc_object_t *obj, void *data,
 179                        bool (*match)(void *, void *));
 180
 181 #define ZOOM_SECTION N_("Zoom")
 182 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
 183 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
 184 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
 185 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 186
 187 /**
 188  * Private LibVLC instance data.
 189  */
 190 typedef struct vlc_dialog_provider vlc_dialog_provider;
 191 typedef struct vlc_keystore vlc_keystore;
 192 typedef struct vlc_actions_t vlc_actions_t;
 193 typedef struct vlc_playlist vlc_playlist_t;
 194 typedef struct vlc_media_source_provider_t vlc_media_source_provider_t;
 195 typedef struct intf_thread_t intf_thread_t;
 196
 197 typedef struct libvlc_priv_t
 198 {
 199     libvlc_int_t       public_data;
 200
 201     /* Singleton objects */
 202     vlc_mutex_t lock; ///< protect playlist and interfaces
 203     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
 204     vlc_dialog_provider *p_dialog_provider; ///< dialog provider
 205     vlc_keystore      *p_memory_keystore; ///< memory keystore
 206     intf_thread_t *interfaces;  ///< Linked-list of interfaces
 207     vlc_playlist_t *main_playlist;
 208     struct input_preparser_t *parser; ///< Input item meta data handler
 209     vlc_media_source_provider_t *media_source_provider;
 210     vlc_actions_t *actions; ///< Hotkeys handler
 211     struct vlc_medialibrary_t *p_media_library; ///< Media library instance
 212     struct vlc_thumbnailer_t *p_thumbnailer; ///< Lazily instantiated media thumbnailer
 213
 214     /* Exit callback */
 215     vlc_exit_t       exit;
 216 } libvlc_priv_t;
 217
 218 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
 219 {
 220     return container_of(libvlc, libvlc_priv_t, public_data);
 221 }
 222
 223 int intf_InsertItem(libvlc_int_t *, const char *mrl, unsigned optc,
 224                     const char * const *optv, unsigned flags);
 225 void intf_DestroyAll( libvlc_int_t * );
 226
 227 int vlc_MetadataRequest(libvlc_int_t *libvlc, input_item_t *item,
 228                         input_item_meta_request_option_t i_options,
 229                         const input_preparser_callbacks_t *cbs,
 230                         void *cbs_userdata,
 231                         int timeout, void *id);
 232
 233 /*
 234  * Variables stuff
 235  */
 236 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
 237
 238 #endif