1 /*****************************************************************************
2 * extension.h: Lua Extensions (meta data, web information, ...)
3 *****************************************************************************
4 * Copyright (C) 2009-2010 VideoLAN and authors
7 * Authors: Jean-Philippe André < jpeg # videolan.org >
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.
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.
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 *****************************************************************************/
24 #ifndef LUA_EXTENSION_H
25 #define LUA_EXTENSION_H
27 #include <vlc_extensions.h>
28 #include <vlc_arrays.h>
30 ///< Array of extension_t
31 TYPEDEF_ARRAY( extension_t, array_extension_t );
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* */
39 #define CMD_SET_INPUT 6 /* No arg. Just signal current input changed */
40 #define CMD_UPDATE_META 7 /* No arg. Just signal current input item meta
42 #define CMD_PLAYING_CHANGED 8 /* Arg1 = int*, New playing status */
52 struct extensions_manager_sys_t
54 /* List of activated extensions */
55 DECL_ARRAY( extension_t* ) activated_extensions;
57 /* Lock for this list */
60 /* Flag indicating that the module is about to be unloaded */
64 struct extension_sys_t
66 /* Extension general */
74 vlc_mutex_t command_lock;
75 vlc_mutex_t running_lock;
78 /* The input this extension should use for vlc.input
79 * or NULL if it should use playlist's current input */
80 struct input_thread_t *p_input;
82 extensions_manager_t *p_mgr; ///< Parent
83 /* Queue of commands to execute */
87 void *data[10]; ///< Optional void* arguments
88 struct command_t *next; ///< Next command
94 /* Extensions: manager functions */
95 int Activate( extensions_manager_t *p_mgr, extension_t * );
96 bool IsActivated( extensions_manager_t *p_mgr, extension_t * );
97 int Deactivate( extensions_manager_t *p_mgr, extension_t * );
98 void WaitForDeactivation( extension_t *p_ext );
99 int __PushCommand( extension_t *ext, bool unique, int cmd, va_list options );
100 static inline int PushCommand( extension_t *ext, int cmd, ... )
103 va_start( args, cmd );
104 int i_ret = __PushCommand( ext, false, cmd, args );
108 static inline int PushCommandUnique( extension_t *ext, int cmd, ... )
111 va_start( args, cmd );
112 int i_ret = __PushCommand( ext, true, cmd, args );
116 bool LockExtension( extension_t *p_ext );
117 void UnlockExtension( extension_t *p_ext );
119 /* Lua specific functions */
120 void vlclua_extension_set( lua_State *L, extension_t * );
121 extension_t *vlclua_extension_get( lua_State *L );
122 int lua_ExtensionActivate( extensions_manager_t *, extension_t * );
123 int lua_ExtensionDeactivate( extensions_manager_t *, extension_t * );
124 int lua_ExecuteFunctionVa( extensions_manager_t *p_mgr, extension_t *p_ext,
125 const char *psz_function, va_list args );
126 int lua_ExecuteFunction( extensions_manager_t *p_mgr, extension_t *p_ext,
127 const char *psz_function, ... );
128 int lua_ExtensionWidgetClick( extensions_manager_t *p_mgr,
130 extension_widget_t *p_widget );
131 int lua_ExtensionTriggerMenu( extensions_manager_t *p_mgr,
132 extension_t *p_ext, int id );
134 /* Dialog specific */
135 int lua_DialogFlush( lua_State *L );
137 #endif // LUA_EXTENSION_H