* FAQ: updated FAQ with config file issues.
[vlc.git] / modules / control / rc / rc.c
1 /*****************************************************************************
2  * rc.c : remote control stdin/stdout plugin for vlc
3  *****************************************************************************
4  * Copyright (C) 2001 VideoLAN
5  * $Id: rc.c,v 1.7 2002/10/03 17:01:59 gbazin Exp $
6  *
7  * Authors: Peter Surda <shurdeek@panorama.sth.ac.at>
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 <string.h>
29
30 #include <errno.h>                                                 /* ENOMEM */
31 #include <stdio.h>
32 #include <ctype.h>
33 #include <signal.h>
34
35 #include <vlc/vlc.h>
36 #include <vlc/intf.h>
37 #include <vlc/vout.h>
38
39 #ifdef HAVE_UNISTD_H
40 #    include <unistd.h>
41 #endif
42
43 #ifdef HAVE_SYS_TIME_H
44 #    include <sys/time.h>
45 #endif
46 #include <sys/types.h>
47
48 #if defined( WIN32 )
49 #include <winsock2.h>                                            /* select() */
50 #endif
51
52 #define MAX_LINE_LENGTH 256
53
54 /*****************************************************************************
55  * Local prototypes
56  *****************************************************************************/
57 static int  Activate     ( vlc_object_t * );
58 static void Run          ( intf_thread_t *p_intf );
59
60 /*****************************************************************************
61  * Module descriptor
62  *****************************************************************************/
63 #define POS_TEXT N_("show stream position")
64 #define POS_LONGTEXT N_("Show the current position in seconds within the stream from time to time.")
65
66 #define TTY_TEXT N_("fake TTY")
67 #define TTY_LONGTEXT N_("Force the rc plugin to use stdin as if it was a TTY.")
68
69 vlc_module_begin();
70     add_category_hint( N_("Remote control"), NULL );
71     add_bool( "rc-show-pos", 0, NULL, POS_TEXT, POS_LONGTEXT );
72     add_bool( "fake-tty", 0, NULL, TTY_TEXT, TTY_LONGTEXT );
73     set_description( _("remote control interface module") );
74     set_capability( "interface", 20 );
75     set_callbacks( Activate, NULL );
76 vlc_module_end();
77
78 /*****************************************************************************
79  * Activate: initialize and create stuff
80  *****************************************************************************/
81 static int Activate( vlc_object_t *p_this )
82 {
83     intf_thread_t *p_intf = (intf_thread_t*)p_this;
84
85 #ifdef HAVE_ISATTY
86     /* Check that stdin is a TTY */
87     if( !config_GetInt( p_intf, "fake-tty" ) && !isatty( 0 ) )
88     {
89         msg_Warn( p_intf, "fd 0 is not a TTY" );
90         return 1;
91     }
92 #endif
93
94     /* Non-buffered stdout */
95     setvbuf( stdout, (char *)NULL, _IOLBF, 0 );
96
97     p_intf->pf_run = Run;
98
99     CONSOLE_INTRO_MSG;
100
101     printf( "remote control interface initialized, `h' for help\n" );
102     return 0;
103 }
104
105 /*****************************************************************************
106  * Run: rc thread
107  *****************************************************************************
108  * This part of the interface is in a separate thread so that we can call
109  * exec() from within it without annoying the rest of the program.
110  *****************************************************************************/
111 static void Run( intf_thread_t *p_intf )
112 {
113     input_thread_t * p_input;
114     playlist_t *     p_playlist;
115
116     char       p_buffer[ MAX_LINE_LENGTH + 1 ];
117     vlc_bool_t b_complete = 0;
118     vlc_bool_t b_showpos = config_GetInt( p_intf, "rc-show-pos" );
119     input_info_category_t * p_category;
120     input_info_t * p_info;
121
122     int        i_dummy;
123     off_t      i_oldpos = 0;
124     off_t      i_newpos;
125     fd_set     fds;                                        /* stdin changed? */
126     struct timeval tv;                                   /* how long to wait */
127
128     double     f_ratio = 1;
129
130     p_input = NULL;
131     p_playlist = NULL;
132
133     while( !p_intf->b_die )
134     {
135         b_complete = 0;
136
137         /* Check stdin */
138         tv.tv_sec = 0;
139         tv.tv_usec = 50000;
140         FD_ZERO( &fds );
141         FD_SET( STDIN_FILENO, &fds );
142
143         i_dummy = select( 32, &fds, NULL, NULL, &tv );
144         if( i_dummy > 0 )
145         {
146             int i_size = 0;
147
148             while( !p_intf->b_die
149                     && i_size < MAX_LINE_LENGTH
150                     && read( STDIN_FILENO, p_buffer + i_size, 1 ) > 0
151                     && p_buffer[ i_size ] != '\r'
152                     && p_buffer[ i_size ] != '\n' )
153             {
154                 i_size++;
155             }
156
157             if( i_size == MAX_LINE_LENGTH
158                  || p_buffer[ i_size ] == '\r'
159                  || p_buffer[ i_size ] == '\n' )
160             {
161                 p_buffer[ i_size ] = 0;
162                 b_complete = 1;
163             }
164         }
165
166         /* Manage the input part */
167         if( p_input == NULL )
168         {
169             if( p_playlist )
170             {
171                 p_input = vlc_object_find( p_playlist, VLC_OBJECT_INPUT,
172                                                        FIND_CHILD );
173             }
174             else
175             {
176                 p_input = vlc_object_find( p_intf, VLC_OBJECT_INPUT,
177                                                    FIND_ANYWHERE );
178                 if( p_input )
179                 {
180                     p_playlist = vlc_object_find( p_input, VLC_OBJECT_PLAYLIST,
181                                                            FIND_PARENT );
182                 }
183             }
184         }
185         else if( p_input->b_dead )
186         {
187             vlc_object_release( p_input );
188             p_input = NULL;
189         }
190
191         if( p_input && b_showpos )
192         {
193             /* Get position */
194             vlc_mutex_lock( &p_input->stream.stream_lock );
195             if( !p_input->b_die && p_input->stream.i_mux_rate )
196             {
197 #define A p_input->stream.p_selected_area
198                 f_ratio = 1.0 / ( 50 * p_input->stream.i_mux_rate );
199                 i_newpos = A->i_tell * f_ratio;
200
201                 if( i_oldpos != i_newpos )
202                 {
203                     i_oldpos = i_newpos;
204                     printf( "pos: %li s / %li s\n", (long int)i_newpos,
205                             (long int)(f_ratio * A->i_size) );
206                 }
207 #undef S
208             }
209             vlc_mutex_unlock( &p_input->stream.stream_lock );
210         }
211
212         /* Is there something to do? */
213         if( b_complete == 1 )
214         {
215             char *p_cmd = p_buffer;
216             char *p_tmp;
217
218             if( !strcmp( p_cmd, "quit" ) )
219             {
220                 p_intf->p_vlc->b_die = VLC_TRUE;
221             }
222             else if( !strcmp( p_cmd, "segfault" ) )
223             {
224                 raise( SIGSEGV );
225             }
226             else if( !strcmp( p_cmd, "prev" ) )
227             {
228                 if( p_playlist ) playlist_Prev( p_playlist );
229             }
230             else if( !strcmp( p_cmd, "next" ) )
231             {
232                 if( p_playlist ) playlist_Next( p_playlist );
233             }
234             else if( !strcmp( p_cmd, "play" ) )
235             {
236                 if( p_playlist ) playlist_Play( p_playlist );
237             }
238             else if( !strcmp( p_cmd, "stop" ) )
239             {
240                 if( p_playlist ) playlist_Stop( p_playlist );
241             }
242             else if( !strcmp( p_cmd, "pause" ) )
243             {
244                 if( p_input ) input_SetStatus( p_input, INPUT_STATUS_PAUSE );
245             }
246             else if( !strcmp( p_cmd, "tree" ) )
247             {
248                 vlc_dumpstructure( p_intf->p_vlc );
249             }
250             else if( !strcmp( p_cmd, "list" ) )
251             {
252                 vlc_liststructure( p_intf->p_vlc );
253             }
254             else if( !strncmp( p_cmd, "set ", 4 ) )
255             {
256 //                vlc_set_r( p_intf->p_vlc, p_cmd + 4, strstr( p_cmd + 4, " " ) );
257                 p_tmp = strstr( p_cmd + 4, " " );
258                 p_tmp[0] = '\0';
259                 config_PutPsz( p_intf->p_vlc, p_cmd + 4, p_tmp + 1 );
260                 config_PutInt( p_intf->p_vlc, p_cmd + 4, atoi(p_tmp + 1) );
261             }
262             else if( !strncmp( p_cmd, "intf ", 5 ) )
263             {
264                 intf_thread_t *p_newintf;
265                 char *psz_oldmodule = config_GetPsz( p_intf->p_vlc, "intf" );
266
267                 config_PutPsz( p_intf->p_vlc, "intf", p_cmd + 5 );
268                 p_newintf = intf_Create( p_intf->p_vlc );
269                 config_PutPsz( p_intf->p_vlc, "intf", psz_oldmodule );
270
271                 if( psz_oldmodule )
272                 {
273                     free( psz_oldmodule );
274                 }
275
276                 if( p_newintf )
277                 {
278                     p_newintf->b_block = VLC_FALSE;
279                     if( intf_RunThread( p_newintf ) )
280                     {
281                         vlc_object_detach( p_newintf );
282                         intf_Destroy( p_newintf );
283                     }
284                 }
285             }
286             else if( !strcmp( p_cmd, "info" ) )
287             {
288                 if ( p_input )
289                 {
290                     vlc_mutex_lock( &p_input->stream.stream_lock );
291                     p_category = p_input->stream.p_info;
292                     while ( p_category )
293                     {
294                         printf( "+----[ %s ]\n", p_category->psz_name );
295                         printf( "| \n" );
296                         p_info = p_category->p_info;
297                         while ( p_info )
298                         {
299                             printf( "| %s: %s\n", p_info->psz_name,
300                                     p_info->psz_value );
301                             p_info = p_info->p_next;
302                         }
303                         p_category = p_category->p_next;
304                         printf( "| \n" );
305                     }
306                     printf( "+----[ end of stream info ]\n" );
307                     vlc_mutex_unlock( &p_input->stream.stream_lock );
308                 }
309                 else
310                 {
311                     printf( "no input\n" );
312                 }
313             }
314             else switch( p_cmd[0] )
315             {
316             case 'a':
317             case 'A':
318                 if( p_cmd[1] == ' ' && p_playlist )
319                 {
320                     playlist_Add( p_playlist, p_cmd + 2,
321                                   PLAYLIST_APPEND | PLAYLIST_GO, PLAYLIST_END );
322                 }
323                 break;
324
325             case 'f':
326             case 'F':
327                 if( p_input )
328                 {
329                     vout_thread_t *p_vout;
330                     p_vout = vlc_object_find( p_input,
331                                               VLC_OBJECT_VOUT, FIND_CHILD );
332
333                     if( p_vout )
334                     {
335                         p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
336                         vlc_object_release( p_vout );
337                     }
338                 }
339                 break;
340
341             case 's':
342             case 'S':
343                 ;
344                 break;
345
346             case 'r':
347             case 'R':
348                 if( p_input )
349                 {
350                     for( i_dummy = 1;
351                          i_dummy < MAX_LINE_LENGTH && p_cmd[ i_dummy ] >= '0'
352                                                    && p_cmd[ i_dummy ] <= '9';
353                          i_dummy++ )
354                     {
355                         ;
356                     }
357
358                     p_cmd[ i_dummy ] = 0;
359                     input_Seek( p_input, (off_t)atoi( p_cmd + 1 ),
360                                 INPUT_SEEK_SECONDS | INPUT_SEEK_SET );
361                     /* rcreseek(f_cpos); */
362                 }
363                 break;
364
365             case '?':
366             case 'h':
367             case 'H':
368                 printf("+----[ remote control commands ]\n");
369                 printf("| \n");
370                 printf("| a XYZ  . . . . . . . . . . . add XYZ to playlist\n");
371                 printf("| play . . . . . . . . . . . . . . . . play stream\n");
372                 printf("| stop . . . . . . . . . . . . . . . . stop stream\n");
373                 printf("| next . . . . . . . . . . . .  next playlist item\n");
374                 printf("| prev . . . . . . . . . .  previous playlist item\n");
375                 printf("| \n");
376                 printf("| r X  . . . seek in seconds, for instance `r 3.5'\n");
377                 printf("| pause  . . . . . . . . . . . . . .  toggle pause\n");
378                 printf("| f  . . . . . . . . . . . . . . toggle fullscreen\n");
379                 printf("| info . . .  information about the current stream\n");
380                 printf("| \n");
381                 printf("| help . . . . . . . . . . . . . this help message\n");
382                 printf("| quit . . . . . . . . . . . . . . . . .  quit vlc\n");
383                 printf("| \n");
384                 printf("+----[ end of help ]\n");
385                 break;
386             case '\0':
387                 /* Ignore empty lines */
388                 break;
389             default:
390                 printf( "unknown command `%s', type `help' for help\n", p_cmd );
391                 break;
392             }
393         }
394
395         msleep( INTF_IDLE_SLEEP );
396     }
397
398     if( p_input )
399     {
400         vlc_object_release( p_input );
401         p_input = NULL;
402     }
403
404     if( p_playlist )
405     {
406         vlc_object_release( p_playlist );
407         p_playlist = NULL;
408     }
409 }
410