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
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #include "defs.h"
  29
  30 #include <stdlib.h>                                      /* malloc(), free() */
  31
  32 #include "config.h"
  33 #include "common.h"                                     /* boolean_t, byte_t */
  34 #include "threads.h"
  35 #include "mtime.h"
  36 #include "tests.h"
  37
  38 #include "interface.h"
  39
  40 #include "audio_output.h"
  41
  42 #include "video.h"
  43 #include "video_output.h"
  44
  45 #include "modules.h"
  46 #include "modules_inner.h"
  47
  48 /*****************************************************************************
  49  * Build configuration tree.
  50  *****************************************************************************/
  51 MODULE_CONFIG_START
  52 ADD_WINDOW( "Configuration for dummy module" )
  53     ADD_COMMENT( "Ha, ha -- nothing to configure yet" )
  54 MODULE_CONFIG_END
  55
  56 /*****************************************************************************
  57  * Capabilities defined in the other files.
  58  *****************************************************************************/
  59 extern void aout_getfunctions( function_list_t * p_function_list );
  60 extern void vout_getfunctions( function_list_t * p_function_list );
  61 extern void intf_getfunctions( function_list_t * p_function_list );
  62
  63 /*****************************************************************************
  64  * InitModule: get the module structure and configuration.
  65  *****************************************************************************
  66  * We have to fill psz_name, psz_longname and psz_version. These variables
  67  * will be strdup()ed later by the main application because the module can
  68  * be unloaded later to save memory, and we want to be able to access this
  69  * data even after the module has been unloaded.
  70  *****************************************************************************/
  71 int InitModule( module_t * p_module )
  72 {
  73     p_module->psz_name = MODULE_STRING;
  74     p_module->psz_longname = "dummy functions module";
  75     p_module->psz_version = VERSION;
  76
  77     p_module->i_capabilities = MODULE_CAPABILITY_NULL
  78                                 | MODULE_CAPABILITY_AOUT
  79                                 | MODULE_CAPABILITY_VOUT
  80                                 | MODULE_CAPABILITY_INTF;
  81
  82     return( 0 );
  83 }
  84
  85 /*****************************************************************************
  86  * ActivateModule: set the module to an usable state.
  87  *****************************************************************************
  88  * This function fills the capability functions and the configuration
  89  * structure. Once ActivateModule() has been called, the i_usage can
  90  * be set to 0 and calls to NeedModule() be made to increment it. To unload
  91  * the module, one has to wait until i_usage == 0 and call DeactivateModule().
  92  *****************************************************************************/
  93 int ActivateModule( module_t * p_module )
  94 {
  95     p_module->p_functions = malloc( sizeof( module_functions_t ) );
  96     if( p_module->p_functions == NULL )
  97     {
  98         return( -1 );
  99     }
 100
 101     aout_getfunctions( &p_module->p_functions->aout );
 102     vout_getfunctions( &p_module->p_functions->vout );
 103     intf_getfunctions( &p_module->p_functions->intf );
 104
 105     p_module->p_config = p_config;
 106
 107     return( 0 );
 108 }
 109
 110 /*****************************************************************************
 111  * DeactivateModule: make sure the module can be unloaded.
 112  *****************************************************************************
 113  * This function must only be called when i_usage == 0. If it successfully
 114  * returns, i_usage can be set to -1 and the module unloaded. Be careful to
 115  * lock usage_lock during the whole process.
 116  *****************************************************************************/
 117 int DeactivateModule( module_t * p_module )
 118 {
 119     free( p_module->p_functions );
 120
 121     return( 0 );
 122 }
 123