x11 factory: use vlc_readdir
[vlc/solaris.git] / src / interface / interface.c
blob11068ce8846de59b5c120b354f911b056a43c333
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-2007 VLC authors and VideoLAN
7 * $Id$
9 * Authors: Vincent Seguin <seguin@via.ecp.fr>
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU Lesser General Public License as published by
13 * the Free Software Foundation; either version 2.1 of the License, or
14 * (at your option) any later version.
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 Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public License
22 * along with this program; if not, write to the Free Software Foundation,
23 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
26 /**
27 * \file
28 * This file contains functions related to interface management
32 /*****************************************************************************
33 * Preamble
34 *****************************************************************************/
36 #ifdef HAVE_CONFIG_H
37 # include "config.h"
38 #endif
40 #include <assert.h>
41 #ifdef HAVE_UNISTD_H
42 # include <unistd.h>
43 #endif
45 #include <vlc_common.h>
46 #include <vlc_modules.h>
47 #include <vlc_interface.h>
48 #include "libvlc.h"
50 /*****************************************************************************
51 * Local prototypes
52 *****************************************************************************/
53 static void* RunInterface( void * );
54 #if defined( __APPLE__)
55 static void * MonitorLibVLCDeath( vlc_object_t *p_this );
56 #endif
57 static int AddIntfCallback( vlc_object_t *, char const *,
58 vlc_value_t , vlc_value_t , void * );
60 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
62 #undef intf_Create
63 /**
64 * Create and start an interface.
66 * @param p_this the calling vlc_object_t
67 * @param chain configuration chain string
68 * @return VLC_SUCCESS or an error code
70 int intf_Create( vlc_object_t *p_this, const char *chain )
72 libvlc_int_t *p_libvlc = p_this->p_libvlc;
73 intf_thread_t * p_intf;
75 /* Allocate structure */
76 p_intf = vlc_custom_create( p_libvlc, sizeof( *p_intf ), "interface" );
77 if( !p_intf )
78 return VLC_ENOMEM;
80 /* Variable used for interface spawning */
81 vlc_value_t val, text;
82 var_Create( p_intf, "intf-add", VLC_VAR_STRING |
83 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
84 text.psz_string = _("Add Interface");
85 var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL );
86 #if !defined(WIN32) && defined(HAVE_ISATTY)
87 if( isatty( 0 ) )
88 #endif
90 val.psz_string = (char *)"rc";
91 text.psz_string = (char *)_("Console");
92 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
94 val.psz_string = (char *)"telnet";
95 text.psz_string = (char *)_("Telnet");
96 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
97 val.psz_string = (char *)"http";
98 text.psz_string = (char *)_("Web");
99 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
100 val.psz_string = (char *)"logger";
101 text.psz_string = (char *)_("Debug logging");
102 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
103 val.psz_string = (char *)"gestures";
104 text.psz_string = (char *)_("Mouse Gestures");
105 var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text );
107 var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL );
109 /* Attach interface to LibVLC */
110 #if defined( __APPLE__ )
111 p_intf->b_should_run_on_first_thread = false;
112 #endif
114 /* Choose the best module */
115 p_intf->p_cfg = NULL;
116 char *psz_parser = *chain == '$'
117 ? var_CreateGetString(p_intf, chain+1)
118 : strdup( chain );
119 char *module;
120 char *psz_tmp = config_ChainCreate( &module, &p_intf->p_cfg,
121 psz_parser );
122 free( psz_tmp );
123 free( psz_parser );
124 p_intf->p_module = module_need( p_intf, "interface", module, true );
125 free(module);
126 if( p_intf->p_module == NULL )
128 msg_Err( p_intf, "no suitable interface module" );
129 goto error;
132 #if defined( __APPLE__ )
133 /* Hack to get Mac OS X Cocoa runtime running
134 * (it needs access to the main thread) */
135 if( p_intf->b_should_run_on_first_thread )
137 if( vlc_clone( &p_intf->thread,
138 MonitorLibVLCDeath, p_intf, VLC_THREAD_PRIORITY_LOW ) )
140 msg_Err( p_intf, "cannot spawn libvlc death monitoring thread" );
141 goto error;
143 assert( p_intf->pf_run );
144 p_intf->pf_run( p_intf );
146 /* It is monitoring libvlc, not the p_intf */
147 vlc_object_kill( p_intf->p_libvlc );
149 vlc_join( p_intf->thread, NULL );
151 else
152 #endif
153 /* Run the interface in a separate thread */
154 if( p_intf->pf_run
155 && vlc_clone( &p_intf->thread,
156 RunInterface, p_intf, VLC_THREAD_PRIORITY_LOW ) )
158 msg_Err( p_intf, "cannot spawn interface thread" );
159 goto error;
162 vlc_mutex_lock( &lock );
163 p_intf->p_next = libvlc_priv( p_libvlc )->p_intf;
164 libvlc_priv( p_libvlc )->p_intf = p_intf;
165 vlc_mutex_unlock( &lock );
167 return VLC_SUCCESS;
169 error:
170 if( p_intf->p_module )
171 module_unneed( p_intf, p_intf->p_module );
172 config_ChainDestroy( p_intf->p_cfg );
173 vlc_object_release( p_intf );
174 return VLC_EGENERIC;
179 * Stops and destroys all interfaces
180 * @param p_libvlc the LibVLC instance
182 void intf_DestroyAll( libvlc_int_t *p_libvlc )
184 intf_thread_t *p_first;
186 vlc_mutex_lock( &lock );
187 p_first = libvlc_priv( p_libvlc )->p_intf;
188 #ifndef NDEBUG
189 libvlc_priv( p_libvlc )->p_intf = NULL;
190 #endif
191 vlc_mutex_unlock( &lock );
193 /* Tell the interfaces to die */
194 for( intf_thread_t *p_intf = p_first; p_intf; p_intf = p_intf->p_next )
195 vlc_object_kill( p_intf );
197 /* Cleanup the interfaces */
198 for( intf_thread_t *p_intf = p_first; p_intf != NULL; )
200 intf_thread_t *p_next = p_intf->p_next;
202 if( p_intf->pf_run )
204 vlc_cancel( p_intf->thread );
205 #ifdef __APPLE__
206 if (!p_intf->b_should_run_on_first_thread)
207 #endif
208 vlc_join( p_intf->thread, NULL );
210 module_unneed( p_intf, p_intf->p_module );
211 config_ChainDestroy( p_intf->p_cfg );
212 vlc_object_release( p_intf );
214 p_intf = p_next;
218 /* Following functions are local */
221 * RunInterface: setups necessary data and give control to the interface
223 * @param p_this: interface object
225 static void* RunInterface( void *p_this )
227 intf_thread_t *p_intf = p_this;
229 p_intf->pf_run( p_intf );
230 return NULL;
233 #if defined( __APPLE__ )
234 #include "../lib/libvlc_internal.h" /* libvlc_InternalWait */
236 * MonitorLibVLCDeath: Used when b_should_run_on_first_thread is set.
238 * @param p_this: the interface object
240 static void * MonitorLibVLCDeath( vlc_object_t * p_this )
242 intf_thread_t *p_intf = (intf_thread_t *)p_this;
243 libvlc_int_t * p_libvlc = p_intf->p_libvlc;
244 int canc = vlc_savecancel ();
246 libvlc_InternalWait( p_libvlc );
248 vlc_object_kill( p_intf ); /* Kill the stupid first thread interface */
249 vlc_restorecancel (canc);
250 return NULL;
252 #endif
254 static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd,
255 vlc_value_t oldval, vlc_value_t newval, void *p_data )
257 (void)psz_cmd; (void)oldval; (void)p_data;
258 char* psz_intf;
260 /* Try to create the interface */
261 if( asprintf( &psz_intf, "%s,none", newval.psz_string ) == -1 )
262 return VLC_ENOMEM;
264 int ret = intf_Create( VLC_OBJECT(p_this->p_libvlc), psz_intf );
265 free( psz_intf );
266 if( ret )
267 msg_Err( p_this, "interface \"%s\" initialization failed",
268 newval.psz_string );
269 return ret;