* Get rid of the Manager thread by making blocking interfaces listen to
[vlc.git] / src / interface / interface.c
1 /*****************************************************************************
2  * interface.c: interface access for other threads
3  * This library provides basic functions for threads to interact with user
4  * interface, such as command line.
5  *****************************************************************************
6  * Copyright (C) 1998-2004 the VideoLAN team
7  * $Id$
8  *
9  * Authors: Vincent Seguin <seguin@via.ecp.fr>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24  *****************************************************************************/
25
26 /**
27  *   \file
28  *   This file contains functions related to interface management
29  */
30
31
32 /*****************************************************************************
33  * Preamble
34  *****************************************************************************/
35 #include <stdlib.h>                                      /* free(), strtol() */
36 #include <stdio.h>                                                   /* FILE */
37 #include <string.h>                                            /* strerror() */
38
39 #include <vlc/vlc.h>
40 #include <vlc/input.h>
41
42 #include "audio_output.h"
43
44 #include "vlc_interface.h"
45 #include "vlc_video.h"
46 #include "video_output.h"
47
48 #ifdef __APPLE__
49 #    include <Cocoa/Cocoa.h>
50 #endif
51
52 /*****************************************************************************
53  * Local prototypes
54  *****************************************************************************/
55 static void RunInterface( intf_thread_t *p_intf );
56
57 static int SwitchIntfCallback( vlc_object_t *, char const *,
58                                vlc_value_t , vlc_value_t , void * );
59 static int AddIntfCallback( vlc_object_t *, char const *,
60                             vlc_value_t , vlc_value_t , void * );
61
62 #ifdef __APPLE__
63 static void Manager( intf_thread_t *p_intf );
64 /*****************************************************************************
65  * VLCApplication interface
66  *****************************************************************************/
67 @interface VLCApplication : NSApplication
68 {
69    libvlc_int_t *o_libvlc;
70 }
71
72 - (void)setVLC: (libvlc_int_t *)p_libvlc;
73
74 @end
75 #endif
76
77 /*****************************************************************************
78  * intf_Create: prepare interface before main loop
79  *****************************************************************************
80  * This function opens output devices and creates specific interfaces. It sends
81  * its own error messages.
82  *****************************************************************************/
83 /**
84  * Create the interface, and prepare it for main loop.
85  * You can give some additional options to be used for interface initialization
86  *
87  * \param p_this the calling vlc_object_t
88  * \param psz_module a prefered interface module
89  * \param i_options number additional options
90  * \param ppsz_options additional option strings
91  * \return a pointer to the created interface thread, NULL on error
92  */
93 intf_thread_t* __intf_Create( vlc_object_t *p_this, const char *psz_module,
94                               int i_options, char **ppsz_options  )
95 {
96     intf_thread_t * p_intf;
97     int i;
98
99     /* Allocate structure */
100     p_intf = vlc_object_create( p_this, VLC_OBJECT_INTF );
101     if( !p_intf )
102     {
103         msg_Err( p_this, "out of memory" );
104         return NULL;
105     }
106     p_intf->pf_request_window = NULL;
107     p_intf->pf_release_window = NULL;
108     p_intf->pf_control_window = NULL;
109     p_intf->b_play = VLC_FALSE;
110     p_intf->b_interaction = VLC_FALSE;
111
112     for( i = 0 ; i< i_options; i++ )
113     {
114         var_OptionParse( p_intf, ppsz_options[i] );
115     }
116
117     /* Choose the best module */
118     p_intf->p_module = module_Need( p_intf, "interface", psz_module, VLC_FALSE );
119
120     if( p_intf->p_module == NULL )
121     {
122         msg_Err( p_intf, "no suitable interface module" );
123         vlc_object_destroy( p_intf );
124         return NULL;
125     }
126
127     /* Initialize structure */
128     p_intf->b_menu        = VLC_FALSE;
129     p_intf->b_menu_change = VLC_FALSE;
130
131     /* Initialize mutexes */
132     vlc_mutex_init( p_intf, &p_intf->change_lock );
133
134     /* Attach interface to its parent object */
135     vlc_object_attach( p_intf, p_this );
136
137     return p_intf;
138 }
139
140 /*****************************************************************************
141  * intf_RunThread: launch the interface thread
142  *****************************************************************************
143  * This function either creates a new thread and runs the interface in it,
144  * or runs the interface in the current thread, depending on b_block.
145  *****************************************************************************/
146 /**
147  * Run the interface thread.
148  *
149  * If b_block is not set, runs the interface in the thread, else,
150  * creates a new thread and runs the interface.
151  * \param p_intf the interface thread
152  * \return VLC_SUCCESS on success, an error number else
153  */
154 int intf_RunThread( intf_thread_t *p_intf )
155 {
156 #ifdef __APPLE__
157     NSAutoreleasePool * o_pool;
158
159     if( p_intf->b_block )
160     {
161         /* This is the primary intf */
162         /* Run a manager thread, launch the interface, kill the manager */
163         if( vlc_thread_create( p_intf, "manage", Manager,
164                                VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
165         {
166             msg_Err( p_intf, "cannot spawn manager thread" );
167             return VLC_EGENERIC;
168         }
169     }
170
171     if( p_intf->b_block && strncmp( p_intf->p_libvlc->psz_object_name,
172                                     "clivlc", 6) )
173     {
174         o_pool = [[NSAutoreleasePool alloc] init];
175         [VLCApplication sharedApplication];
176         [NSApp setVLC: p_intf->p_libvlc];
177     }
178
179     if( p_intf->b_block &&
180         ( !strncmp( p_intf->p_module->psz_object_name, "macosx" , 6 ) ||
181           !strncmp( p_intf->p_libvlc->psz_object_name, "clivlc", 6 ) ) )
182     {
183         /* VLC in normal primary interface mode */
184         RunInterface( p_intf );
185         p_intf->b_die = VLC_TRUE;
186     }
187     else
188     {
189         /* This interface doesn't need to be run */
190         if( !p_intf->pf_run )
191             return VLC_SUCCESS;
192
193         /* Run the interface in a separate thread */
194         if( !strcmp( p_intf->p_module->psz_object_name, "macosx" ) )
195         {
196             msg_Err( p_intf, "You cannot run the MacOS X module as an "
197                              "extra interface. Please read the "
198                              "README.MacOSX.rtf file.");
199             return VLC_EGENERIC;
200         }
201         if( vlc_thread_create( p_intf, "interface", RunInterface,
202                                VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
203         {
204             msg_Err( p_intf, "cannot spawn interface thread" );
205             return VLC_EGENERIC;
206         }
207
208         if( p_intf->b_block )
209         {
210             /* VLC in primary interface mode with a working macosx vout */
211             [NSApp run];
212             p_intf->b_die = VLC_TRUE;
213         }
214     }
215 #else
216     if( p_intf->b_block )
217     {
218         /* If the main interface does not have a run function,
219          * implement a waiting loop ourselves
220          */
221         if( p_intf->pf_run )
222             RunInterface( p_intf );
223         else
224         {
225             while( !intf_ShouldDie( p_intf ) )
226                 msleep( INTF_IDLE_SLEEP * 2);
227         }
228         p_intf->b_die = VLC_TRUE;
229         /* Do not join the thread... intf_StopThread will do it for us */
230     }
231     else
232     {
233         /* This interface doesn't need to be run */
234         if( !p_intf->pf_run )
235             return VLC_SUCCESS;
236
237         /* Run the interface in a separate thread */
238         if( vlc_thread_create( p_intf, "interface", RunInterface,
239                                VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
240         {
241             msg_Err( p_intf, "cannot spawn interface thread" );
242             return VLC_EGENERIC;
243         }
244     }
245 #endif
246
247     return VLC_SUCCESS;
248 }
249
250 /**
251  * Stops the interface thread
252  *
253  * This function asks the interface thread to stop
254  * \param p_intf the interface thread
255  * \return nothing
256  */
257 void intf_StopThread( intf_thread_t *p_intf )
258 {
259     /* Tell the interface to die */
260     if( !p_intf->b_block )
261     {
262         p_intf->b_die = VLC_TRUE;
263         if( p_intf->pf_run )
264             vlc_thread_join( p_intf );
265     }
266 }
267
268 /**
269  * \brief Destroy the interface after the main loop endeed.
270  *
271  * Destroys interfaces and closes output devices
272  * \param p_intf the interface thread
273  * \return nothing
274  */
275 void intf_Destroy( intf_thread_t *p_intf )
276 {
277     /* Unlock module if present (a switch may have failed) */
278     if( p_intf->p_module )
279     {
280         module_Unneed( p_intf, p_intf->p_module );
281     }
282
283     vlc_mutex_destroy( &p_intf->change_lock );
284
285     /* Free structure */
286     vlc_object_destroy( p_intf );
287 }
288
289
290 /* Following functions are local */
291
292 /*****************************************************************************
293  * Manager: helper thread for blocking OS X
294  *****************************************************************************/
295 #ifdef __APPLE__
296 static void Manager( intf_thread_t *p_intf )
297 {
298     while( !p_intf->b_die )
299     {
300         msleep( INTF_IDLE_SLEEP );
301
302         if( p_intf->p_libvlc->b_die )
303         {
304             p_intf->b_die = VLC_TRUE;
305             if( strncmp( p_intf->p_libvlc->psz_object_name, "clivlc", 6 ) )
306             {
307                 [NSApp stop: NULL];
308             }
309             return;
310         }
311     }
312 }
313 #endif
314
315 /*****************************************************************************
316  * RunInterface: setups necessary data and give control to the interface
317  *****************************************************************************/
318 static void RunInterface( intf_thread_t *p_intf )
319 {
320     static char *ppsz_interfaces[] =
321     {
322         "skins2", "Skins 2",
323 #ifndef WIN32
324         "wxwidgets", "wxWidgets",
325 #endif
326         NULL, NULL
327     };
328     char **ppsz_parser;
329
330     vlc_list_t *p_list;
331     int i;
332     vlc_value_t val, text;
333     char *psz_intf;
334
335     /* Variable used for interface switching */
336     p_intf->psz_switch_intf = NULL;
337     var_Create( p_intf, "intf-switch", VLC_VAR_STRING |
338                 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
339     text.psz_string = _("Switch interface");
340     var_Change( p_intf, "intf-switch", VLC_VAR_SETTEXT, &text, NULL );
341
342     /* Only fill the list with available modules */
343     p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
344     for( ppsz_parser = ppsz_interfaces; *ppsz_parser; ppsz_parser += 2 )
345     {
346         for( i = 0; i < p_list->i_count; i++ )
347         {
348             module_t *p_module = (module_t *)p_list->p_values[i].p_object;
349             if( !strcmp( p_module->psz_object_name, ppsz_parser[0] ) )
350             {
351                 val.psz_string = ppsz_parser[0];
352                 text.psz_string = ppsz_parser[1];
353                 var_Change( p_intf, "intf-switch", VLC_VAR_ADDCHOICE,
354                             &val, &text );
355                 break;
356             }
357         }
358     }
359     vlc_list_release( p_list );
360
361     var_AddCallback( p_intf, "intf-switch", SwitchIntfCallback, NULL );
362
363     /* Variable used for interface spawning */
364     var_Create( p_intf, "intf-add", VLC_VAR_STRING |
365                 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
366     text.psz_string = _("Add Interface");
367     var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
368
369     val.psz_string = "rc"; text.psz_string = "Console";
370     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
371     val.psz_string = "telnet"; text.psz_string = "Telnet Interface";
372     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
373     val.psz_string = "http"; text.psz_string = "Web Interface";
374     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
375     val.psz_string = "logger"; text.psz_string = "Debug logging";
376     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
377     val.psz_string = "gestures"; text.psz_string = "Mouse Gestures";
378     var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
379
380     var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
381
382     do
383     {
384         /* Give control to the interface */
385         p_intf->pf_run( p_intf );
386
387         /* Reset play on start status */
388         p_intf->b_play = VLC_FALSE;
389
390         if( !p_intf->psz_switch_intf )
391         {
392             break;
393         }
394
395         /* Make sure the old interface is completely uninitialized */
396         module_Unneed( p_intf, p_intf->p_module );
397
398         /* Provide ability to switch the main interface on the fly */
399         psz_intf = p_intf->psz_switch_intf;
400         p_intf->psz_switch_intf = NULL;
401
402         vlc_mutex_lock( &p_intf->object_lock );
403         p_intf->b_die = VLC_FALSE;
404         p_intf->b_dead = VLC_FALSE;
405         vlc_mutex_unlock( &p_intf->object_lock );
406
407         p_intf->p_module = module_Need( p_intf, "interface", psz_intf, 0 );
408         free( psz_intf );
409     }
410     while( p_intf->p_module );
411 }
412
413 static int SwitchIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
414                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
415 {
416     intf_thread_t *p_intf = (intf_thread_t *)p_this;
417
418     p_intf->psz_switch_intf =
419         malloc( strlen(newval.psz_string) + sizeof(",none") );
420     sprintf( p_intf->psz_switch_intf, "%s,none", newval.psz_string );
421     p_intf->b_die = VLC_TRUE;
422
423     return VLC_SUCCESS;
424 }
425
426 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
427                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
428 {
429     intf_thread_t *p_intf;
430     char *psz_intf = malloc( strlen(newval.psz_string) + sizeof(",none") );
431
432     /* Try to create the interface */
433     sprintf( psz_intf, "%s,none", newval.psz_string );
434     p_intf = intf_Create( p_this->p_libvlc, psz_intf, 0, NULL );
435     free( psz_intf );
436     if( p_intf == NULL )
437     {
438         msg_Err( p_this, "interface \"%s\" initialization failed",
439                  newval.psz_string );
440         return VLC_EGENERIC;
441     }
442
443     /* Try to run the interface */
444     p_intf->b_block = VLC_FALSE;
445     if( intf_RunThread( p_intf ) != VLC_SUCCESS )
446     {
447         vlc_object_detach( p_intf );
448         intf_Destroy( p_intf );
449         return VLC_EGENERIC;
450     }
451
452     return VLC_SUCCESS;
453 }
454
455 #ifdef __APPLE__
456 /*****************************************************************************
457  * VLCApplication implementation
458  *****************************************************************************/
459 @implementation VLCApplication
460
461 - (void)setVLC: (libvlc_int_t *) p_libvlc
462 {
463     o_libvlc = p_libvlc;
464 }
465
466 - (void)stop: (id)sender
467 {
468     NSEvent *o_event;
469     NSAutoreleasePool *o_pool;
470     [super stop:sender];
471
472     o_pool = [[NSAutoreleasePool alloc] init];
473     /* send a dummy event to break out of the event loop */
474     o_event = [NSEvent mouseEventWithType: NSLeftMouseDown
475                 location: NSMakePoint( 1, 1 ) modifierFlags: 0
476                 timestamp: 1 windowNumber: [[NSApp mainWindow] windowNumber]
477                 context: [NSGraphicsContext currentContext] eventNumber: 1
478                 clickCount: 1 pressure: 0.0];
479     [NSApp postEvent: o_event atStart: YES];
480     [o_pool release];
481 }
482
483 - (void)terminate: (id)sender
484 {
485     o_libvlc->b_die = VLC_TRUE;
486 }
487
488 @end
489 #endif
490