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