git.sesse.net Git - vlc/blob - modules/misc/lua/extension.h

   1 /*****************************************************************************
   2  * extension.h: Lua Extensions (meta data, web information, ...)
   3  *****************************************************************************
   4  * Copyright (C) 2009-2010 VideoLAN and authors
   5  * $Id$
   6  *
   7  * Authors: Jean-Philippe André < jpeg # videolan.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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef LUA_EXTENSION_H
  25 #define LUA_EXTENSION_H
  26
  27 #include <vlc_extensions.h>
  28 #include <vlc_arrays.h>
  29
  30 ///< Array of extension_t
  31 TYPEDEF_ARRAY( extension_t, array_extension_t );
  32
  33 /* List of available commands */
  34 #define CMD_ACTIVATE    1
  35 #define CMD_DEACTIVATE  2
  36 #define CMD_TRIGGERMENU 3    /* Arg1 = int*, pointing to id to trigger. free */
  37 #define CMD_CLICK       4    /* Arg1 = extension_widget_t* */
  38 #define CMD_CLOSE       5
  39
  40 struct extensions_manager_sys_t
  41 {
  42     /* List of activated extensions */
  43     DECL_ARRAY( extension_t* ) activated_extensions;
  44
  45     /* Lock for this list */
  46     vlc_mutex_t lock;
  47
  48     /* Lua specific */
  49     lua_State *L;
  50
  51     /* Flag indicating that the module is about to be unloaded */
  52     bool b_killed;
  53 };
  54
  55 struct extension_sys_t
  56 {
  57     /* Extension general */
  58     int i_capabilities;
  59
  60     /* Lua specific */
  61     lua_State *L;
  62
  63     /* Thread data */
  64     vlc_thread_t thread;
  65     vlc_mutex_t command_lock;
  66     vlc_mutex_t running_lock;
  67     vlc_cond_t wait;
  68
  69     /* The input this extension should use for vlc.input
  70      * or NULL if it should use playlist's current input */
  71     struct input_thread_t *p_input;
  72
  73     extensions_manager_t *p_mgr;     ///< Parent
  74     /* Queue of commands to execute */
  75     struct command_t
  76     {
  77         int i_command;
  78         void *data[10];         ///< Optional void* arguments
  79         struct command_t *next; ///< Next command
  80     } *command;
  81
  82     bool b_exiting;
  83 };
  84
  85 /* Extensions: manager functions */
  86 int Activate( extensions_manager_t *p_mgr, extension_t * );
  87 bool IsActivated( extensions_manager_t *p_mgr, extension_t * );
  88 int Deactivate( extensions_manager_t *p_mgr, extension_t * );
  89 void WaitForDeactivation( extension_t *p_ext );
  90 int PushCommand( extension_t *p_ext, int i_command, ... );
  91 bool LockExtension( extension_t *p_ext );
  92 void UnlockExtension( extension_t *p_ext );
  93
  94 /* Lua specific functions */
  95 extension_t *vlclua_extension_get( lua_State *L );
  96 int lua_ExtensionActivate( extensions_manager_t *, extension_t * );
  97 int lua_ExtensionDeactivate( extensions_manager_t *, extension_t * );
  98 int lua_ExecuteFunction( extensions_manager_t *p_mgr, extension_t *p_ext,
  99                          const char *psz_function );
 100 int lua_ExtensionWidgetClick( extensions_manager_t *p_mgr,
 101                               extension_t *p_ext,
 102                               extension_widget_t *p_widget );
 103 int lua_ExtensionTriggerMenu( extensions_manager_t *p_mgr,
 104                               extension_t *p_ext, int id );
 105
 106 #endif // LUA_EXTENSION_H