git.sesse.net Git - vlc/blob - plugins/gtk/gtk.c

   1 /*****************************************************************************
   2  * gtk.c : Gtk+ plugin for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2000-2001 VideoLAN
   5  * $Id: gtk.c,v 1.31 2002/07/31 20:56:51 sam Exp $
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *
   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.
  13  *
  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.
  18  *
  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  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <stdlib.h>                                      /* malloc(), free() */
  28 #include <errno.h>                                                 /* ENOMEM */
  29 #include <string.h>                                            /* strerror() */
  30 #include <stdio.h>
  31
  32 #include <vlc/vlc.h>
  33 #include <vlc/intf.h>
  34
  35 #include <gtk/gtk.h>
  36
  37 #include "gtk_callbacks.h"
  38 #include "gtk_interface.h"
  39 #include "gtk_support.h"
  40 #include "gtk_menu.h"
  41 #include "gtk_display.h"
  42 #include "gtk_common.h"
  43
  44 /*****************************************************************************
  45  * Local prototypes.
  46  *****************************************************************************/
  47 static int  Open         ( vlc_object_t * );
  48 static void Close        ( vlc_object_t * );
  49
  50 static void Run          ( intf_thread_t * );
  51 static gint Manage       ( gpointer );
  52
  53 /*****************************************************************************
  54  * Local variables (mutex-protected).
  55  *****************************************************************************/
  56 static void ** pp_global_data = NULL;
  57
  58 /*****************************************************************************
  59  * Module descriptor
  60  *****************************************************************************/
  61 #define TOOLTIPS_TEXT N_("show tooltips")
  62 #define TOOLTIPS_LONGTEXT N_("Show tooltips for configuration options.")
  63
  64 #define PREFS_MAXH_TEXT N_("maximum height for the configuration windows")
  65 #define PREFS_MAXH_LONGTEXT N_( \
  66     "You can set the maximum height that the configuration windows in the " \
  67     "preferences menu will occupy.")
  68
  69 vlc_module_begin();
  70 #ifdef WIN32
  71     int i = 90;
  72 #else
  73     int i = getenv( "DISPLAY" ) == NULL ? 10 : 90;
  74 #endif
  75     pp_global_data = p_module->p_vlc->pp_global_data;
  76
  77     add_category_hint( N_("Miscellaneous"), NULL );
  78     add_bool( "gtk-tooltips", 1, GtkHideTooltips,
  79               TOOLTIPS_TEXT, TOOLTIPS_LONGTEXT );
  80     add_integer( "gtk-prefs-maxh", 480, NULL,
  81                  PREFS_MAXH_TEXT, PREFS_MAXH_LONGTEXT );
  82
  83     set_description( _("Gtk+ interface module") );
  84     set_capability( "interface", i );
  85     set_callbacks( Open, Close );
  86     set_program( "gvlc" );
  87 vlc_module_end();
  88
  89 /*****************************************************************************
  90  * g_atexit: kludge to avoid the Gtk+ thread to segfault at exit
  91  *****************************************************************************
  92  * gtk_init() makes several calls to g_atexit() which calls atexit() to
  93  * register tidying callbacks to be called at program exit. Since the Gtk+
  94  * plugin is likely to be unloaded at program exit, we have to export this
  95  * symbol to intercept the g_atexit() calls. Talk about crude hack.
  96  *****************************************************************************/
  97 void g_atexit( GVoidFunc func )
  98 {
  99     intf_thread_t *p_intf;
 100
 101     int i_dummy;
 102
 103     if( pp_global_data == NULL )
 104     {
 105         atexit( func );
 106         return;
 107     }
 108
 109     p_intf = (intf_thread_t *)*pp_global_data;
 110     if( p_intf == NULL )
 111     {
 112         return;
 113     }
 114
 115     for( i_dummy = 0;
 116          i_dummy < MAX_ATEXIT && p_intf->p_sys->pf_callback[i_dummy] != NULL;
 117          i_dummy++ )
 118     {
 119         ;
 120     }
 121
 122     if( i_dummy >= MAX_ATEXIT - 1 )
 123     {
 124         msg_Err( p_intf, "too many atexit() callbacks to register" );
 125         return;
 126     }
 127
 128     p_intf->p_sys->pf_callback[i_dummy]     = func;
 129     p_intf->p_sys->pf_callback[i_dummy + 1] = NULL;
 130 }
 131
 132 /*****************************************************************************
 133  * Open: initialize and create window
 134  *****************************************************************************/
 135 static int Open( vlc_object_t *p_this )
 136 {
 137     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 138
 139     /* Allocate instance and initialize some members */
 140     p_intf->p_sys = malloc( sizeof( intf_sys_t ) );
 141     if( p_intf->p_sys == NULL )
 142     {
 143         msg_Err( p_intf, "out of memory" );
 144         return( 1 );
 145     }
 146
 147     p_intf->pf_run = Run;
 148
 149     p_intf->p_sys->p_sub = msg_Subscribe( p_intf );
 150
 151     /* Initialize Gtk+ thread */
 152     p_intf->p_sys->b_playing = 0;
 153     p_intf->p_sys->b_popup_changed = 0;
 154     p_intf->p_sys->b_window_changed = 0;
 155     p_intf->p_sys->b_playlist_changed = 0;
 156
 157     p_intf->p_sys->p_input = NULL;
 158     p_intf->p_sys->i_playing = -1;
 159     p_intf->p_sys->b_slider_free = 1;
 160
 161     p_intf->p_sys->pf_callback[0] = NULL;
 162
 163     p_intf->p_sys->i_part = 0;
 164
 165     return( 0 );
 166 }
 167
 168 /*****************************************************************************
 169  * Close: destroy interface window
 170  *****************************************************************************/
 171 static void Close( vlc_object_t *p_this )
 172 {
 173     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 174
 175     if( p_intf->p_sys->p_input )
 176     {
 177         vlc_object_release( p_intf->p_sys->p_input );
 178     }
 179
 180     msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
 181
 182     /* Destroy structure */
 183     free( p_intf->p_sys );
 184 }
 185
 186 /*****************************************************************************
 187  * Run: Gtk+ thread
 188  *****************************************************************************
 189  * this part of the interface is in a separate thread so that we can call
 190  * gtk_main() from within it without annoying the rest of the program.
 191  * XXX: the approach may look kludgy, and probably is, but I could not find
 192  * a better way to dynamically load a Gtk+ interface at runtime.
 193  *****************************************************************************/
 194 static void Run( intf_thread_t *p_intf )
 195 {
 196     /* gtk_init needs to know the command line. We don't care, so we
 197      * give it an empty one */
 198     char  *p_args[] = { "" };
 199     char **pp_args  = p_args;
 200     int    i_args   = 1;
 201     int    i_dummy;
 202
 203     /* The data types we are allowed to receive */
 204     static GtkTargetEntry target_table[] =
 205     {
 206         { "STRING", 0, DROP_ACCEPT_STRING },
 207         { "text/uri-list", 0, DROP_ACCEPT_TEXT_URI_LIST },
 208         { "text/plain", 0, DROP_ACCEPT_TEXT_PLAIN }
 209     };
 210
 211     /* Initialize Gtk+ */
 212
 213     /* gtk_init will register stuff with g_atexit, so we need to take
 214      * the global lock if we want to be able to intercept the calls */
 215     vlc_mutex_lock( p_intf->p_vlc->p_global_lock );
 216     *p_intf->p_vlc->pp_global_data = p_intf;
 217     gtk_init( &i_args, &pp_args );
 218     vlc_mutex_unlock( p_intf->p_vlc->p_global_lock );
 219
 220     /* Create some useful widgets that will certainly be used */
 221     p_intf->p_sys->p_window = create_intf_window();
 222     p_intf->p_sys->p_popup = create_intf_popup();
 223     p_intf->p_sys->p_playwin = create_intf_playlist();
 224     p_intf->p_sys->p_messages = create_intf_messages();
 225     p_intf->p_sys->p_tooltips = gtk_tooltips_new();
 226
 227     /* Set the title of the main window */
 228     gtk_window_set_title( GTK_WINDOW(p_intf->p_sys->p_window),
 229                           VOUT_TITLE " (Gtk+ interface)");
 230
 231     /* Accept file drops on the main window */
 232     gtk_drag_dest_set( GTK_WIDGET( p_intf->p_sys->p_window ),
 233                        GTK_DEST_DEFAULT_ALL, target_table,
 234                        1, GDK_ACTION_COPY );
 235
 236     /* Accept file drops on the playlist window */
 237     gtk_drag_dest_set( GTK_WIDGET( lookup_widget( p_intf->p_sys->p_playwin,
 238                                    "playlist_clist") ),
 239                        GTK_DEST_DEFAULT_ALL, target_table,
 240                        1, GDK_ACTION_COPY );
 241
 242     /* Get the slider object */
 243     p_intf->p_sys->p_slider_frame = GTK_FRAME( gtk_object_get_data(
 244         GTK_OBJECT( p_intf->p_sys->p_window ), "slider_frame" ) );
 245
 246     /* Configure the log window */
 247     p_intf->p_sys->p_messages_text = GTK_TEXT( gtk_object_get_data(
 248         GTK_OBJECT(p_intf->p_sys->p_messages ), "messages_textbox" ) );
 249     gtk_text_set_line_wrap( p_intf->p_sys->p_messages_text, TRUE);
 250     gtk_text_set_word_wrap( p_intf->p_sys->p_messages_text, FALSE);
 251
 252     /* Get the interface labels */
 253 #define P_LABEL( name ) GTK_LABEL( gtk_object_get_data( \
 254                          GTK_OBJECT( p_intf->p_sys->p_window ), name ) )
 255     p_intf->p_sys->p_label_title = P_LABEL( "title_label" );
 256     p_intf->p_sys->p_label_chapter = P_LABEL( "chapter_label" );
 257 #undef P_LABEL
 258
 259     /* Connect the date display to the slider */
 260 #define P_SLIDER GTK_RANGE( gtk_object_get_data( \
 261                          GTK_OBJECT( p_intf->p_sys->p_window ), "slider" ) )
 262     p_intf->p_sys->p_adj = gtk_range_get_adjustment( P_SLIDER );
 263
 264     gtk_signal_connect ( GTK_OBJECT( p_intf->p_sys->p_adj ), "value_changed",
 265                          GTK_SIGNAL_FUNC( GtkDisplayDate ), NULL );
 266     p_intf->p_sys->f_adj_oldvalue = 0;
 267 #undef P_SLIDER
 268
 269     /* We don't create these ones yet because we perhaps won't need them */
 270     p_intf->p_sys->p_about = NULL;
 271     p_intf->p_sys->p_modules = NULL;
 272     p_intf->p_sys->p_open = NULL;
 273     p_intf->p_sys->p_jump = NULL;
 274
 275     /* Hide tooltips if the option is set */
 276     if( !config_GetInt( p_intf, "gtk-tooltips" ) )
 277     {
 278         gtk_tooltips_disable( p_intf->p_sys->p_tooltips );
 279     }
 280
 281     /* Store p_intf to keep an eye on it */
 282     gtk_object_set_data( GTK_OBJECT(p_intf->p_sys->p_window),
 283                          "p_intf", p_intf );
 284
 285     gtk_object_set_data( GTK_OBJECT(p_intf->p_sys->p_popup),
 286                          "p_intf", p_intf );
 287
 288     gtk_object_set_data( GTK_OBJECT( p_intf->p_sys->p_playwin ),
 289                          "p_intf", p_intf );
 290
 291     gtk_object_set_data( GTK_OBJECT( p_intf->p_sys->p_messages ),
 292                          "p_intf", p_intf );
 293
 294     gtk_object_set_data( GTK_OBJECT(p_intf->p_sys->p_adj),
 295                          "p_intf", p_intf );
 296
 297     /* Show the control window */
 298     gtk_widget_show( p_intf->p_sys->p_window );
 299
 300     /* Sleep to avoid using all CPU - since some interfaces needs to access
 301      * keyboard events, a 100ms delay is a good compromise */
 302     i_dummy = gtk_timeout_add( INTF_IDLE_SLEEP / 1000, Manage, p_intf );
 303
 304     /* Enter Gtk mode */
 305     gtk_main();
 306
 307     /* Remove the timeout */
 308     gtk_timeout_remove( i_dummy );
 309
 310     /* Destroy the Tooltips structure */
 311     gtk_object_destroy( GTK_OBJECT(p_intf->p_sys->p_tooltips) );
 312
 313     /* Launch stored callbacks */
 314     for( i_dummy = 0;
 315          i_dummy < MAX_ATEXIT && p_intf->p_sys->pf_callback[i_dummy] != NULL;
 316          i_dummy++ )
 317     {
 318         p_intf->p_sys->pf_callback[i_dummy]();
 319     }
 320 }
 321
 322 /* following functions are local */
 323
 324 /*****************************************************************************
 325  * Manage: manage main thread messages
 326  *****************************************************************************
 327  * In this function, called approx. 10 times a second, we check what the
 328  * main program wanted to tell us.
 329  *****************************************************************************/
 330 static gint Manage( gpointer p_data )
 331 {
 332 #define p_intf ((intf_thread_t *)p_data)
 333     int i_start, i_stop;
 334
 335     vlc_mutex_lock( &p_intf->change_lock );
 336
 337     /* If the "display popup" flag has changed */
 338     if( p_intf->b_menu_change )
 339     {
 340         if( !GTK_IS_WIDGET( p_intf->p_sys->p_popup ) )
 341         {
 342             p_intf->p_sys->p_popup = create_intf_popup();
 343             gtk_object_set_data( GTK_OBJECT( p_intf->p_sys->p_popup ),
 344                                  "p_intf", p_intf );
 345         }
 346         gtk_menu_popup( GTK_MENU( p_intf->p_sys->p_popup ),
 347                         NULL, NULL, NULL, NULL, 0, GDK_CURRENT_TIME );
 348         p_intf->b_menu_change = 0;
 349     }
 350
 351     /* Update the log window */
 352     vlc_mutex_lock( p_intf->p_sys->p_sub->p_lock );
 353     i_stop = *p_intf->p_sys->p_sub->pi_stop;
 354     vlc_mutex_unlock( p_intf->p_sys->p_sub->p_lock );
 355
 356     if( p_intf->p_sys->p_sub->i_start != i_stop )
 357     {
 358         static GdkColor white  = { 0, 0xffff, 0xffff, 0xffff };
 359         static GdkColor gray   = { 0, 0xaaaa, 0xaaaa, 0xaaaa };
 360         static GdkColor yellow = { 0, 0xffff, 0xffff, 0x6666 };
 361         static GdkColor red    = { 0, 0xffff, 0x6666, 0x6666 };
 362
 363         static const char * ppsz_type[4] = { ": ", " error: ", " warning: ",
 364                                              " debug: " };
 365         static GdkColor *   pp_color[4] = { &white, &red, &yellow, &gray };
 366
 367         for( i_start = p_intf->p_sys->p_sub->i_start;
 368              i_start != i_stop;
 369              i_start = (i_start+1) % VLC_MSG_QSIZE )
 370         {
 371             /* Append all messages to log window */
 372             gtk_text_insert( p_intf->p_sys->p_messages_text, NULL, &gray,
 373              NULL, p_intf->p_sys->p_sub->p_msg[i_start].psz_module, -1 );
 374
 375             gtk_text_insert( p_intf->p_sys->p_messages_text, NULL, &gray,
 376                 NULL, ppsz_type[p_intf->p_sys->p_sub->p_msg[i_start].i_type],
 377                 -1 );
 378
 379             gtk_text_insert( p_intf->p_sys->p_messages_text, NULL,
 380                 pp_color[p_intf->p_sys->p_sub->p_msg[i_start].i_type], NULL,
 381                 p_intf->p_sys->p_sub->p_msg[i_start].psz_msg, -1 );
 382
 383             gtk_text_insert( p_intf->p_sys->p_messages_text, NULL, &gray,
 384                 NULL, "\n", -1 );
 385         }
 386
 387         vlc_mutex_lock( p_intf->p_sys->p_sub->p_lock );
 388         p_intf->p_sys->p_sub->i_start = i_start;
 389         vlc_mutex_unlock( p_intf->p_sys->p_sub->p_lock );
 390
 391         gtk_text_set_point( p_intf->p_sys->p_messages_text,
 392                     gtk_text_get_length( p_intf->p_sys->p_messages_text ) );
 393     }
 394
 395     /* Update the playlist */
 396     GtkPlayListManage( p_data );
 397
 398     /* Update the input */
 399     if( p_intf->p_sys->p_input == NULL )
 400     {
 401         p_intf->p_sys->p_input = vlc_object_find( p_intf, VLC_OBJECT_INPUT,
 402                                                           FIND_ANYWHERE );
 403     }
 404     else if( p_intf->p_sys->p_input->b_dead )
 405     {
 406         vlc_object_release( p_intf->p_sys->p_input );
 407         p_intf->p_sys->p_input = NULL;
 408     }
 409
 410     if( p_intf->p_sys->p_input )
 411     {
 412         input_thread_t *p_input = p_intf->p_sys->p_input;
 413
 414         vlc_mutex_lock( &p_input->stream.stream_lock );
 415
 416         if( !p_input->b_die )
 417         {
 418             /* New input or stream map change */
 419             if( p_input->stream.b_changed )
 420             {
 421                 GtkModeManage( p_intf );
 422                 GtkSetupMenus( p_intf );
 423                 p_intf->p_sys->b_playing = 1;
 424             }
 425
 426             /* Manage the slider */
 427             if( p_input->stream.b_seekable && p_intf->p_sys->b_playing )
 428             {
 429                 float newvalue = p_intf->p_sys->p_adj->value;
 430
 431 #define p_area p_input->stream.p_selected_area
 432                 /* If the user hasn't touched the slider since the last time,
 433                  * then the input can safely change it */
 434                 if( newvalue == p_intf->p_sys->f_adj_oldvalue )
 435                 {
 436                     /* Update the value */
 437                     p_intf->p_sys->p_adj->value =
 438                     p_intf->p_sys->f_adj_oldvalue =
 439                         ( 100. * p_area->i_tell ) / p_area->i_size;
 440
 441                     gtk_signal_emit_by_name( GTK_OBJECT( p_intf->p_sys->p_adj ),
 442                                              "value_changed" );
 443                 }
 444                 /* Otherwise, send message to the input if the user has
 445                  * finished dragging the slider */
 446                 else if( p_intf->p_sys->b_slider_free )
 447                 {
 448                     off_t i_seek = ( newvalue * p_area->i_size ) / 100;
 449
 450                     /* release the lock to be able to seek */
 451                     vlc_mutex_unlock( &p_input->stream.stream_lock );
 452                     input_Seek( p_input, i_seek, INPUT_SEEK_SET );
 453                     vlc_mutex_lock( &p_input->stream.stream_lock );
 454
 455                     /* Update the old value */
 456                     p_intf->p_sys->f_adj_oldvalue = newvalue;
 457                 }
 458 #undef p_area
 459             }
 460
 461             if( p_intf->p_sys->i_part !=
 462                 p_input->stream.p_selected_area->i_part )
 463             {
 464                 p_intf->p_sys->b_chapter_update = 1;
 465                 GtkSetupMenus( p_intf );
 466             }
 467         }
 468
 469         vlc_mutex_unlock( &p_input->stream.stream_lock );
 470     }
 471     else if( p_intf->p_sys->b_playing && !p_intf->b_die )
 472     {
 473         GtkModeManage( p_intf );
 474         p_intf->p_sys->b_playing = 0;
 475     }
 476
 477     if( p_intf->b_die )
 478     {
 479         vlc_mutex_unlock( &p_intf->change_lock );
 480
 481         /* Prepare to die, young Skywalker */
 482         gtk_main_quit();
 483
 484         /* Just in case */
 485         return( FALSE );
 486     }
 487
 488     vlc_mutex_unlock( &p_intf->change_lock );
 489
 490     return( TRUE );
 491
 492 #undef p_intf
 493 }