git.sesse.net Git - vlc/blob - modules/gui/wxwidgets/wxwidgets.cpp

   1 /*****************************************************************************
   2  * wxwidgets.cpp : wxWidgets plugin for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2000-2005 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Gildas Bazin <gbazin@netcourrier.com>
   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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <errno.h>                                                 /* ENOMEM */
  28
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <vlc_common.h>
  34 #include <vlc_plugin.h>
  35 #include <vlc_interface.h>
  36
  37 #ifdef HAVE_LOCALE_H
  38 #   include <locale.h>
  39 #endif
  40
  41 #include "interface.hpp"
  42
  43 /* Temporary hack */
  44 #if defined(WIN32) && defined(_WX_INIT_H_)
  45 #if (wxMAJOR_VERSION <= 2) && (wxMINOR_VERSION <= 5) && (wxRELEASE_NUMBER < 3)
  46 /* Hack to detect wxWidgets 2.5 which has a different wxEntry() prototype */
  47 extern int wxEntry( HINSTANCE hInstance, HINSTANCE hPrevInstance = NULL,
  48                     char *pCmdLine = NULL, int nCmdShow = SW_NORMAL );
  49 #endif
  50 #endif
  51
  52 /*****************************************************************************
  53  * Local prototypes.
  54  *****************************************************************************/
  55 static int  Open         ( vlc_object_t * );
  56 static void Close        ( vlc_object_t * );
  57 static int  OpenDialogs  ( vlc_object_t * );
  58
  59 static void Run          ( intf_thread_t * );
  60 static void Init         ( intf_thread_t * );
  61
  62 static void ShowDialog   ( intf_thread_t *, int, int, intf_dialog_args_t * );
  63
  64 #if (wxCHECK_VERSION(2,5,0))
  65 void *wxClassInfo_sm_classTable_BUGGY = 0;
  66 #endif
  67
  68 /*****************************************************************************
  69  * Local classes declarations.
  70  *****************************************************************************/
  71 class Instance: public wxApp
  72 {
  73 public:
  74     Instance();
  75     Instance( intf_thread_t *_p_intf );
  76
  77     bool OnInit();
  78     int  OnExit();
  79
  80 private:
  81     intf_thread_t *p_intf;
  82     wxLocale locale;                                /* locale we'll be using */
  83 };
  84
  85 /*****************************************************************************
  86  * Module descriptor
  87  *****************************************************************************/
  88 #define EMBED_TEXT N_("Embed video in interface")
  89 #define EMBED_LONGTEXT N_("Embed the video inside the interface instead " \
  90     "of having it in a separate window.")
  91 #define BOOKMARKS_TEXT N_("Bookmarks dialog")
  92 #define BOOKMARKS_LONGTEXT N_("Show bookmarks dialog at startup" )
  93 #define EXTENDED_TEXT N_("Extended GUI")
  94 #define EXTENDED_LONGTEXT N_("Show extended GUI (equalizer, image adjust, "  \
  95               "video filters...) at startup"  )
  96 #define TASKBAR_TEXT N_("Taskbar")
  97 #define TASKBAR_LONGTEXT N_("Show VLC on the taskbar")
  98 #define MINIMAL_TEXT N_("Minimal interface")
  99 #define MINIMAL_LONGTEXT N_("Use minimal interface, with no toolbar and " \
 100                 "fewer menus.")
 101 #define SIZE_TO_VIDEO_TEXT N_("Size to video")
 102 #define SIZE_TO_VIDEO_LONGTEXT N_("Resize VLC to match the video resolution.")
 103 #define SYSTRAY_TEXT N_("Systray icon")
 104 #define SYSTRAY_LONGTEXT N_("Show a systray icon for VLC")
 105 #define LABEL_TEXT N_("Show labels in toolbar")
 106 #define LABEL_LONGTEXT N_("Show labels below the icons in the toolbar.")
 107
 108 #define PLAYLIST_TEXT N_("Playlist view" )
 109 #define PLAYLIST_LONGTEXT N_("There are two possible playlist views in the " \
 110                 "interface : the normal playlist (separate window), or an " \
 111                 "embedded playlist (within the main interface, but with " \
 112                 "less features). You can select which one will be available " \
 113                 "on the toolbar (or both)." )
 114
 115 static const int pi_playlist_views[] = { 0,1,2 };
 116 static const char *const psz_playlist_views[] = {
 117     N_("Normal" ), N_("Embedded" ), N_("Both") };
 118
 119 vlc_module_begin();
 120     set_shortname( "wxWidgets" );
 121     set_description( N_("wxWidgets interface module") );
 122     set_category( CAT_INTERFACE );
 123     set_subcategory( SUBCAT_INTERFACE_MAIN );
 124     set_capability( "interface", 150 );
 125     set_callbacks( Open, Close );
 126     add_shortcut( "wxwindows" );
 127     add_shortcut( "wxwin" );
 128     add_shortcut( "wx" );
 129     add_shortcut( "wxwidgets" );
 130
 131     add_bool( "wx-embed", 1, NULL,
 132               EMBED_TEXT, EMBED_LONGTEXT, false );
 133         add_deprecated_alias( "wxwin-enbed" ); /*Deprecated since 0.8.4*/
 134     add_bool( "wx-bookmarks", 0, NULL,
 135               BOOKMARKS_TEXT, BOOKMARKS_LONGTEXT, false );
 136         add_deprecated_alias( "wxwin-bookmarks" ); /*Deprecated since 0.8.4*/
 137     add_bool( "wx-taskbar", 1, NULL,
 138               TASKBAR_TEXT, TASKBAR_LONGTEXT, false );
 139         add_deprecated_alias( "wxwin-taskbar" ); /*Deprecated since 0.8.4*/
 140     add_bool( "wx-extended", 0, NULL,
 141               EXTENDED_TEXT, EXTENDED_LONGTEXT, false );
 142     add_bool( "wx-minimal", 0, NULL,
 143               MINIMAL_TEXT, MINIMAL_LONGTEXT, true );
 144         add_deprecated_alias( "wxwin-minimal" ); /*Deprecated since 0.8.4*/
 145     add_bool( "wx-autosize", 1, NULL,
 146               SIZE_TO_VIDEO_TEXT, SIZE_TO_VIDEO_LONGTEXT, true );
 147         add_deprecated_alias( "wxwin-autosize" ); /*Deprecated since 0.8.4*/
 148     add_integer( "wx-playlist-view", 0, NULL, PLAYLIST_TEXT, PLAYLIST_LONGTEXT,
 149              false );
 150         change_integer_list( pi_playlist_views, psz_playlist_views, 0 );
 151 /* wxCocoa pretends to support this, but at least 2.6.x doesn't */
 152 #ifndef __APPLE__
 153 #ifdef wxHAS_TASK_BAR_ICON
 154     add_bool( "wx-systray", 0, NULL,
 155               SYSTRAY_TEXT, SYSTRAY_LONGTEXT, false );
 156         add_deprecated_alias( "wxwin-systray" ); /*Deprecated since 0.8.4*/
 157 #endif
 158 #endif
 159     add_bool( "wx-labels", 0, NULL, LABEL_TEXT, LABEL_LONGTEXT, true);
 160     add_string( "wx-config-last", NULL, NULL,
 161                 N_("last config"), N_("last config"), true );
 162         change_autosave();
 163         change_internal();
 164         add_deprecated_alias( "wxwin-config-last" ); /*Deprecated since 0.8.4*/
 165
 166     add_submodule();
 167     set_description( N_("wxWidgets dialogs provider") );
 168     set_capability( "dialogs provider", 50 );
 169     set_callbacks( OpenDialogs, Close );
 170
 171 #if !defined(WIN32)
 172     linked_with_a_crap_library_which_uses_atexit();
 173 #endif
 174 vlc_module_end();
 175
 176 /*****************************************************************************
 177  * Open: initialize and create window
 178  *****************************************************************************/
 179 static int Open( vlc_object_t *p_this )
 180 {
 181     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 182     /* Test in we have an X*/
 183 #if defined HAVE_GETENV && (defined __WXGTK__ || defined __WXX11)
 184     if( !getenv( "DISPLAY" ) )
 185     {
 186         msg_Err( p_intf, "no X server");
 187         return VLC_EGENERIC;
 188     }
 189 #endif
 190     /* Allocate instance and initialize some members */
 191     p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
 192     if( p_intf->p_sys == NULL )
 193         return VLC_ENOMEM;
 194     memset( p_intf->p_sys, 0, sizeof( intf_sys_t ) );
 195
 196     p_intf->pf_run = Run;
 197
 198     p_intf->p_sys->p_sub = msg_Subscribe( p_intf );
 199
 200     /* Initialize wxWidgets thread */
 201     p_intf->p_sys->b_playing = 0;
 202
 203     p_intf->p_sys->p_input = NULL;
 204     p_intf->p_sys->i_playing = -1;
 205
 206     p_intf->p_sys->p_popup_menu = NULL;
 207     p_intf->p_sys->p_video_window = NULL;
 208
 209     p_intf->pf_show_dialog = NULL;
 210
 211     p_intf->p_sys->b_video_autosize =
 212         config_GetInt( p_intf, "wx-autosize" );
 213
 214     return VLC_SUCCESS;
 215 }
 216
 217 static int OpenDialogs( vlc_object_t *p_this )
 218 {
 219     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 220     int i_ret = Open( p_this );
 221
 222     p_intf->pf_show_dialog = ShowDialog;
 223
 224     return i_ret;
 225 }
 226
 227 /*****************************************************************************
 228  * Close: destroy interface window
 229  *****************************************************************************/
 230 static void Close( vlc_object_t *p_this )
 231 {
 232     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 233
 234     vlc_object_lock( p_intf );
 235     p_intf->b_dead = true;
 236     vlc_object_unlock( p_intf );
 237
 238     if( p_intf->pf_show_dialog )
 239     {
 240         /* We must destroy the dialogs thread */
 241         wxCommandEvent event( wxEVT_DIALOG, INTF_DIALOG_EXIT );
 242         p_intf->p_sys->p_wxwindow->AddPendingEvent( event );
 243         vlc_thread_join( p_intf );
 244     }
 245
 246     msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
 247
 248     /* */
 249     delete p_intf->p_sys->p_window_settings;
 250
 251 #if (wxCHECK_VERSION(2,5,0))
 252     wxClassInfo::sm_classTable = (wxHashTable*)wxClassInfo_sm_classTable_BUGGY;
 253 #endif
 254
 255     /* Destroy structure */
 256     free( p_intf->p_sys );
 257 }
 258
 259 /*****************************************************************************
 260  * Run: wxWidgets thread
 261  *****************************************************************************/
 262
 263 //when is this called?
 264 #if !defined(__BUILTIN__) && defined( WIN32 )
 265 HINSTANCE hInstance = 0;
 266 extern "C" BOOL WINAPI
 267 DllMain (HANDLE hModule, DWORD fdwReason, LPVOID lpReserved)
 268 {
 269     hInstance = (HINSTANCE)hModule;
 270     return TRUE;
 271 }
 272 #endif
 273
 274 static void Run( intf_thread_t *p_intf )
 275 {
 276     if( p_intf->pf_show_dialog )
 277     {
 278         /* The module is used in dialog provider mode */
 279
 280         /* Create a new thread for wxWidgets */
 281         if( vlc_thread_create( p_intf, "Skins Dialogs Thread",
 282                                Init, 0, true ) )
 283         {
 284             msg_Err( p_intf, "cannot create Skins Dialogs Thread" );
 285             p_intf->pf_show_dialog = NULL;
 286         }
 287     }
 288     else
 289     {
 290         /* The module is used in interface mode */
 291         Init( p_intf );
 292     }
 293 }
 294
 295 static void Init( intf_thread_t *p_intf )
 296 {
 297 #if !defined( WIN32 )
 298     static char  *p_args[] = { "" };
 299     int i_args = 1;
 300 #endif
 301
 302     /* Hack to pass the p_intf pointer to the new wxWidgets Instance object */
 303 #ifdef wxTheApp
 304     wxApp::SetInstance( new Instance( p_intf ) );
 305 #else
 306     wxTheApp = new Instance( p_intf );
 307 #endif
 308
 309 #if defined( WIN32 )
 310 #if !defined(__BUILTIN__)
 311
 312     //because no one knows when DllMain is called
 313     if (hInstance == NULL)
 314       hInstance = GetModuleHandle(NULL);
 315
 316     wxEntry( hInstance/*GetModuleHandle(NULL)*/, NULL, NULL, SW_SHOW );
 317 #else
 318     wxEntry( GetModuleHandle(NULL), NULL, NULL, SW_SHOW );
 319 #endif
 320 #else
 321     wxEntry( i_args, p_args );
 322 #endif
 323 }
 324
 325 /* following functions are local */
 326
 327 /*****************************************************************************
 328  * Constructors.
 329  *****************************************************************************/
 330 Instance::Instance( )
 331 {
 332 }
 333
 334 Instance::Instance( intf_thread_t *_p_intf )
 335 {
 336     /* Initialization */
 337     p_intf = _p_intf;
 338 }
 339
 340 IMPLEMENT_APP_NO_MAIN(Instance)
 341
 342 /*****************************************************************************
 343  * Instance::OnInit: the parent interface execution starts here
 344  *****************************************************************************
 345  * This is the "main program" equivalent, the program execution will
 346  * start here.
 347  *****************************************************************************/
 348 bool Instance::OnInit()
 349 {
 350     /* Initialization of i18n stuff.
 351      * Usefull for things we don't have any control over, like wxWidgets
 352      * provided facilities (eg. open file dialog) */
 353     locale.Init( wxLANGUAGE_DEFAULT, wxLOCALE_LOAD_DEFAULT );
 354
 355     /* Load saved window settings */
 356     p_intf->p_sys->p_window_settings = new WindowSettings( p_intf );
 357
 358     /* Make an instance of your derived frame. Passing NULL (the default value
 359      * of Frame's constructor is NULL) as the frame doesn't have a parent
 360      * since it is the first window */
 361
 362     if( !p_intf->pf_show_dialog )
 363     {
 364         /* The module is used in interface mode */
 365         long style = wxDEFAULT_FRAME_STYLE;
 366         if ( ! config_GetInt( p_intf, "wx-taskbar" ) )
 367         {
 368             style = wxDEFAULT_FRAME_STYLE|wxFRAME_NO_TASKBAR;
 369         }
 370
 371         Interface *MainInterface = new Interface( p_intf, style );
 372         p_intf->p_sys->p_wxwindow = MainInterface;
 373
 374         /* Show the interface */
 375         MainInterface->Show( TRUE );
 376         SetTopWindow( MainInterface );
 377         MainInterface->Raise();
 378     }
 379
 380     /* Creates the dialogs provider */
 381     p_intf->p_sys->p_wxwindow =
 382         CreateDialogsProvider( p_intf, p_intf->pf_show_dialog ?
 383                                NULL : p_intf->p_sys->p_wxwindow );
 384
 385     p_intf->p_sys->pf_show_dialog = ShowDialog;
 386
 387     /* OK, initialization is over */
 388     vlc_thread_ready( p_intf );
 389
 390     /* Return TRUE to tell program to continue (FALSE would terminate) */
 391     return TRUE;
 392 }
 393
 394 /*****************************************************************************
 395  * Instance::OnExit: called when the interface execution stops
 396  *****************************************************************************/
 397 int Instance::OnExit()
 398 {
 399     if( p_intf->pf_show_dialog )
 400     {
 401          /* We need to manually clean up the dialogs class */
 402          delete p_intf->p_sys->p_wxwindow;
 403     }
 404
 405 #if (wxCHECK_VERSION(2,5,0))
 406     wxClassInfo_sm_classTable_BUGGY = wxClassInfo::sm_classTable;
 407     wxClassInfo::sm_classTable = 0;
 408 #endif
 409
 410     return 0;
 411 }
 412
 413 static void ShowDialog( intf_thread_t *p_intf, int i_dialog_event, int i_arg,
 414                         intf_dialog_args_t *p_arg )
 415 {
 416     wxCommandEvent event( wxEVT_DIALOG, i_dialog_event );
 417     event.SetInt( i_arg );
 418     event.SetClientData( p_arg );
 419
 420 #ifdef WIN32
 421     SendMessage( (HWND)p_intf->p_sys->p_wxwindow->GetHandle(),
 422                  WM_CANCELMODE, 0, 0 );
 423 #endif
 424     if( i_dialog_event == INTF_DIALOG_POPUPMENU && i_arg == 0 ) return;
 425
 426     /* Hack to prevent popup events to be enqueued when
 427      * one is already active */
 428     if( i_dialog_event != INTF_DIALOG_POPUPMENU ||
 429         !p_intf->p_sys->p_popup_menu )
 430     {
 431         p_intf->p_sys->p_wxwindow->AddPendingEvent( event );
 432     }
 433 }
 434
 435 /*****************************************************************************
 436  * WindowSettings utility class
 437  *****************************************************************************/
 438 WindowSettings::WindowSettings( intf_thread_t *_p_intf )
 439 {
 440     char *psz_org = NULL;
 441     char *psz;
 442     int i;
 443
 444     /* */
 445     p_intf = _p_intf;
 446
 447     /* */
 448     for( i = 0; i < ID_MAX; i++ )
 449     {
 450         b_valid[i] = false;
 451         b_shown[i] = false;
 452         position[i] = wxDefaultPosition;
 453         size[i] = wxDefaultSize;
 454     }
 455     b_shown[ID_MAIN] = true;
 456
 457     if( p_intf->pf_show_dialog ) return;
 458
 459     /* Parse the configuration */
 460     psz_org = psz = config_GetPsz( p_intf, "wx-config-last" );
 461     if( !psz || *psz == '\0' ) return;
 462
 463     msg_Dbg( p_intf, "Using last windows config '%s'", psz );
 464
 465     i_screen_w = 0;
 466     i_screen_h = 0;
 467     while( psz && *psz )
 468     {
 469         int id, v[4];
 470
 471         psz = strchr( psz, '(' );
 472
 473         if( !psz )
 474             break;
 475         psz++;
 476
 477         id = strtol( psz, &psz, 0 );
 478         if( *psz != ',' ) /* broken cfg */
 479         {
 480             goto invalid;
 481         }
 482         psz++;
 483
 484         for( i = 0; i < 4; i++ )
 485         {
 486             v[i] = strtol( psz, &psz, 0 );
 487
 488             if( i < 3 )
 489             {
 490                 if( *psz != ',' )
 491                 {
 492                     goto invalid;
 493                 }
 494                 psz++;
 495             }
 496             else
 497             {
 498                 if( *psz != ')' )
 499                 {
 500                     goto invalid;
 501                 }
 502             }
 503         }
 504         if( id == ID_SCREEN )
 505         {
 506             i_screen_w = v[2];
 507             i_screen_h = v[3];
 508         }
 509         else if( id >= 0 && id < ID_MAX )
 510         {
 511             b_valid[id] = true;
 512             b_shown[id] = true;
 513             position[id] = wxPoint( v[0], v[1] );
 514             size[id] = wxSize( v[2], v[3] );
 515
 516             msg_Dbg( p_intf, "id=%d p=(%d,%d) s=(%d,%d)",
 517                      id, position[id].x, position[id].y,
 518                          size[id].x, size[id].y );
 519         }
 520
 521         psz = strchr( psz, ')' );
 522         if( psz ) psz++;
 523     }
 524
 525     if( i_screen_w <= 0 || i_screen_h <= 0 )
 526     {
 527         goto invalid;
 528     }
 529
 530     for( i = 0; i < ID_MAX; i++ )
 531     {
 532         if( !b_valid[i] )
 533             continue;
 534         if( position[i].x < 0 || position[i].y < 0 )
 535         {
 536             goto invalid;
 537         }
 538         if( i != ID_SMALL_PLAYLIST && (size[i].x <= 0 || size[i].y <= 0)  )
 539         {
 540             goto invalid;
 541         }
 542     }
 543
 544     free( psz_org );
 545     return;
 546
 547 invalid:
 548     msg_Dbg( p_intf, "last windows config is invalid (ignored)" );
 549     for( i = 0; i < ID_MAX; i++ )
 550     {
 551         b_valid[i] = false;
 552         b_shown[i] = false;
 553         position[i] = wxDefaultPosition;
 554         size[i] = wxDefaultSize;
 555     }
 556     free( psz_org );
 557 }
 558
 559
 560 WindowSettings::~WindowSettings( )
 561 {
 562     wxString sCfg;
 563
 564     if( p_intf->pf_show_dialog ) return;
 565
 566     sCfg = wxString::Format( wxT("(%d,0,0,%d,%d)"), ID_SCREEN,
 567                              wxSystemSettings::GetMetric( wxSYS_SCREEN_X ),
 568                              wxSystemSettings::GetMetric( wxSYS_SCREEN_Y ) );
 569     for( int i = 0; i < ID_MAX; i++ )
 570     {
 571         if( !b_valid[i] || !b_shown[i] )
 572             continue;
 573
 574         sCfg += wxString::Format( wxT("(%d,%d,%d,%d,%d)"),
 575                                   i, position[i].x, position[i].y,
 576                                      size[i].x, size[i].y );
 577     }
 578
 579     config_PutPsz( p_intf, "wx-config-last", sCfg.mb_str(wxConvUTF8) );
 580 }
 581
 582 void WindowSettings::SetScreen( int i_screen_w, int i_screen_h )
 583 {
 584     int i;
 585
 586     for( i = 0; i < ID_MAX; i++ )
 587     {
 588         if( !b_valid[i] )
 589             continue;
 590         if( position[i].x >= i_screen_w || position[i].y >= i_screen_h )
 591             goto invalid;
 592     }
 593     return;
 594
 595 invalid:
 596     for( i = 0; i < ID_MAX; i++ )
 597     {
 598         b_valid[i] = false;
 599         b_shown[i] = false;
 600         position[i] = wxDefaultPosition;
 601         size[i] = wxDefaultSize;
 602     }
 603 }
 604
 605 void WindowSettings::SetSettings( int id, bool _b_shown, wxPoint p, wxSize s )
 606 {
 607     if( id < 0 || id >= ID_MAX )
 608         return;
 609
 610     b_valid[id] = true;
 611     b_shown[id] = _b_shown;
 612
 613     position[id] = p;
 614     size[id] = s;
 615 }
 616
 617 bool WindowSettings::GetSettings( int id, bool& _b_shown, wxPoint& p, wxSize& s)
 618 {
 619     if( id < 0 || id >= ID_MAX )
 620         return false;
 621
 622     if( !b_valid[id] )
 623         return false;
 624
 625     _b_shown = b_shown[id];
 626     p = position[id];
 627     s = size[id];
 628
 629     return true;
 630 }