codec: dvbsub: remove usage of bs_show
[vlc.git] / src / libvlc.h
blob6c0381122bfdc36b374ff620e6d088c33bb78482
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$
8 * Authors: Vincent Seguin <seguin@via.ecp.fr>
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.
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.
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 *****************************************************************************/
25 #ifndef LIBVLC_LIBVLC_H
26 # define LIBVLC_LIBVLC_H 1
28 #include <vlc_input_item.h>
30 extern const char psz_vlc_changeset[];
32 typedef struct variable_t variable_t;
35 * OS-specific initialization
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 size_t EnumClockSource( const char *, char ***, char *** );
43 #endif
44 #endif
45 void vlc_CPU_dump(vlc_object_t *);
48 * Threads subsystem
51 /* This cannot be used as is from plugins yet: */
52 int vlc_clone_detach (vlc_thread_t *, void *(*)(void *), void *, int);
54 int vlc_set_priority( vlc_thread_t, int );
56 void vlc_threads_setup (libvlc_int_t *);
58 void vlc_trace (const char *fn, const char *file, unsigned line);
59 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
61 #if (defined (LIBVLC_USE_PTHREAD) || defined(__ANDROID__)) && !defined (NDEBUG)
62 void vlc_assert_locked (vlc_mutex_t *);
63 #else
64 # define vlc_assert_locked( m ) (void)m
65 #endif
68 * Logging
70 typedef struct vlc_logger_t vlc_logger_t;
72 int vlc_LogPreinit(libvlc_int_t *);
73 int vlc_LogInit(libvlc_int_t *);
74 void vlc_LogDeinit(libvlc_int_t *);
77 * LibVLC exit event handling
79 typedef struct vlc_exit
81 vlc_mutex_t lock;
82 void (*handler) (void *);
83 void *opaque;
84 } vlc_exit_t;
86 void vlc_ExitInit( vlc_exit_t * );
87 void vlc_ExitDestroy( vlc_exit_t * );
90 * LibVLC objects stuff
93 /**
94 * Creates a VLC object.
96 * Note that because the object name pointer must remain valid, potentially
97 * even after the destruction of the object (through the message queues), this
98 * function CANNOT be exported to plugins as is. In this case, the old
99 * vlc_object_create() must be used instead.
101 * @param p_this an existing VLC object
102 * @param i_size byte size of the object structure
103 * @param psz_type object type name
104 * @return the created object, or NULL.
106 extern void *
107 vlc_custom_create (vlc_object_t *p_this, size_t i_size, const char *psz_type);
108 #define vlc_custom_create(o, s, n) \
109 vlc_custom_create(VLC_OBJECT(o), s, n)
112 * Assign a name to an object for vlc_object_find_name().
114 extern int vlc_object_set_name(vlc_object_t *, const char *);
115 #define vlc_object_set_name(o, n) vlc_object_set_name(VLC_OBJECT(o), n)
117 /* Types */
118 typedef void (*vlc_destructor_t) (struct vlc_object_t *);
119 void vlc_object_set_destructor (vlc_object_t *, vlc_destructor_t);
120 #define vlc_object_set_destructor(a,b) \
121 vlc_object_set_destructor (VLC_OBJECT(a), b)
124 * Allocates an object resource.
126 * @param size storage size in bytes of the resource data
127 * @param release callback to release the resource
129 * @return a pointer to the (uninitialized) storage space, or NULL on error
131 void *vlc_objres_new(size_t size, void (*release)(void *));
134 * Pushes an object resource on the object resources stack.
136 * @param obj object to allocate the resource for
137 * @param data resource base address (as returned by vlc_objres_new())
139 void vlc_objres_push(vlc_object_t *obj, void *data);
142 * Releases all resources of an object.
144 * All resources added with vlc_objres_add() are released in reverse order.
145 * The resource list is reset to empty.
147 * @param obj object whose resources to release
149 void vlc_objres_clear(vlc_object_t *obj);
152 * Releases one object resource explicitly.
154 * If a resource associated with an object needs to be released explicitly
155 * earlier than normal, call this function. This is relatively slow and should
156 * be avoided.
158 * @param obj object whose resource to release
159 * @param data private data for the comparison function
160 * @param match comparison function to match the targeted resource
162 void vlc_objres_remove(vlc_object_t *obj, void *data,
163 bool (*match)(void *, void *));
165 #define ZOOM_SECTION N_("Zoom")
166 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
167 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
168 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
169 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
172 * Private LibVLC instance data.
174 typedef struct vlc_dialog_provider vlc_dialog_provider;
175 typedef struct vlc_keystore vlc_keystore;
176 typedef struct vlc_actions_t vlc_actions_t;
178 typedef struct libvlc_priv_t
180 libvlc_int_t public_data;
182 /* Singleton objects */
183 vlc_logger_t *logger;
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 struct playlist_t *playlist; ///< Playlist for interfaces
188 struct input_preparser_t *parser; ///< Input item meta data handler
189 vlc_actions_t *actions; ///< Hotkeys handler
190 struct vlc_medialibrary_t *p_media_library; ///< Media library instance
192 /* Exit callback */
193 vlc_exit_t exit;
194 } libvlc_priv_t;
196 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
198 return container_of(libvlc, libvlc_priv_t, public_data);
201 int intf_InsertItem(libvlc_int_t *, const char *mrl, unsigned optc,
202 const char * const *optv, unsigned flags);
203 void intf_DestroyAll( libvlc_int_t * );
205 int vlc_MetadataRequest(libvlc_int_t *libvlc, input_item_t *item,
206 input_item_meta_request_option_t i_options,
207 const input_preparser_callbacks_t *cbs,
208 void *cbs_userdata,
209 int timeout, void *id);
212 * Variables stuff
214 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
216 #endif