git.sesse.net Git - vlc/blob - src/modules/entry.c

   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
   6  *
   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.
  11  *
  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.
  16  *
  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  *****************************************************************************/
  21
  22 #ifdef HAVE_CONFIG_H
  23 # include "config.h"
  24 #endif
  25
  26 #include <vlc_common.h>
  27 #include <vlc_plugin.h>
  28 #include <assert.h>
  29 #include <stdarg.h>
  30
  31 #include "modules/modules.h"
  32 #include "config/configuration.h"
  33 #include "libvlc.h"
  34 #ifndef ENABLE_NLS
  35 # define dgettext(d, m) ((char *)(m))
  36 #endif
  37
  38 static void vlc_module_destruct (gc_object_t *obj)
  39 {
  40     module_t *module = vlc_priv (obj, module_t);
  41
  42     vlc_mutex_destroy (&module->lock);
  43     free (module->psz_object_name);
  44     free (module);
  45 }
  46
  47 static const char default_name[] = "unnamed";
  48
  49 module_t *vlc_module_create (vlc_object_t *obj)
  50 {
  51     module_t *module = malloc (sizeof (*module));
  52     if (module == NULL)
  53         return NULL;
  54
  55     module->psz_object_name = strdup( default_name );
  56     module->next = NULL;
  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);
  62
  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*)"";
  69     module->i_score = 1;
  70     module->i_cpu = 0;
  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;
  77     module->confsize = 0;
  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;
  84
  85     (void)obj;
  86     return module;
  87 }
  88
  89
  90 static void vlc_submodule_destruct (gc_object_t *obj)
  91 {
  92     module_t *module = vlc_priv (obj, module_t);
  93     free (module->psz_object_name);
  94     free (module);
  95 }
  96
  97 module_t *vlc_submodule_create (module_t *module)
  98 {
  99     assert (module != NULL);
 100
 101     module_t *submodule = malloc (sizeof (*submodule));
 102     if (submodule == NULL)
 103         return NULL;
 104
 105     memset (submodule, 0, sizeof (*submodule));
 106     vlc_gc_init (submodule, vlc_submodule_destruct);
 107
 108     submodule->next = module->submodule;
 109     submodule->parent = module;
 110     module->submodule = submodule;
 111     module->submodule_count++;
 112
 113     /* Muahahaha! Heritage! Polymorphism! Ugliness!! */
 114     memcpy (submodule->pp_shortcuts, module->pp_shortcuts,
 115             sizeof (submodule->pp_shortcuts));
 116
 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;
 124     return submodule;
 125 }
 126
 127
 128 int vlc_module_set (module_t *module, int propid, ...)
 129 {
 130     va_list ap;
 131     int ret = VLC_SUCCESS;
 132
 133     va_start (ap, propid);
 134     switch (propid)
 135     {
 136         case VLC_MODULE_CPU_REQUIREMENT:
 137             assert (!module->b_submodule);
 138             module->i_cpu |= va_arg (ap, int);
 139             break;
 140
 141         case VLC_MODULE_SHORTCUT:
 142         {
 143             unsigned i;
 144             for (i = 0; module->pp_shortcuts[i] != NULL; i++);
 145             if (i >= (MODULE_SHORTCUT_MAX - 1))
 146             {
 147                 ret = VLC_ENOMEM;
 148                 break;
 149             }
 150
 151             module->pp_shortcuts[i] = va_arg (ap, char *);
 152             break;
 153         }
 154
 155         case VLC_MODULE_SHORTNAME_NODOMAIN:
 156         {
 157             const char *name = va_arg (ap, char *);
 158             ret = vlc_module_set (module, VLC_MODULE_SHORTNAME, NULL, name);
 159             break;
 160         }
 161
 162         case VLC_MODULE_DESCRIPTION_NODOMAIN:
 163         {
 164             const char *desc = va_arg (ap, char *);
 165             ret = vlc_module_set (module, VLC_MODULE_DESCRIPTION, NULL, desc);
 166             break;
 167         }
 168
 169         case VLC_MODULE_HELP_NODOMAIN:
 170         {
 171             const char *help = va_arg (ap, char *);
 172             ret = vlc_module_set (module, VLC_MODULE_HELP, NULL, help);
 173             break;
 174         }
 175
 176         case VLC_MODULE_CAPABILITY:
 177             module->psz_capability = va_arg (ap, char *);
 178             break;
 179
 180         case VLC_MODULE_SCORE:
 181             module->i_score = va_arg (ap, int);
 182             break;
 183
 184         case VLC_MODULE_PROGRAM:
 185             fprintf (stderr, "deprecated module property %d", propid);
 186             break;
 187
 188         case VLC_MODULE_CB_OPEN:
 189             module->pf_activate = va_arg (ap, int (*) (vlc_object_t *));
 190             break;
 191
 192         case VLC_MODULE_CB_CLOSE:
 193             module->pf_deactivate = va_arg (ap, void (*) (vlc_object_t *));
 194             break;
 195
 196         case VLC_MODULE_NO_UNLOAD:
 197             module->b_unloadable = false;
 198             break;
 199
 200         case VLC_MODULE_NAME:
 201         {
 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! */
 208             break;
 209         }
 210
 211         case VLC_MODULE_SHORTNAME:
 212         {
 213             const char *domain = va_arg (ap, const char *);
 214             if (domain == NULL)
 215                 domain = PACKAGE;
 216             module->psz_shortname = dgettext (domain, va_arg (ap, char *));
 217             break;
 218         }
 219
 220         case VLC_MODULE_DESCRIPTION:
 221         {
 222             const char *domain = va_arg (ap, const char *);
 223             if (domain == NULL)
 224                 domain = PACKAGE;
 225             module->psz_longname = dgettext (domain, va_arg (ap, char *));
 226             break;
 227         }
 228
 229         case VLC_MODULE_HELP:
 230         {
 231             const char *domain = va_arg (ap, const char *);
 232             if (domain == NULL)
 233                 domain = PACKAGE;
 234             module->psz_help = dgettext (domain, va_arg (ap, char *));
 235             break;
 236         }
 237
 238         default:
 239             fprintf (stderr, "LibVLC: unknown module property %d", propid);
 240             fprintf (stderr, "LibVLC: too old to use this module?");
 241             ret = VLC_EGENERIC;
 242             break;
 243     }
 244     va_end (ap);
 245     return ret;
 246 }
 247
 248 module_config_t *vlc_config_create (module_t *module, int type)
 249 {
 250     unsigned confsize = module->confsize;
 251     module_config_t *tab = module->p_config;
 252
 253     if ((confsize & 0xf) == 0)
 254     {
 255         tab = realloc (tab, (confsize + 17) * sizeof (*tab));
 256         if (tab == NULL)
 257             return NULL;
 258
 259         module->p_config = tab;
 260     }
 261
 262     memset (tab + confsize, 0, sizeof (tab[confsize]));
 263     tab[confsize].i_type = type;
 264     tab[confsize].p_lock = &module->lock;
 265
 266     if (type & CONFIG_ITEM)
 267     {
 268         module->i_config_items++;
 269         if (type == CONFIG_ITEM_BOOL)
 270             module->i_bool_items++;
 271     }
 272
 273     module->confsize++;
 274     return tab + confsize;
 275 }
 276
 277 int vlc_config_set (module_config_t *restrict item, int id, ...)
 278 {
 279     int ret = -1;
 280     va_list ap;
 281
 282     assert (item != NULL);
 283     va_start (ap, id);
 284
 285     switch (id)
 286     {
 287         case VLC_CONFIG_NAME:
 288         {
 289             const char *name = va_arg (ap, const char *);
 290             vlc_callback_t cb = va_arg (ap, vlc_callback_t);
 291
 292             assert (name != NULL);
 293             item->psz_name = strdup (name);
 294             item->pf_callback = cb;
 295             ret = 0;
 296             break;
 297         }
 298
 299         case VLC_CONFIG_DESC_NODOMAIN:
 300         {
 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);
 304             break;
 305         }
 306
 307         case VLC_CONFIG_VALUE:
 308         {
 309             if (IsConfigIntegerType (item->i_type))
 310             {
 311                 item->orig.i = item->saved.i =
 312                 item->value.i = va_arg (ap, int);
 313                 ret = 0;
 314             }
 315             else
 316             if (IsConfigFloatType (item->i_type))
 317             {
 318                 item->orig.f = item->saved.f =
 319                 item->value.f = va_arg (ap, double);
 320                 ret = 0;
 321             }
 322             else
 323             if (IsConfigStringType (item->i_type))
 324             {
 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;
 329                 ret = 0;
 330             }
 331             break;
 332         }
 333
 334         case VLC_CONFIG_RANGE:
 335         {
 336             if (IsConfigIntegerType (item->i_type))
 337             {
 338                 item->min.i = va_arg (ap, int);
 339                 item->max.i = va_arg (ap, int);
 340                 ret = 0;
 341             }
 342             else
 343             if (IsConfigFloatType (item->i_type))
 344             {
 345                 item->min.f = va_arg (ap, double);
 346                 item->max.f = va_arg (ap, double);
 347                 ret = 0;
 348             }
 349             break;
 350         }
 351
 352         case VLC_CONFIG_ADVANCED:
 353             item->b_advanced = true;
 354             ret = 0;
 355             break;
 356
 357         case VLC_CONFIG_VOLATILE:
 358             item->b_unsaveable = true;
 359             ret = 0;
 360             break;
 361
 362         case VLC_CONFIG_PERSISTENT:
 363             item->b_autosave = true;
 364             ret = 0;
 365             break;
 366
 367         case VLC_CONFIG_RESTART:
 368             item->b_restart = true;
 369             ret = 0;
 370             break;
 371
 372         case VLC_CONFIG_PRIVATE:
 373             item->b_internal = true;
 374             ret = 0;
 375             break;
 376
 377         case VLC_CONFIG_REMOVED:
 378             item->b_removed = true;
 379             ret = 0;
 380             break;
 381
 382         case VLC_CONFIG_CAPABILITY:
 383         {
 384             const char *cap = va_arg (ap, const char *);
 385             item->psz_type = cap ? strdup (cap) : NULL;
 386             ret = 0;
 387             break;
 388         }
 389
 390         case VLC_CONFIG_SHORTCUT:
 391             item->i_short = va_arg (ap, int);
 392             ret = 0;
 393             break;
 394
 395         case VLC_CONFIG_LIST_NODOMAIN:
 396         {
 397             size_t len = va_arg (ap, size_t);
 398             if (IsConfigIntegerType (item->i_type))
 399             {
 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,
 403                                       text);
 404             }
 405             else
 406             if (IsConfigStringType (item->i_type))
 407             {
 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,
 411                                       text);
 412             }
 413             break;
 414         }
 415
 416         case VLC_CONFIG_ADD_ACTION_NODOMAIN:
 417         {
 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);
 421             break;
 422         }
 423
 424         case VLC_CONFIG_OLDNAME:
 425         {
 426             const char *oldname = va_arg (ap, const char *);
 427             item->psz_oldname = oldname ? strdup (oldname) : NULL;
 428             ret = 0;
 429             break;
 430         }
 431
 432         case VLC_CONFIG_SAFE:
 433             item->b_safe = true;
 434             ret = 0;
 435             break;
 436
 437         case VLC_CONFIG_DESC:
 438         {
 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 *);
 442
 443             if (domain == NULL)
 444                 domain = PACKAGE;
 445             item->psz_text = text ? strdup (dgettext (domain, text)) : NULL;
 446             item->psz_longtext =
 447                 longtext ? strdup (dgettext (domain, longtext)) : NULL;
 448             ret = 0;
 449             break;
 450         }
 451
 452         case VLC_CONFIG_LIST:
 453         {
 454             const char *domain = va_arg (ap, const char *);
 455             size_t len = va_arg (ap, size_t);
 456             char **dtext = malloc (sizeof (char *) * (len + 1));
 457
 458             if (dtext == NULL)
 459                 break;
 460
 461             /* Copy values */
 462             if (IsConfigIntegerType (item->i_type))
 463             {
 464                 const int *src = va_arg (ap, const int *);
 465                 int *dst = malloc (sizeof (int) * (len + 1));
 466
 467                 if (dst != NULL)
 468                 {
 469                     memcpy (dst, src, sizeof (int) * len);
 470                     dst[len] = 0;
 471                 }
 472                 item->pi_list = dst;
 473             }
 474             else
 475 #if 0
 476             if (IsConfigFloatType (item->i_type))
 477             {
 478                 const float *src = va_arg (ap, const float *);
 479                 float *dst = malloc (sizeof (float) * (len + 1));
 480
 481                 if (dst != NULL)
 482                 {
 483                     memcpy (dst, src, sizeof (float) * len);
 484                     dst[len] = 0.;
 485                 }
 486                 item->pf_list = dst;
 487             }
 488             else
 489 #endif
 490             if (IsConfigStringType (item->i_type))
 491             {
 492                 const char *const *src = va_arg (ap, const char *const *);
 493                 char **dst = malloc (sizeof (char *) * (len + 1));
 494
 495                 if (dst != NULL)
 496                 {
 497                     for (size_t i = 0; i < len; i++)
 498                         dst[i] = src[i] ? strdup (src[i]) : NULL;
 499                     dst[len] = NULL;
 500                 }
 501                 item->ppsz_list = dst;
 502             }
 503             else
 504                 break;
 505
 506             /* Copy textual descriptions */
 507             if (domain == NULL)
 508                 domain = PACKAGE;
 509
 510             const char *const *text = va_arg (ap, const char *const *);
 511             if (text != NULL)
 512             {
 513                 for (size_t i = 0; i < len; i++)
 514                     dtext[i] =
 515                         text[i] ? strdup (dgettext (domain, text[i])) : NULL;
 516
 517                 dtext[len] = NULL;
 518                 item->ppsz_list_text = dtext;
 519             }
 520             else
 521             {
 522                 free (dtext);
 523                 item->ppsz_list_text = NULL;
 524             }
 525
 526             item->i_list = len;
 527             item->pf_update_list = va_arg (ap, vlc_callback_t);
 528             ret = 0;
 529             break;
 530         }
 531
 532         case VLC_CONFIG_ADD_ACTION:
 533         {
 534             const char *domain = va_arg (ap, const char *);
 535             vlc_callback_t cb = va_arg (ap, vlc_callback_t), *tabcb;
 536             const char *name = va_arg (ap, const char *);
 537             char **tabtext;
 538
 539             tabcb = realloc (item->ppf_action,
 540                              (item->i_action + 2) * sizeof (cb));
 541             if (tabcb == NULL)
 542                 break;
 543             item->ppf_action = tabcb;
 544             tabcb[item->i_action] = cb;
 545             tabcb[item->i_action + 1] = NULL;
 546
 547             tabtext = realloc (item->ppsz_action_text,
 548                                (item->i_action + 2) * sizeof (name));
 549             if (tabtext == NULL)
 550                 break;
 551             item->ppsz_action_text = tabtext;
 552
 553             if (domain == NULL)
 554                 domain = PACKAGE;
 555             if (name)
 556                 tabtext[item->i_action] = strdup (dgettext (domain, name));
 557             else
 558                 tabtext[item->i_action] = NULL;
 559             tabtext[item->i_action + 1] = NULL;
 560
 561             item->i_action++;
 562             ret = 0;
 563             break;
 564         }
 565     }
 566
 567     va_end (ap);
 568     return ret;
 569 }