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 = malloc (sizeof (*submodule));
102 if (submodule == NULL)
105 memset (submodule, 0, sizeof (*submodule));
106 vlc_gc_init (submodule, vlc_submodule_destruct);
108 submodule->next = module->submodule;
109 submodule->parent = module;
110 module->submodule = submodule;
111 module->submodule_count++;
113 /* Muahahaha! Heritage! Polymorphism! Ugliness!! */
114 memcpy (submodule->pp_shortcuts, module->pp_shortcuts,
115 sizeof (submodule->pp_shortcuts));
117 submodule->psz_object_name = strdup( module->psz_object_name );
118 submodule->psz_shortname = module->psz_shortname;
119 submodule->psz_longname = module->psz_longname;
120 submodule->psz_capability = module->psz_capability;
121 submodule->i_score = module->i_score;
122 submodule->i_cpu = module->i_cpu;
123 submodule->b_submodule = true;
128 int vlc_module_set (module_t *module, int propid, ...)
131 int ret = VLC_SUCCESS;
133 va_start (ap, propid);
136 case VLC_MODULE_CPU_REQUIREMENT:
137 assert (!module->b_submodule);
138 module->i_cpu |= va_arg (ap, int);
141 case VLC_MODULE_SHORTCUT:
144 for (i = 0; module->pp_shortcuts[i] != NULL; i++);
145 if (i >= (MODULE_SHORTCUT_MAX - 1))
151 module->pp_shortcuts[i] = va_arg (ap, char *);
155 case VLC_MODULE_SHORTNAME_NODOMAIN:
157 const char *name = va_arg (ap, char *);
158 ret = vlc_module_set (module, VLC_MODULE_SHORTNAME, NULL, name);
162 case VLC_MODULE_DESCRIPTION_NODOMAIN:
164 const char *desc = va_arg (ap, char *);
165 ret = vlc_module_set (module, VLC_MODULE_DESCRIPTION, NULL, desc);
169 case VLC_MODULE_HELP_NODOMAIN:
171 const char *help = va_arg (ap, char *);
172 ret = vlc_module_set (module, VLC_MODULE_HELP, NULL, help);
176 case VLC_MODULE_CAPABILITY:
177 module->psz_capability = va_arg (ap, char *);
180 case VLC_MODULE_SCORE:
181 module->i_score = va_arg (ap, int);
184 case VLC_MODULE_PROGRAM:
185 fprintf (stderr, "deprecated module property %d", propid);
188 case VLC_MODULE_CB_OPEN:
189 module->pf_activate = va_arg (ap, int (*) (vlc_object_t *));
192 case VLC_MODULE_CB_CLOSE:
193 module->pf_deactivate = va_arg (ap, void (*) (vlc_object_t *));
196 case VLC_MODULE_NO_UNLOAD:
197 module->b_unloadable = false;
200 case VLC_MODULE_NAME:
202 const char *value = va_arg (ap, const char *);
203 free( module->psz_object_name );
204 module->psz_object_name = strdup( value );
205 module->pp_shortcuts[0] = (char*)value; /* dooh! */
206 if (module->psz_longname == default_name)
207 module->psz_longname = (char*)value; /* dooh! */
211 case VLC_MODULE_SHORTNAME:
213 const char *domain = va_arg (ap, const char *);
216 module->psz_shortname = dgettext (domain, va_arg (ap, char *));
220 case VLC_MODULE_DESCRIPTION:
222 const char *domain = va_arg (ap, const char *);
225 module->psz_longname = dgettext (domain, va_arg (ap, char *));
229 case VLC_MODULE_HELP:
231 const char *domain = va_arg (ap, const char *);
234 module->psz_help = dgettext (domain, va_arg (ap, char *));
239 fprintf (stderr, "LibVLC: unknown module property %d", propid);
240 fprintf (stderr, "LibVLC: too old to use this module?");
248 module_config_t *vlc_config_create (module_t *module, int type)
250 unsigned confsize = module->confsize;
251 module_config_t *tab = module->p_config;
253 if ((confsize & 0xf) == 0)
255 tab = realloc (tab, (confsize + 17) * sizeof (*tab));
259 module->p_config = tab;
262 memset (tab + confsize, 0, sizeof (tab[confsize]));
263 tab[confsize].i_type = type;
264 tab[confsize].p_lock = &module->lock;
266 if (type & CONFIG_ITEM)
268 module->i_config_items++;
269 if (type == CONFIG_ITEM_BOOL)
270 module->i_bool_items++;
274 return tab + confsize;
277 int vlc_config_set (module_config_t *restrict item, int id, ...)
282 assert (item != NULL);
287 case VLC_CONFIG_NAME:
289 const char *name = va_arg (ap, const char *);
290 vlc_callback_t cb = va_arg (ap, vlc_callback_t);
292 assert (name != NULL);
293 item->psz_name = strdup (name);
294 item->pf_callback = cb;
299 case VLC_CONFIG_DESC_NODOMAIN:
301 const char *text = va_arg (ap, const char *);
302 const char *longtext = va_arg (ap, const char *);
303 ret = vlc_config_set (item, VLC_CONFIG_DESC, NULL, text, longtext);
307 case VLC_CONFIG_VALUE:
309 if (IsConfigIntegerType (item->i_type))
311 item->orig.i = item->saved.i =
312 item->value.i = va_arg (ap, int);
316 if (IsConfigFloatType (item->i_type))
318 item->orig.f = item->saved.f =
319 item->value.f = va_arg (ap, double);
323 if (IsConfigStringType (item->i_type))
325 const char *value = va_arg (ap, const char *);
326 item->value.psz = value ? strdup (value) : NULL;
327 item->orig.psz = value ? strdup (value) : NULL;
328 item->saved.psz = value ? strdup (value) : NULL;
334 case VLC_CONFIG_RANGE:
336 if (IsConfigIntegerType (item->i_type))
338 item->min.i = va_arg (ap, int);
339 item->max.i = va_arg (ap, int);
343 if (IsConfigFloatType (item->i_type))
345 item->min.f = va_arg (ap, double);
346 item->max.f = va_arg (ap, double);
352 case VLC_CONFIG_ADVANCED:
353 item->b_advanced = true;
357 case VLC_CONFIG_VOLATILE:
358 item->b_unsaveable = true;
362 case VLC_CONFIG_PERSISTENT:
363 item->b_autosave = true;
367 case VLC_CONFIG_RESTART:
368 item->b_restart = true;
372 case VLC_CONFIG_PRIVATE:
373 item->b_internal = true;
377 case VLC_CONFIG_REMOVED:
378 item->b_removed = true;
382 case VLC_CONFIG_CAPABILITY:
384 const char *cap = va_arg (ap, const char *);
385 item->psz_type = cap ? strdup (cap) : NULL;
390 case VLC_CONFIG_SHORTCUT:
391 item->i_short = va_arg (ap, int);
395 case VLC_CONFIG_LIST_NODOMAIN:
397 size_t len = va_arg (ap, size_t);
398 if (IsConfigIntegerType (item->i_type))
400 const int *src = va_arg (ap, const int *);
401 const char *const *text = va_arg (ap, const char *const *);
402 ret = vlc_config_set (item, VLC_CONFIG_LIST, NULL, len, src,
406 if (IsConfigStringType (item->i_type))
408 const char *const *src = va_arg (ap, const char *const *);
409 const char *const *text = va_arg (ap, const char *const *);
410 ret = vlc_config_set (item, VLC_CONFIG_LIST, NULL, len, src,
416 case VLC_CONFIG_ADD_ACTION_NODOMAIN:
418 vlc_callback_t cb = va_arg (ap, vlc_callback_t);
419 const char *name = va_arg (ap, const char *);
420 ret = vlc_config_set (item, VLC_CONFIG_ADD_ACTION, NULL, cb, name);
424 case VLC_CONFIG_OLDNAME:
426 const char *oldname = va_arg (ap, const char *);
427 item->psz_oldname = oldname ? strdup (oldname) : NULL;
432 case VLC_CONFIG_SAFE:
437 case VLC_CONFIG_DESC:
439 const char *domain = va_arg (ap, const char *);
440 const char *text = va_arg (ap, const char *);
441 const char *longtext = va_arg (ap, const char *);
445 item->psz_text = text ? strdup (dgettext (domain, text)) : NULL;
447 longtext ? strdup (dgettext (domain, longtext)) : NULL;
452 case VLC_CONFIG_LIST:
454 const char *domain = va_arg (ap, const char *);
455 size_t len = va_arg (ap, size_t);
458 if (IsConfigIntegerType (item->i_type))
460 const int *src = va_arg (ap, const int *);
461 int *dst = malloc (sizeof (int) * (len + 1));
465 memcpy (dst, src, sizeof (int) * len);
472 if (IsConfigFloatType (item->i_type))
474 const float *src = va_arg (ap, const float *);
475 float *dst = malloc (sizeof (float) * (len + 1));
479 memcpy (dst, src, sizeof (float) * len);
486 if (IsConfigStringType (item->i_type))
488 const char *const *src = va_arg (ap, const char *const *);
489 char **dst = malloc (sizeof (char *) * (len + 1));
493 for (size_t i = 0; i < len; i++)
494 dst[i] = src[i] ? strdup (src[i]) : NULL;
497 item->ppsz_list = dst;
502 /* Copy textual descriptions */
506 const char *const *text = va_arg (ap, const char *const *);
509 char **dtext = malloc (sizeof (char *) * (len + 1));
512 for (size_t i = 0; i < len; i++)
514 strdup( dgettext( domain, text[i] ) ) :
518 item->ppsz_list_text = dtext;
521 item->ppsz_list_text = NULL;
524 item->pf_update_list = va_arg (ap, vlc_callback_t);
529 case VLC_CONFIG_ADD_ACTION:
531 const char *domain = va_arg (ap, const char *);
532 vlc_callback_t cb = va_arg (ap, vlc_callback_t), *tabcb;
533 const char *name = va_arg (ap, const char *);
536 tabcb = realloc (item->ppf_action,
537 (item->i_action + 2) * sizeof (cb));
540 item->ppf_action = tabcb;
541 tabcb[item->i_action] = cb;
542 tabcb[item->i_action + 1] = NULL;
544 tabtext = realloc (item->ppsz_action_text,
545 (item->i_action + 2) * sizeof (name));
548 item->ppsz_action_text = tabtext;
553 tabtext[item->i_action] = strdup (dgettext (domain, name));
555 tabtext[item->i_action] = NULL;
556 tabtext[item->i_action + 1] = NULL;