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 /**
  25  * \file
  26  * This file defines functions for modules in vlc
  27  */
  28
  29 /*****************************************************************************
  30  * Exported functions.
  31  *****************************************************************************/
  32
  33 #define module_need(a,b,c,d) __module_need(VLC_OBJECT(a),b,c,d)
  34 VLC_EXPORT( module_t *, __module_need, ( vlc_object_t *, const char *, const char *, bool ) );
  35 #define module_unneed(a,b) __module_unneed(VLC_OBJECT(a),b)
  36 VLC_EXPORT( void, __module_unneed, ( vlc_object_t *, module_t * ) );
  37 #define module_exists(a,b) __module_exists(VLC_OBJECT(a),b)
  38 VLC_EXPORT( bool,  __module_exists, ( vlc_object_t *, const char * ) );
  39
  40 #define module_find(a,b) __module_find(VLC_OBJECT(a),b)
  41 VLC_EXPORT( module_t *, __module_find, ( vlc_object_t *, const char * ) );
  42
  43 VLC_EXPORT( module_config_t *, module_config_get, ( const module_t *, unsigned * ) );
  44 VLC_EXPORT( void, module_config_free, ( module_config_t * ) );
  45
  46 VLC_EXPORT( module_t *, module_hold, (module_t *module) );
  47 VLC_EXPORT( void, module_release, (module_t *module) );
  48 VLC_EXPORT( void, module_list_free, (module_t **) );
  49 VLC_EXPORT( module_t **, module_list_get, (size_t *n) );
  50
  51 /* Return a NULL terminated array with the names of the modules that have a
  52  * certain capability.
  53  * Free after uses both the string and the table. */
  54  #define module_GetModulesNamesForCapability(a,b,c) \
  55                     __module_GetModulesNamesForCapability(VLC_OBJECT(a),b,c)
  56 VLC_EXPORT(char **, __module_GetModulesNamesForCapability,
  57                     ( vlc_object_t *p_this, const char * psz_capability,
  58                       char ***psz_longname ) );
  59
  60 VLC_EXPORT( bool, module_provides, ( const module_t *m, const char *cap ) );
  61 VLC_EXPORT( const char *, module_get_object, ( const module_t *m ) );
  62 VLC_EXPORT( const char *, module_get_name, ( const module_t *m, bool long_name ) );
  63 #define module_GetLongName( m ) module_get_name( m, true )
  64 VLC_EXPORT( const char *, module_get_help, ( const module_t *m ) );
  65
  66
  67 #define module_get_main(a) __module_get_main(VLC_OBJECT(a))
  68 static inline module_t * __module_get_main( vlc_object_t * p_this )
  69 {
  70     return module_find( p_this, "main" );
  71 }
  72
  73 static inline bool module_is_main( const module_t * p_module )
  74 {
  75     return !strcmp( module_get_object( p_module ), "main" );
  76 }