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 # define dgettext(d, m) ((char *)(m))
38 static void vlc_module_destruct (gc_object_t *obj)
40 module_t *module = vlc_priv (obj, module_t);
42 vlc_mutex_destroy (&module->lock);
43 free (module->psz_object_name);
47 static const char default_name[] = "unnamed";
49 module_t *vlc_module_create (vlc_object_t *obj)
51 module_t *module = malloc (sizeof (*module));
55 module->psz_object_name = strdup( default_name );
57 module->submodule = NULL;
58 module->parent = NULL;
59 module->submodule_count = 0;
60 vlc_gc_init (module, vlc_module_destruct);
61 vlc_mutex_init (&module->lock);
63 module->psz_shortname = NULL;
64 module->psz_longname = (char*)default_name;
65 module->psz_help = NULL;
66 for (unsigned i = 0; i < MODULE_SHORTCUT_MAX; i++)
67 module->pp_shortcuts[i] = NULL;
68 module->psz_capability = (char*)"";
71 module->b_unloadable = true;
72 module->b_reentrant = true;
73 module->b_submodule = false;
74 module->pf_activate = NULL;
75 module->pf_deactivate = NULL;
76 module->p_config = NULL;
78 module->i_config_items = 0;
79 module->i_bool_items = 0;
80 /*module->handle = garbage */
81 module->psz_filename = NULL;
82 module->b_builtin = false;
83 module->b_loaded = false;
90 static void vlc_submodule_destruct (gc_object_t *obj)
92 module_t *module = vlc_priv (obj, module_t);
93 free (module->psz_object_name);
97 module_t *vlc_submodule_create (module_t *module)
99 assert (module != NULL);
101 module_t *submodule = calloc( 1, sizeof(*submodule) );
105 vlc_gc_init (submodule, vlc_submodule_destruct);
107 submodule->next = module->submodule;
108 submodule->parent = module;
109 module->submodule = submodule;
110 module->submodule_count++;
112 /* Muahahaha! Heritage! Polymorphism! Ugliness!! */
113 memcpy (submodule->pp_shortcuts, module->pp_shortcuts,
114 sizeof (submodule->pp_shortcuts));
116 submodule->psz_object_name = strdup( module->psz_object_name );
117 submodule->psz_shortname = module->psz_shortname;
118 submodule->psz_longname = module->psz_longname;
119 submodule->psz_capability = module->psz_capability;
120 submodule->i_score = module->i_score;
121 submodule->i_cpu = module->i_cpu;
122 submodule->b_submodule = true;
127 int vlc_module_set (module_t *module, int propid, ...)
130 int ret = VLC_SUCCESS;
132 va_start (ap, propid);
135 case VLC_MODULE_CPU_REQUIREMENT:
136 assert (!module->b_submodule);
137 module->i_cpu |= va_arg (ap, int);
140 case VLC_MODULE_SHORTCUT:
143 for (i = 0; module->pp_shortcuts[i] != NULL; i++);
144 if (i >= (MODULE_SHORTCUT_MAX - 1))
150 module->pp_shortcuts[i] = va_arg (ap, char *);
154 case VLC_MODULE_SHORTNAME_NODOMAIN:
156 const char *name = va_arg (ap, char *);
157 ret = vlc_module_set (module, VLC_MODULE_SHORTNAME, NULL, name);
161 case VLC_MODULE_DESCRIPTION_NODOMAIN:
163 const char *desc = va_arg (ap, char *);
164 ret = vlc_module_set (module, VLC_MODULE_DESCRIPTION, NULL, desc);
168 case VLC_MODULE_HELP_NODOMAIN:
170 const char *help = va_arg (ap, char *);
171 ret = vlc_module_set (module, VLC_MODULE_HELP, NULL, help);
175 case VLC_MODULE_CAPABILITY:
176 module->psz_capability = va_arg (ap, char *);
179 case VLC_MODULE_SCORE:
180 module->i_score = va_arg (ap, int);
183 case VLC_MODULE_CB_OPEN:
184 module->pf_activate = va_arg (ap, int (*) (vlc_object_t *));
187 case VLC_MODULE_CB_CLOSE:
188 module->pf_deactivate = va_arg (ap, void (*) (vlc_object_t *));
191 case VLC_MODULE_NO_UNLOAD:
192 module->b_unloadable = false;
195 case VLC_MODULE_NAME:
197 const char *value = va_arg (ap, const char *);
198 free( module->psz_object_name );
199 module->psz_object_name = strdup( value );
200 module->pp_shortcuts[0] = (char*)value; /* dooh! */
201 if (module->psz_longname == default_name)
202 module->psz_longname = (char*)value; /* dooh! */
206 case VLC_MODULE_SHORTNAME:
208 const char *domain = va_arg (ap, const char *);
211 module->psz_shortname = dgettext (domain, va_arg (ap, char *));
215 case VLC_MODULE_DESCRIPTION:
217 const char *domain = va_arg (ap, const char *);
220 module->psz_longname = dgettext (domain, va_arg (ap, char *));
224 case VLC_MODULE_HELP:
226 const char *domain = va_arg (ap, const char *);
229 module->psz_help = dgettext (domain, va_arg (ap, char *));
234 fprintf (stderr, "LibVLC: unknown module property %d", propid);
235 fprintf (stderr, "LibVLC: too old to use this module?");
243 module_config_t *vlc_config_create (module_t *module, int type)
245 unsigned confsize = module->confsize;
246 module_config_t *tab = module->p_config;
248 if ((confsize & 0xf) == 0)
250 tab = realloc (tab, (confsize + 17) * sizeof (*tab));
254 module->p_config = tab;
257 memset (tab + confsize, 0, sizeof (tab[confsize]));
258 tab[confsize].i_type = type;
259 tab[confsize].p_lock = &module->lock;
261 if (type & CONFIG_ITEM)
263 module->i_config_items++;
264 if (type == CONFIG_ITEM_BOOL)
265 module->i_bool_items++;
269 return tab + confsize;
272 int vlc_config_set (module_config_t *restrict item, int id, ...)
277 assert (item != NULL);
282 case VLC_CONFIG_NAME:
284 const char *name = va_arg (ap, const char *);
285 vlc_callback_t cb = va_arg (ap, vlc_callback_t);
287 assert (name != NULL);
288 item->psz_name = strdup (name);
289 item->pf_callback = cb;
294 case VLC_CONFIG_DESC_NODOMAIN:
296 const char *text = va_arg (ap, const char *);
297 const char *longtext = va_arg (ap, const char *);
298 ret = vlc_config_set (item, VLC_CONFIG_DESC, NULL, text, longtext);
302 case VLC_CONFIG_VALUE:
304 if (IsConfigIntegerType (item->i_type))
306 item->orig.i = item->saved.i =
307 item->value.i = va_arg (ap, int);
311 if (IsConfigFloatType (item->i_type))
313 item->orig.f = item->saved.f =
314 item->value.f = va_arg (ap, double);
318 if (IsConfigStringType (item->i_type))
320 const char *value = va_arg (ap, const char *);
321 item->value.psz = value ? strdup (value) : NULL;
322 item->orig.psz = value ? strdup (value) : NULL;
323 item->saved.psz = value ? strdup (value) : NULL;
329 case VLC_CONFIG_RANGE:
331 if (IsConfigIntegerType (item->i_type))
333 item->min.i = va_arg (ap, int);
334 item->max.i = va_arg (ap, int);
338 if (IsConfigFloatType (item->i_type))
340 item->min.f = va_arg (ap, double);
341 item->max.f = va_arg (ap, double);
347 case VLC_CONFIG_ADVANCED:
348 item->b_advanced = true;
352 case VLC_CONFIG_VOLATILE:
353 item->b_unsaveable = true;
357 case VLC_CONFIG_PERSISTENT:
358 item->b_autosave = true;
362 case VLC_CONFIG_RESTART:
363 item->b_restart = true;
367 case VLC_CONFIG_PRIVATE:
368 item->b_internal = true;
372 case VLC_CONFIG_REMOVED:
373 item->b_removed = true;
377 case VLC_CONFIG_CAPABILITY:
379 const char *cap = va_arg (ap, const char *);
380 item->psz_type = cap ? strdup (cap) : NULL;
385 case VLC_CONFIG_SHORTCUT:
386 item->i_short = va_arg (ap, int);
390 case VLC_CONFIG_LIST_NODOMAIN:
392 size_t len = va_arg (ap, size_t);
393 if (IsConfigIntegerType (item->i_type))
395 const int *src = va_arg (ap, const int *);
396 const char *const *text = va_arg (ap, const char *const *);
397 ret = vlc_config_set (item, VLC_CONFIG_LIST, NULL, len, src,
401 if (IsConfigStringType (item->i_type))
403 const char *const *src = va_arg (ap, const char *const *);
404 const char *const *text = va_arg (ap, const char *const *);
405 ret = vlc_config_set (item, VLC_CONFIG_LIST, NULL, len, src,
411 case VLC_CONFIG_ADD_ACTION_NODOMAIN:
413 vlc_callback_t cb = va_arg (ap, vlc_callback_t);
414 const char *name = va_arg (ap, const char *);
415 ret = vlc_config_set (item, VLC_CONFIG_ADD_ACTION, NULL, cb, name);
419 case VLC_CONFIG_OLDNAME:
421 const char *oldname = va_arg (ap, const char *);
422 item->psz_oldname = oldname ? strdup (oldname) : NULL;
427 case VLC_CONFIG_SAFE:
432 case VLC_CONFIG_DESC:
434 const char *domain = va_arg (ap, const char *);
435 const char *text = va_arg (ap, const char *);
436 const char *longtext = va_arg (ap, const char *);
440 item->psz_text = text ? strdup (dgettext (domain, text)) : NULL;
442 longtext ? strdup (dgettext (domain, longtext)) : NULL;
447 case VLC_CONFIG_LIST:
449 const char *domain = va_arg (ap, const char *);
450 size_t len = va_arg (ap, size_t);
453 if (IsConfigIntegerType (item->i_type))
455 const int *src = va_arg (ap, const int *);
456 int *dst = malloc (sizeof (int) * (len + 1));
460 memcpy (dst, src, sizeof (int) * len);
467 if (IsConfigFloatType (item->i_type))
469 const float *src = va_arg (ap, const float *);
470 float *dst = malloc (sizeof (float) * (len + 1));
474 memcpy (dst, src, sizeof (float) * len);
481 if (IsConfigStringType (item->i_type))
483 const char *const *src = va_arg (ap, const char *const *);
484 char **dst = malloc (sizeof (char *) * (len + 1));
488 for (size_t i = 0; i < len; i++)
489 dst[i] = src[i] ? strdup (src[i]) : NULL;
492 item->ppsz_list = dst;
497 /* Copy textual descriptions */
501 const char *const *text = va_arg (ap, const char *const *);
504 char **dtext = malloc (sizeof (char *) * (len + 1));
507 for (size_t i = 0; i < len; i++)
509 strdup( dgettext( domain, text[i] ) ) :
513 item->ppsz_list_text = dtext;
516 item->ppsz_list_text = NULL;
519 item->pf_update_list = va_arg (ap, vlc_callback_t);
524 case VLC_CONFIG_ADD_ACTION:
526 const char *domain = va_arg (ap, const char *);
527 vlc_callback_t cb = va_arg (ap, vlc_callback_t), *tabcb;
528 const char *name = va_arg (ap, const char *);
531 tabcb = realloc (item->ppf_action,
532 (item->i_action + 2) * sizeof (cb));
535 item->ppf_action = tabcb;
536 tabcb[item->i_action] = cb;
537 tabcb[item->i_action + 1] = NULL;
539 tabtext = realloc (item->ppsz_action_text,
540 (item->i_action + 2) * sizeof (name));
543 item->ppsz_action_text = tabtext;
548 tabtext[item->i_action] = strdup (dgettext (domain, name));
550 tabtext[item->i_action] = NULL;
551 tabtext[item->i_action + 1] = NULL;