git.sesse.net Git - vlc/blob - include/vlc_modules.h

   1 /*****************************************************************************
   2  * modules.h : Module descriptor and load functions
   3  *****************************************************************************
   4  * Copyright (C) 2001 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #if !defined( __LIBVLC__ )
  25   #error You are not libvlc or one of its plugins. You cannot include this file
  26 #endif
  27
  28 /*****************************************************************************
  29  * Exported functions.
  30  *****************************************************************************/
  31 #define module_Need(a,b,c,d) __module_Need(VLC_OBJECT(a),b,c,d)
  32 VLC_EXPORT( module_t *, __module_Need, ( vlc_object_t *, const char *, const char *, vlc_bool_t ) );
  33 #define module_Unneed(a,b) __module_Unneed(VLC_OBJECT(a),b)
  34 VLC_EXPORT( void, __module_Unneed, ( vlc_object_t *, module_t * ) );
  35 #define module_Exists(a,b) __module_Exists(VLC_OBJECT(a),b)
  36 VLC_EXPORT( vlc_bool_t,  __module_Exists, ( vlc_object_t *, const char * ) );
  37
  38 /* Use only if you know what you're doing... */
  39 #define module_FindName(a,b) __module_FindName(VLC_OBJECT(a),b)
  40 VLC_EXPORT( module_t *, __module_FindName, ( vlc_object_t *, const char * ) );
  41 VLC_EXPORT( void, module_Put, ( module_t *module ) );
  42
  43 VLC_EXPORT( module_config_t *, module_GetConfig, ( const module_t *, unsigned * ) );
  44 VLC_EXPORT( void, module_PutConfig, ( module_config_t * ) );
  45
  46
  47 /* Return a NULL terminated array with the names of the modules that have a
  48  * certain capability.
  49  * Free after uses both the string and the table. */
  50  #define module_GetModulesNamesForCapability(a,b,c) \
  51                     __module_GetModulesNamesForCapability(VLC_OBJECT(a),b,c)
  52 VLC_EXPORT(char **, __module_GetModulesNamesForCapability,
  53                     ( vlc_object_t *p_this, const char * psz_capability,
  54                       char ***psz_longname ) );
  55
  56 VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) );
  57 VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) );
  58 VLC_EXPORT( int, vlc_module_set, (module_t *module, int propid, void *value) );
  59
  60 enum vlc_module_properties
  61 {
  62     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
  63      * Append new items at the end ONLY. */
  64     VLC_MODULE_CPU_REQUIREMENT,
  65     VLC_MODULE_SHORTCUT,
  66     VLC_MODULE_SHORTNAME,
  67     VLC_MODULE_DESCRIPTION,
  68     VLC_MODULE_HELP,
  69     VLC_MODULE_CAPABILITY,
  70     VLC_MODULE_SCORE,
  71     VLC_MODULE_PROGRAM,
  72     VLC_MODULE_CB_OPEN,
  73     VLC_MODULE_CB_CLOSE,
  74     VLC_MODULE_UNLOADABLE,
  75     VLC_MODULE_NAME
  76 };
  77
  78 VLC_EXPORT( vlc_bool_t, module_IsCapable, ( const module_t *m, const char *cap ) );
  79 VLC_EXPORT( const char *, module_GetObjName, ( const module_t *m ) );
  80 VLC_EXPORT( const char *, module_GetName, ( const module_t *m, vlc_bool_t long_name ) );
  81 #define module_GetLongName( m ) module_GetName( m, VLC_TRUE )
  82 VLC_EXPORT( const char *, module_GetHelp, ( const module_t *m ) );