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