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_t vlc_logger_t;
  79
  80 int vlc_LogPreinit(libvlc_int_t *) VLC_USED;
  81 void vlc_LogInit(libvlc_int_t *);
  82 void vlc_LogDeinit(libvlc_int_t *);
  83
  84 /*
  85  * LibVLC exit event handling
  86  */
  87 typedef struct vlc_exit
  88 {
  89     vlc_mutex_t lock;
  90     void (*handler) (void *);
  91     void *opaque;
  92 } vlc_exit_t;
  93
  94 void vlc_ExitInit( vlc_exit_t * );
  95 void vlc_ExitDestroy( vlc_exit_t * );
  96
  97 /*
  98  * LibVLC objects stuff
  99  */
 100
 101 /**
 102  * Creates a VLC object.
 103  *
 104  * Note that because the object name pointer must remain valid, potentially
 105  * even after the destruction of the object (through the message queues), this
 106  * function CANNOT be exported to plugins as is. In this case, the old
 107  * vlc_object_create() must be used instead.
 108  *
 109  * @param p_this an existing VLC object
 110  * @param i_size byte size of the object structure
 111  * @param psz_type object type name
 112  * @return the created object, or NULL.
 113  */
 114 extern void *
 115 vlc_custom_create (vlc_object_t *p_this, size_t i_size, const char *psz_type);
 116 #define vlc_custom_create(o, s, n) \
 117         vlc_custom_create(VLC_OBJECT(o), s, n)
 118
 119 /**
 120  * Assign a name to an object for vlc_object_find_name().
 121  */
 122 extern int vlc_object_set_name(vlc_object_t *, const char *);
 123 #define vlc_object_set_name(o, n) vlc_object_set_name(VLC_OBJECT(o), n)
 124
 125 /* Types */
 126 typedef void (*vlc_destructor_t) (struct vlc_object_t *);
 127 void vlc_object_set_destructor (vlc_object_t *, vlc_destructor_t);
 128 #define vlc_object_set_destructor(a,b) \
 129         vlc_object_set_destructor (VLC_OBJECT(a), b)
 130
 131 /**
 132  * Allocates an object resource.
 133  *
 134  * @param size storage size in bytes of the resource data
 135  * @param release callback to release the resource
 136  *
 137  * @return a pointer to the (uninitialized) storage space, or NULL on error
 138  */
 139 void *vlc_objres_new(size_t size, void (*release)(void *));
 140
 141 /**
 142  * Pushes an object resource on the object resources stack.
 143  *
 144  * @param obj object to allocate the resource for
 145  * @param data resource base address (as returned by vlc_objres_new())
 146  */
 147 void vlc_objres_push(vlc_object_t *obj, void *data);
 148
 149 /**
 150  * Releases all resources of an object.
 151  *
 152  * All resources added with vlc_objres_add() are released in reverse order.
 153  * The resource list is reset to empty.
 154  *
 155  * @param obj object whose resources to release
 156  */
 157 void vlc_objres_clear(vlc_object_t *obj);
 158
 159 /**
 160  * Releases one object resource explicitly.
 161  *
 162  * If a resource associated with an object needs to be released explicitly
 163  * earlier than normal, call this function. This is relatively slow and should
 164  * be avoided.
 165  *
 166  * @param obj object whose resource to release
 167  * @param data private data for the comparison function
 168  * @param match comparison function to match the targeted resource
 169  */
 170 void vlc_objres_remove(vlc_object_t *obj, void *data,
 171                        bool (*match)(void *, void *));
 172
 173 #define ZOOM_SECTION N_("Zoom")
 174 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
 175 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
 176 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
 177 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 178
 179 /**
 180  * Private LibVLC instance data.
 181  */
 182 typedef struct vlc_dialog_provider vlc_dialog_provider;
 183 typedef struct vlc_keystore vlc_keystore;
 184 typedef struct vlc_actions_t vlc_actions_t;
 185 typedef struct vlc_playlist vlc_playlist_t;
 186 typedef struct vlc_media_source_provider_t vlc_media_source_provider_t;
 187
 188 typedef struct libvlc_priv_t
 189 {
 190     libvlc_int_t       public_data;
 191
 192     /* Singleton objects */
 193     vlc_logger_t      *logger;
 194     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
 195     vlc_dialog_provider *p_dialog_provider; ///< dialog provider
 196     vlc_keystore      *p_memory_keystore; ///< memory keystore
 197     struct playlist_t *playlist; ///< Playlist for interfaces
 198     vlc_playlist_t *main_playlist;
 199     struct input_preparser_t *parser; ///< Input item meta data handler
 200     vlc_media_source_provider_t *media_source_provider;
 201     vlc_actions_t *actions; ///< Hotkeys handler
 202     struct vlc_medialibrary_t *p_media_library; ///< Media library instance
 203     struct vlc_thumbnailer_t *p_thumbnailer; ///< Lazily instantiated media thumbnailer
 204
 205     /* Exit callback */
 206     vlc_exit_t       exit;
 207 } libvlc_priv_t;
 208
 209 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
 210 {
 211     return container_of(libvlc, libvlc_priv_t, public_data);
 212 }
 213
 214 int intf_InsertItem(libvlc_int_t *, const char *mrl, unsigned optc,
 215                     const char * const *optv, unsigned flags);
 216 void intf_DestroyAll( libvlc_int_t * );
 217
 218 int vlc_MetadataRequest(libvlc_int_t *libvlc, input_item_t *item,
 219                         input_item_meta_request_option_t i_options,
 220                         const input_preparser_callbacks_t *cbs,
 221                         void *cbs_userdata,
 222                         int timeout, void *id);
 223
 224 /*
 225  * Variables stuff
 226  */
 227 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
 228
 229 #endif