]> git.sesse.net Git - vlc/blobdiff - plugins/dummy/dummy.c
* Ported Glide and MGA plugins to the new module API. MGA never worked,
[vlc] / plugins / dummy / dummy.c
index 7ce2ed0fcccb246b852028f765208fc483b21e88..8bdc53d17cf5a67e182bcb0d15f57f4fb5b96ea1 100644 (file)
@@ -1,9 +1,9 @@
 /*****************************************************************************
  * dummy.c : dummy plugin for vlc
  *****************************************************************************
- * Copyright (C) 2000 VideoLAN
+ * Copyright (C) 2000, 2001 VideoLAN
  *
- * Authors:
+ * Authors: Samuel Hocevar <sam@zoy.org>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -20,6 +20,9 @@
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  *****************************************************************************/
 
+#define MODULE_NAME dummy
+#include "modules_inner.h"
+
 /*****************************************************************************
  * Preamble
  *****************************************************************************/
 #include "common.h"                                     /* boolean_t, byte_t */
 #include "threads.h"
 #include "mtime.h"
-#include "tests.h"
-#include "plugins.h"
 
-#include "interface.h"
-#include "audio_output.h"
-#include "video.h"
-#include "video_output.h"
+#include "modules.h"
 
 /*****************************************************************************
- * Exported prototypes
+ * Build configuration tree.
  *****************************************************************************/
-static void aout_GetPlugin( p_aout_thread_t p_aout );
-static void vout_GetPlugin( p_vout_thread_t p_vout );
-static void intf_GetPlugin( p_intf_thread_t p_intf );
-
-/* Audio output */
-int     aout_DummyOpen         ( aout_thread_t *p_aout );
-int     aout_DummySetFormat    ( aout_thread_t *p_aout );
-long    aout_DummyGetBufInfo   ( aout_thread_t *p_aout, long l_buffer_info );
-void    aout_DummyPlay         ( aout_thread_t *p_aout, byte_t *buffer,
-                                 int i_size );
-void    aout_DummyClose        ( aout_thread_t *p_aout );
-
-/* Video output */
-int     vout_DummyCreate       ( vout_thread_t *p_vout, char *psz_display,
-                                 int i_root_window, void *p_data );
-int     vout_DummyInit         ( p_vout_thread_t p_vout );
-void    vout_DummyEnd          ( p_vout_thread_t p_vout );
-void    vout_DummyDestroy      ( p_vout_thread_t p_vout );
-int     vout_DummyManage       ( p_vout_thread_t p_vout );
-void    vout_DummyDisplay      ( p_vout_thread_t p_vout );
-void    vout_DummySetPalette   ( p_vout_thread_t p_vout,
-                                 u16 *red, u16 *green, u16 *blue, u16 *transp );
-
-/* Interface */
-int     intf_DummyCreate       ( p_intf_thread_t p_intf );
-void    intf_DummyDestroy      ( p_intf_thread_t p_intf );
-void    intf_DummyManage       ( p_intf_thread_t p_intf );
+MODULE_CONFIG_START
+ADD_WINDOW( "Configuration for dummy module" )
+    ADD_COMMENT( "Ha, ha -- nothing to configure yet" )
+MODULE_CONFIG_END
 
 /*****************************************************************************
- * GetConfig: get the plugin structure and configuration
+ * Capabilities defined in the other files.
  *****************************************************************************/
