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_CB_OPEN:
 184             module->pf_activate = va_arg (ap, int (*) (vlc_object_t *));
 185             break;
 186
 187         case VLC_MODULE_CB_CLOSE:
 188             module->pf_deactivate = va_arg (ap, void (*) (vlc_object_t *));
 189             break;
 190
 191         case VLC_MODULE_NO_UNLOAD:
 192             module->b_unloadable = false;
 193             break;
 194
 195         case VLC_MODULE_NAME:
 196         {
 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! */
 203             break;
 204         }
 205
 206         case VLC_MODULE_SHORTNAME:
 207         {
 208             const char *domain = va_arg (ap, const char *);
 209             if (domain == NULL)
 210                 domain = PACKAGE;
 211             module->psz_shortname = dgettext (domain, va_arg (ap, char *));
 212             break;
 213         }
 214
 215         case VLC_MODULE_DESCRIPTION:
 216         {
 217             const char *domain = va_arg (ap, const char *);
 218             if (domain == NULL)
 219                 domain = PACKAGE;
 220             module->psz_longname = dgettext (domain, va_arg (ap, char *));
 221             break;
 222         }
 223
 224         case VLC_MODULE_HELP:
 225         {
 226             const char *domain = va_arg (ap, const char *);
 227             if (domain == NULL)
 228                 domain = PACKAGE;
 229             module->psz_help = dgettext (domain, va_arg (ap, char *));
 230             break;
 231         }
 232
 233         default:
 234             fprintf (stderr, "LibVLC: unknown module property %d", propid);
 235             fprintf (stderr, "LibVLC: too old to use this module?");
 236             ret = VLC_EGENERIC;
 237             break;
 238     }
 239     va_end (ap);
 240     return ret;
 241 }
 242
 243 module_config_t *vlc_config_create (module_t *module, int type)
 244 {
 245     unsigned confsize = module->confsize;
 246     module_config_t *tab = module->p_config;
 247
 248     if ((confsize & 0xf) == 0)
 249     {
 250         tab = realloc (tab, (confsize + 17) * sizeof (*tab));
 251         if (tab == NULL)
 252             return NULL;
 253
 254         module->p_config = tab;
 255     }
 256
 257     memset (tab + confsize, 0, sizeof (tab[confsize]));
 258     tab[confsize].i_type = type;
 259     tab[confsize].p_lock = &module->lock;
 260
 261     if (type & CONFIG_ITEM)
 262     {
 263         module->i_config_items++;
 264         if (type == CONFIG_ITEM_BOOL)
 265             module->i_bool_items++;
 266     }
 267
 268     module->confsize++;
 269     return tab + confsize;
 270 }
 271
 272 int vlc_config_set (module_config_t *restrict item, int id, ...)
 273 {
 274     int ret = -1;
 275     va_list ap;
 276
 277     assert (item != NULL);
 278     va_start (ap, id);
 279
 280     switch (id)
 281     {
 282         case VLC_CONFIG_NAME:
 283         {
 284             const char *name = va_arg (ap, const char *);
 285             vlc_callback_t cb = va_arg (ap, vlc_callback_t);
 286
 287             assert (name != NULL);
 288             item->psz_name = strdup (name);
 289             item->pf_callback = cb;
 290             ret = 0;
 291             break;
 292         }
 293
 294         case VLC_CONFIG_DESC_NODOMAIN:
 295         {
 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);
 299             break;
 300         }
 301
 302         case VLC_CONFIG_VALUE:
 303         {
 304             if (IsConfigIntegerType (item->i_type))
 305             {
 306                 item->orig.i = item->saved.i =
 307                 item->value.i = va_arg (ap, int);
 308                 ret = 0;
 309             }
 310             else
 311             if (IsConfigFloatType (item->i_type))
 312             {
 313                 item->orig.f = item->saved.f =
 314                 item->value.f = va_arg (ap, double);
 315                 ret = 0;
 316             }
 317             else
 318             if (IsConfigStringType (item->i_type))
 319             {
 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;
 324                 ret = 0;
 325             }
 326             break;
 327         }
 328
 329         case VLC_CONFIG_RANGE:
 330         {
 331             if (IsConfigIntegerType (item->i_type))
 332             {
 333                 item->min.i = va_arg (ap, int);
 334                 item->max.i = va_arg (ap, int);
 335                 ret = 0;
 336             }
 337             else
 338             if (IsConfigFloatType (item->i_type))
 339             {
 340                 item->min.f = va_arg (ap, double);
 341                 item->max.f = va_arg (ap, double);
 342                 ret = 0;
 343             }
 344             break;
 345         }
 346
 347         case VLC_CONFIG_ADVANCED:
 348             item->b_advanced = true;
 349             ret = 0;
 350             break;
 351
 352         case VLC_CONFIG_VOLATILE:
 353             item->b_unsaveable = true;
 354             ret = 0;
 355             break;
 356
 357         case VLC_CONFIG_PERSISTENT:
 358             item->b_autosave = true;
 359             ret = 0;
 360             break;
 361
 362         case VLC_CONFIG_RESTART:
 363             item->b_restart = true;
 364             ret = 0;
 365             break;
 366
 367         case VLC_CONFIG_PRIVATE:
 368             item->b_internal = true;
 369             ret = 0;
 370             break;
 371
 372         case VLC_CONFIG_REMOVED:
 373             item->b_removed = true;
 374             ret = 0;
 375             break;
 376
 377         case VLC_CONFIG_CAPABILITY:
 378         {
 379             const char *cap = va_arg (ap, const char *);
 380             item->psz_type = cap ? strdup (cap) : NULL;
 381             ret = 0;
 382             break;
 383         }
 384
 385         case VLC_CONFIG_SHORTCUT:
 386             item->i_short = va_arg (ap, int);
 387             ret = 0;
 388             break;
 389
 390         case VLC_CONFIG_LIST_NODOMAIN:
 391         {
 392             size_t len = va_arg (ap, size_t);
 393             if (IsConfigIntegerType (item->i_type))
 394             {
 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,
 398                                       text);
 399             }
 400             else
 401             if (IsConfigStringType (item->i_type))
 402             {
 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,
 406                                       text);
 407             }
 408             break;
 409         }
 410
 411         case VLC_CONFIG_ADD_ACTION_NODOMAIN:
 412         {
 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);
 416             break;
 417         }
 418
 419         case VLC_CONFIG_OLDNAME:
 420         {
 421             const char *oldname = va_arg (ap, const char *);
 422             item->psz_oldname = oldname ? strdup (oldname) : NULL;
 423             ret = 0;
 424             break;
 425         }
 426
 427         case VLC_CONFIG_SAFE:
 428             item->b_safe = true;
 429             ret = 0;
 430             break;
 431
 432         case VLC_CONFIG_DESC:
 433         {
 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 *);
 437
 438             if (domain == NULL)
 439                 domain = PACKAGE;
 440             item->psz_text = text ? strdup (dgettext (domain, text)) : NULL;
 441             item->psz_longtext =
 442                 longtext ? strdup (dgettext (domain, longtext)) : NULL;
 443             ret = 0;
 444             break;
 445         }
 446
 447         case VLC_CONFIG_LIST:
 448         {
 449             const char *domain = va_arg (ap, const char *);
 450             size_t len = va_arg (ap, size_t);
 451
 452             /* Copy values */
 453             if (IsConfigIntegerType (item->i_type))
 454             {
 455                 const int *src = va_arg (ap, const int *);
 456                 int *dst = malloc (sizeof (int) * (len + 1));
 457
 458                 if (dst != NULL)
 459                 {
 460                     memcpy (dst, src, sizeof (int) * len);
 461                     dst[len] = 0;
 462                 }
 463                 item->pi_list = dst;
 464             }
 465             else
 466 #if 0
 467             if (IsConfigFloatType (item->i_type))
 468             {
 469                 const float *src = va_arg (ap, const float *);
 470                 float *dst = malloc (sizeof (float) * (len + 1));
 471
 472                 if (dst != NULL)
 473                 {
 474                     memcpy (dst, src, sizeof (float) * len);
 475                     dst[len] = 0.;
 476                 }
 477                 item->pf_list = dst;
 478             }
 479             else
 480 #endif
 481             if (IsConfigStringType (item->i_type))
 482             {
 483                 const char *const *src = va_arg (ap, const char *const *);
 484                 char **dst = malloc (sizeof (char *) * (len + 1));
 485
 486                 if (dst != NULL)
 487                 {
 488                     for (size_t i = 0; i < len; i++)
 489                         dst[i] = src[i] ? strdup (src[i]) : NULL;
 490                     dst[len] = NULL;
 491                 }
 492                 item->ppsz_list = dst;
 493             }
 494             else
 495                 break;
 496
 497             /* Copy textual descriptions */
 498             if (domain == NULL)
 499                 domain = PACKAGE;
 500
 501             const char *const *text = va_arg (ap, const char *const *);
 502             if (text != NULL)
 503             {
 504                 char **dtext = malloc (sizeof (char *) * (len + 1));
 505                 if( dtext != NULL )
 506                 {
 507                     for (size_t i = 0; i < len; i++)
 508                         dtext[i] = text[i] ?
 509                                         strdup( dgettext( domain, text[i] ) ) :
 510                                         NULL;
 511                     dtext[len] = NULL;
 512                 }
 513                 item->ppsz_list_text = dtext;
 514             }
 515             else
 516                 item->ppsz_list_text = NULL;
 517
 518             item->i_list = len;
 519             item->pf_update_list = va_arg (ap, vlc_callback_t);
 520             ret = 0;
 521             break;
 522         }
 523
 524         case VLC_CONFIG_ADD_ACTION:
 525         {
 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 *);
 529             char **tabtext;
 530
 531             tabcb = realloc (item->ppf_action,
 532                              (item->i_action + 2) * sizeof (cb));
 533             if (tabcb == NULL)
 534                 break;
 535             item->ppf_action = tabcb;
 536             tabcb[item->i_action] = cb;
 537             tabcb[item->i_action + 1] = NULL;
 538
 539             tabtext = realloc (item->ppsz_action_text,
 540                                (item->i_action + 2) * sizeof (name));
 541             if (tabtext == NULL)
 542                 break;
 543             item->ppsz_action_text = tabtext;
 544
 545             if (domain == NULL)
 546                 domain = PACKAGE;
 547             if (name)
 548                 tabtext[item->i_action] = strdup (dgettext (domain, name));
 549             else
 550                 tabtext[item->i_action] = NULL;
 551             tabtext[item->i_action + 1] = NULL;
 552
 553             item->i_action++;
 554             ret = 0;
 555             break;
 556         }
 557     }
 558
 559     va_end (ap);
 560     return ret;
 561 }