extension_thread.c 13 KB
Newer Older
JPeg's avatar
JPeg committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/*****************************************************************************
 * extension_thread.c: Extensions Manager, Threads manager (no Lua here)
 *****************************************************************************
 * 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.
 *****************************************************************************/

Rafaël Carré's avatar
Rafaël Carré committed
24
25
26
27
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

28
#include "vlc.h"
JPeg's avatar
JPeg committed
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
#include "extension.h"
#include "assert.h"

struct thread_sys_t
{
    extensions_manager_t *p_mgr;
    extension_t *p_ext;
};

/** Thread Run */
static void* Run( void *data );
static void FreeCommands( struct command_t *command );
static int RemoveActivated( extensions_manager_t *p_mgr, extension_t *p_ext );

/**
 * Activate an extension
 * @param p_mgr This manager
 * @param p_ext Extension to activate
 * @return The usual VLC return codes
 **/
int Activate( extensions_manager_t *p_mgr, extension_t *p_ext )
{
    assert( p_ext != NULL );

    struct extension_sys_t *p_sys = p_ext->p_sys;
    assert( p_sys != NULL );

    msg_Dbg( p_mgr, "Activating extension '%s'", p_ext->psz_title );

    if( IsActivated( p_mgr, p_ext ) )
    {
        msg_Warn( p_mgr, "Extension is already activated!" );
        return VLC_EGENERIC;
    }

    /* Add this script to the activated extensions list */
65
    vlc_mutex_lock( &p_mgr->p_sys->lock );
JPeg's avatar
JPeg committed
66
    ARRAY_APPEND( p_mgr->p_sys->activated_extensions, p_ext );
67
    vlc_mutex_unlock( &p_mgr->p_sys->lock );
JPeg's avatar
JPeg committed
68
69
70
71
72
73
74
75
76

    /* Prepare first command */
    p_sys->command = calloc( 1, sizeof( struct command_t ) );
    if( !p_sys->command )
        return VLC_ENOMEM;
    p_sys->command->i_command = CMD_ACTIVATE; /* No params */

    /* Start thread */
    p_sys->b_exiting = false;
77
    p_sys->b_thread_running = true;
JPeg's avatar
JPeg committed
78
79
80
81
82

    if( vlc_clone( &p_sys->thread, Run, p_ext, VLC_THREAD_PRIORITY_LOW )
        != VLC_SUCCESS )
    {
        p_sys->b_exiting = true;
83
        p_sys->b_thread_running = false;
JPeg's avatar
JPeg committed
84
85
86
87
88
89
        return VLC_ENOMEM;
    }

    return VLC_SUCCESS;
}

90
91
92
/** Look for an extension in the activated extensions list
 * @todo FIXME Should be entered with the lock held
 **/
JPeg's avatar
JPeg committed
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
bool IsActivated( extensions_manager_t *p_mgr, extension_t *p_ext )
{
    assert( p_ext != NULL );
    vlc_mutex_lock( &p_mgr->p_sys->lock );

    extension_t *p_iter;
    FOREACH_ARRAY( p_iter, p_mgr->p_sys->activated_extensions )
    {
        if( !p_iter )
            break;
        assert( p_iter->psz_name != NULL );
        if( !strcmp( p_iter->psz_name, p_ext->psz_name ) )
        {
            vlc_mutex_unlock( &p_mgr->p_sys->lock );
            return true;
        }
    }
    FOREACH_END()

    vlc_mutex_unlock( &p_mgr->p_sys->lock );
    return false;
}

/** Recursively drop and free commands starting from "command" */
static void FreeCommands( struct command_t *command )
{
    if( !command ) return;
    struct command_t *next = command->next;
    switch( command->i_command )
    {
        case CMD_ACTIVATE:
        case CMD_DEACTIVATE:
        case CMD_CLICK: // Arg1 must not be freed
            break;

        case CMD_TRIGGERMENU:
129
        case CMD_PLAYING_CHANGED:
JPeg's avatar
JPeg committed
130
131
            free( command->data[0] ); // Arg1 is int*, to free
            break;
132
133
134

        default:
            break;
JPeg's avatar
JPeg committed
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
    }
    free( command );
    FreeCommands( next );
}

