home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 2009 June / maximum-cd-2009-06.iso / DiscContents / vlc-0.9.8a-win32.exe / sdk / include / vlc / plugins / vlc_modules.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-12-06  |  3.2 KB  |  73 lines
  1. /*****************************************************************************
  2.  * modules.h : Module descriptor and load functions
  3.  *****************************************************************************
  4.  * Copyright (C) 2001 the VideoLAN team
  5.  * $Id: 97023972974e47a077d4520b3813475c30c27da2 $
  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. VLC_EXPORT( void, module_Put, ( module_t *module ) );
  43.  
  44. VLC_EXPORT( module_config_t *, module_GetConfig, ( const module_t *, unsigned * ) );
  45. VLC_EXPORT( void, module_PutConfig, ( module_config_t * ) );
  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( bool, module_IsCapable, ( const module_t *m, const char *cap ) );
  57. VLC_EXPORT( const char *, module_GetObjName, ( const module_t *m ) );
  58. VLC_EXPORT( const char *, module_GetName, ( const module_t *m, bool long_name ) );
  59. #define module_GetLongName( m ) module_GetName( m, true )
  60. VLC_EXPORT( const char *, module_GetHelp, ( const module_t *m ) );
  61.  
  62.  
  63. #define module_GetMainModule(a) __module_GetMainModule(VLC_OBJECT(a))
  64. static inline module_t * __module_GetMainModule( vlc_object_t * p_this )
  65. {
  66.     return module_Find( p_this, "main" );
  67. }
  68.  
  69. static inline bool module_IsMainModule( const module_t * p_module )
  70. {
  71.     return !strcmp( module_GetObjName( p_module ), "main" );
  72. }
  73.