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