/** Deactivate this extension: pushes immediate command and drops queued */
int Deactivate( extensions_manager_t *p_mgr, extension_t *p_ext )
{
    vlc_mutex_lock( &p_ext->p_sys->command_lock );

    if( p_ext->p_sys->b_exiting )
    {
        vlc_mutex_unlock( &p_ext->p_sys->command_lock );
        return VLC_EGENERIC;
    }

Thomas Guillem's avatar
Thomas Guillem committed
151
    if( p_ext->p_sys->p_progress_id != NULL )
JPeg's avatar
JPeg committed
152
153
    {
        // Extension is stuck, kill it now
Thomas Guillem's avatar
Thomas Guillem committed
154
155
        vlc_dialog_release( p_mgr, p_ext->p_sys->p_progress_id );
        p_ext->p_sys->p_progress_id = NULL;
156
        vlc_mutex_unlock( &p_ext->p_sys->command_lock );
157
        KillExtension( p_mgr, p_ext );
JPeg's avatar
JPeg committed
158
159
160
        return VLC_SUCCESS;
    }

JPeg's avatar
JPeg committed
161
    /* Free the list of commands */
162
163
    if( p_ext->p_sys->command )
        FreeCommands( p_ext->p_sys->command->next );
JPeg's avatar
JPeg committed
164
165
166
167

    /* Push command */
    struct command_t *cmd = calloc( 1, sizeof( struct command_t ) );
    cmd->i_command = CMD_DEACTIVATE;
168
169
170
171
    if( p_ext->p_sys->command )
        p_ext->p_sys->command->next = cmd;
    else
        p_ext->p_sys->command = cmd;
JPeg's avatar
JPeg committed
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

    vlc_cond_signal( &p_ext->p_sys->wait );
    vlc_mutex_unlock( &p_ext->p_sys->command_lock );

    return VLC_SUCCESS;
}

/** Remove an extension from the activated list */
static int RemoveActivated( extensions_manager_t *p_mgr, extension_t *p_ext )
{
    if( p_mgr->p_sys->b_killed )
        return VLC_SUCCESS;
    vlc_mutex_lock( &p_mgr->p_sys->lock );

    int i_idx = -1;
    extension_t *p_iter;
    FOREACH_ARRAY( p_iter, p_mgr->p_sys->activated_extensions )
    {
        i_idx++;
        if( !p_iter )
        {
            i_idx = -1;
            break;
        }
        assert( p_iter->psz_name != NULL );
        if( !strcmp( p_iter->psz_name, p_ext->psz_name ) )
            break;
    }
    FOREACH_END()

    if( i_idx >= 0 )
    {
        ARRAY_REMOVE( p_mgr->p_sys->activated_extensions, i_idx );
    }
    else
    {
        msg_Dbg( p_mgr, "Can't find extension '%s' in the activated list",
                 p_ext->psz_title );
    }

    vlc_mutex_unlock( &p_mgr->p_sys->lock );
    return (i_idx >= 0) ? VLC_SUCCESS : VLC_EGENERIC;
}

JPeg's avatar
JPeg committed
216
217
218
219
void KillExtension( extensions_manager_t *p_mgr, extension_t *p_ext )
{
    msg_Dbg( p_mgr, "Killing extension now" );
    lua_ExtensionDeactivate( p_mgr, p_ext );
220
    vlc_mutex_lock( &p_ext->p_sys->command_lock );
JPeg's avatar
JPeg committed
221
    p_ext->p_sys->b_exiting = true;
222
    vlc_cond_signal( &p_ext->p_sys->wait );
223
    vlc_mutex_unlock( &p_ext->p_sys->command_lock );
JPeg's avatar
JPeg committed
224
225
226
    RemoveActivated( p_mgr, p_ext );
}

JPeg's avatar
JPeg committed
227
/** Push a UI command */
228
int PushCommand__( extension_t *p_ext,  bool b_unique, command_type_e i_command,
229
                   va_list args )