-plugin_info_t * GetConfig( void )
-{
-    plugin_info_t * p_info = (plugin_info_t *) malloc( sizeof(plugin_info_t) );
+void _M( aout_getfunctions )( function_list_t * p_function_list );
+void _M( vout_getfunctions )( function_list_t * p_function_list );
+void _M( intf_getfunctions )( function_list_t * p_function_list );
 
-    p_info->psz_name    = "Dummy";
-    p_info->psz_version = VERSION;
-    p_info->psz_author  = "the VideoLAN team <vlc@videolan.org>";
+/*****************************************************************************
+ * InitModule: get the module structure and configuration.
+ *****************************************************************************
+ * We have to fill psz_name, psz_longname and psz_version. These variables
+ * will be strdup()ed later by the main application because the module can
+ * be unloaded later to save memory, and we want to be able to access this
+ * data even after the module has been unloaded.
+ *****************************************************************************/
+MODULE_INIT
+{
+    p_module->psz_name = MODULE_STRING;
+    p_module->psz_longname = "dummy functions module";
+    p_module->psz_version = VERSION;
 
-    p_info->aout_GetPlugin = aout_GetPlugin;
-    p_info->vout_GetPlugin = vout_GetPlugin;
-    p_info->intf_GetPlugin = intf_GetPlugin;
-    p_info->yuv_GetPlugin  = NULL;
+    p_module->i_capabilities = MODULE_CAPABILITY_NULL
+                                | MODULE_CAPABILITY_AOUT
+                                | MODULE_CAPABILITY_VOUT
+                                | MODULE_CAPABILITY_INTF;
 
-    /* The dummy plugin always works, but should have low priority */
-    p_info->i_score = 0x1;
+    return( 0 );
+}
 
-    /* If this plugin was requested, score it higher */
-    if( TestMethod( VOUT_METHOD_VAR, "dummy" ) )
+/*****************************************************************************
+ * ActivateModule: set the module to an usable state.
+ *****************************************************************************
+ * This function fills the capability functions and the configuration
+ * structure. Once ActivateModule() has been called, the i_usage can
+ * be set to 0 and calls to NeedModule() be made to increment it. To unload
+ * the module, one has to wait until i_usage == 0 and call DeactivateModule().
+ *****************************************************************************/
+MODULE_ACTIVATE
+{
+    p_module->p_functions = malloc( sizeof( module_functions_t ) );
+    if( p_module->p_functions == NULL )
     {
-        p_info->i_score += 0x200;
+        return( -1 );
     }
 
-    /* If this plugin was requested, score it higher */
-    if( TestMethod( AOUT_METHOD_VAR, "dummy" ) )
-    {
-        p_info->i_score += 0x200;
-    }
+    _M( aout_getfunctions )( &p_module->p_functions->aout );
+    _M( vout_getfunctions )( &p_module->p_functions->vout );
+    _M( intf_getfunctions )( &p_module->p_functions->intf );
 
+    p_module->p_config = p_config;
 
-    return( p_info );
+    return( 0 );
 }
 
 /*****************************************************************************
- * Following functions are only called through the p_info structure
+ * DeactivateModule: make sure the module can be unloaded.
+ *****************************************************************************
+ * This function must only be called when i_usage == 0. If it successfully
+ * returns, i_usage can be set to -1 and the module unloaded. Be careful to
+ * lock usage_lock during the whole process.
  *****************************************************************************/
-
-static void aout_GetPlugin( p_aout_thread_t p_aout )
+MODULE_DEACTIVATE
 {
-    p_aout->p_open        = aout_DummyOpen;
-    p_aout->p_setformat   = aout_DummySetFormat;
-    p_aout->p_getbufinfo  = aout_DummyGetBufInfo;
-    p_aout->p_play        = aout_DummyPlay;
-    p_aout->p_close       = aout_DummyClose;
-}
+    free( p_module->p_functions );
 
-static void vout_GetPlugin( p_vout_thread_t p_vout )
-{
-    p_vout->p_sys_create  = vout_DummyCreate;
-    p_vout->p_sys_init    = vout_DummyInit;
-    p_vout->p_sys_end     = vout_DummyEnd;
-    p_vout->p_sys_destroy = vout_DummyDestroy;
-    p_vout->p_sys_manage  = vout_DummyManage;
-    p_vout->p_sys_display = vout_DummyDisplay;
-}
-
-static void intf_GetPlugin( p_intf_thread_t p_intf )
-{
-    p_intf->p_sys_create  = intf_DummyCreate;
-    p_intf->p_sys_destroy = intf_DummyDestroy;
-    p_intf->p_sys_manage  = intf_DummyManage;
+    return( 0 );
 }