git.sesse.net Git - vlc/blob - plugins/dummy/dummy.c

   1 /*****************************************************************************
   2  * dummy.c : dummy plugin for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2000, 2001 VideoLAN
   5  *
   6  * Authors: Samuel Hocevar <sam@zoy.org>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  21  *****************************************************************************/
  22
  23 #define MODULE_NAME dummy
  24 #include "modules_inner.h"
  25
  26 /*****************************************************************************
  27  * Preamble
  28  *****************************************************************************/
  29 #include "defs.h"
  30
  31 #include <stdlib.h>                                      /* malloc(), free() */
  32
  33 #include "config.h"
  34 #include "common.h"                                     /* boolean_t, byte_t */
  35 #include "threads.h"
  36 #include "mtime.h"
  37
  38 #include "modules.h"
  39
  40 /*****************************************************************************
  41  * Build configuration tree.
  42  *****************************************************************************/
  43 MODULE_CONFIG_START
  44 ADD_WINDOW( "Configuration for dummy module" )
  45     ADD_COMMENT( "Ha, ha -- nothing to configure yet" )
  46 MODULE_CONFIG_END
  47
  48 /*****************************************************************************
  49  * Capabilities defined in the other files.
  50  *****************************************************************************/
  51 void _M( aout_getfunctions )( function_list_t * p_function_list );
  52 void _M( vout_getfunctions )( function_list_t * p_function_list );
  53 void _M( intf_getfunctions )( function_list_t * p_function_list );
  54
  55 /*****************************************************************************
  56  * InitModule: get the module structure and configuration.
  57  *****************************************************************************
  58  * We have to fill psz_name, psz_longname and psz_version. These variables
  59  * will be strdup()ed later by the main application because the module can
  60  * be unloaded later to save memory, and we want to be able to access this
  61  * data even after the module has been unloaded.
  62  *****************************************************************************/
  63 MODULE_INIT
  64 {
  65     p_module->psz_name = MODULE_STRING;
  66     p_module->psz_longname = "dummy functions module";
  67     p_module->psz_version = VERSION;
  68
  69     p_module->i_capabilities = MODULE_CAPABILITY_NULL
  70                                 | MODULE_CAPABILITY_AOUT
  71                                 | MODULE_CAPABILITY_VOUT
  72                                 | MODULE_CAPABILITY_INTF;
  73
  74     return( 0 );
  75 }
  76
  77 /*****************************************************************************
  78  * ActivateModule: set the module to an usable state.
  79  *****************************************************************************
  80  * This function fills the capability functions and the configuration
  81  * structure. Once ActivateModule() has been called, the i_usage can
  82  * be set to 0 and calls to NeedModule() be made to increment it. To unload
  83  * the module, one has to wait until i_usage == 0 and call DeactivateModule().
  84  *****************************************************************************/
  85 MODULE_ACTIVATE
  86 {
  87     p_module->p_functions = malloc( sizeof( module_functions_t ) );
  88     if( p_module->p_functions == NULL )
  89     {
  90         return( -1 );
  91     }
  92
  93     _M( aout_getfunctions )( &p_module->p_functions->aout );
  94     _M( vout_getfunctions )( &p_module->p_functions->vout );
  95     _M( intf_getfunctions )( &p_module->p_functions->intf );
  96
  97     p_module->p_config = p_config;
  98
  99     return( 0 );
 100 }
 101
 102 /*****************************************************************************
 103  * DeactivateModule: make sure the module can be unloaded.
 104  *****************************************************************************
 105  * This function must only be called when i_usage == 0. If it successfully
 106  * returns, i_usage can be set to -1 and the module unloaded. Be careful to
 107  * lock usage_lock during the whole process.
 108  *****************************************************************************/
 109 MODULE_DEACTIVATE
 110 {
 111     free( p_module->p_functions );
 112
 113     return( 0 );
 114 }
 115