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
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
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.
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.
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 *****************************************************************************/
24 #ifndef LIBVLC_LIBVLC_H
25 # define LIBVLC_LIBVLC_H 1
27 #include <vlc_input_item.h>
29 extern const char psz_vlc_changeset
[];
31 typedef struct variable_t variable_t
;
34 * OS-specific initialization
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);
41 void vlc_CPU_dump(vlc_object_t
*);
47 /* This cannot be used as is from plugins yet: */
48 int vlc_clone_detach (vlc_thread_t
*, void *(*)(void *), void *, int);
50 int vlc_set_priority( vlc_thread_t
, int );
52 void vlc_threads_setup (libvlc_int_t
*);
54 void vlc_trace (const char *fn
, const char *file
, unsigned line
);
55 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
60 typedef struct vlc_logger vlc_logger_t
;
62 int vlc_LogPreinit(libvlc_int_t
*) VLC_USED
;
63 void vlc_LogInit(libvlc_int_t
*);
66 * LibVLC exit event handling
68 typedef struct vlc_exit
71 void (*handler
) (void *);
75 void vlc_ExitInit( vlc_exit_t
* );
78 * LibVLC objects stuff
82 * Initializes a VLC object.
84 * @param obj storage space for object to initialize [OUT]
85 * @param parent parent object (or NULL to initialize the root) [IN]
86 * @param type_name object type name
88 * @note The type name pointer must remain valid even after the object is
89 * deinitialized, as it might be passed by address to log message queue.
90 * Using constant string literals is appropriate.
92 * @retval 0 on success
93 * @retval -1 on (out of memory) error
95 int vlc_object_init(vlc_object_t
*obj
, vlc_object_t
*parent
,
96 const char *type_name
);
99 * Deinitializes a VLC object.
101 * This frees resources allocated by vlc_object_init().
103 void vlc_object_deinit(vlc_object_t
*obj
);
106 * Creates a VLC object.
108 * Note that because the object name pointer must remain valid, potentially
109 * even after the destruction of the object (through the message queues), this
110 * function CANNOT be exported to plugins as is. In this case, the old
111 * vlc_object_create() must be used instead.
113 * @param p_this an existing VLC object
114 * @param i_size byte size of the object structure
115 * @param psz_type object type name
116 * @return the created object, or NULL.
119 vlc_custom_create (vlc_object_t
*p_this
, size_t i_size
, const char *psz_type
);
120 #define vlc_custom_create(o, s, n) \
121 vlc_custom_create(VLC_OBJECT(o), s, n)
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
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
;
177 typedef struct vlc_playlist vlc_playlist_t
;
178 typedef struct vlc_media_source_provider_t vlc_media_source_provider_t
;
179 typedef struct intf_thread_t intf_thread_t
;
181 typedef struct libvlc_priv_t
183 libvlc_int_t public_data
;
185 /* Singleton objects */
186 vlc_mutex_t lock
; ///< protect playlist and interfaces
187 vlm_t
*p_vlm
; ///< the VLM singleton (or NULL)
188 vlc_dialog_provider
*p_dialog_provider
; ///< dialog provider
189 vlc_keystore
*p_memory_keystore
; ///< memory keystore
190 intf_thread_t
*interfaces
; ///< Linked-list of interfaces
191 vlc_playlist_t
*main_playlist
;
192 struct input_preparser_t
*parser
; ///< Input item meta data handler
193 vlc_media_source_provider_t
*media_source_provider
;
194 vlc_actions_t
*actions
; ///< Hotkeys handler
195 struct vlc_medialibrary_t
*p_media_library
; ///< Media library instance
196 struct vlc_thumbnailer_t
*p_thumbnailer
; ///< Lazily instantiated media thumbnailer
202 static inline libvlc_priv_t
*libvlc_priv (libvlc_int_t
*libvlc
)
204 return container_of(libvlc
, libvlc_priv_t
, public_data
);
207 int intf_InsertItem(libvlc_int_t
*, const char *mrl
, unsigned optc
,
208 const char * const *optv
, unsigned flags
);
209 void intf_DestroyAll( libvlc_int_t
* );
211 int vlc_MetadataRequest(libvlc_int_t
*libvlc
, input_item_t
*item
,
212 input_item_meta_request_option_t i_options
,
213 const input_preparser_callbacks_t
*cbs
,
215 int timeout
, void *id
);
220 void var_OptionParse (vlc_object_t
*, const char *, bool trusted
);