1 /*****************************************************************************
2 * gtk.c : Gtk+ plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2000-2001 VideoLAN
5 * $Id: gtk.c,v 1.30 2002/07/15 20:09:31 sam Exp $
7 * Authors: Samuel Hocevar <sam@zoy.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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
27 #include <stdlib.h> /* malloc(), free() */
28 #include <errno.h> /* ENOMEM */
29 #include <string.h> /* strerror() */
37 #include "gtk_callbacks.h"
38 #include "gtk_interface.h"
39 #include "gtk_support.h"
41 #include "gtk_display.h"
42 #include "gtk_common.h"
44 /*****************************************************************************
46 *****************************************************************************/
47 static void intf_getfunctions ( function_list_t * p_function_list );
48 static int intf_Open ( intf_thread_t *p_intf );
49 static void intf_Close ( intf_thread_t *p_intf );
50 static void intf_Run ( intf_thread_t *p_intf );
52 static gint GtkManage ( gpointer p_data );
54 /*****************************************************************************
55 * Local variables (mutex-protected).
56 *****************************************************************************/
57 static void ** pp_global_data = NULL;
59 /*****************************************************************************
60 * Building configuration tree
61 *****************************************************************************/
62 #define TOOLTIPS_TEXT N_("show tooltips")
63 #define TOOLTIPS_LONGTEXT N_("Show tooltips for configuration options.")
65 #define PREFS_MAXH_TEXT N_("maximum height for the configuration windows")
66 #define PREFS_MAXH_LONGTEXT N_( \
67 "You can set the maximum height that the configuration windows in the " \
68 "preferences menu will occupy.")
71 ADD_CATEGORY_HINT( N_("Miscellaneous"), NULL )
72 ADD_BOOL( "gtk-tooltips", 1, GtkHideTooltips, TOOLTIPS_TEXT, TOOLTIPS_LONGTEXT)
73 ADD_INTEGER( "gtk-prefs-maxh", 480, NULL, PREFS_MAXH_TEXT, PREFS_MAXH_LONGTEXT)
77 pp_global_data = p_module->p_vlc->pp_global_data;
78 SET_DESCRIPTION( _("Gtk+ interface module") )
80 if( getenv( "DISPLAY" ) == NULL )
82 ADD_CAPABILITY( INTF, 10 )
87 ADD_CAPABILITY( INTF, 90 )
93 intf_getfunctions( &p_module->p_functions->intf );
96 MODULE_DEACTIVATE_START
97 MODULE_DEACTIVATE_STOP
99 /*****************************************************************************
100 * g_atexit: kludge to avoid the Gtk+ thread to segfault at exit
101 *****************************************************************************
102 * gtk_init() makes several calls to g_atexit() which calls atexit() to
103 * register tidying callbacks to be called at program exit. Since the Gtk+
104 * plugin is likely to be unloaded at program exit, we have to export this
105 * symbol to intercept the g_atexit() calls. Talk about crude hack.
106 *****************************************************************************/
107 void g_atexit( GVoidFunc func )
109 intf_thread_t *p_intf;
113 if( pp_global_data == NULL )
119 p_intf = (intf_thread_t *)*pp_global_data;
126 i_dummy < MAX_ATEXIT && p_intf->p_sys->pf_callback[i_dummy] != NULL;
132 if( i_dummy >= MAX_ATEXIT - 1 )
134 msg_Err( p_intf, "too many atexit() callbacks to register" );
138 p_intf->p_sys->pf_callback[i_dummy] = func;
139 p_intf->p_sys->pf_callback[i_dummy + 1] = NULL;
142 /*****************************************************************************
143 * Functions exported as capabilities. They are declared as static so that
144 * we don't pollute the namespace too much.
145 *****************************************************************************/
146 static void intf_getfunctions( function_list_t * p_function_list )
148 p_function_list->functions.intf.pf_open = intf_Open;
149 p_function_list->functions.intf.pf_close = intf_Close;
150 p_function_list->functions.intf.pf_run = intf_Run;
153 /*****************************************************************************
154 * intf_Open: initialize and create window
155 *****************************************************************************/
156 static int intf_Open( intf_thread_t *p_intf )
158 /* Allocate instance and initialize some members */
159 p_intf->p_sys = malloc( sizeof( intf_sys_t ) );
160 if( p_intf->p_sys == NULL )
162 msg_Err( p_intf, "out of memory" );
166 p_intf->p_sys->p_sub = msg_Subscribe( p_intf );
168 /* Initialize Gtk+ thread */
169 p_intf->p_sys->b_playing = 0;
170 p_intf->p_sys->b_popup_changed = 0;
171 p_intf->p_sys->b_window_changed = 0;
172 p_intf->p_sys->b_playlist_changed = 0;
174 p_intf->p_sys->p_input = NULL;
175 p_intf->p_sys->i_playing = -1;
176 p_intf->p_sys->b_slider_free = 1;
178 p_intf->p_sys->pf_callback[0] = NULL;
180 p_intf->p_sys->i_part = 0;
185 /*****************************************************************************
186 * intf_Close: destroy interface window
187 *****************************************************************************/
188 static void intf_Close( intf_thread_t *p_intf )
190 if( p_intf->p_sys->p_input )
192 vlc_object_release( p_intf->p_sys->p_input );
195 msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
197 /* Destroy structure */
198 free( p_intf->p_sys );
201 /*****************************************************************************
202 * intf_Run: Gtk+ thread
203 *****************************************************************************
204 * this part of the interface is in a separate thread so that we can call
205 * gtk_main() from within it without annoying the rest of the program.
206 * XXX: the approach may look kludgy, and probably is, but I could not find
207 * a better way to dynamically load a Gtk+ interface at runtime.
208 *****************************************************************************/
209 static void intf_Run( intf_thread_t *p_intf )
211 /* gtk_init needs to know the command line. We don't care, so we
212 * give it an empty one */
213 char *p_args[] = { "" };
214 char **pp_args = p_args;
218 /* The data types we are allowed to receive */
219 static GtkTargetEntry target_table[] =
221 { "STRING", 0, DROP_ACCEPT_STRING },
222 { "text/uri-list", 0, DROP_ACCEPT_TEXT_URI_LIST },
223 { "text/plain", 0, DROP_ACCEPT_TEXT_PLAIN }
226 /* Initialize Gtk+ */
228 /* gtk_init will register stuff with g_atexit, so we need to take
229 * the global lock if we want to be able to intercept the calls */
230 vlc_mutex_lock( p_intf->p_vlc->p_global_lock );
231 *p_intf->p_vlc->pp_global_data = p_intf;
232 gtk_init( &i_args, &pp_args );
233 vlc_mutex_unlock( p_intf->p_vlc->p_global_lock );
235 /* Create some useful widgets that will certainly be used */
236 p_intf->p_sys->p_window = create_intf_window();
237 p_intf->p_sys->p_popup = create_intf_popup();
238 p_intf->p_sys->p_playwin = create_intf_playlist();
239 p_intf->p_sys->p_messages = create_intf_messages();
240 p_intf->p_sys->p_tooltips = gtk_tooltips_new();
242 /* Set the title of the main window */
243 gtk_window_set_title( GTK_WINDOW(p_intf->p_sys->p_window),
244 VOUT_TITLE " (Gtk+ interface)");
246 /* Accept file drops on the main window */
247 gtk_drag_dest_set( GTK_WIDGET( p_intf->p_sys->p_window ),
248 GTK_DEST_DEFAULT_ALL, target_table,
249 1, GDK_ACTION_COPY );
251 /* Accept file drops on the playlist window */
252 gtk_drag_dest_set( GTK_WIDGET( lookup_widget( p_intf->p_sys->p_playwin,
254 GTK_DEST_DEFAULT_ALL, target_table,
255 1, GDK_ACTION_COPY );
257 /* Get the slider object */
258 p_intf->p_sys->p_slider_frame = GTK_FRAME( gtk_object_get_data(
259 GTK_OBJECT( p_intf->p_sys->p_window ), "slider_frame" ) );
261 /* Configure the log window */
262 p_intf->p_sys->p_messages_text = GTK_TEXT( gtk_object_get_data(
263 GTK_OBJECT(p_intf->p_sys->p_messages ), "messages_textbox" ) );
264 gtk_text_set_line_wrap( p_intf->p_sys->p_messages_text, TRUE);
265 gtk_text_set_word_wrap( p_intf->p_sys->p_messages_text, FALSE);
267 /* Get the interface labels */
268 #define P_LABEL( name ) GTK_LABEL( gtk_object_get_data( \
269 GTK_OBJECT( p_intf->p_sys->p_window ), name ) )
270 p_intf->p_sys->p_label_title = P_LABEL( "title_label" );
271 p_intf->p_sys->p_label_chapter = P_LABEL( "chapter_label" );
274 /* Connect the date display to the slider */
275 #define P_SLIDER GTK_RANGE( gtk_object_get_data( \
276 GTK_OBJECT( p_intf->p_sys->p_window ), "slider" ) )
277 p_intf->p_sys->p_adj = gtk_range_get_adjustment( P_SLIDER );
279 gtk_signal_connect ( GTK_OBJECT( p_intf->p_sys->p_adj ), "value_changed",
280 GTK_SIGNAL_FUNC( GtkDisplayDate ), NULL );
281 p_intf->p_sys->f_adj_oldvalue = 0;
284 /* We don't create these ones yet because we perhaps won't need them */
285 p_intf->p_sys->p_about = NULL;
286 p_intf->p_sys->p_modules = NULL;
287 p_intf->p_sys->p_open = NULL;
288 p_intf->p_sys->p_jump = NULL;
290 /* Hide tooltips if the option is set */
291 if( !config_GetInt( p_intf, "gtk-tooltips" ) )
293 gtk_tooltips_disable( p_intf->p_sys->p_tooltips );
296 /* Store p_intf to keep an eye on it */
297 gtk_object_set_data( GTK_OBJECT(p_intf->p_sys->p_window),
300 gtk_object_set_data( GTK_OBJECT(p_intf->p_sys->p_popup),
303 gtk_object_set_data( GTK_OBJECT( p_intf->p_sys->p_playwin ),
306 gtk_object_set_data( GTK_OBJECT( p_intf->p_sys->p_messages ),
309 gtk_object_set_data( GTK_OBJECT(p_intf->p_sys->p_adj),
312 /* Show the control window */
313 gtk_widget_show( p_intf->p_sys->p_window );
315 /* Sleep to avoid using all CPU - since some interfaces needs to access
316 * keyboard events, a 100ms delay is a good compromise */
317 i_dummy = gtk_timeout_add( INTF_IDLE_SLEEP / 1000, GtkManage, p_intf );
322 /* Remove the timeout */
323 gtk_timeout_remove( i_dummy );
325 /* Destroy the Tooltips structure */
326 gtk_object_destroy( GTK_OBJECT(p_intf->p_sys->p_tooltips) );
328 /* Launch stored callbacks */
330 i_dummy < MAX_ATEXIT && p_intf->p_sys->pf_callback[i_dummy] != NULL;
333 p_intf->p_sys->pf_callback[i_dummy]();
337 /* following functions are local */
339 /*****************************************************************************
340 * GtkManage: manage main thread messages
341 *****************************************************************************
342 * In this function, called approx. 10 times a second, we check what the
343 * main program wanted to tell us.
344 *****************************************************************************/
345 static gint GtkManage( gpointer p_data )
347 #define p_intf ((intf_thread_t *)p_data)
350 vlc_mutex_lock( &p_intf->change_lock );
352 /* If the "display popup" flag has changed */
353 if( p_intf->b_menu_change )
355 if( !GTK_IS_WIDGET( p_intf->p_sys->p_popup ) )
357 p_intf->p_sys->p_popup = create_intf_popup();
358 gtk_object_set_data( GTK_OBJECT( p_intf->p_sys->p_popup ),
361 gtk_menu_popup( GTK_MENU( p_intf->p_sys->p_popup ),
362 NULL, NULL, NULL, NULL, 0, GDK_CURRENT_TIME );
363 p_intf->b_menu_change = 0;
366 /* Update the log window */
367 vlc_mutex_lock( p_intf->p_sys->p_sub->p_lock );
368 i_stop = *p_intf->p_sys->p_sub->pi_stop;
369 vlc_mutex_unlock( p_intf->p_sys->p_sub->p_lock );
371 if( p_intf->p_sys->p_sub->i_start != i_stop )
373 static GdkColor white = { 0, 0xffff, 0xffff, 0xffff };
374 static GdkColor gray = { 0, 0xaaaa, 0xaaaa, 0xaaaa };
375 static GdkColor yellow = { 0, 0xffff, 0xffff, 0x6666 };
376 static GdkColor red = { 0, 0xffff, 0x6666, 0x6666 };
378 static const char * ppsz_type[4] = { ": ", " error: ", " warning: ",
380 static GdkColor * pp_color[4] = { &white, &red, &yellow, &gray };
382 for( i_start = p_intf->p_sys->p_sub->i_start;
384 i_start = (i_start+1) % VLC_MSG_QSIZE )
386 /* Append all messages to log window */
387 gtk_text_insert( p_intf->p_sys->p_messages_text, NULL, &gray,
388 NULL, p_intf->p_sys->p_sub->p_msg[i_start].psz_module, -1 );
390 gtk_text_insert( p_intf->p_sys->p_messages_text, NULL, &gray,
391 NULL, ppsz_type[p_intf->p_sys->p_sub->p_msg[i_start].i_type],
394 gtk_text_insert( p_intf->p_sys->p_messages_text, NULL,
395 pp_color[p_intf->p_sys->p_sub->p_msg[i_start].i_type], NULL,
396 p_intf->p_sys->p_sub->p_msg[i_start].psz_msg, -1 );
398 gtk_text_insert( p_intf->p_sys->p_messages_text, NULL, &gray,
402 vlc_mutex_lock( p_intf->p_sys->p_sub->p_lock );
403 p_intf->p_sys->p_sub->i_start = i_start;
404 vlc_mutex_unlock( p_intf->p_sys->p_sub->p_lock );
406 gtk_text_set_point( p_intf->p_sys->p_messages_text,
407 gtk_text_get_length( p_intf->p_sys->p_messages_text ) );
410 /* Update the playlist */
411 GtkPlayListManage( p_data );
413 /* Update the input */
414 if( p_intf->p_sys->p_input == NULL )
416 p_intf->p_sys->p_input = vlc_object_find( p_intf, VLC_OBJECT_INPUT,
419 else if( p_intf->p_sys->p_input->b_dead )
421 vlc_object_release( p_intf->p_sys->p_input );
422 p_intf->p_sys->p_input = NULL;
425 if( p_intf->p_sys->p_input )
427 input_thread_t *p_input = p_intf->p_sys->p_input;
429 vlc_mutex_lock( &p_input->stream.stream_lock );
431 if( !p_input->b_die )
433 /* New input or stream map change */
434 if( p_input->stream.b_changed )
436 GtkModeManage( p_intf );
437 GtkSetupMenus( p_intf );
438 p_intf->p_sys->b_playing = 1;
441 /* Manage the slider */
442 if( p_input->stream.b_seekable && p_intf->p_sys->b_playing )
444 float newvalue = p_intf->p_sys->p_adj->value;
446 #define p_area p_input->stream.p_selected_area
447 /* If the user hasn't touched the slider since the last time,
448 * then the input can safely change it */
449 if( newvalue == p_intf->p_sys->f_adj_oldvalue )
451 /* Update the value */
452 p_intf->p_sys->p_adj->value =
453 p_intf->p_sys->f_adj_oldvalue =
454 ( 100. * p_area->i_tell ) / p_area->i_size;
456 gtk_signal_emit_by_name( GTK_OBJECT( p_intf->p_sys->p_adj ),
459 /* Otherwise, send message to the input if the user has
460 * finished dragging the slider */
461 else if( p_intf->p_sys->b_slider_free )
463 off_t i_seek = ( newvalue * p_area->i_size ) / 100;
465 /* release the lock to be able to seek */
466 vlc_mutex_unlock( &p_input->stream.stream_lock );
467 input_Seek( p_input, i_seek, INPUT_SEEK_SET );
468 vlc_mutex_lock( &p_input->stream.stream_lock );
470 /* Update the old value */
471 p_intf->p_sys->f_adj_oldvalue = newvalue;
476 if( p_intf->p_sys->i_part !=
477 p_input->stream.p_selected_area->i_part )
479 p_intf->p_sys->b_chapter_update = 1;
480 GtkSetupMenus( p_intf );
484 vlc_mutex_unlock( &p_input->stream.stream_lock );
486 else if( p_intf->p_sys->b_playing && !p_intf->b_die )
488 GtkModeManage( p_intf );
489 p_intf->p_sys->b_playing = 0;
494 vlc_mutex_unlock( &p_intf->change_lock );
496 /* Prepare to die, young Skywalker */
503 vlc_mutex_unlock( &p_intf->change_lock );