]> git.sesse.net Git - vlc/blob - plugins/text/rc.c
d43c96c71dd8d974fc31072fd8c5d46bfea68dfd
[vlc] / plugins / text / rc.c
1 /*****************************************************************************
2  * rc.cpp : stdin/stdout plugin for vlc
3  *****************************************************************************
4  * Copyright (C) 2001 VideoLAN
5  * $Id: rc.cpp,v 0.1 2001/04/27 shurdeek
6  *
7  * Authors: Peter Surda <shurdeek@panorama.sth.ac.at>
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 rc
25 #include "modules_inner.h"
26
27 /*****************************************************************************
28  * Preamble
29  *****************************************************************************/
30 #include "defs.h"
31
32 #include <stdlib.h>                                      /* malloc(), free() */
33
34 #include "config.h"
35 #include "common.h"                                     /* boolean_t, byte_t */
36 #include "threads.h"
37 #include "mtime.h"
38
39 #include "modules.h"
40
41 /*****************************************************************************
42  * Build configuration tree.
43  *****************************************************************************/
44 MODULE_CONFIG_START
45 ADD_WINDOW( "Configuration for rc module" )
46     ADD_COMMENT( "Ha, ha -- nothing to configure yet" )
47 MODULE_CONFIG_END
48
49 /*****************************************************************************
50  * Capabilities defined in the other files.
51  *****************************************************************************/
52 void _M( intf_getfunctions )( function_list_t * p_function_list );
53
54 /*****************************************************************************
55  * InitModule: get the module structure and configuration.
56  *****************************************************************************
57  * We have to fill psz_name, psz_longname and psz_version. These variables
58  * will be strdup()ed later by the main application because the module can
59  * be unloaded later to save memory, and we want to be able to access this
60  * data even after the module has been unloaded.
61  *****************************************************************************/
62 MODULE_INIT
63 {
64     p_module->psz_name = MODULE_STRING;
65     p_module->psz_longname = "rc interface module";
66     p_module->psz_version = VERSION;
67
68     p_module->i_capabilities = MODULE_CAPABILITY_NULL
69                                 | MODULE_CAPABILITY_INTF;
70
71     return( 0 );
72 }
73
74 /*****************************************************************************
75  * ActivateModule: set the module to an usable state.
76  *****************************************************************************
77  * This function fills the capability functions and the configuration
78  * structure. Once ActivateModule() has been called, the i_usage can
79  * be set to 0 and calls to NeedModule() be made to increment it. To unload
80  * the module, one has to wait until i_usage == 0 and call DeactivateModule().
81  *****************************************************************************/
82 MODULE_ACTIVATE
83 {
84     p_module->p_functions =
85                 ( module_functions_t * )malloc( sizeof( module_functions_t ) );
86     if( p_module->p_functions == NULL )
87     {
88         return( -1 );
89     }
90
91     _M( intf_getfunctions )( &p_module->p_functions->intf );
92
93     p_module->p_config = p_config;
94
95     return( 0 );
96 }
97
98 /*****************************************************************************
99  * DeactivateModule: make sure the module can be unloaded.
100  *****************************************************************************
101  * This function must only be called when i_usage == 0. If it successfully
102  * returns, i_usage can be set to -1 and the module unloaded. Be careful to
103  * lock usage_lock during the whole process.
104  *****************************************************************************/
105 MODULE_DEACTIVATE
106 {
107     free( p_module->p_functions );
108
109     return( 0 );
110 }
111