2 * miracle_local.c -- Local Miracle Parser
3 * Copyright (C) 2002-2003 Ushodaya Enterprises Limited
4 * Author: Charles Yates <charles.yates@pandora.be>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25 /* System header files */
30 /* Valerie header files */
31 #include <valerie/valerie_util.h>
33 /* MLT header files. */
34 #include <framework/mlt_factory.h>
36 /* Application header files */
37 #include "miracle_local.h"
38 #include "miracle_connection.h"
39 #include "miracle_commands.h"
40 #include "miracle_unit_commands.h"
41 #include "miracle_log.h"
43 /** Private miracle_local structure.
48 valerie_parser parser
;
51 *miracle_local
, miracle_local_t
;
53 /** Forward declarations.
56 static valerie_response
miracle_local_connect( miracle_local
);
57 static valerie_response
miracle_local_execute( miracle_local
, char * );
58 static void miracle_local_close( miracle_local
);
59 response_codes
miracle_help( command_argument arg
);
60 response_codes
miracle_run( command_argument arg
);
61 response_codes
miracle_shutdown( command_argument arg
);
63 /** DV Parser constructor.
66 valerie_parser
miracle_parser_init_local( )
68 valerie_parser parser
= malloc( sizeof( valerie_parser_t
) );
69 miracle_local local
= malloc( sizeof( miracle_local_t
) );
73 memset( parser
, 0, sizeof( valerie_parser_t
) );
75 parser
->connect
= (parser_connect
)miracle_local_connect
;
76 parser
->execute
= (parser_execute
)miracle_local_execute
;
77 parser
->close
= (parser_close
)miracle_local_close
;
82 memset( local
, 0, sizeof( miracle_local_t
) );
83 local
->parser
= parser
;
84 local
->root_dir
[0] = '/';
90 /** response status code/message pair
100 /** response messages
103 static responses_t responses
[] =
105 {RESPONSE_SUCCESS
, "OK"},
106 {RESPONSE_SUCCESS_N
, "OK"},
107 {RESPONSE_SUCCESS_1
, "OK"},
108 {RESPONSE_UNKNOWN_COMMAND
, "Unknown command"},
109 {RESPONSE_TIMEOUT
, "Operation timed out"},
110 {RESPONSE_MISSING_ARG
, "Argument missing"},
111 {RESPONSE_INVALID_UNIT
, "Unit not found"},
112 {RESPONSE_BAD_FILE
, "Failed to locate or open clip"},
113 {RESPONSE_OUT_OF_RANGE
, "Argument value out of range"},
114 {RESPONSE_TOO_MANY_FILES
, "Too many files open"},
115 {RESPONSE_ERROR
, "Server Error"}
130 /** A command definition.
135 /* The command string corresponding to this operation (e.g. "play") */
137 /* The function associated with it */
138 response_codes (*operation
) ( command_argument
);
139 /* a boolean to indicate if this is a unit or global command
140 unit commands require a unit identifier as first argument */
142 /* What type is the argument (RTTI :-) ATYPE_whatever */
144 /* online help information */
149 /* The following define the queue of commands available to the user. The
150 first entry is the name of the command (the string which must be typed),
151 the second command is the function associated with it, the third argument
152 is for the type of the argument, and the last argument specifies whether
153 this is something which should be handled immediately or whether it
154 should be queued (only robot motion commands need to be queued). */
156 static command_t vocabulary
[] =
158 {"BYE", NULL
, 0, ATYPE_NONE
, "Terminates the session. Units are not removed and task queue is not flushed."},
159 {"HELP", miracle_help
, 0, ATYPE_NONE
, "Display this information!"},
160 {"NLS", miracle_list_nodes
, 0, ATYPE_NONE
, "List the AV/C nodes on the 1394 bus."},
161 {"UADD", miracle_add_unit
, 0, ATYPE_STRING
, "Create a new DV unit (virtual VTR) to transmit to receiver specified in GUID argument."},
162 {"ULS", miracle_list_units
, 0, ATYPE_NONE
, "Lists the units that have already been added to the server."},
163 {"CLS", miracle_list_clips
, 0, ATYPE_STRING
, "Lists the clips at directory name argument."},
164 {"SET", miracle_set_global_property
, 0, ATYPE_STRING
, "Set a server configuration property."},
165 {"GET", miracle_get_global_property
, 0, ATYPE_STRING
, "Get a server configuration property."},
166 {"RUN", miracle_run
, 0, ATYPE_STRING
, "Run a batch file." },
167 {"LIST", miracle_list
, 1, ATYPE_NONE
, "List the playlist associated to a unit."},
168 {"LOAD", miracle_load
, 1, ATYPE_STRING
, "Load clip specified in absolute filename argument."},
169 {"INSERT", miracle_insert
, 1, ATYPE_STRING
, "Insert a clip at the given clip index."},
170 {"REMOVE", miracle_remove
, 1, ATYPE_NONE
, "Remove a clip at the given clip index."},
171 {"CLEAN", miracle_clean
, 1, ATYPE_NONE
, "Clean a unit by removing all but the currently playing clip."},
172 {"MOVE", miracle_move
, 1, ATYPE_INT
, "Move a clip to another clip index."},
173 {"APND", miracle_append
, 1, ATYPE_STRING
, "Append a clip specified in absolute filename argument."},
174 {"PLAY", miracle_play
, 1, ATYPE_NONE
, "Play a loaded clip at speed -2000 to 2000 where 1000 = normal forward speed."},
175 {"STOP", miracle_stop
, 1, ATYPE_NONE
, "Stop a loaded and playing clip."},
176 {"PAUSE", miracle_pause
, 1, ATYPE_NONE
, "Pause a playing clip."},
177 {"REW", miracle_rewind
, 1, ATYPE_NONE
, "Rewind a unit. If stopped, seek to beginning of clip. If playing, play fast backwards."},
178 {"FF", miracle_ff
, 1, ATYPE_NONE
, "Fast forward a unit. If stopped, seek to beginning of clip. If playing, play fast forwards."},
179 {"STEP", miracle_step
, 1, ATYPE_INT
, "Step argument number of frames forward or backward."},
180 {"GOTO", miracle_goto
, 1, ATYPE_INT
, "Jump to frame number supplied as argument."},
181 {"SIN", miracle_set_in_point
, 1, ATYPE_INT
, "Set the IN point of the loaded clip to frame number argument. -1 = reset in point to 0"},
182 {"SOUT", miracle_set_out_point
, 1, ATYPE_INT
, "Set the OUT point of the loaded clip to frame number argument. -1 = reset out point to maximum."},
183 {"USTA", miracle_get_unit_status
, 1, ATYPE_NONE
, "Report information about the unit."},
184 {"USET", miracle_set_unit_property
, 1, ATYPE_STRING
, "Set a unit configuration property."},
185 {"UGET", miracle_get_unit_property
, 1, ATYPE_STRING
, "Get a unit configuration property."},
186 {"XFER", miracle_transfer
, 1, ATYPE_STRING
, "Transfer the unit's clip to another unit specified as argument."},
187 {"SHUTDOWN", miracle_shutdown
, 0, ATYPE_NONE
, "Shutdown the server."},
188 {NULL
, NULL
, 0, ATYPE_NONE
, NULL
}
194 static char helpstr
[] =
195 "Miracle -- A Multimedia Playout Server\n"
196 " Copyright (C) 2002-2003 Ushodaya Enterprises Limited\n"
198 " Dan Dennedy <dan@dennedy.org>\n"
199 " Charles Yates <charles.yates@pandora.be>\n"
200 "Available commands:\n";
202 /** Lookup the response message for a status code.
205 inline char *get_response_msg( int code
)
208 for ( i
= 0; responses
[ i
].message
!= NULL
&& code
!= responses
[ i
].code
; i
++ ) ;
209 return responses
[ i
].message
;
212 /** Tell the user the miracle command set
215 response_codes
miracle_help( command_argument cmd_arg
)
219 valerie_response_printf( cmd_arg
->response
, 10240, "%s", helpstr
);
221 for ( i
= 0; vocabulary
[ i
].command
!= NULL
; i
++ )
222 valerie_response_printf( cmd_arg
->response
, 1024,
224 vocabulary
[ i
].command
,
225 vocabulary
[ i
].help
);
227 valerie_response_printf( cmd_arg
->response
, 2, "\n" );
229 return RESPONSE_SUCCESS_N
;
232 /** Execute a batch file.
235 response_codes
miracle_run( command_argument cmd_arg
)
237 valerie_response temp
= valerie_parser_run( cmd_arg
->parser
, (char *)cmd_arg
->argument
);
243 valerie_response_set_error( cmd_arg
->response
,
244 valerie_response_get_error_code( temp
),
245 valerie_response_get_error_string( temp
) );
247 for ( index
= 1; index
< valerie_response_count( temp
); index
++ )
248 valerie_response_printf( cmd_arg
->response
, 10240, "%s\n", valerie_response_get_line( temp
, index
) );
250 valerie_response_close( temp
);
253 return valerie_response_get_error_code( cmd_arg
->response
);
256 response_codes
miracle_shutdown( command_argument cmd_arg
)
259 return RESPONSE_SUCCESS
;
262 /** Processes 'thread' id
265 static pthread_t self
;
267 /* Signal handler to deal with various shutdown signals. Basically this
268 should clean up and power down the motor. Note that the death of any
269 child thread will kill all thrads. */
271 void signal_handler( int sig
)
273 if ( pthread_equal( self
, pthread_self( ) ) )
277 miracle_log( LOG_DEBUG
, "Received %s - shutting down.", strsignal(sig
) );
279 miracle_log( LOG_DEBUG
, "Received signal %i - shutting down.", sig
);
286 /** Local 'connect' function.
289 static valerie_response
miracle_local_connect( miracle_local local
)
291 valerie_response response
= valerie_response_init( );
293 self
= pthread_self( );
295 valerie_response_set_error( response
, 100, "VTR Ready" );
297 signal( SIGHUP
, signal_handler
);
298 signal( SIGINT
, signal_handler
);
299 signal( SIGTERM
, SIG_DFL
);
300 signal( SIGSTOP
, signal_handler
);
301 signal( SIGPIPE
, signal_handler
);
302 signal( SIGALRM
, signal_handler
);
303 signal( SIGCHLD
, SIG_IGN
);
308 /** Set the error and determine the message associated to this command.
311 void miracle_command_set_error( command_argument cmd
, response_codes code
)
313 valerie_response_set_error( cmd
->response
, code
, get_response_msg( code
) );
316 /** Parse the unit argument.
319 int miracle_command_parse_unit( command_argument cmd
, int argument
)
322 char *string
= valerie_tokeniser_get_string( cmd
->tokeniser
, argument
);
323 if ( string
!= NULL
&& ( string
[ 0 ] == 'U' || string
[ 0 ] == 'u' ) && strlen( string
) > 1 )
324 unit
= atoi( string
+ 1 );
328 /** Parse a normal argument.
331 void *miracle_command_parse_argument( command_argument cmd
, int argument
, arguments_types type
)
334 char *value
= valerie_tokeniser_get_string( cmd
->tokeniser
, argument
);
344 ret
= malloc( sizeof( float ) );
346 *( float * )ret
= atof( value
);
350 ret
= strdup( value
);
354 ret
= malloc( sizeof( int ) );
356 *( int * )ret
= atoi( value
);
364 /** Get the error code - note that we simply the success return.
367 response_codes
miracle_command_get_error( command_argument cmd
)
369 response_codes ret
= valerie_response_get_error_code( cmd
->response
);
370 if ( ret
== RESPONSE_SUCCESS_N
|| ret
== RESPONSE_SUCCESS_1
)
371 ret
= RESPONSE_SUCCESS
;
375 /** Execute the command.
378 static valerie_response
miracle_local_execute( miracle_local local
, char *command
)
380 command_argument_t cmd
;
381 cmd
.parser
= local
->parser
;
382 cmd
.response
= valerie_response_init( );
383 cmd
.tokeniser
= valerie_tokeniser_init( );
384 cmd
.command
= command
;
387 cmd
.root_dir
= local
->root_dir
;
389 /* Set the default error */
390 miracle_command_set_error( &cmd
, RESPONSE_UNKNOWN_COMMAND
);
392 /* Parse the command */
393 if ( valerie_tokeniser_parse_new( cmd
.tokeniser
, command
, " " ) > 0 )
396 char *value
= valerie_tokeniser_get_string( cmd
.tokeniser
, 0 );
399 /* Strip quotes from all tokens */
400 for ( index
= 0; index
< valerie_tokeniser_count( cmd
.tokeniser
); index
++ )
401 valerie_util_strip( valerie_tokeniser_get_string( cmd
.tokeniser
, index
), '\"' );
403 /* Search the vocabulary array for value */
404 for ( index
= 1; !found
&& vocabulary
[ index
].command
!= NULL
; index
++ )
405 if ( ( found
= !strcasecmp( vocabulary
[ index
].command
, value
) ) )
408 /* If we found something, the handle the args and call the handler. */
413 miracle_command_set_error( &cmd
, RESPONSE_SUCCESS
);
415 if ( vocabulary
[ index
].is_unit
)
417 cmd
.unit
= miracle_command_parse_unit( &cmd
, position
);
418 if ( cmd
.unit
== -1 )
419 miracle_command_set_error( &cmd
, RESPONSE_MISSING_ARG
);
423 if ( miracle_command_get_error( &cmd
) == RESPONSE_SUCCESS
)
425 cmd
.argument
= miracle_command_parse_argument( &cmd
, position
, vocabulary
[ index
].type
);
426 if ( cmd
.argument
== NULL
&& vocabulary
[ index
].type
!= ATYPE_NONE
)
427 miracle_command_set_error( &cmd
, RESPONSE_MISSING_ARG
);
431 if ( miracle_command_get_error( &cmd
) == RESPONSE_SUCCESS
)
433 response_codes error
= vocabulary
[ index
].operation( &cmd
);
434 miracle_command_set_error( &cmd
, error
);
437 free( cmd
.argument
);
441 valerie_tokeniser_close( cmd
.tokeniser
);
446 /** Close the parser.
449 static void miracle_local_close( miracle_local local
)
451 miracle_delete_all_units();
452 pthread_kill_other_threads_np();
453 miracle_log( LOG_DEBUG
, "Clean shutdown." );