1 /*****************************************************************************
2 * entry.c : Callbacks for module entry point
3 *****************************************************************************
4 * Copyright (C) 2007 the VideoLAN team
5 * Copyright © 2007-2008 Rémi Denis-Courmont
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
20 *****************************************************************************/
26 #include <vlc_common.h>
27 #include <vlc_plugin.h>
31 #include "modules/modules.h"
32 #include "config/configuration.h"
35 static const char default_name[] = "unnamed";
37 module_t *vlc_module_create (vlc_object_t *obj)
40 (module_t *)vlc_custom_create (obj, sizeof (module_t),
41 VLC_OBJECT_MODULE, "module");
45 module->b_reentrant = module->b_unloadable = true;
46 module->psz_object_name = strdup( default_name );
47 module->psz_longname = default_name;
48 module->psz_capability = (char*)"";
50 module->i_config_items = module->i_bool_items = 0;
56 module_t *vlc_submodule_create (module_t *module)
58 assert (module != NULL);
59 assert (!module->b_submodule); // subsubmodules are not supported
62 (module_t *)vlc_custom_create (VLC_OBJECT (module), sizeof (module_t),
63 VLC_OBJECT_MODULE, "submodule");
64 if (submodule == NULL)
67 vlc_object_attach (submodule, module);
68 submodule->b_submodule = true;
70 /* Muahahaha! Heritage! Polymorphism! Ugliness!! */
71 memcpy (submodule->pp_shortcuts, module->pp_shortcuts,
72 sizeof (submodule->pp_shortcuts));
74 submodule->psz_object_name = strdup( module->psz_object_name );
75 submodule->psz_shortname = module->psz_shortname;
76 submodule->psz_longname = module->psz_longname;
77 submodule->psz_capability = module->psz_capability;
78 submodule->i_score = module->i_score;
79 submodule->i_cpu = module->i_cpu;
84 int vlc_module_set (module_t *module, int propid, ...)
87 int ret = VLC_SUCCESS;
89 va_start (ap, propid);
92 case VLC_MODULE_CPU_REQUIREMENT:
93 assert (!module->b_submodule);
94 module->i_cpu |= va_arg (ap, int);
97 case VLC_MODULE_SHORTCUT:
100 for (i = 0; module->pp_shortcuts[i] != NULL; i++);
101 if (i >= (MODULE_SHORTCUT_MAX - 1))
107 module->pp_shortcuts[i] = va_arg (ap, char *);
111 case VLC_MODULE_SHORTNAME:
112 module->psz_shortname = dgettext (PACKAGE, va_arg (ap, char *));
115 case VLC_MODULE_DESCRIPTION:
116 module->psz_longname = dgettext (PACKAGE, va_arg (ap, char *));
119 case VLC_MODULE_HELP:
120 module->psz_help = dgettext (PACKAGE, va_arg (ap, char *));
123 case VLC_MODULE_CAPABILITY:
124 module->psz_capability = va_arg (ap, char *);
127 case VLC_MODULE_SCORE:
128 module->i_score = va_arg (ap, int);
131 case VLC_MODULE_CB_OPEN:
132 module->pf_activate = va_arg (ap, int (*) (vlc_object_t *));
135 case VLC_MODULE_CB_CLOSE:
136 module->pf_deactivate = va_arg (ap, void (*) (vlc_object_t *));
139 case VLC_MODULE_NO_UNLOAD:
140 module->b_unloadable = false;
143 case VLC_MODULE_NAME:
145 const char *value = va_arg (ap, const char *);
146 free( module->psz_object_name );
147 module->psz_object_name = strdup( value );
148 module->pp_shortcuts[0] = value;
149 if (module->psz_longname == default_name)
150 module->psz_longname = value;
154 case VLC_MODULE_PROGRAM:
155 msg_Warn (module, "deprecated module property %d", propid);
159 msg_Err (module, "unknown module property %d", propid);
160 msg_Err (module, "LibVLC might be too old to use this module.");
168 module_config_t *vlc_config_create (module_t *module, int type)
170 unsigned confsize = module->confsize;
171 module_config_t *tab = module->p_config;
173 if ((confsize & 0xf) == 0)
175 tab = realloc (tab, (confsize + 17) * sizeof (*tab));
179 module->p_config = tab;
182 memset (tab + confsize, 0, sizeof (tab[confsize]));
183 tab[confsize].i_type = type;
184 tab[confsize].p_lock = &module->object_lock;
186 if (type & CONFIG_ITEM)
188 module->i_config_items++;
189 if (type == CONFIG_ITEM_BOOL)
190 module->i_bool_items++;
194 return tab + confsize;
197 int vlc_config_set (module_config_t *restrict item, int id, ...)
202 assert (item != NULL);
207 case VLC_CONFIG_NAME:
209 const char *name = va_arg (ap, const char *);
210 vlc_callback_t cb = va_arg (ap, vlc_callback_t);
212 assert (name != NULL);
213 item->psz_name = strdup (name);
214 item->pf_callback = cb;
219 case VLC_CONFIG_DESC:
221 const char *text = va_arg (ap, const char *);
222 const char *longtext = va_arg (ap, const char *);
224 item->psz_text = text ? strdup (dgettext (PACKAGE, text)) : NULL;
226 longtext ? strdup (dgettext (PACKAGE, longtext)) : NULL;
231 case VLC_CONFIG_VALUE:
233 if (IsConfigIntegerType (item->i_type))
235 item->orig.i = item->saved.i =
236 item->value.i = va_arg (ap, int);
240 if (IsConfigFloatType (item->i_type))
242 item->orig.f = item->saved.f =
243 item->value.f = va_arg (ap, double);
247 if (IsConfigStringType (item->i_type))
249 const char *value = va_arg (ap, const char *);
250 item->value.psz = value ? strdup (value) : NULL;
251 item->orig.psz = value ? strdup (value) : NULL;
252 item->saved.psz = value ? strdup (value) : NULL;
258 case VLC_CONFIG_RANGE:
260 if (IsConfigIntegerType (item->i_type))
262 item->min.i = va_arg (ap, int);
263 item->max.i = va_arg (ap, int);
267 if (IsConfigFloatType (item->i_type))
269 item->min.f = va_arg (ap, double);
270 item->max.f = va_arg (ap, double);
276 case VLC_CONFIG_ADVANCED:
277 item->b_advanced = true;
281 case VLC_CONFIG_VOLATILE:
282 item->b_unsaveable = true;
286 case VLC_CONFIG_PERSISTENT:
287 item->b_autosave = true;
291 case VLC_CONFIG_RESTART:
292 item->b_restart = true;
296 case VLC_CONFIG_PRIVATE:
297 item->b_internal = true;
301 case VLC_CONFIG_REMOVED:
302 item->b_removed = true;
306 case VLC_CONFIG_CAPABILITY:
308 const char *cap = va_arg (ap, const char *);
309 item->psz_type = cap ? strdup (cap) : NULL;
314 case VLC_CONFIG_SHORTCUT:
315 item->i_short = va_arg (ap, int);
319 case VLC_CONFIG_LIST:
321 size_t len = va_arg (ap, size_t);
322 char **dtext = malloc (sizeof (char *) * (len + 1));
328 if (IsConfigIntegerType (item->i_type))
330 const int *src = va_arg (ap, const int *);
331 int *dst = malloc (sizeof (int) * (len + 1));
335 memcpy (dst, src, sizeof (int) * len);
342 if (IsConfigFloatType (item->i_type))
344 const float *src = va_arg (ap, const float *);
345 float *dst = malloc (sizeof (float) * (len + 1));
349 memcpy (dst, src, sizeof (float) * len);
356 if (IsConfigStringType (item->i_type))
358 const char *const *src = va_arg (ap, const char *const *);
359 char **dst = malloc (sizeof (char *) * (len + 1));
363 for (size_t i = 0; i < len; i++)
364 dst[i] = src[i] ? strdup (src[i]) : NULL;
367 item->ppsz_list = dst;
372 /* Copy textual descriptions */
373 const char *const *text = va_arg (ap, const char *const *);
376 for (size_t i = 0; i < len; i++)
378 text[i] ? strdup (dgettext (PACKAGE, text[i])) : NULL;
381 item->ppsz_list_text = dtext;
386 item->ppsz_list_text = NULL;
390 item->pf_update_list = va_arg (ap, vlc_callback_t);
395 case VLC_CONFIG_ADD_ACTION:
397 vlc_callback_t cb = va_arg (ap, vlc_callback_t), *tabcb;
398 const char *name = va_arg (ap, const char *);
401 tabcb = realloc (item->ppf_action,
402 (item->i_action + 2) * sizeof (cb));
405 item->ppf_action = tabcb;
406 tabcb[item->i_action] = cb;
407 tabcb[item->i_action + 1] = NULL;
409 tabtext = realloc (item->ppsz_action_text,
410 (item->i_action + 2) * sizeof (name));
413 item->ppsz_action_text = tabtext;
416 tabtext[item->i_action] = strdup (dgettext (PACKAGE, name));
418 tabtext[item->i_action] = NULL;
419 tabtext[item->i_action + 1] = NULL;
426 case VLC_CONFIG_OLDNAME:
428 const char *oldname = va_arg (ap, const char *);
429 item->psz_oldname = oldname ? strdup (oldname) : NULL;
434 case VLC_CONFIG_SAFE: