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>
35 #include "modules/modules.h"
36 #include "config/configuration.h"
39 static const char *mdgettext (const char *domain, const char *msg)
43 if (*msg) /* Do not translate ""! */
44 return dgettext (domain, msg);
51 static void vlc_module_destruct (gc_object_t *obj)
53 module_t *module = vlc_priv (obj, module_t);
55 vlc_mutex_destroy (&module->lock);
56 free (module->psz_object_name);
60 static const char default_name[] = "unnamed";
62 module_t *vlc_module_create (vlc_object_t *obj)
64 module_t *module = malloc (sizeof (*module));
68 module->psz_object_name = strdup( default_name );
70 module->submodule = NULL;
71 module->parent = NULL;
72 module->submodule_count = 0;
73 vlc_gc_init (module, vlc_module_destruct);
74 vlc_mutex_init (&module->lock);
76 module->psz_shortname = NULL;
77 module->psz_longname = (char*)default_name;
78 module->psz_help = NULL;
79 for (unsigned i = 0; i < MODULE_SHORTCUT_MAX; i++)
80 module->pp_shortcuts[i] = NULL;
81 module->psz_capability = (char*)"";
84 module->b_unloadable = true;
85 module->b_reentrant = true;
86 module->b_submodule = false;
87 module->pf_activate = NULL;
88 module->pf_deactivate = NULL;
89 module->p_config = NULL;
91 module->i_config_items = 0;
92 module->i_bool_items = 0;
93 /*module->handle = garbage */
94 module->psz_filename = NULL;
95 module->b_builtin = false;
96 module->b_loaded = false;
103 static void vlc_submodule_destruct (gc_object_t *obj)
105 module_t *module = vlc_priv (obj, module_t);
106 free (module->psz_object_name);
110 module_t *vlc_submodule_create (module_t *module)
112 assert (module != NULL);
114 module_t *submodule = calloc( 1, sizeof(*submodule) );
118 vlc_gc_init (submodule, vlc_submodule_destruct);
120 submodule->next = module->submodule;
121 submodule->parent = module;
122 module->submodule = submodule;
123 module->submodule_count++;
125 /* Muahahaha! Heritage! Polymorphism! Ugliness!! */
126 submodule->pp_shortcuts[0] = module->pp_shortcuts[0]; /* object name */
127 for (unsigned i = 1; i < MODULE_SHORTCUT_MAX; i++)
128 submodule->pp_shortcuts[i] = NULL;
130 submodule->psz_object_name = strdup( module->psz_object_name );
131 submodule->psz_shortname = module->psz_shortname;
132 submodule->psz_longname = module->psz_longname;
133 submodule->psz_capability = module->psz_capability;
134 submodule->i_score = module->i_score;
135 submodule->i_cpu = module->i_cpu;
136 submodule->b_submodule = true;
140 static module_config_t *vlc_config_create (module_t *module, int type)
142 unsigned confsize = module->confsize;
143 module_config_t *tab = module->p_config;
145 if ((confsize & 0xf) == 0)
147 tab = realloc (tab, (confsize + 17) * sizeof (*tab));
151 module->p_config = tab;
154 memset (tab + confsize, 0, sizeof (tab[confsize]));
155 tab[confsize].i_type = type;
156 tab[confsize].p_lock = &module->lock;
158 if (type & CONFIG_ITEM)
160 module->i_config_items++;
161 if (type == CONFIG_ITEM_BOOL)
162 module->i_bool_items++;
166 return tab + confsize;
170 int vlc_plugin_set (module_t *module, module_config_t *item, int propid, ...)
175 va_start (ap, propid);
178 case VLC_SUBMODULE_CREATE:
180 module_t **pp = va_arg (ap, module_t **);
181 *pp = vlc_submodule_create (module);
187 case VLC_CONFIG_CREATE:
189 int type = va_arg (ap, int);
190 module_config_t **pp = va_arg (ap, module_config_t **);
191 *pp = vlc_config_create (module, type);
197 case VLC_MODULE_CPU_REQUIREMENT:
198 assert (!module->b_submodule);
199 module->i_cpu |= va_arg (ap, int);
202 case VLC_MODULE_SHORTCUT:
205 for (i = 0; module->pp_shortcuts[i] != NULL; i++);
206 if (i >= (MODULE_SHORTCUT_MAX - 1))
209 module->pp_shortcuts[i] = va_arg (ap, char *);
213 case VLC_MODULE_CAPABILITY:
214 module->psz_capability = va_arg (ap, char *);
217 case VLC_MODULE_SCORE:
218 module->i_score = va_arg (ap, int);
221 case VLC_MODULE_CB_OPEN:
222 module->pf_activate = va_arg (ap, int (*) (vlc_object_t *));
225 case VLC_MODULE_CB_CLOSE:
226 module->pf_deactivate = va_arg (ap, void (*) (vlc_object_t *));
229 case VLC_MODULE_NO_UNLOAD:
230 module->b_unloadable = false;
233 case VLC_MODULE_NAME:
235 const char *value = va_arg (ap, const char *);
236 free( module->psz_object_name );
237 module->psz_object_name = strdup( value );
238 module->pp_shortcuts[0] = (char*)value; /* dooh! */
239 if (module->psz_longname == default_name)
240 module->psz_longname = (char*)value; /* dooh! */
244 case VLC_MODULE_SHORTNAME:
246 const char *domain = va_arg (ap, const char *);
249 module->psz_shortname = mdgettext (domain, va_arg (ap, char *));
253 case VLC_MODULE_DESCRIPTION:
255 const char *domain = va_arg (ap, const char *);
258 module->psz_longname = mdgettext (domain, va_arg (ap, char *));
262 case VLC_MODULE_HELP:
264 const char *domain = va_arg (ap, const char *);
267 module->psz_help = mdgettext (domain, va_arg (ap, char *));
271 case VLC_CONFIG_NAME:
273 const char *name = va_arg (ap, const char *);
274 vlc_callback_t cb = va_arg (ap, vlc_callback_t);
276 assert (name != NULL);
277 item->psz_name = strdup (name);
278 item->pf_callback = cb;
282 case VLC_CONFIG_VALUE:
284 if (IsConfigIntegerType (item->i_type))
286 item->orig.i = item->saved.i =
287 item->value.i = va_arg (ap, int);
290 if (IsConfigFloatType (item->i_type))
292 item->orig.f = item->saved.f =
293 item->value.f = va_arg (ap, double);
296 if (IsConfigStringType (item->i_type))
298 const char *value = va_arg (ap, const char *);
299 item->value.psz = value ? strdup (value) : NULL;
300 item->orig.psz = value ? strdup (value) : NULL;
301 item->saved.psz = value ? strdup (value) : NULL;
306 case VLC_CONFIG_RANGE:
308 if (IsConfigIntegerType (item->i_type)
309 || item->i_type == CONFIG_ITEM_MODULE_LIST_CAT
310 || item->i_type == CONFIG_ITEM_MODULE_CAT)
312 item->min.i = va_arg (ap, int);
313 item->max.i = va_arg (ap, int);
316 if (IsConfigFloatType (item->i_type))
318 item->min.f = va_arg (ap, double);
319 item->max.f = va_arg (ap, double);
324 case VLC_CONFIG_ADVANCED:
325 item->b_advanced = true;
328 case VLC_CONFIG_VOLATILE:
329 item->b_unsaveable = true;
332 case VLC_CONFIG_PERSISTENT:
333 item->b_autosave = true;
336 case VLC_CONFIG_RESTART:
337 item->b_restart = true;
340 case VLC_CONFIG_PRIVATE:
341 item->b_internal = true;
344 case VLC_CONFIG_REMOVED:
345 item->b_removed = true;
348 case VLC_CONFIG_CAPABILITY:
350 const char *cap = va_arg (ap, const char *);
351 item->psz_type = cap ? strdup (cap) : NULL;
355 case VLC_CONFIG_SHORTCUT:
356 item->i_short = va_arg (ap, int);
359 case VLC_CONFIG_OLDNAME:
361 const char *oldname = va_arg (ap, const char *);
362 item->psz_oldname = oldname ? strdup (oldname) : NULL;
366 case VLC_CONFIG_SAFE:
370 case VLC_CONFIG_DESC:
372 const char *domain = va_arg (ap, const char *);
373 const char *text = va_arg (ap, const char *);
374 const char *longtext = va_arg (ap, const char *);
378 item->psz_text = text ? strdup (mdgettext (domain, text)) : NULL;
380 longtext ? strdup (mdgettext (domain, longtext)) : NULL;
384 case VLC_CONFIG_LIST:
386 const char *domain = va_arg (ap, const char *);
387 size_t len = va_arg (ap, size_t);
390 if (IsConfigIntegerType (item->i_type))
392 const int *src = va_arg (ap, const int *);
393 int *dst = malloc (sizeof (int) * (len + 1));
397 memcpy (dst, src, sizeof (int) * len);
403 if (IsConfigStringType (item->i_type))
405 const char *const *src = va_arg (ap, const char *const *);
406 char **dst = malloc (sizeof (char *) * (len + 1));
410 for (size_t i = 0; i < len; i++)
411 dst[i] = src[i] ? strdup (src[i]) : NULL;
414 item->ppsz_list = dst;
419 /* Copy textual descriptions */
423 const char *const *text = va_arg (ap, const char *const *);
426 char **dtext = malloc (sizeof (char *) * (len + 1));
429 for (size_t i = 0; i < len; i++)
431 strdup (mdgettext( domain, text[i] )) :
435 item->ppsz_list_text = dtext;
438 item->ppsz_list_text = NULL;
441 item->pf_update_list = va_arg (ap, vlc_callback_t);
445 case VLC_CONFIG_ADD_ACTION:
447 const char *domain = va_arg (ap, const char *);
448 vlc_callback_t cb = va_arg (ap, vlc_callback_t), *tabcb;
449 const char *name = va_arg (ap, const char *);
452 tabcb = realloc (item->ppf_action,
453 (item->i_action + 2) * sizeof (cb));
456 item->ppf_action = tabcb;
457 tabcb[item->i_action] = cb;
458 tabcb[item->i_action + 1] = NULL;
460 tabtext = realloc (item->ppsz_action_text,
461 (item->i_action + 2) * sizeof (name));
464 item->ppsz_action_text = tabtext;
469 tabtext[item->i_action] = strdup (mdgettext (domain, name));
471 tabtext[item->i_action] = NULL;
472 tabtext[item->i_action + 1] = NULL;
479 fprintf (stderr, "LibVLC: unknown module property %d\n", propid);
480 fprintf (stderr, "LibVLC: too old to use this module?\n");