1 /*****************************************************************************
2 * rc.c : remote control stdin/stdout plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2001 VideoLAN
5 * $Id: rc.c,v 1.39 2003/12/02 13:31:23 gbazin Exp $
7 * Authors: Peter Surda <shurdeek@panorama.sth.ac.at>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
27 #include <stdlib.h> /* malloc(), free() */
30 #include <errno.h> /* ENOMEM */
44 #ifdef HAVE_SYS_TIME_H
45 # include <sys/time.h>
47 #include <sys/types.h>
49 #include "vlc_error.h"
51 #define MAX_LINE_LENGTH 256
53 /*****************************************************************************
55 *****************************************************************************/
56 static int Activate ( vlc_object_t * );
57 static void Run ( intf_thread_t *p_intf );
59 static int Input ( vlc_object_t *, char const *,
60 vlc_value_t, vlc_value_t, void * );
61 static int Playlist ( vlc_object_t *, char const *,
62 vlc_value_t, vlc_value_t, void * );
63 static int Quit ( vlc_object_t *, char const *,
64 vlc_value_t, vlc_value_t, void * );
65 static int Intf ( vlc_object_t *, char const *,
66 vlc_value_t, vlc_value_t, void * );
67 static int Volume ( vlc_object_t *, char const *,
68 vlc_value_t, vlc_value_t, void * );
69 static int VolumeMove ( vlc_object_t *, char const *,
70 vlc_value_t, vlc_value_t, void * );
71 static int AudioConfig ( vlc_object_t *, char const *,
72 vlc_value_t, vlc_value_t, void * );
74 /*****************************************************************************
76 *****************************************************************************/
77 #define POS_TEXT N_("Show stream position")
78 #define POS_LONGTEXT N_("Show the current position in seconds within the stream from time to time.")
80 #define TTY_TEXT N_("Fake TTY")
81 #define TTY_LONGTEXT N_("Force the rc plugin to use stdin as if it was a TTY.")
84 add_category_hint( N_("Remote control"), NULL, VLC_TRUE );
85 add_bool( "rc-show-pos", 0, NULL, POS_TEXT, POS_LONGTEXT, VLC_TRUE );
87 add_bool( "fake-tty", 0, NULL, TTY_TEXT, TTY_LONGTEXT, VLC_TRUE );
89 set_description( _("remote control interface") );
90 set_capability( "interface", 20 );
91 set_callbacks( Activate, NULL );
94 /*****************************************************************************
95 * Activate: initialize and create stuff
96 *****************************************************************************/
97 static int Activate( vlc_object_t *p_this )
99 intf_thread_t *p_intf = (intf_thread_t*)p_this;
101 #if defined(HAVE_ISATTY) && !defined(WIN32)
102 /* Check that stdin is a TTY */
103 if( !config_GetInt( p_intf, "fake-tty" ) && !isatty( 0 ) )
105 msg_Warn( p_intf, "fd 0 is not a TTY" );
110 /* Non-buffered stdout */
111 setvbuf( stdout, (char *)NULL, _IOLBF, 0 );
113 p_intf->pf_run = Run;
117 printf( "remote control interface initialized, `h' for help\n" );
121 /*****************************************************************************
123 *****************************************************************************
124 * This part of the interface is in a separate thread so that we can call
125 * exec() from within it without annoying the rest of the program.
126 *****************************************************************************/
127 static void Run( intf_thread_t *p_intf )
129 input_thread_t * p_input;
130 playlist_t * p_playlist;
132 char p_buffer[ MAX_LINE_LENGTH + 1 ];
133 vlc_bool_t b_showpos = config_GetInt( p_intf, "rc-show-pos" );
134 input_info_category_t * p_category;
135 input_info_t * p_info;
141 double f_ratio = 1.0;
145 INPUT_RECORD input_record;
152 /* Register commands that will be cleaned up upon object destruction */
153 var_Create( p_intf, "quit", VLC_VAR_VOID | VLC_VAR_ISCOMMAND );
154 var_AddCallback( p_intf, "quit", Quit, NULL );
155 var_Create( p_intf, "intf", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
156 var_AddCallback( p_intf, "intf", Intf, NULL );
158 var_Create( p_intf, "add", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
159 var_AddCallback( p_intf, "add", Playlist, NULL );
160 var_Create( p_intf, "playlist", VLC_VAR_VOID | VLC_VAR_ISCOMMAND );
161 var_AddCallback( p_intf, "playlist", Playlist, NULL );
162 var_Create( p_intf, "play", VLC_VAR_VOID | VLC_VAR_ISCOMMAND );
163 var_AddCallback( p_intf, "play", Playlist, NULL );
164 var_Create( p_intf, "stop", VLC_VAR_VOID | VLC_VAR_ISCOMMAND );
165 var_AddCallback( p_intf, "stop", Playlist, NULL );
166 var_Create( p_intf, "prev", VLC_VAR_VOID | VLC_VAR_ISCOMMAND );
167 var_AddCallback( p_intf, "prev", Playlist, NULL );
168 var_Create( p_intf, "next", VLC_VAR_VOID | VLC_VAR_ISCOMMAND );
169 var_AddCallback( p_intf, "next", Playlist, NULL );
171 var_Create( p_intf, "pause", VLC_VAR_VOID | VLC_VAR_ISCOMMAND );
172 var_AddCallback( p_intf, "pause", Input, NULL );
173 var_Create( p_intf, "seek", VLC_VAR_INTEGER | VLC_VAR_ISCOMMAND );
174 var_AddCallback( p_intf, "seek", Input, NULL );
175 var_Create( p_intf, "title", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
176 var_AddCallback( p_intf, "title", Input, NULL );
177 var_Create( p_intf, "title_n", VLC_VAR_VOID | VLC_VAR_ISCOMMAND );
178 var_AddCallback( p_intf, "title_n", Input, NULL );
179 var_Create( p_intf, "title_p", VLC_VAR_VOID | VLC_VAR_ISCOMMAND );
180 var_AddCallback( p_intf, "title_p", Input, NULL );
181 var_Create( p_intf, "chapter", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
182 var_AddCallback( p_intf, "chapter", Input, NULL );
183 var_Create( p_intf, "chapter_n", VLC_VAR_VOID | VLC_VAR_ISCOMMAND );
184 var_AddCallback( p_intf, "chapter_n", Input, NULL );
185 var_Create( p_intf, "chapter_p", VLC_VAR_VOID | VLC_VAR_ISCOMMAND );
186 var_AddCallback( p_intf, "chapter_p", Input, NULL );
188 var_Create( p_intf, "volume", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
189 var_AddCallback( p_intf, "volume", Volume, NULL );
190 var_Create( p_intf, "volup", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
191 var_AddCallback( p_intf, "volup", VolumeMove, NULL );
192 var_Create( p_intf, "voldown", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
193 var_AddCallback( p_intf, "voldown", VolumeMove, NULL );
194 var_Create( p_intf, "adev", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
195 var_AddCallback( p_intf, "adev", AudioConfig, NULL );
196 var_Create( p_intf, "achan", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
197 var_AddCallback( p_intf, "achan", AudioConfig, NULL );
200 /* Get the file descriptor of the console input */
201 hConsoleIn = GetStdHandle(STD_INPUT_HANDLE);
202 if( hConsoleIn == INVALID_HANDLE_VALUE )
204 msg_Err( p_intf, "Couldn't open STD_INPUT_HANDLE" );
205 p_intf->b_die = VLC_TRUE;
209 while( !p_intf->b_die )
211 vlc_bool_t b_complete = VLC_FALSE;
219 tv.tv_usec = (long)INTF_IDLE_SLEEP;
221 FD_SET( STDIN_FILENO, &fds );
223 i_dummy = select( STDIN_FILENO + 1, &fds, NULL, NULL, &tv );
225 /* On Win32, select() only works on socket descriptors */
226 i_dummy = ( WaitForSingleObject( hConsoleIn, INTF_IDLE_SLEEP/1000 )
233 while( !p_intf->b_die
234 && i_size < MAX_LINE_LENGTH
236 && read( STDIN_FILENO, p_buffer + i_size, 1 ) > 0
238 && ReadConsoleInput( hConsoleIn, &input_record, 1,
244 if( input_record.EventType != KEY_EVENT ||
245 !input_record.Event.KeyEvent.bKeyDown ||
246 input_record.Event.KeyEvent.wVirtualKeyCode == VK_SHIFT ||
247 input_record.Event.KeyEvent.wVirtualKeyCode == VK_CONTROL||
248 input_record.Event.KeyEvent.wVirtualKeyCode == VK_MENU ||
249 input_record.Event.KeyEvent.wVirtualKeyCode == VK_CAPITAL )
251 /* nothing interesting */
256 input_record.Event.KeyEvent.uChar.AsciiChar;
258 /* Echo out the command */
259 putc( p_buffer[ i_size ], stdout );
261 /* Handle special keys */
262 if( p_buffer[ i_size ] == '\r' || p_buffer[ i_size ] == '\n' )
264 putc( '\n', stdout );
267 switch( p_buffer[ i_size ] )
274 putc( '\b', stdout );
285 if( p_buffer[ i_size ] == '\r' || p_buffer[ i_size ] == '\n' )
294 if( i_size == MAX_LINE_LENGTH
295 || p_buffer[ i_size ] == '\r'
296 || p_buffer[ i_size ] == '\n' )
298 p_buffer[ i_size ] = 0;
299 b_complete = VLC_TRUE;
303 /* Manage the input part */
304 if( p_input == NULL )
308 p_input = vlc_object_find( p_playlist, VLC_OBJECT_INPUT,
313 p_input = vlc_object_find( p_intf, VLC_OBJECT_INPUT,
317 p_playlist = vlc_object_find( p_input, VLC_OBJECT_PLAYLIST,
322 else if( p_input->b_dead )
324 vlc_object_release( p_input );
328 if( p_input && b_showpos )
331 vlc_mutex_lock( &p_input->stream.stream_lock );
332 if( !p_input->b_die && p_input->stream.i_mux_rate )
334 #define A p_input->stream.p_selected_area
335 f_ratio = 1.0 / ( 50 * p_input->stream.i_mux_rate );
336 i_newpos = A->i_tell * f_ratio;
338 if( i_oldpos != i_newpos )
341 printf( "pos: %li s / %li s\n", (long int)i_newpos,
342 (long int)(f_ratio * A->i_size) );
346 vlc_mutex_unlock( &p_input->stream.stream_lock );
349 /* Is there something to do? */
352 char *psz_cmd, *psz_arg;
354 /* Skip heading spaces */
356 while( *psz_cmd == ' ' )
361 /* Split psz_cmd at the first space and make sure that
362 * psz_arg is valid */
363 psz_arg = strchr( psz_cmd, ' ' );
367 while( *psz_arg == ' ' )
377 /* If the user typed a registered local command, try it */
378 if( var_Type( p_intf, psz_cmd ) & VLC_VAR_ISCOMMAND )
383 val.psz_string = psz_arg;
384 i_ret = var_Set( p_intf, psz_cmd, val );
385 printf( "%s: returned %i (%s)\n",
386 psz_cmd, i_ret, vlc_error( i_ret ) );
388 /* Or maybe it's a global command */
389 else if( var_Type( p_intf->p_libvlc, psz_cmd ) & VLC_VAR_ISCOMMAND )
394 val.psz_string = psz_arg;
395 /* FIXME: it's a global command, but we should pass the
396 * local object as an argument, not p_intf->p_libvlc. */
397 i_ret = var_Set( p_intf->p_libvlc, psz_cmd, val );
398 printf( "%s: returned %i (%s)\n",
399 psz_cmd, i_ret, vlc_error( i_ret ) );
401 else if( !strcmp( psz_cmd, "info" ) )
405 vlc_mutex_lock( &p_input->stream.stream_lock );
406 p_category = p_input->stream.p_info;
409 printf( "+----[ %s ]\n", p_category->psz_name );
411 p_info = p_category->p_info;
414 printf( "| %s: %s\n", p_info->psz_name,
416 p_info = p_info->p_next;
418 p_category = p_category->p_next;
421 printf( "+----[ end of stream info ]\n" );
422 vlc_mutex_unlock( &p_input->stream.stream_lock );
426 printf( "no input\n" );
429 else switch( psz_cmd[0] )
435 vout_thread_t *p_vout;
436 p_vout = vlc_object_find( p_input,
437 VLC_OBJECT_VOUT, FIND_CHILD );
441 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
442 vlc_object_release( p_vout );
455 printf("+----[ remote control commands ]\n");
457 printf("| add XYZ . . . . . . . . . . add XYZ to playlist\n");
458 printf("| playlist . . . show items currently in playlist\n");
459 printf("| play . . . . . . . . . . . . . . . . play stream\n");
460 printf("| stop . . . . . . . . . . . . . . . . stop stream\n");
461 printf("| next . . . . . . . . . . . . next playlist item\n");
462 printf("| prev . . . . . . . . . . previous playlist item\n");
463 printf("| title [X] . . . . set/get title in current item\n");
464 printf("| title_n . . . . . . next title in current item\n");
465 printf("| title_p . . . . previous title in current item\n");
466 printf("| chapter [X] . . set/get chapter in current item\n");
467 printf("| chapter_n . . . . next chapter in current item\n");
468 printf("| chapter_p . . previous chapter in current item\n");
470 printf("| seek X . seek in seconds, for instance `seek 12'\n");
471 printf("| pause . . . . . . . . . . . . . . toggle pause\n");
472 printf("| f . . . . . . . . . . . . . . toggle fullscreen\n");
473 printf("| info . . . information about the current stream\n");
475 printf("| volume [X] . . . . . . . . set/get audio volume\n");
476 printf("| volup [X] . . . . . raise audio volume X steps\n");
477 printf("| voldown [X] . . . . lower audio volume X steps\n");
478 printf("| adev [X] . . . . . . . . . set/get audio device\n");
479 printf("| achan [X]. . . . . . . . set/get audio channels\n");
481 printf("| help . . . . . . . . . . . . . this help message\n");
482 printf("| quit . . . . . . . . . . . . . . . . . quit vlc\n");
484 printf("+----[ end of help ]\n");
487 /* Ignore empty lines */
490 printf( "unknown command `%s', type `help' for help\n", psz_cmd );
498 vlc_object_release( p_input );
504 vlc_object_release( p_playlist );
509 static int Input( vlc_object_t *p_this, char const *psz_cmd,
510 vlc_value_t oldval, vlc_value_t newval, void *p_data )
512 input_thread_t * p_input;
515 p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
522 /* Parse commands that only require an input */
523 if( !strcmp( psz_cmd, "pause" ) )
527 var_Set( p_input, "state", val );
528 vlc_object_release( p_input );
531 else if( !strcmp( psz_cmd, "seek" ) )
533 if( strlen( newval.psz_string ) > 0 &&
534 newval.psz_string[strlen( newval.psz_string ) - 1] == '%' )
536 val.f_float = (float)atoi( newval.psz_string ) / 100.0;
537 var_Set( p_input, "position", val );
541 val.i_time = ((int64_t)atoi( newval.psz_string )) * 1000000;
542 var_Set( p_input, "time", val );
544 vlc_object_release( p_input );
547 else if( !strcmp( psz_cmd, "chapter" ) ||
548 !strcmp( psz_cmd, "chapter_n" ) ||
549 !strcmp( psz_cmd, "chapter_p" ) )
551 if( !strcmp( psz_cmd, "chapter" ) )
553 if ( *newval.psz_string )
556 val.i_int = atoi( newval.psz_string );
557 var_Set( p_input, "chapter", val );
561 vlc_value_t val_list;
564 var_Get( p_input, "chapter", &val );
565 var_Change( p_input, "chapter", VLC_VAR_GETCHOICES, &val_list, NULL );
566 printf( "Currently playing chapter %d/%d\n", val.i_int, val_list.p_list->i_count );
567 var_Change( p_this, "chapter", VLC_VAR_FREELIST, &val_list, NULL );
570 else if( !strcmp( psz_cmd, "chapter_n" ) )
572 val.b_bool = VLC_TRUE;
573 var_Set( p_input, "next-chapter", val );
575 else if( !strcmp( psz_cmd, "chapter_p" ) )
577 val.b_bool = VLC_TRUE;
578 var_Set( p_input, "prev-chapter", val );
581 vlc_object_release( p_input );
584 else if( !strcmp( psz_cmd, "title" ) ||
585 !strcmp( psz_cmd, "title_n" ) ||
586 !strcmp( psz_cmd, "title_p" ) )
588 if( !strcmp( psz_cmd, "title" ) )
590 if ( *newval.psz_string )
593 val.i_int = atoi( newval.psz_string );
594 var_Set( p_input, "title", val );
598 vlc_value_t val_list;
601 var_Get( p_input, "title", &val );
602 var_Change( p_input, "title", VLC_VAR_GETCHOICES, &val_list, NULL );
603 printf( "Currently playing title %d/%d\n", val.i_int, val_list.p_list->i_count );
604 var_Change( p_this, "title", VLC_VAR_FREELIST, &val_list, NULL );
607 else if( !strcmp( psz_cmd, "title_n" ) )
609 val.b_bool = VLC_TRUE;
610 var_Set( p_input, "next-title", val );
612 else if( !strcmp( psz_cmd, "title_p" ) )
614 val.b_bool = VLC_TRUE;
615 var_Set( p_input, "prev-title", val );
618 vlc_object_release( p_input );
626 static int Playlist( vlc_object_t *p_this, char const *psz_cmd,
627 vlc_value_t oldval, vlc_value_t newval, void *p_data )
629 playlist_t * p_playlist;
631 p_playlist = vlc_object_find( p_this, VLC_OBJECT_PLAYLIST,
638 /* Parse commands that require a playlist */
639 if( !strcmp( psz_cmd, "prev" ) )
641 playlist_Prev( p_playlist );
643 else if( !strcmp( psz_cmd, "next" ) )
645 playlist_Next( p_playlist );
647 else if( !strcmp( psz_cmd, "play" ) )
649 playlist_Play( p_playlist );
651 else if( !strcmp( psz_cmd, "stop" ) )
653 playlist_Stop( p_playlist );
655 else if( !strcmp( psz_cmd, "add" ) )
657 printf( "trying to add %s to playlist\n", newval.psz_string );
658 playlist_Add( p_playlist, newval.psz_string, NULL, 0,
659 PLAYLIST_GO|PLAYLIST_APPEND, PLAYLIST_END );
661 else if( !strcmp( psz_cmd, "playlist" ) )
664 for ( i = 0; i < p_playlist->i_size; i++ )
666 printf( "|%s%s %s|\n", i == p_playlist->i_index?"*":" ",
667 p_playlist->pp_items[i]->psz_name,
668 p_playlist->pp_items[i]->psz_uri );
672 printf( "| no entries\n" );
680 printf( "unknown command!\n" );
683 vlc_object_release( p_playlist );
687 static int Quit( vlc_object_t *p_this, char const *psz_cmd,
688 vlc_value_t oldval, vlc_value_t newval, void *p_data )
690 p_this->p_vlc->b_die = VLC_TRUE;
694 static int Intf( vlc_object_t *p_this, char const *psz_cmd,
695 vlc_value_t oldval, vlc_value_t newval, void *p_data )
697 intf_thread_t *p_newintf;
699 p_newintf = intf_Create( p_this->p_vlc, newval.psz_string );
703 p_newintf->b_block = VLC_FALSE;
704 if( intf_RunThread( p_newintf ) )
706 vlc_object_detach( p_newintf );
707 intf_Destroy( p_newintf );
714 static int Volume( vlc_object_t *p_this, char const *psz_cmd,
715 vlc_value_t oldval, vlc_value_t newval, void *p_data )
719 if ( *newval.psz_string )
722 audio_volume_t i_volume = atoi( newval.psz_string );
723 if ( i_volume > AOUT_VOLUME_MAX )
725 printf( "Volume must be in the range %d-%d\n", AOUT_VOLUME_MIN,
727 i_error = VLC_EBADVAR;
729 else i_error = aout_VolumeSet( p_this, i_volume );
734 audio_volume_t i_volume;
735 if ( aout_VolumeGet( p_this, &i_volume ) < 0 )
737 i_error = VLC_EGENERIC;
741 printf( "Volume is %d\n", i_volume );
742 i_error = VLC_SUCCESS;
749 static int VolumeMove( vlc_object_t *p_this, char const *psz_cmd,
750 vlc_value_t oldval, vlc_value_t newval, void *p_data )
752 audio_volume_t i_volume;
753 int i_nb_steps = atoi(newval.psz_string);
754 int i_error = VLC_SUCCESS;
756 if ( i_nb_steps <= 0 || i_nb_steps > (AOUT_VOLUME_MAX/AOUT_VOLUME_STEP) )
761 if ( !strcmp(psz_cmd, "volup") )
763 if ( aout_VolumeUp( p_this, i_nb_steps, &i_volume ) < 0 )
764 i_error = VLC_EGENERIC;
768 if ( aout_VolumeDown( p_this, i_nb_steps, &i_volume ) < 0 )
769 i_error = VLC_EGENERIC;
772 if ( !i_error ) printf( "Volume is %d\n", i_volume );
776 static int AudioConfig( vlc_object_t *p_this, char const *psz_cmd,
777 vlc_value_t oldval, vlc_value_t newval, void *p_data )
779 aout_instance_t * p_aout;
780 const char * psz_variable;
781 vlc_value_t val_name;
784 p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT, FIND_ANYWHERE );
785 if ( p_aout == NULL ) return VLC_ENOOBJ;
787 if ( !strcmp( psz_cmd, "adev" ) )
789 psz_variable = "audio-device";
793 psz_variable = "audio-channels";
796 /* Get the descriptive name of the variable */
797 var_Change( (vlc_object_t *)p_aout, psz_variable, VLC_VAR_GETTEXT,
799 if( !val_name.psz_string ) val_name.psz_string = strdup(psz_variable);
801 if ( !*newval.psz_string )
803 /* Retrieve all registered ***. */
804 vlc_value_t val, text;
807 if ( var_Get( (vlc_object_t *)p_aout, psz_variable, &val ) < 0 )
809 vlc_object_release( (vlc_object_t *)p_aout );
814 if ( var_Change( (vlc_object_t *)p_aout, psz_variable,
815 VLC_VAR_GETLIST, &val, &text ) < 0 )
817 vlc_object_release( (vlc_object_t *)p_aout );
821 printf( "+----[ %s ]\n", val_name.psz_string );
822 for ( i = 0; i < val.p_list->i_count; i++ )
824 if ( i_value == val.p_list->p_values[i].i_int )
825 printf( "| %i - %s *\n", val.p_list->p_values[i].i_int,
826 text.p_list->p_values[i].psz_string );
828 printf( "| %i - %s\n", val.p_list->p_values[i].i_int,
829 text.p_list->p_values[i].psz_string );
831 var_Change( (vlc_object_t *)p_aout, psz_variable, VLC_VAR_FREELIST,
833 printf( "+----[ end of %s ]\n", val_name.psz_string );
835 if( val_name.psz_string ) free( val_name.psz_string );
836 i_error = VLC_SUCCESS;
841 val.i_int = atoi( newval.psz_string );
843 i_error = var_Set( (vlc_object_t *)p_aout, psz_variable, val );
845 vlc_object_release( (vlc_object_t *)p_aout );