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

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