forked from videolan/vlc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathextension.c
1219 lines (1070 loc) · 38 KB
/
extension.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*****************************************************************************
* extension.c: Lua Extensions (meta data, web information, ...)
*****************************************************************************
* Copyright (C) 2009-2010 VideoLAN and authors
* $Id$
*
* Authors: Jean-Philippe André < jpeg # videolan.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
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
#ifndef _GNU_SOURCE
# define _GNU_SOURCE
#endif
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include "vlc.h"
#include "libs.h"
#include "extension.h"
#include "assert.h"
#include <vlc_common.h>
#include <vlc_input.h>
#include <vlc_interface.h>
#include <vlc_events.h>
#include <vlc_dialog.h>
/* Functions to register */
static const luaL_Reg p_reg[] =
{
{ NULL, NULL }
};
/*
* Extensions capabilities
* Note: #define and ppsz_capabilities must be in sync
*/
static const char caps[][20] = {
#define EXT_HAS_MENU (1 << 0) ///< Hook: menu
"menu",
#define EXT_TRIGGER_ONLY (1 << 1) ///< Hook: trigger. Not activable
"trigger",
#define EXT_INPUT_LISTENER (1 << 2) ///< Hook: input_changed
"input-listener",
#define EXT_META_LISTENER (1 << 3) ///< Hook: meta_changed
"meta-listener",
#define EXT_PLAYING_LISTENER (1 << 4) ///< Hook: status_changed
"playing-listener",
};
static int ScanExtensions( extensions_manager_t *p_this );
static int ScanLuaCallback( vlc_object_t *p_this, const char *psz_script,
const struct luabatch_context_t * );
static int Control( extensions_manager_t *, int, va_list );
static int GetMenuEntries( extensions_manager_t *p_mgr, extension_t *p_ext,
char ***pppsz_titles, uint16_t **ppi_ids );
static lua_State* GetLuaState( extensions_manager_t *p_mgr,
extension_t *p_ext );
static int TriggerMenu( extension_t *p_ext, int id );
static int TriggerExtension( extensions_manager_t *p_mgr,
extension_t *p_ext );
static void WatchTimerCallback( void* );
static int vlclua_extension_deactivate( lua_State *L );
static int vlclua_extension_keep_alive( lua_State *L );
/* Interactions */
static int vlclua_extension_dialog_callback( vlc_object_t *p_this,
char const *psz_var,
vlc_value_t oldval,
vlc_value_t newval,
void *p_data );
/* Input item callback: vlc_InputItemMetaChanged */
static void inputItemMetaChanged( const vlc_event_t *p_event,
void *data );
/**
* Module entry-point
**/
int Open_Extension( vlc_object_t *p_this )
{
if( lua_Disabled( p_this ) )
return VLC_EGENERIC;
msg_Dbg( p_this, "Opening Lua Extension module" );
extensions_manager_t *p_mgr = ( extensions_manager_t* ) p_this;
p_mgr->pf_control = Control;
p_mgr->p_sys = NULL;
vlc_mutex_init( &p_mgr->lock );
/* Scan available Lua Extensions */
if( ScanExtensions( p_mgr ) != VLC_SUCCESS )
{
msg_Err( p_mgr, "Can't load extensions modules" );
return VLC_EGENERIC;
}
// Create the dialog-event variable
var_Create( p_this, "dialog-event", VLC_VAR_ADDRESS );
var_AddCallback( p_this, "dialog-event",
vlclua_extension_dialog_callback, NULL );
return VLC_SUCCESS;
}
/**
* Module unload function
**/
void Close_Extension( vlc_object_t *p_this )
{
extensions_manager_t *p_mgr = ( extensions_manager_t* ) p_this;
var_DelCallback( p_this, "dialog-event",
vlclua_extension_dialog_callback, NULL );
var_Destroy( p_mgr, "dialog-event" );
extension_t *p_ext = NULL;
/* Free extensions' memory */
FOREACH_ARRAY( p_ext, p_mgr->extensions )
{
if( !p_ext )
break;
vlc_mutex_lock( &p_ext->p_sys->command_lock );
if( p_ext->p_sys->b_activated == true && p_ext->p_sys->p_progress_id == NULL )
{
p_ext->p_sys->b_exiting = true;
// QueueDeactivateCommand will signal the wait condition.
QueueDeactivateCommand( p_ext );
}
else
{
if ( p_ext->p_sys->L != NULL )
vlclua_fd_interrupt( &p_ext->p_sys->dtable );
// however here we need to manually signal the wait cond, since no command is queued.
p_ext->p_sys->b_exiting = true;
vlc_cond_signal( &p_ext->p_sys->wait );
}
vlc_mutex_unlock( &p_ext->p_sys->command_lock );
if( p_ext->p_sys->b_thread_running == true )
vlc_join( p_ext->p_sys->thread, NULL );
/* Clear Lua State */
if( p_ext->p_sys->L )
{
lua_close( p_ext->p_sys->L );
vlclua_fd_cleanup( &p_ext->p_sys->dtable );
}
free( p_ext->psz_name );
free( p_ext->psz_title );
free( p_ext->psz_author );
free( p_ext->psz_description );
free( p_ext->psz_shortdescription );
free( p_ext->psz_url );
free( p_ext->psz_version );
free( p_ext->p_icondata );
vlc_mutex_destroy( &p_ext->p_sys->running_lock );
vlc_mutex_destroy( &p_ext->p_sys->command_lock );
vlc_cond_destroy( &p_ext->p_sys->wait );
vlc_timer_destroy( p_ext->p_sys->timer );
free( p_ext->p_sys );
free( p_ext );
}
FOREACH_END()
vlc_mutex_destroy( &p_mgr->lock );
ARRAY_RESET( p_mgr->extensions );
}
/**
* Batch scan all Lua files in folder "extensions"
* @param p_mgr This extensions_manager_t object
**/
static int ScanExtensions( extensions_manager_t *p_mgr )
{
int i_ret =
vlclua_scripts_batch_execute( VLC_OBJECT( p_mgr ),
"extensions",
&ScanLuaCallback,
NULL );
if( !i_ret )
return VLC_EGENERIC;
return VLC_SUCCESS;
}
/**
* Dummy Lua function: does nothing
* @note This function can be used to replace "require" while scanning for
* extensions
* Even the built-in libraries are not loaded when calling descriptor()
**/
static int vlclua_dummy_require( lua_State *L )
{
(void) L;
return 0;
}
/**
* Replacement for "require", adding support for packaged extensions
* @note Loads modules in the modules/ folder of a package
* @note Try first with .luac and then with .lua
**/
static int vlclua_extension_require( lua_State *L )
{
const char *psz_module = luaL_checkstring( L, 1 );
vlc_object_t *p_this = vlclua_get_this( L );
extension_t *p_ext = vlclua_extension_get( L );
msg_Dbg( p_this, "loading module '%s' from extension package",
psz_module );
char *psz_fullpath, *psz_package, *sep;
psz_package = strdup( p_ext->psz_name );
sep = strrchr( psz_package, '/' );
if( !sep )
{
free( psz_package );
return luaL_error( L, "could not find package name" );
}
*sep = '\0';
if( -1 == asprintf( &psz_fullpath,
"%s/modules/%s.luac", psz_package, psz_module ) )
{
free( psz_package );
return 1;
}
int i_ret = vlclua_dofile( p_this, L, psz_fullpath );
if( i_ret != 0 )
{
// Remove trailing 'c' --> try with .lua script
psz_fullpath[ strlen( psz_fullpath ) - 1 ] = '\0';
i_ret = vlclua_dofile( p_this, L, psz_fullpath );
}
free( psz_fullpath );
free( psz_package );
if( i_ret != 0 )
{
return luaL_error( L, "unable to load module '%s' from package",
psz_module );
}
return 0;
}
/**
* Batch scan all Lua files in folder "extensions": callback
* @param p_this This extensions_manager_t object
* @param psz_filename Name of the script to run
* @param L Lua State, common to all scripts here
* @param dummy: unused
**/
int ScanLuaCallback( vlc_object_t *p_this, const char *psz_filename,
const struct luabatch_context_t *dummy )
{
VLC_UNUSED(dummy);
extensions_manager_t *p_mgr = ( extensions_manager_t* ) p_this;
bool b_ok = false;
msg_Dbg( p_mgr, "Scanning Lua script %s", psz_filename );
/* Experimental: read .vle packages (Zip archives) */
char *psz_script = NULL;
int i_flen = strlen( psz_filename );
if( !strncasecmp( psz_filename + i_flen - 4, ".vle", 4 ) )
{
msg_Dbg( p_this, "reading Lua script in a zip archive" );
psz_script = calloc( 1, i_flen + 6 + 12 + 1 );
if( !psz_script )
return 0;
strcpy( psz_script, "zip://" );
strncat( psz_script, psz_filename, i_flen + 19 );
strncat( psz_script, "!/script.lua", i_flen + 19 );
}
else
{
psz_script = strdup( psz_filename );
if( !psz_script )
return 0;
}
/* Create new script descriptor */
extension_t *p_ext = ( extension_t* ) calloc( 1, sizeof( extension_t ) );
if( !p_ext )
{
free( psz_script );
return 0;
}
p_ext->psz_name = psz_script;
p_ext->p_sys = (extension_sys_t*) calloc( 1, sizeof( extension_sys_t ) );
if( !p_ext->p_sys || !p_ext->psz_name )
{
free( p_ext->psz_name );
free( p_ext->p_sys );
free( p_ext );
return 0;
}
p_ext->p_sys->p_mgr = p_mgr;
/* Watch timer */
if( vlc_timer_create( &p_ext->p_sys->timer, WatchTimerCallback, p_ext ) )
{
free( p_ext->psz_name );
free( p_ext->p_sys );
free( p_ext );
return 0;
}
/* Mutexes and conditions */
vlc_mutex_init( &p_ext->p_sys->command_lock );
vlc_mutex_init( &p_ext->p_sys->running_lock );
vlc_cond_init( &p_ext->p_sys->wait );
/* Prepare Lua state */
lua_State *L = luaL_newstate();
lua_register( L, "require", &vlclua_dummy_require );
/* Let's run it */
if( vlclua_dofile( p_this, L, psz_script ) ) // luaL_dofile
{
msg_Warn( p_mgr, "Error loading script %s: %s", psz_script,
lua_tostring( L, lua_gettop( L ) ) );
lua_pop( L, 1 );
goto exit;
}
/* Scan script for capabilities */
lua_getglobal( L, "descriptor" );
if( !lua_isfunction( L, -1 ) )
{
msg_Warn( p_mgr, "Error while running script %s, "
"function descriptor() not found", psz_script );
goto exit;
}
if( lua_pcall( L, 0, 1, 0 ) )
{
msg_Warn( p_mgr, "Error while running script %s, "
"function descriptor(): %s", psz_script,
lua_tostring( L, lua_gettop( L ) ) );
goto exit;
}
if( lua_gettop( L ) )
{
if( lua_istable( L, -1 ) )
{
/* Get caps */
lua_getfield( L, -1, "capabilities" );
if( lua_istable( L, -1 ) )
{
lua_pushnil( L );
while( lua_next( L, -2 ) != 0 )
{
/* Key is at index -2 and value at index -1. Discard key */
const char *psz_cap = luaL_checkstring( L, -1 );
bool b_ok = false;
/* Find this capability's flag */
for( size_t i = 0; i < sizeof(caps)/sizeof(caps[0]); i++ )
{
if( !strcmp( caps[i], psz_cap ) )
{
/* Flag it! */
p_ext->p_sys->i_capabilities |= 1 << i;
b_ok = true;
break;
}
}
if( !b_ok )
{
msg_Warn( p_mgr, "Extension capability '%s' unknown in"
" script %s", psz_cap, psz_script );
}
/* Removes 'value'; keeps 'key' for next iteration */
lua_pop( L, 1 );
}
}
else
{
msg_Warn( p_mgr, "In script %s, function descriptor() "
"did not return a table of capabilities.",
psz_script );
}
lua_pop( L, 1 );
/* Get title */
lua_getfield( L, -1, "title" );
if( lua_isstring( L, -1 ) )
{
p_ext->psz_title = strdup( luaL_checkstring( L, -1 ) );
}
else
{
msg_Dbg( p_mgr, "In script %s, function descriptor() "
"did not return a string as title.",
psz_script );
p_ext->psz_title = strdup( psz_script );
}
lua_pop( L, 1 );
/* Get author */
lua_getfield( L, -1, "author" );
p_ext->psz_author = luaL_strdupornull( L, -1 );
lua_pop( L, 1 );
/* Get description */
lua_getfield( L, -1, "description" );
p_ext->psz_description = luaL_strdupornull( L, -1 );
lua_pop( L, 1 );
/* Get short description */
lua_getfield( L, -1, "shortdesc" );
p_ext->psz_shortdescription = luaL_strdupornull( L, -1 );
lua_pop( L, 1 );
/* Get URL */
lua_getfield( L, -1, "url" );
p_ext->psz_url = luaL_strdupornull( L, -1 );
lua_pop( L, 1 );
/* Get version */
lua_getfield( L, -1, "version" );
p_ext->psz_version = luaL_strdupornull( L, -1 );
lua_pop( L, 1 );
/* Get icon data */
lua_getfield( L, -1, "icon" );
if( !lua_isnil( L, -1 ) && lua_isstring( L, -1 ) )
{
int len = lua_strlen( L, -1 );
p_ext->p_icondata = malloc( len );
if( p_ext->p_icondata )
{
p_ext->i_icondata_size = len;
memcpy( p_ext->p_icondata, lua_tostring( L, -1 ), len );
}
}
lua_pop( L, 1 );
}
else
{
msg_Warn( p_mgr, "In script %s, function descriptor() "
"did not return a table!", psz_script );
goto exit;
}
}
else
{
msg_Err( p_mgr, "Script %s went completely foobar", psz_script );
goto exit;
}
msg_Dbg( p_mgr, "Script %s has the following capability flags: 0x%x",
psz_script, p_ext->p_sys->i_capabilities );
b_ok = true;
exit:
lua_close( L );
if( !b_ok )
{
free( p_ext->psz_name );
free( p_ext->psz_title );
free( p_ext->psz_url );
free( p_ext->psz_author );
free( p_ext->psz_description );
free( p_ext->psz_shortdescription );
free( p_ext->psz_version );
vlc_mutex_destroy( &p_ext->p_sys->command_lock );
vlc_mutex_destroy( &p_ext->p_sys->running_lock );
vlc_cond_destroy( &p_ext->p_sys->wait );
free( p_ext->p_sys );
free( p_ext );
}
else
{
/* Add the extension to the list of known extensions */
ARRAY_APPEND( p_mgr->extensions, p_ext );
}
/* Continue batch execution */
return VLC_EGENERIC;
}
static int Control( extensions_manager_t *p_mgr, int i_control, va_list args )
{
extension_t *p_ext = NULL;
bool *pb = NULL;
uint16_t **ppus = NULL;
char ***pppsz = NULL;
int i = 0;
switch( i_control )
{
case EXTENSION_ACTIVATE:
p_ext = ( extension_t* ) va_arg( args, extension_t* );
return Activate( p_mgr, p_ext );
case EXTENSION_DEACTIVATE:
p_ext = ( extension_t* ) va_arg( args, extension_t* );
return Deactivate( p_mgr, p_ext );
case EXTENSION_IS_ACTIVATED:
p_ext = ( extension_t* ) va_arg( args, extension_t* );
pb = ( bool* ) va_arg( args, bool* );
vlc_mutex_lock( &p_ext->p_sys->command_lock );
*pb = p_ext->p_sys->b_activated;
vlc_mutex_unlock( &p_ext->p_sys->command_lock );
break;
case EXTENSION_HAS_MENU:
p_ext = ( extension_t* ) va_arg( args, extension_t* );
pb = ( bool* ) va_arg( args, bool* );
*pb = ( p_ext->p_sys->i_capabilities & EXT_HAS_MENU ) ? 1 : 0;
break;
case EXTENSION_GET_MENU:
p_ext = ( extension_t* ) va_arg( args, extension_t* );
pppsz = ( char*** ) va_arg( args, char*** );
ppus = ( uint16_t** ) va_arg( args, uint16_t** );
if( p_ext == NULL )
return VLC_EGENERIC;
return GetMenuEntries( p_mgr, p_ext, pppsz, ppus );
case EXTENSION_TRIGGER_ONLY:
p_ext = ( extension_t* ) va_arg( args, extension_t* );
pb = ( bool* ) va_arg( args, bool* );
*pb = ( p_ext->p_sys->i_capabilities & EXT_TRIGGER_ONLY ) ? 1 : 0;
break;
case EXTENSION_TRIGGER:
p_ext = ( extension_t* ) va_arg( args, extension_t* );
return TriggerExtension( p_mgr, p_ext );
case EXTENSION_TRIGGER_MENU:
p_ext = ( extension_t* ) va_arg( args, extension_t* );
// GCC: 'uint16_t' is promoted to 'int' when passed through '...'
i = ( int ) va_arg( args, int );
return TriggerMenu( p_ext, i );
case EXTENSION_SET_INPUT:
{
p_ext = ( extension_t* ) va_arg( args, extension_t* );
input_thread_t *p_input = va_arg( args, struct input_thread_t * );
if( p_ext == NULL )
return VLC_EGENERIC;
vlc_mutex_lock( &p_ext->p_sys->command_lock );
if ( p_ext->p_sys->b_exiting == true )
{
vlc_mutex_unlock( &p_ext->p_sys->command_lock );
return VLC_EGENERIC;
}
vlc_mutex_unlock( &p_ext->p_sys->command_lock );
vlc_mutex_lock( &p_ext->p_sys->running_lock );
// Change input
input_thread_t *old = p_ext->p_sys->p_input;
input_item_t *p_item;
if( old )
{
// Untrack meta fetched events
if( p_ext->p_sys->i_capabilities & EXT_META_LISTENER )
{
p_item = input_GetItem( old );
vlc_event_detach( &p_item->event_manager,
vlc_InputItemMetaChanged,
inputItemMetaChanged,
p_ext );
input_item_Release( p_item );
}
vlc_object_release( old );
}
p_ext->p_sys->p_input = p_input ? vlc_object_hold( p_input )
: p_input;
// Tell the script the input changed
if( p_ext->p_sys->i_capabilities & EXT_INPUT_LISTENER )
{
PushCommandUnique( p_ext, CMD_SET_INPUT );
}
// Track meta fetched events
if( p_ext->p_sys->p_input &&
p_ext->p_sys->i_capabilities & EXT_META_LISTENER )
{
p_item = input_GetItem( p_ext->p_sys->p_input );
input_item_Hold( p_item );
vlc_event_attach( &p_item->event_manager,
vlc_InputItemMetaChanged,
inputItemMetaChanged,
p_ext );
}
vlc_mutex_unlock( &p_ext->p_sys->running_lock );
break;
}
case EXTENSION_PLAYING_CHANGED:
{
extension_t *p_ext;
p_ext = ( extension_t* ) va_arg( args, extension_t* );
assert( p_ext->psz_name != NULL );
i = ( int ) va_arg( args, int );
if( p_ext->p_sys->i_capabilities & EXT_PLAYING_LISTENER )
{
PushCommand( p_ext, CMD_PLAYING_CHANGED, i );
}
break;
}
case EXTENSION_META_CHANGED:
{
extension_t *p_ext;
p_ext = ( extension_t* ) va_arg( args, extension_t* );
PushCommand( p_ext, CMD_UPDATE_META );
break;
}
default:
msg_Warn( p_mgr, "Control '%d' not yet implemented in Extension",
i_control );
return VLC_EGENERIC;
}
return VLC_SUCCESS;
}
int lua_ExtensionActivate( extensions_manager_t *p_mgr, extension_t *p_ext )
{
assert( p_mgr != NULL && p_ext != NULL );
return lua_ExecuteFunction( p_mgr, p_ext, "activate", LUA_END );
}
int lua_ExtensionDeactivate( extensions_manager_t *p_mgr, extension_t *p_ext )
{
assert( p_mgr != NULL && p_ext != NULL );
if( p_ext->p_sys->b_activated == false )
return VLC_SUCCESS;
vlclua_fd_interrupt( &p_ext->p_sys->dtable );
// Unset and release input objects
if( p_ext->p_sys->p_input )
{
if( p_ext->p_sys->i_capabilities & EXT_META_LISTENER )
{
// Release item
input_item_t *p_item = input_GetItem( p_ext->p_sys->p_input );
input_item_Release( p_item );
}
vlc_object_release( p_ext->p_sys->p_input );
p_ext->p_sys->p_input = NULL;
}
int i_ret = lua_ExecuteFunction( p_mgr, p_ext, "deactivate", LUA_END );
if ( p_ext->p_sys->L == NULL )
return VLC_EGENERIC;
lua_close( p_ext->p_sys->L );
p_ext->p_sys->L = NULL;
return i_ret;
}
int lua_ExtensionWidgetClick( extensions_manager_t *p_mgr,
extension_t *p_ext,
extension_widget_t *p_widget )
{
if( !p_ext->p_sys->L )
return VLC_SUCCESS;
lua_State *L = GetLuaState( p_mgr, p_ext );
lua_pushlightuserdata( L, p_widget );
lua_gettable( L, LUA_REGISTRYINDEX );
return lua_ExecuteFunction( p_mgr, p_ext, NULL, LUA_END );
}
/**
* Get the list of menu entries from an extension script
* @param p_mgr
* @param p_ext
* @param pppsz_titles Pointer to NULL. All strings must be freed by the caller
* @param ppi_ids Pointer to NULL. Must be freed by the caller.
* @note This function is allowed to run in the UI thread. This means
* that it MUST respond very fast.
* @todo Remove the menu() hook and provide a new function vlc.set_menu()
**/
static int GetMenuEntries( extensions_manager_t *p_mgr, extension_t *p_ext,
char ***pppsz_titles, uint16_t **ppi_ids )
{
assert( *pppsz_titles == NULL );
assert( *ppi_ids == NULL );
vlc_mutex_lock( &p_ext->p_sys->command_lock );
if( p_ext->p_sys->b_activated == false || p_ext->p_sys->b_exiting == true )
{
vlc_mutex_unlock( &p_ext->p_sys->command_lock );
msg_Dbg( p_mgr, "Can't get menu of an unactivated/dying extension!" );
return VLC_EGENERIC;
}
vlc_mutex_unlock( &p_ext->p_sys->command_lock );
vlc_mutex_lock( &p_ext->p_sys->running_lock );
int i_ret = VLC_EGENERIC;
lua_State *L = GetLuaState( p_mgr, p_ext );
if( ( p_ext->p_sys->i_capabilities & EXT_HAS_MENU ) == 0 )
{
msg_Dbg( p_mgr, "can't get a menu from an extension without menu!" );
goto exit;
}
lua_getglobal( L, "menu" );
if( !lua_isfunction( L, -1 ) )
{
msg_Warn( p_mgr, "Error while running script %s, "
"function menu() not found", p_ext->psz_name );
goto exit;
}
if( lua_pcall( L, 0, 1, 0 ) )
{
msg_Warn( p_mgr, "Error while running script %s, "
"function menu(): %s", p_ext->psz_name,
lua_tostring( L, lua_gettop( L ) ) );
goto exit;
}
if( lua_gettop( L ) )
{
if( lua_istable( L, -1 ) )
{
/* Get table size */
size_t i_size = lua_objlen( L, -1 );
*pppsz_titles = ( char** ) calloc( i_size+1, sizeof( char* ) );
*ppi_ids = ( uint16_t* ) calloc( i_size+1, sizeof( uint16_t ) );
/* Walk table */
size_t i_idx = 0;
lua_pushnil( L );
while( lua_next( L, -2 ) != 0 )
{
assert( i_idx < i_size );
if( (!lua_isstring( L, -1 )) || (!lua_isnumber( L, -2 )) )
{
msg_Warn( p_mgr, "In script %s, an entry in "
"the menu table is invalid!", p_ext->psz_name );
goto exit;
}
(*pppsz_titles)[ i_idx ] = strdup( luaL_checkstring( L, -1 ) );
(*ppi_ids)[ i_idx ] = luaL_checkinteger( L, -2 ) & 0xFFFF;
i_idx++;
lua_pop( L, 1 );
}
}
else
{
msg_Warn( p_mgr, "Function menu() in script %s "
"did not return a table", p_ext->psz_name );
goto exit;
}
}
else
{
msg_Warn( p_mgr, "Script %s went completely foobar", p_ext->psz_name );
goto exit;
}
i_ret = VLC_SUCCESS;
exit:
vlc_mutex_unlock( &p_ext->p_sys->running_lock );
if( i_ret != VLC_SUCCESS )
{
msg_Dbg( p_mgr, "Something went wrong in %s (%s:%d)",
__func__, __FILE__, __LINE__ );
}
return i_ret;
}
/* Must be entered with the Lock on Extension */
static lua_State* GetLuaState( extensions_manager_t *p_mgr,
extension_t *p_ext )
{
assert( p_ext != NULL );
lua_State *L = p_ext->p_sys->L;
if( !L )
{
L = luaL_newstate();
if( !L )
{
msg_Err( p_mgr, "Could not create new Lua State" );
return NULL;
}
vlclua_set_this( L, p_mgr );
vlclua_set_playlist_internal( L,
pl_Get((intf_thread_t *)(p_mgr->obj.parent)) );
vlclua_extension_set( L, p_ext );
luaL_openlibs( L );
luaL_register_namespace( L, "vlc", p_reg );
luaopen_msg( L );
/* Load more libraries */
luaopen_config( L );
luaopen_dialog( L, p_ext );
luaopen_input( L );
luaopen_msg( L );
if( vlclua_fd_init( L, &p_ext->p_sys->dtable ) )
{
lua_close( L );
return NULL;
}
luaopen_object( L );
luaopen_osd( L );
luaopen_playlist( L );
luaopen_sd_intf( L );
luaopen_stream( L );
luaopen_strings( L );
luaopen_variables( L );
luaopen_video( L );
luaopen_vlm( L );
luaopen_volume( L );
luaopen_xml( L );
luaopen_vlcio( L );
luaopen_errno( L );
#if defined(_WIN32) && !VLC_WINSTORE_APP
luaopen_win( L );
#endif
/* Register extension specific functions */
lua_getglobal( L, "vlc" );
lua_pushcfunction( L, vlclua_extension_deactivate );
lua_setfield( L, -2, "deactivate" );
lua_pushcfunction( L, vlclua_extension_keep_alive );
lua_setfield( L, -2, "keep_alive" );
/* Setup the module search path */
if( !strncmp( p_ext->psz_name, "zip://", 6 ) )
{
/* Load all required modules manually */
lua_register( L, "require", &vlclua_extension_require );
}
else
{
if( vlclua_add_modules_path( L, p_ext->psz_name ) )
{
msg_Warn( p_mgr, "Error while setting the module "
"search path for %s", p_ext->psz_name );
vlclua_fd_cleanup( &p_ext->p_sys->dtable );
lua_close( L );
return NULL;
}
}
/* Load and run the script(s) */
if( vlclua_dofile( VLC_OBJECT( p_mgr ), L, p_ext->psz_name ) )
{
msg_Warn( p_mgr, "Error loading script %s: %s", p_ext->psz_name,
lua_tostring( L, lua_gettop( L ) ) );
vlclua_fd_cleanup( &p_ext->p_sys->dtable );
lua_close( L );
return NULL;
}
p_ext->p_sys->L = L;
}
return L;
}
int lua_ExecuteFunction( extensions_manager_t *p_mgr, extension_t *p_ext,
const char *psz_function, ... )
{
va_list args;
va_start( args, psz_function );
int i_ret = lua_ExecuteFunctionVa( p_mgr, p_ext, psz_function, args );
va_end( args );
return i_ret;
}
/**
* Execute a function in a Lua script
* @param psz_function Name of global function to execute. If NULL, assume
* that the function object is already on top of the
* stack.
* @return < 0 in case of failure, >= 0 in case of success
* @note It's better to call this function from a dedicated thread
* (see extension_thread.c)
**/
int lua_ExecuteFunctionVa( extensions_manager_t *p_mgr, extension_t *p_ext,
const char *psz_function, va_list args )
{
int i_ret = VLC_SUCCESS;
int i_args = 0;
assert( p_mgr != NULL );
assert( p_ext != NULL );
lua_State *L = GetLuaState( p_mgr, p_ext );
if( !L )
return -1;
if( psz_function )
lua_getglobal( L, psz_function );
if( !lua_isfunction( L, -1 ) )
{
msg_Warn( p_mgr, "Error while running script %s, "
"function %s() not found", p_ext->psz_name, psz_function );
lua_pop( L, 1 );
goto exit;
}
lua_datatype_e type = LUA_END;
while( ( type = va_arg( args, int ) ) != LUA_END )
{
if( type == LUA_NUM )
{
lua_pushnumber( L , ( int ) va_arg( args, int ) );
}
else if( type == LUA_TEXT )
{
lua_pushstring( L , ( char * ) va_arg( args, char* ) );
}
else
{
msg_Warn( p_mgr, "Undefined argument type %d to lua function %s"
"from script %s", type, psz_function, p_ext->psz_name );
if( i_args > 0 )
lua_pop( L, i_args );
goto exit;
}
i_args ++;
}
// Start actual call to Lua
if( lua_pcall( L, i_args, 1, 0 ) )
{
msg_Warn( p_mgr, "Error while running script %s, "
"function %s(): %s", p_ext->psz_name, psz_function,
lua_tostring( L, lua_gettop( L ) ) );
i_ret = VLC_EGENERIC;
}
i_ret |= lua_DialogFlush( L );
exit:
return i_ret;
}
static inline int TriggerMenu( extension_t *p_ext, int i_id )
{
return PushCommand( p_ext, CMD_TRIGGERMENU, i_id );
}
int lua_ExtensionTriggerMenu( extensions_manager_t *p_mgr,
extension_t *p_ext, int id )
{
int i_ret = VLC_SUCCESS;
lua_State *L = GetLuaState( p_mgr, p_ext );
if( !L )
return VLC_EGENERIC;
luaopen_dialog( L, p_ext );
lua_getglobal( L, "trigger_menu" );
if( !lua_isfunction( L, -1 ) )
{
msg_Warn( p_mgr, "Error while running script %s, "