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

   1 /*****************************************************************************
   2  * esd.c : EsounD module
   3  *****************************************************************************
   4  * Copyright (C) 2000, 2001 VideoLAN
   5  * $Id: esd.c,v 1.7 2001/03/21 13:42:33 sam Exp $
   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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 #define MODULE_NAME esd
  25 #include "modules_inner.h"
  26
  27 /*****************************************************************************
  28  * Preamble
  29  *****************************************************************************/
  30 #include "defs.h"
  31
  32 #include <stdlib.h>                                      /* malloc(), free() */
  33 #include <string.h>                                              /* strdup() */
  34
  35 #include "config.h"
  36 #include "common.h"                                     /* boolean_t, byte_t */
  37 #include "threads.h"
  38 #include "mtime.h"
  39
  40 #include "modules.h"
  41
  42 /*****************************************************************************
  43  * Build configuration tree.
  44  *****************************************************************************/
  45 MODULE_CONFIG_START
  46 ADD_WINDOW( "Configuration for esd module" )
  47     ADD_FRAME( "EsounD" )
  48         ADD_COMMENT( "This module does not need configuration" )
  49 MODULE_CONFIG_END
  50
  51 /*****************************************************************************
  52  * Capabilities defined in the other files.
  53  *****************************************************************************/
  54 void _M( aout_getfunctions )( function_list_t * p_function_list );
  55
  56 /*****************************************************************************
  57  * InitModule: get the module structure and configuration.
  58  *****************************************************************************
  59  * We have to fill psz_name, psz_longname and psz_version. These variables
  60  * will be strdup()ed later by the main application because the module can
  61  * be unloaded later to save memory, and we want to be able to access this
  62  * data even after the module has been unloaded.
  63  *****************************************************************************/
  64 MODULE_INIT
  65 {
  66     p_module->psz_name = MODULE_STRING;
  67     p_module->psz_longname = "EsounD audio module";
  68     p_module->psz_version = VERSION;
  69
  70     p_module->i_capabilities = MODULE_CAPABILITY_NULL
  71                                 | MODULE_CAPABILITY_AOUT;
  72
  73     return( 0 );
  74 }
  75
  76 /*****************************************************************************
  77  * ActivateModule: set the module to an usable state.
  78  *****************************************************************************
  79  * This function fills the capability functions and the configuration
  80  * structure. Once ActivateModule() has been called, the i_usage can
  81  * be set to 0 and calls to NeedModule() be made to increment it. To unload
  82  * the module, one has to wait until i_usage == 0 and call DeactivateModule().
  83  *****************************************************************************/
  84 MODULE_ACTIVATE
  85 {
  86     p_module->p_functions = malloc( sizeof( module_functions_t ) );
  87     if( p_module->p_functions == NULL )
  88     {
  89         return( -1 );
  90     }
  91
  92     _M( aout_getfunctions )( &p_module->p_functions->aout );
  93
  94     p_module->p_config = p_config;
  95
  96     return( 0 );
  97 }
  98
  99 /*****************************************************************************
 100  * DeactivateModule: make sure the module can be unloaded.
 101  *****************************************************************************
 102  * This function must only be called when i_usage == 0. If it successfully
 103  * returns, i_usage can be set to -1 and the module unloaded. Be careful to
 104  * lock usage_lock during the whole process.
 105  *****************************************************************************/
 106 MODULE_DEACTIVATE
 107 {
 108     free( p_module->p_functions );
 109
 110     return( 0 );
 111 }
 112