JPeg's avatar
JPeg committed
230
231
232
{
    /* Create command */
    struct command_t *cmd = calloc( 1, sizeof( struct command_t ) );
233
234
    if( unlikely( cmd == NULL ) )
        return VLC_ENOMEM;
JPeg's avatar
JPeg committed
235
236
237
238
239
240
241
242
243
    cmd->i_command = i_command;
    switch( i_command )
    {
        case CMD_CLICK:
            cmd->data[0] = va_arg( args, void* );
            break;
        case CMD_TRIGGERMENU:
            {
                int *pi = malloc( sizeof( int ) );
244
245
246
247
248
                if( !pi )
                {
                    free( cmd );
                    return VLC_ENOMEM;
                }
JPeg's avatar
JPeg committed
249
250
251
252
                *pi = va_arg( args, int );
                cmd->data[0] = pi;
            }
            break;
253
254
255
256
257
258
259
260
261
262
263
264
        case CMD_PLAYING_CHANGED:
            {
                int *pi = malloc( sizeof( int ) );
                if( !pi )
                {
                    free( cmd );
                    return VLC_ENOMEM;
                }
                *pi = va_arg( args, int );
                cmd->data[0] = pi;
            }
            break;
265
266
267
268
269
        case CMD_CLOSE:
        case CMD_SET_INPUT:
        case CMD_UPDATE_META:
            // Nothing to do here
            break;
JPeg's avatar
JPeg committed
270
271
272
273
274
275
        default:
            msg_Dbg( p_ext->p_sys->p_mgr,
                     "Unknown command send to extension: %d", i_command );
            break;
    }

276
277
    vlc_mutex_lock( &p_ext->p_sys->command_lock );

JPeg's avatar
JPeg committed
278
279
280
281
282
283
284
285
    /* Push command to the end of the queue */
    struct command_t *last = p_ext->p_sys->command;
    if( !last )
    {
        p_ext->p_sys->command = cmd;
    }
    else
    {
286
        bool b_skip = false;
JPeg's avatar
JPeg committed
287
288
        while( last->next != NULL )
        {
289
290
291
            if( b_unique && last->i_command == i_command )
            {
                // Do not push this 'unique' command a second time
292
                b_skip = !memcmp( last->data, cmd->data, sizeof( cmd->data ) );
293
294
295
296
297
298
                break;
            }
            else
            {
                last = last->next;
            }
JPeg's avatar
JPeg committed
299
        }
300
        if( !b_skip )
301
        {
302
303
304
305
306
            last->next = cmd;
        }
        else
        {
            FreeCommands( cmd );
307
        }
JPeg's avatar
JPeg committed
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
    }

    vlc_cond_signal( &p_ext->p_sys->wait );
    vlc_mutex_unlock( &p_ext->p_sys->command_lock );
    return VLC_SUCCESS;
}

