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 #include <vlc_input_item.h>
  29
  30 extern const char psz_vlc_changeset[];
  31
  32 typedef struct variable_t variable_t;
  33
  34 /*
  35  * OS-specific initialization
  36  */
  37 void system_Init      ( void );
  38 void system_Configure ( libvlc_int_t *, int, const char *const [] );
  39 #if defined(_WIN32) || defined(__OS2__)
  40 void system_End(void);
  41 #ifndef __OS2__
  42 int EnumClockSource( const char *, char ***, char *** );
  43 #endif
  44 #endif
  45 void vlc_CPU_dump(vlc_object_t *);
  46
  47 /*
  48  * Threads subsystem
  49  */
  50
  51 /* This cannot be used as is from plugins yet: */
  52 int vlc_clone_detach (vlc_thread_t *, void *(*)(void *), void *, int);
  53
  54 int vlc_set_priority( vlc_thread_t, int );
  55
  56 void vlc_threads_setup (libvlc_int_t *);
  57
  58 void vlc_trace (const char *fn, const char *file, unsigned line);
  59 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
  60
  61 #ifndef NDEBUG
  62 /**
  63  * Marks a mutex locked.
  64  */
  65 void vlc_mutex_mark(const vlc_mutex_t *);
  66
  67 /**
  68  * Unmarks a mutex.
  69  */
  70 void vlc_mutex_unmark(const vlc_mutex_t *);
  71 #else
  72 # define vlc_mutex_mark(m) ((void)(m))
  73 # define vlc_mutex_unmark(m) ((void)(m))
  74 #endif
  75
  76 /*
  77  * Logging
  78  */
  79 typedef struct vlc_logger_t vlc_logger_t;
  80
  81 int vlc_LogPreinit(libvlc_int_t *);
  82 int vlc_LogInit(libvlc_int_t *);
  83 void vlc_LogDeinit(libvlc_int_t *);
  84
  85 /*
  86  * LibVLC exit event handling
  87  */
  88 typedef struct vlc_exit
  89 {
  90     vlc_mutex_t lock;
  91     void (*handler) (void *);
  92     void *opaque;
  93 } vlc_exit_t;
  94
  95 void vlc_ExitInit( vlc_exit_t * );
  96 void vlc_ExitDestroy( vlc_exit_t * );
  97
  98 /*
  99  * LibVLC objects stuff
 100  */
 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  * Assign a name to an object for vlc_object_find_name().
 122  */
 123 extern int vlc_object_set_name(vlc_object_t *, const char *);
 124 #define vlc_object_set_name(o, n) vlc_object_set_name(VLC_OBJECT(o), n)
 125
 126 /* Types */
 127 typedef void (*vlc_destructor_t) (struct vlc_object_t *);
 128 void vlc_object_set_destructor (vlc_object_t *, vlc_destructor_t);
 129 #define vlc_object_set_destructor(a,b) \
 130         vlc_object_set_destructor (VLC_OBJECT(a), b)
 131
 132 /**
 133  * Allocates an object resource.
 134  *
 135  * @param size storage size in bytes of the resource data
 136  * @param release callback to release the resource
 137  *
 138  * @return a pointer to the (uninitialized) storage space, or NULL on error
 139  */
 140 void *vlc_objres_new(size_t size, void (*release)(void *));
 141
 142 /**
 143  * Pushes an object resource on the object resources stack.
 144  *
 145  * @param obj object to allocate the resource for
 146  * @param data resource base address (as returned by vlc_objres_new())
 147  */
 148 void vlc_objres_push(vlc_object_t *obj, void *data);
 149
 150 /**
 151  * Releases all resources of an object.
 152  *
 153  * All resources added with vlc_objres_add() are released in reverse order.
 154  * The resource list is reset to empty.
 155  *
 156  * @param obj object whose resources to release
 157  */
 158 void vlc_objres_clear(vlc_object_t *obj);
 159
 160 /**
 161  * Releases one object resource explicitly.
 162  *
 163  * If a resource associated with an object needs to be released explicitly
 164  * earlier than normal, call this function. This is relatively slow and should
 165  * be avoided.
 166  *
 167  * @param obj object whose resource to release
 168  * @param data private data for the comparison function
 169  * @param match comparison function to match the targeted resource
 170  */
 171 void vlc_objres_remove(vlc_object_t *obj, void *data,
 172                        bool (*match)(void *, void *));
 173
 174 #define ZOOM_SECTION N_("Zoom")
 175 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
 176 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
 177 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
 178 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 179
 180 /**
 181  * Private LibVLC instance data.
 182  */
 183 typedef struct vlc_dialog_provider vlc_dialog_provider;
 184 typedef struct vlc_keystore vlc_keystore;
 185 typedef struct vlc_actions_t vlc_actions_t;
 186
 187 typedef struct libvlc_priv_t
 188 {
 189     libvlc_int_t       public_data;
 190
 191     /* Singleton objects */
 192     vlc_logger_t      *logger;
 193     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
 194     vlc_dialog_provider *p_dialog_provider; ///< dialog provider
 195     vlc_keystore      *p_memory_keystore; ///< memory keystore
 196     struct playlist_t *playlist; ///< Playlist for interfaces
 197     struct input_preparser_t *parser; ///< Input item meta data handler
 198     vlc_actions_t *actions; ///< Hotkeys handler
 199     struct vlc_medialibrary_t *p_media_library; ///< Media library instance
 200
 201     /* Exit callback */
 202     vlc_exit_t       exit;
 203 } libvlc_priv_t;
 204
 205 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
 206 {
 207     return container_of(libvlc, libvlc_priv_t, public_data);
 208 }
 209
 210 int intf_InsertItem(libvlc_int_t *, const char *mrl, unsigned optc,
 211                     const char * const *optv, unsigned flags);
 212 void intf_DestroyAll( libvlc_int_t * );
 213
 214 int vlc_MetadataRequest(libvlc_int_t *libvlc, input_item_t *item,
 215                         input_item_meta_request_option_t i_options,
 216                         const input_preparser_callbacks_t *cbs,
 217                         void *cbs_userdata,
 218                         int timeout, void *id);
 219
 220 /*
 221  * Variables stuff
 222  */
 223 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
 224
 225 #endif