git.sesse.net Git - vlc/blob - modules/control/hotkeys.c

   1 /*****************************************************************************
   2  * hotkeys.c: Hotkey handling for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2004 VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Sigmund Augdal <sigmunau@idi.ntnu.no>
   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
  29 #include <vlc/vlc.h>
  30 #include <vlc/intf.h>
  31 #include <vlc/input.h>
  32 #include <vlc/vout.h>
  33 #include <vlc/aout.h>
  34 #include <osd.h>
  35
  36 #include "vlc_keys.h"
  37
  38 #define BUFFER_SIZE 10
  39 /*****************************************************************************
  40  * intf_sys_t: description and status of FB interface
  41  *****************************************************************************/
  42 struct intf_sys_t
  43 {
  44     vlc_mutex_t         change_lock;  /* mutex to keep the callback
  45                                        * and the main loop from
  46                                        * stepping on each others
  47                                        * toes */
  48     int                 p_keys[ BUFFER_SIZE ]; /* buffer that contains
  49                                                 * keyevents */
  50     int                 i_size;        /* number of events in buffer */
  51     input_thread_t *    p_input;       /* pointer to input */
  52     vout_thread_t *     p_vout;        /* pointer to vout object */
  53 };
  54
  55 /*****************************************************************************
  56  * Local prototypes
  57  *****************************************************************************/
  58 static int  Open    ( vlc_object_t * );
  59 static void Close   ( vlc_object_t * );
  60 static void Run     ( intf_thread_t * );
  61 static int  GetKey  ( intf_thread_t *);
  62 static int  KeyEvent( vlc_object_t *, char const *,
  63                       vlc_value_t, vlc_value_t, void * );
  64 static int  ActionKeyCB( vlc_object_t *, char const *,
  65                          vlc_value_t, vlc_value_t, void * );
  66 static void PlayBookmark( intf_thread_t *, int );
  67 static void SetBookmark ( intf_thread_t *, int );
  68
  69 /*****************************************************************************
  70  * Module descriptor
  71  *****************************************************************************/
  72 #define BOOKMARK1_TEXT N_("Playlist bookmark 1")
  73 #define BOOKMARK2_TEXT N_("Playlist bookmark 2")
  74 #define BOOKMARK3_TEXT N_("Playlist bookmark 3")
  75 #define BOOKMARK4_TEXT N_("Playlist bookmark 4")
  76 #define BOOKMARK5_TEXT N_("Playlist bookmark 5")
  77 #define BOOKMARK6_TEXT N_("Playlist bookmark 6")
  78 #define BOOKMARK7_TEXT N_("Playlist bookmark 7")
  79 #define BOOKMARK8_TEXT N_("Playlist bookmark 8")
  80 #define BOOKMARK9_TEXT N_("Playlist bookmark 9")
  81 #define BOOKMARK10_TEXT N_("Playlist bookmark 10")
  82 #define BOOKMARK_LONGTEXT N_( \
  83     "This option allows you to define playlist bookmarks.")
  84
  85 vlc_module_begin();
  86     set_description( _("Hotkeys management interface") );
  87     add_string( "bookmark1", NULL, NULL,
  88                 BOOKMARK1_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
  89     add_string( "bookmark2", NULL, NULL,
  90                 BOOKMARK2_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
  91     add_string( "bookmark3", NULL, NULL,
  92                 BOOKMARK3_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
  93     add_string( "bookmark4", NULL, NULL,
  94                 BOOKMARK4_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
  95     add_string( "bookmark5", NULL, NULL,
  96                 BOOKMARK5_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
  97     add_string( "bookmark6", NULL, NULL,
  98                 BOOKMARK6_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
  99     add_string( "bookmark7", NULL, NULL,
 100                 BOOKMARK7_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
 101     add_string( "bookmark8", NULL, NULL,
 102                 BOOKMARK8_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
 103     add_string( "bookmark9", NULL, NULL,
 104                 BOOKMARK9_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
 105     add_string( "bookmark10", NULL, NULL,
 106                 BOOKMARK10_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
 107
 108     set_capability( "interface", 0 );
 109     set_callbacks( Open, Close );
 110 vlc_module_end();
 111
 112 /*****************************************************************************
 113  * Open: initialize interface
 114  *****************************************************************************/
 115 static int Open( vlc_object_t *p_this )
 116 {
 117     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 118
 119     /* Allocate instance and initialize some members */
 120     p_intf->p_sys = malloc( sizeof( intf_sys_t ) );
 121     if( p_intf->p_sys == NULL )
 122     {
 123         msg_Err( p_intf, "out of memory" );
 124         return 1;
 125     }
 126     vlc_mutex_init( p_intf, &p_intf->p_sys->change_lock );
 127     p_intf->p_sys->i_size = 0;
 128     p_intf->pf_run = Run;
 129
 130     p_intf->p_sys->p_input = NULL;
 131     p_intf->p_sys->p_vout = NULL;
 132
 133     var_AddCallback( p_intf->p_vlc, "key-pressed", KeyEvent, p_intf );
 134     return 0;
 135 }
 136
 137 /*****************************************************************************
 138  * Close: destroy interface
 139  *****************************************************************************/
 140 static void Close( vlc_object_t *p_this )
 141 {
 142     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 143
 144     if( p_intf->p_sys->p_input )
 145     {
 146         vlc_object_release( p_intf->p_sys->p_input );
 147     }
 148     if( p_intf->p_sys->p_vout )
 149     {
 150         vlc_object_release( p_intf->p_sys->p_vout );
 151     }
 152     /* Destroy structure */
 153     free( p_intf->p_sys );
 154 }
 155
 156 /*****************************************************************************
 157  * Run: main loop
 158  *****************************************************************************/
 159 static void Run( intf_thread_t *p_intf )
 160 {
 161     playlist_t *p_playlist;
 162     input_thread_t *p_input;
 163     vout_thread_t *p_vout = NULL;
 164     struct hotkey *p_hotkeys = p_intf->p_vlc->p_hotkeys;
 165     vlc_value_t val;
 166     int i;
 167
 168     /* Initialize hotkey structure */
 169     for( i = 0; p_hotkeys[i].psz_action != NULL; i++ )
 170     {
 171         var_Create( p_intf->p_vlc, p_hotkeys[i].psz_action,
 172                     VLC_VAR_HOTKEY | VLC_VAR_DOINHERIT );
 173
 174         var_AddCallback( p_intf->p_vlc, p_hotkeys[i].psz_action,
 175                          ActionKeyCB, NULL );
 176         var_Get( p_intf->p_vlc, p_hotkeys[i].psz_action, &val );
 177         var_Set( p_intf->p_vlc, p_hotkeys[i].psz_action, val );
 178     }
 179
 180     while( !p_intf->b_die )
 181     {
 182         int i_key, i_action;
 183
 184         /* Sleep a bit */
 185         msleep( INTF_IDLE_SLEEP );
 186
 187         /* Update the input */
 188         if( p_intf->p_sys->p_input == NULL )
 189         {
 190             p_intf->p_sys->p_input = vlc_object_find( p_intf, VLC_OBJECT_INPUT,
 191                                                       FIND_ANYWHERE );
 192         }
 193         else if( p_intf->p_sys->p_input->b_dead )
 194         {
 195             vlc_object_release( p_intf->p_sys->p_input );
 196             p_intf->p_sys->p_input = NULL;
 197         }
 198         p_input = p_intf->p_sys->p_input;
 199
 200         /* Update the vout */
 201         if( p_vout == NULL )
 202         {
 203             p_vout = vlc_object_find( p_intf, VLC_OBJECT_VOUT,
 204                                       FIND_ANYWHERE );
 205             p_intf->p_sys->p_vout = p_vout;
 206         }
 207         else if( p_vout->b_die )
 208         {
 209             vlc_object_release( p_vout );
 210             p_vout = NULL;
 211             p_intf->p_sys->p_vout = NULL;
 212         }
 213
 214         /* Find action triggered by hotkey */
 215         i_action = 0;
 216         i_key = GetKey( p_intf );
 217         for( i = 0; p_hotkeys[i].psz_action != NULL; i++ )
 218         {
 219             if( p_hotkeys[i].i_key == i_key )
 220             {
 221                  i_action = p_hotkeys[i].i_action;
 222             }
 223         }
 224
 225         if( !i_action )
 226         {
 227             /* No key pressed, sleep a bit more */
 228             msleep( INTF_IDLE_SLEEP );
 229             continue;
 230         }
 231
 232         if( i_action == ACTIONID_QUIT )
 233         {
 234             p_intf->p_vlc->b_die = VLC_TRUE;
 235             vout_OSDMessage( p_intf, _( "Quit" ) );
 236             continue;
 237         }
 238         else if( i_action == ACTIONID_VOL_UP )
 239         {
 240             audio_volume_t i_newvol;
 241             aout_VolumeUp( p_intf, 1, &i_newvol );
 242             vout_OSDMessage( p_intf, "Vol %d%%", i_newvol*100/AOUT_VOLUME_MAX );
 243         }
 244         else if( i_action == ACTIONID_VOL_DOWN )
 245         {
 246             audio_volume_t i_newvol;
 247             aout_VolumeDown( p_intf, 1, &i_newvol );
 248             vout_OSDMessage( p_intf, "Vol %d%%", i_newvol*100/AOUT_VOLUME_MAX);
 249         }
 250         else if( i_action == ACTIONID_SUBDELAY_DOWN )
 251         {
 252             int i_delay;
 253             if( input_Control( p_input, INPUT_GET_SUBDELAY, &i_delay ) ==
 254                              VLC_SUCCESS )
 255             {
 256                 i_delay--;
 257                 input_Control( p_input, INPUT_SET_SUBDELAY, i_delay );
 258                 vout_OSDMessage( p_intf, "Subtitle delay %i ms",i_delay*100);
 259             }
 260         }
 261         else if( i_action == ACTIONID_SUBDELAY_UP )
 262         {
 263             int i_delay;
 264             if( input_Control( p_input, INPUT_GET_SUBDELAY, &i_delay ) ==
 265                              VLC_SUCCESS )
 266             {
 267                 i_delay++;
 268                 input_Control( p_input, INPUT_SET_SUBDELAY, i_delay );
 269                 vout_OSDMessage( p_intf, "Subtitle delay %i ms",i_delay*100);
 270             }
 271         }
 272         else if( i_action == ACTIONID_VOL_MUTE )
 273         {
 274             audio_volume_t i_newvol = -1;
 275             aout_VolumeMute( p_intf, &i_newvol );
 276             if( i_newvol == 0 )
 277             {
 278                 vout_OSDMessage( p_intf, _( "Mute" ) );
 279             }
 280             else
 281             {
 282                 vout_OSDMessage( p_intf, "Vol %d%%",
 283                                  i_newvol*100/AOUT_VOLUME_MAX );
 284             }
 285         }
 286         else if( i_action == ACTIONID_FULLSCREEN )
 287         {
 288             if( p_vout )
 289             {
 290                 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
 291             }
 292         }
 293         else if( i_action == ACTIONID_PLAY )
 294         {
 295             p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 296                                           FIND_ANYWHERE );
 297             if( p_playlist )
 298             {
 299                 vlc_mutex_lock( &p_playlist->object_lock );
 300                 if( p_playlist->i_size )
 301                 {
 302                     vlc_mutex_unlock( &p_playlist->object_lock );
 303                     playlist_Play( p_playlist );
 304                     vlc_object_release( p_playlist );
 305                 }
 306             }
 307         }
 308         else if( i_action == ACTIONID_PLAY_PAUSE )
 309         {
 310             val.i_int = PLAYING_S;
 311             if( p_input )
 312             {
 313                 var_Get( p_input, "state", &val );
 314             }
 315             if( p_input && val.i_int != PAUSE_S )
 316             {
 317                 vout_OSDMessage( p_intf, _( "Pause" ) );
 318                 val.i_int = PAUSE_S;
 319                 var_Set( p_input, "state", val );
 320             }
 321             else
 322             {
 323                 p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 324                                               FIND_ANYWHERE );
 325                 if( p_playlist )
 326                 {
 327                     vlc_mutex_lock( &p_playlist->object_lock );
 328                     if( p_playlist->i_size )
 329                     {
 330                         vlc_mutex_unlock( &p_playlist->object_lock );
 331                         vout_OSDMessage( p_intf, _( "Play" ) );
 332                         playlist_Play( p_playlist );
 333                         vlc_object_release( p_playlist );
 334                     }
 335                 }
 336             }
 337         }
 338         else if( p_input )
 339         {
 340             if( i_action == ACTIONID_PAUSE )
 341             {
 342                 vout_OSDMessage( p_intf, _( "Pause" ) );
 343                 val.i_int = PAUSE_S;
 344                 var_Set( p_input, "state", val );
 345             }
 346             else if( i_action == ACTIONID_JUMP_BACKWARD_10SEC )
 347             {
 348                 vout_OSDMessage( p_intf, _( "Jump -10 seconds" ) );
 349                 val.i_time = -10000000;
 350                 var_Set( p_input, "time-offset", val );
 351             }
 352             else if( i_action == ACTIONID_JUMP_FORWARD_10SEC )
 353             {
 354                 vout_OSDMessage( p_intf, _( "Jump +10 seconds" ) );
 355                 val.i_time = 10000000;
 356                 var_Set( p_input, "time-offset", val );
 357             }
 358             else if( i_action == ACTIONID_JUMP_BACKWARD_1MIN )
 359             {
 360                 vout_OSDMessage( p_intf, _( "Jump -1 minute" ) );
 361                 val.i_time = -60000000;
 362                 var_Set( p_input, "time-offset", val );
 363             }
 364             else if( i_action == ACTIONID_JUMP_FORWARD_1MIN )
 365             {
 366                 vout_OSDMessage( p_intf, _( "Jump +1 minute" ) );
 367                 val.i_time = 60000000;
 368                 var_Set( p_input, "time-offset", val );
 369             }
 370             else if( i_action == ACTIONID_JUMP_BACKWARD_5MIN )
 371             {
 372                 vout_OSDMessage( p_intf, _( "Jump -5 minutes" ) );
 373                 val.i_time = -300000000;
 374                 var_Set( p_input, "time-offset", val );
 375             }
 376             else if( i_action == ACTIONID_JUMP_FORWARD_5MIN )
 377             {
 378                 vout_OSDMessage( p_intf, _( "Jump +5 minutes" ) );
 379                 val.i_time = 300000000;
 380                 var_Set( p_input, "time-offset", val );
 381             }
 382             else if( i_action == ACTIONID_NEXT )
 383             {
 384                 p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 385                                               FIND_ANYWHERE );
 386                 if( p_playlist )
 387                 {
 388                     playlist_Next( p_playlist );
 389                     vlc_object_release( p_playlist );
 390                 }
 391             }
 392             else if( i_action == ACTIONID_PREV )
 393             {
 394                 p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 395                                               FIND_ANYWHERE );
 396                 if( p_playlist )
 397                 {
 398                     playlist_Prev( p_playlist );
 399                     vlc_object_release( p_playlist );
 400                 }
 401             }
 402             else if( i_action == ACTIONID_STOP )
 403             {
 404                 p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 405                                               FIND_ANYWHERE );
 406                 if( p_playlist )
 407                 {
 408                     playlist_Stop( p_playlist );
 409                     vlc_object_release( p_playlist );
 410                 }
 411             }
 412             else if( i_action == ACTIONID_FASTER )
 413             {
 414                 vlc_value_t val; val.b_bool = VLC_TRUE;
 415                 var_Set( p_input, "rate-faster", val );
 416             }
 417             else if( i_action == ACTIONID_SLOWER )
 418             {
 419                 vlc_value_t val; val.b_bool = VLC_TRUE;
 420                 var_Set( p_input, "rate-slower", val );
 421             }
 422             else if( i_action == ACTIONID_POSITION )
 423             {
 424                 playlist_t *p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 425                                               FIND_ANYWHERE );
 426                 char psz_duration[MSTRTIME_MAX_SIZE];
 427                 char psz_time[MSTRTIME_MAX_SIZE];
 428                 vlc_value_t time;
 429                 mtime_t i_seconds;
 430
 431                 var_Get( p_input, "time", &time );
 432
 433                 if( p_playlist )
 434                 {
 435                     mtime_t dur =
 436                         p_playlist->pp_items[p_playlist->i_index]->i_duration;
 437
 438                     i_seconds = time.i_time / 1000000;
 439                     secstotimestr ( psz_time, i_seconds );
 440
 441                     if( dur != -1 )
 442                     {
 443                         secstotimestr( psz_duration, dur/1000000 );
 444                         vout_OSDMessage( p_playlist, "%s / %s", psz_time, psz_duration );
 445                     }
 446                     else if( i_seconds > 0 )
 447                     {
 448                         vout_OSDMessage( p_playlist, psz_time );
 449                     }
 450                     vlc_object_release( p_playlist );
 451                 }
 452             }
 453             else if( i_action >= ACTIONID_PLAY_BOOKMARK1 &&
 454                      i_action <= ACTIONID_PLAY_BOOKMARK10 )
 455             {
 456                 PlayBookmark( p_intf, i_action - ACTIONID_PLAY_BOOKMARK1 + 1 );
 457             }
 458             else if( i_action >= ACTIONID_SET_BOOKMARK1 &&
 459                      i_action <= ACTIONID_SET_BOOKMARK10 )
 460             {
 461                 SetBookmark( p_intf, i_action - ACTIONID_SET_BOOKMARK1 + 1 );
 462             }
 463         }
 464     }
 465 }
 466
 467 static int GetKey( intf_thread_t *p_intf)
 468 {
 469     vlc_mutex_lock( &p_intf->p_sys->change_lock );
 470     if ( p_intf->p_sys->i_size == 0 )
 471     {
 472         vlc_mutex_unlock( &p_intf->p_sys->change_lock );
 473         return -1;
 474     }
 475     else
 476     {
 477         int i_return = p_intf->p_sys->p_keys[ 0 ];
 478         int i;
 479         p_intf->p_sys->i_size--;
 480         for ( i = 0; i < BUFFER_SIZE - 1; i++)
 481         {
 482             p_intf->p_sys->p_keys[ i ] = p_intf->p_sys->p_keys[ i + 1 ];
 483         }
 484         vlc_mutex_unlock( &p_intf->p_sys->change_lock );
 485         return i_return;
 486     }
 487 }
 488
 489 /*****************************************************************************
 490  * KeyEvent: callback for keyboard events
 491  *****************************************************************************/
 492 static int KeyEvent( vlc_object_t *p_this, char const *psz_var,
 493                      vlc_value_t oldval, vlc_value_t newval, void *p_data )
 494 {
 495     intf_thread_t *p_intf = (intf_thread_t *)p_data;
 496     vlc_mutex_lock( &p_intf->p_sys->change_lock );
 497     if ( p_intf->p_sys->i_size == BUFFER_SIZE )
 498     {
 499         msg_Warn( p_intf, "event buffer full, dropping keypress" );
 500         vlc_mutex_unlock( &p_intf->p_sys->change_lock );
 501         return VLC_EGENERIC;
 502     }
 503     else
 504     {
 505         p_intf->p_sys->p_keys[ p_intf->p_sys->i_size ] = newval.i_int;
 506         p_intf->p_sys->i_size++;
 507     }
 508     vlc_mutex_unlock( &p_intf->p_sys->change_lock );
 509
 510     return VLC_SUCCESS;
 511 }
 512
 513 static int ActionKeyCB( vlc_object_t *p_this, char const *psz_var,
 514                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
 515 {
 516     vlc_t *p_vlc = (vlc_t *)p_this;
 517     struct hotkey *p_hotkeys = p_vlc->p_hotkeys;
 518     int i;
 519
 520     for( i = 0; p_hotkeys[i].psz_action != NULL; i++ )
 521     {
 522         if( !strcmp( p_hotkeys[i].psz_action, psz_var ) )
 523         {
 524             p_hotkeys[i].i_key = newval.i_int;
 525         }
 526     }
 527
 528     return VLC_SUCCESS;
 529 }
 530
 531 static void PlayBookmark( intf_thread_t *p_intf, int i_num )
 532 {
 533     vlc_value_t val;
 534     int i_position;
 535     char psz_bookmark_name[11];
 536     playlist_t *p_playlist = vlc_object_find( p_intf,
 537              VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
 538
 539     sprintf( psz_bookmark_name, "bookmark%i", i_num );
 540     var_Create( p_intf, psz_bookmark_name, VLC_VAR_STRING|VLC_VAR_DOINHERIT );
 541     var_Get( p_intf, psz_bookmark_name, &val );
 542
 543     if( p_playlist )
 544     {
 545         char *psz_bookmark = strdup( val.psz_string );
 546         for( i_position = 0 ; i_position < p_playlist->i_size ; i_position++)
 547         {
 548             if( !strcmp( psz_bookmark, p_playlist->pp_items[i_position]->psz_uri ) )
 549             {
 550                 playlist_Goto( p_playlist, i_position );
 551                 break;
 552             }
 553         }
 554         vlc_object_release( p_playlist );
 555     }
 556 }
 557
 558 static void SetBookmark( intf_thread_t *p_intf, int i_num )
 559 {
 560     vlc_value_t val;
 561     playlist_t *p_playlist = vlc_object_find( p_intf,
 562             VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
 563     if( p_playlist )
 564     {
 565         char psz_bookmark_name[11];
 566         sprintf( psz_bookmark_name, "bookmark%i", i_num );
 567         var_Create( p_intf, psz_bookmark_name, VLC_VAR_STRING|VLC_VAR_DOINHERIT );
 568         val.psz_string = strdup( p_playlist->pp_items[p_playlist->i_index]->psz_uri );
 569         var_Set( p_intf, psz_bookmark_name, val );
 570         msg_Info( p_intf, "setting playlist bookmark %i to %s", i_num, val.psz_string );
 571         vlc_object_release( p_playlist );
 572     }
 573 }