/* Thread loop */
static void* Run( void *data )
{
    extension_t *p_ext = data;
    extensions_manager_t *p_mgr = p_ext->p_sys->p_mgr;

    vlc_mutex_lock( &p_ext->p_sys->command_lock );

    while( !p_ext->p_sys->b_exiting )
    {
        struct command_t *cmd = p_ext->p_sys->command;
326
327
328
329
330
331
332
333
334

        /* Pop command in front */
        if( cmd == NULL )
        {
            vlc_cond_wait( &p_ext->p_sys->wait, &p_ext->p_sys->command_lock );
            continue;
        }
        p_ext->p_sys->command = cmd->next;
        cmd->next = NULL; /* unlink command (for FreeCommands()) */
335
336
        // Create watch timer
        vlc_timer_schedule( p_ext->p_sys->timer, false, WATCH_TIMER_PERIOD, 0 );
JPeg's avatar
JPeg committed
337
338
339
        vlc_mutex_unlock( &p_ext->p_sys->command_lock );

        /* Run command */
340
        if( LockExtension( p_ext ) )
JPeg's avatar
JPeg committed
341
        {
342
            switch( cmd->i_command )
JPeg's avatar
JPeg committed
343
            {
344
                case CMD_ACTIVATE:
JPeg's avatar
JPeg committed
345
                {
346
                    if( lua_ExecuteFunction( p_mgr, p_ext, "activate", LUA_END ) < 0 )
JPeg's avatar
JPeg committed
347
                    {
348
349
                        msg_Err( p_mgr, "Could not activate extension!" );
                        Deactivate( p_mgr, p_ext );
JPeg's avatar
JPeg committed
350
                    }
351
352
                    break;
                }
JPeg's avatar
JPeg committed
353

354
355
356
357
                case CMD_DEACTIVATE:
                {
                    msg_Dbg( p_mgr, "Deactivating '%s'", p_ext->psz_title );
                    if( lua_ExtensionDeactivate( p_mgr, p_ext ) < 0 )
JPeg's avatar
JPeg committed
358
                    {
359
360
                        msg_Warn( p_mgr, "Extension '%s' did not deactivate properly",
                                  p_ext->psz_title );
JPeg's avatar
JPeg committed
361
                    }
362
363
364
365
                    p_ext->p_sys->b_exiting = true;
                    RemoveActivated( p_mgr, p_ext );
                    break;
                }
JPeg's avatar
JPeg committed
366

367
368
369
370
371
                case CMD_CLOSE:
                {
                    lua_ExecuteFunction( p_mgr, p_ext, "close", LUA_END );
                    break;
                }
JPeg's avatar
JPeg committed
372

373
374
375
376
377
378
                case CMD_CLICK:
                {
                    extension_widget_t *p_widget = cmd->data[0];
                    assert( p_widget );
                    msg_Dbg( p_mgr, "Clicking '%s': '%s'",
                             p_ext->psz_name, p_widget->psz_text );
ivoire's avatar
ivoire committed
379
                    if( lua_ExtensionWidgetClick( p_mgr, p_ext, p_widget ) < 0 )
JPeg's avatar
JPeg committed
380
                    {
381
                        msg_Warn( p_mgr, "Could not translate click" );
JPeg's avatar
JPeg committed
382
                    }
383
384
                    break;
                }
JPeg's avatar
JPeg committed
385

386
387
388
389
390
391
392
393
394
                case CMD_TRIGGERMENU:
                {
                    int *pi_id = cmd->data[0];
                    assert( pi_id );
                    msg_Dbg( p_mgr, "Trigger menu %d of '%s'",
                             *pi_id, p_ext->psz_name );
                    lua_ExtensionTriggerMenu( p_mgr, p_ext, *pi_id );
                    break;
                }
JPeg's avatar
JPeg committed
395

396
397
398
399
400
                case CMD_SET_INPUT:
                {
                    lua_ExecuteFunction( p_mgr, p_ext, "input_changed", LUA_END );
                    break;
                }
401

402
403
404
405
406
                case CMD_UPDATE_META:
                {
                    lua_ExecuteFunction( p_mgr, p_ext, "meta_changed", LUA_END );
                    break;
                }
407

408
409
410
411
412
413
                case CMD_PLAYING_CHANGED:
                {
                    lua_ExecuteFunction( p_mgr, p_ext, "playing_changed",
                            LUA_NUM, *((int *)cmd->data[0]), LUA_END );
                    break;
                }
414

415
416
417
418
419
                default:
                {
                    msg_Dbg( p_mgr, "Unknown command in extension command queue: %d",
                             cmd->i_command );
                    break;
JPeg's avatar
JPeg committed
420
421
                }
            }
422
            UnlockExtension( p_ext );
JPeg's avatar
JPeg committed
423
        }
424
        FreeCommands( cmd );
JPeg's avatar
JPeg committed
425

ivoire's avatar
ivoire committed
426
        vlc_mutex_lock( &p_ext->p_sys->command_lock );
427
428
429
430
431
432
433
        // Reset watch timer and timestamp
        if( p_ext->p_sys->p_progress_id != NULL )
        {
            vlc_dialog_release( p_mgr, p_ext->p_sys->p_progress_id );
            p_ext->p_sys->p_progress_id = NULL;
        }
        vlc_timer_schedule( p_ext->p_sys->timer, false, 0, 0 );
JPeg's avatar
JPeg committed
434
435
    }

436
    vlc_mutex_unlock( &p_ext->p_sys->command_lock );
437
    msg_Dbg( p_mgr, "Extension thread end: '%s'", p_ext->psz_title );
JPeg's avatar
JPeg committed
438
439
440
441

    // Note: At this point, the extension should be deactivated
    return NULL;
}