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 /* Needed for backtrace on linux */
35 /* Valerie header files */
36 #include <valerie/valerie_util.h>
38 /* MLT header files. */
39 #include <framework/mlt_factory.h>
41 /* Application header files */
42 #include "miracle_local.h"
43 #include "miracle_connection.h"
44 #include "miracle_commands.h"
45 #include "miracle_unit_commands.h"
46 #include "miracle_log.h"
48 /** Private miracle_local structure.
53 valerie_parser parser
;
56 *miracle_local
, miracle_local_t
;
58 /** Forward declarations.
61 static valerie_response
miracle_local_connect( miracle_local
);
62 static valerie_response
miracle_local_execute( miracle_local
, char * );
63 static void miracle_local_close( miracle_local
);
64 response_codes
miracle_help( command_argument arg
);
65 response_codes
miracle_run( command_argument arg
);
66 response_codes
miracle_shutdown( command_argument arg
);
68 /** DV Parser constructor.
71 valerie_parser
miracle_parser_init_local( )
73 valerie_parser parser
= malloc( sizeof( valerie_parser_t
) );
74 miracle_local local
= malloc( sizeof( miracle_local_t
) );
78 memset( parser
, 0, sizeof( valerie_parser_t
) );
80 parser
->connect
= (parser_connect
)miracle_local_connect
;
81 parser
->execute
= (parser_execute
)miracle_local_execute
;
82 parser
->close
= (parser_close
)miracle_local_close
;
87 memset( local
, 0, sizeof( miracle_local_t
) );
88 local
->parser
= parser
;
89 local
->root_dir
[0] = '/';
92 // Construct the factory
93 mlt_factory_init( getenv( "MLT_REPOSITORY" ) );
98 /** response status code/message pair
108 /** response messages
111 static responses_t responses
[] =
113 {RESPONSE_SUCCESS
, "OK"},
114 {RESPONSE_SUCCESS_N
, "OK"},
115 {RESPONSE_SUCCESS_1
, "OK"},
116 {RESPONSE_UNKNOWN_COMMAND
, "Unknown command"},
117 {RESPONSE_TIMEOUT
, "Operation timed out"},
118 {RESPONSE_MISSING_ARG
, "Argument missing"},
119 {RESPONSE_INVALID_UNIT
, "Unit not found"},
120 {RESPONSE_BAD_FILE
, "Failed to locate or open clip"},
121 {RESPONSE_OUT_OF_RANGE
, "Argument value out of range"},
122 {RESPONSE_TOO_MANY_FILES
, "Too many files open"},
123 {RESPONSE_ERROR
, "Server Error"}
139 /** A command definition.
144 /* The command string corresponding to this operation (e.g. "play") */
146 /* The function associated with it */
147 response_codes (*operation
) ( command_argument
);
148 /* a boolean to indicate if this is a unit or global command
149 unit commands require a unit identifier as first argument */
151 /* What type is the argument (RTTI :-) ATYPE_whatever */
153 /* online help information */
158 /* The following define the queue of commands available to the user. The
159 first entry is the name of the command (the string which must be typed),
160 the second command is the function associated with it, the third argument
161 is for the type of the argument, and the last argument specifies whether
162 this is something which should be handled immediately or whether it
163 should be queued (only robot motion commands need to be queued). */
165 static command_t vocabulary
[] =
167 {"BYE", NULL
, 0, ATYPE_NONE
, "Terminates the session. Units are not removed and task queue is not flushed."},
168 {"HELP", miracle_help
, 0, ATYPE_NONE
, "Display this information!"},
169 {"NLS", miracle_list_nodes
, 0, ATYPE_NONE
, "List the AV/C nodes on the 1394 bus."},
170 {"UADD", miracle_add_unit
, 0, ATYPE_STRING
, "Create a new DV unit (virtual VTR) to transmit to receiver specified in GUID argument."},
171 {"ULS", miracle_list_units
, 0, ATYPE_NONE
, "Lists the units that have already been added to the server."},
172 {"CLS", miracle_list_clips
, 0, ATYPE_STRING
, "Lists the clips at directory name argument."},
173 {"SET", miracle_set_global_property
, 0, ATYPE_PAIR
, "Set a server configuration property."},
174 {"GET", miracle_get_global_property
, 0, ATYPE_STRING
, "Get a server configuration property."},
175 {"RUN", miracle_run
, 0, ATYPE_STRING
, "Run a batch file." },
176 {"LIST", miracle_list
, 1, ATYPE_NONE
, "List the playlist associated to a unit."},
177 {"LOAD", miracle_load
, 1, ATYPE_STRING
, "Load clip specified in absolute filename argument."},
178 {"INSERT", miracle_insert
, 1, ATYPE_STRING
, "Insert a clip at the given clip index."},
179 {"REMOVE", miracle_remove
, 1, ATYPE_NONE
, "Remove a clip at the given clip index."},
180 {"CLEAN", miracle_clean
, 1, ATYPE_NONE
, "Clean a unit by removing all but the currently playing clip."},
181 {"CLEAR", miracle_clear
, 1, ATYPE_NONE
, "Clear a unit by removing all clips."},
182 {"MOVE", miracle_move
, 1, ATYPE_INT
, "Move a clip to another clip index."},
183 {"APND", miracle_append
, 1, ATYPE_STRING
, "Append a clip specified in absolute filename argument."},
184 {"PLAY", miracle_play
, 1, ATYPE_NONE
, "Play a loaded clip at speed -2000 to 2000 where 1000 = normal forward speed."},
185 {"STOP", miracle_stop
, 1, ATYPE_NONE
, "Stop a loaded and playing clip."},
186 {"PAUSE", miracle_pause
, 1, ATYPE_NONE
, "Pause a playing clip."},
187 {"REW", miracle_rewind
, 1, ATYPE_NONE
, "Rewind a unit. If stopped, seek to beginning of clip. If playing, play fast backwards."},
188 {"FF", miracle_ff
, 1, ATYPE_NONE
, "Fast forward a unit. If stopped, seek to beginning of clip. If playing, play fast forwards."},
189 {"STEP", miracle_step
, 1, ATYPE_INT
, "Step argument number of frames forward or backward."},
190 {"GOTO", miracle_goto
, 1, ATYPE_INT
, "Jump to frame number supplied as argument."},
191 {"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"},
192 {"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."},
193 {"USTA", miracle_get_unit_status
, 1, ATYPE_NONE
, "Report information about the unit."},
194 {"USET", miracle_set_unit_property
, 1, ATYPE_PAIR
, "Set a unit configuration property."},
195 {"UGET", miracle_get_unit_property
, 1, ATYPE_STRING
, "Get a unit configuration property."},
196 {"XFER", miracle_transfer
, 1, ATYPE_STRING
, "Transfer the unit's clip to another unit specified as argument."},
197 {"SHUTDOWN", miracle_shutdown
, 0, ATYPE_NONE
, "Shutdown the server."},
198 {NULL
, NULL
, 0, ATYPE_NONE
, NULL
}
204 static char helpstr
[] =
205 "Miracle -- A Multimedia Playout Server\n"
206 " Copyright (C) 2002-2003 Ushodaya Enterprises Limited\n"
208 " Dan Dennedy <dan@dennedy.org>\n"
209 " Charles Yates <charles.yates@pandora.be>\n"
210 "Available commands:\n";
212 /** Lookup the response message for a status code.
215 inline char *get_response_msg( int code
)
218 for ( i
= 0; responses
[ i
].message
!= NULL
&& code
!= responses
[ i
].code
; i
++ ) ;
219 return responses
[ i
].message
;
222 /** Tell the user the miracle command set
225 response_codes
miracle_help( command_argument cmd_arg
)
229 valerie_response_printf( cmd_arg
->response
, 10240, "%s", helpstr
);
231 for ( i
= 0; vocabulary
[ i
].command
!= NULL
; i
++ )
232 valerie_response_printf( cmd_arg
->response
, 1024,
234 vocabulary
[ i
].command
,
235 vocabulary
[ i
].help
);
237 valerie_response_printf( cmd_arg
->response
, 2, "\n" );
239 return RESPONSE_SUCCESS_N
;
242 /** Execute a batch file.
245 response_codes
miracle_run( command_argument cmd_arg
)
247 valerie_response temp
= valerie_parser_run( cmd_arg
->parser
, (char *)cmd_arg
->argument
);
253 valerie_response_set_error( cmd_arg
->response
,
254 valerie_response_get_error_code( temp
),
255 valerie_response_get_error_string( temp
) );
257 for ( index
= 1; index
< valerie_response_count( temp
); index
++ )
258 valerie_response_printf( cmd_arg
->response
, 10240, "%s\n", valerie_response_get_line( temp
, index
) );
260 valerie_response_close( temp
);
263 return valerie_response_get_error_code( cmd_arg
->response
);
266 response_codes
miracle_shutdown( command_argument cmd_arg
)
269 return RESPONSE_SUCCESS
;
272 /** Processes 'thread' id
275 static pthread_t self
;
277 /* Signal handler to deal with various shutdown signals. Basically this
278 should clean up and power down the motor. Note that the death of any
279 child thread will kill all thrads. */
281 void signal_handler( int sig
)
283 if ( pthread_equal( self
, pthread_self( ) ) )
287 miracle_log( LOG_DEBUG
, "Received %s - shutting down.", strsignal(sig
) );
289 miracle_log( LOG_DEBUG
, "Received signal %i - shutting down.", sig
);
296 static void sigsegv_handler()
304 miracle_log( LOG_CRIT
, "\a\nMiracle experienced a segmentation fault.\n"
305 "Dumping stack from the offending thread\n\n" );
306 size
= backtrace( array
, 10 );
307 strings
= backtrace_symbols( array
, size
);
309 miracle_log( LOG_CRIT
, "Obtained %zd stack frames.\n", size
);
311 for ( i
= 0; i
< size
; i
++ )
312 miracle_log( LOG_CRIT
, "%s", strings
[ i
] );
316 miracle_log( LOG_CRIT
, "\nDone dumping - exiting.\n" );
318 miracle_log( LOG_CRIT
, "\a\nMiracle experienced a segmentation fault.\n" );
320 exit( EXIT_FAILURE
);
325 /** Local 'connect' function.
328 static valerie_response
miracle_local_connect( miracle_local local
)
330 valerie_response response
= valerie_response_init( );
332 self
= pthread_self( );
334 valerie_response_set_error( response
, 100, "VTR Ready" );
336 signal( SIGHUP
, signal_handler
);
337 signal( SIGINT
, signal_handler
);
338 signal( SIGTERM
, SIG_DFL
);
339 signal( SIGSTOP
, signal_handler
);
340 signal( SIGPIPE
, signal_handler
);
341 signal( SIGALRM
, signal_handler
);
342 signal( SIGCHLD
, SIG_IGN
);
343 if ( getenv( "MLT_SIGSEGV" ) )
344 signal( SIGSEGV
, sigsegv_handler
);
349 /** Set the error and determine the message associated to this command.
352 void miracle_command_set_error( command_argument cmd
, response_codes code
)
354 valerie_response_set_error( cmd
->response
, code
, get_response_msg( code
) );
357 /** Parse the unit argument.
360 int miracle_command_parse_unit( command_argument cmd
, int argument
)
363 char *string
= valerie_tokeniser_get_string( cmd
->tokeniser
, argument
);
364 if ( string
!= NULL
&& ( string
[ 0 ] == 'U' || string
[ 0 ] == 'u' ) && strlen( string
) > 1 )
365 unit
= atoi( string
+ 1 );
369 /** Parse a normal argument.
372 void *miracle_command_parse_argument( command_argument cmd
, int argument
, arguments_types type
, char *command
)
375 char *value
= valerie_tokeniser_get_string( cmd
->tokeniser
, argument
);
385 ret
= malloc( sizeof( float ) );
387 *( float * )ret
= atof( value
);
391 ret
= strdup( value
);
395 if ( strchr( command
, '=' ) )
397 char *ptr
= strchr( command
, '=' );
398 while ( *( ptr
- 1 ) != ' ' )
402 while( ptr
[ strlen( ptr
) - 1 ] == ' ' )
403 ptr
[ strlen( ptr
) - 1 ] = '\0';
408 ret
= malloc( sizeof( int ) );
410 *( int * )ret
= atoi( value
);
418 /** Get the error code - note that we simply the success return.
421 response_codes
miracle_command_get_error( command_argument cmd
)
423 response_codes ret
= valerie_response_get_error_code( cmd
->response
);
424 if ( ret
== RESPONSE_SUCCESS_N
|| ret
== RESPONSE_SUCCESS_1
)
425 ret
= RESPONSE_SUCCESS
;
429 /** Execute the command.
432 static valerie_response
miracle_local_execute( miracle_local local
, char *command
)
434 command_argument_t cmd
;
435 cmd
.parser
= local
->parser
;
436 cmd
.response
= valerie_response_init( );
437 cmd
.tokeniser
= valerie_tokeniser_init( );
438 cmd
.command
= command
;
441 cmd
.root_dir
= local
->root_dir
;
443 /* Set the default error */
444 miracle_command_set_error( &cmd
, RESPONSE_UNKNOWN_COMMAND
);
446 /* Parse the command */
447 if ( valerie_tokeniser_parse_new( cmd
.tokeniser
, command
, " " ) > 0 )
450 char *value
= valerie_tokeniser_get_string( cmd
.tokeniser
, 0 );
453 /* Strip quotes from all tokens */
454 for ( index
= 0; index
< valerie_tokeniser_count( cmd
.tokeniser
); index
++ )
455 valerie_util_strip( valerie_tokeniser_get_string( cmd
.tokeniser
, index
), '\"' );
457 /* Search the vocabulary array for value */
458 for ( index
= 1; !found
&& vocabulary
[ index
].command
!= NULL
; index
++ )
459 if ( ( found
= !strcasecmp( vocabulary
[ index
].command
, value
) ) )
462 /* If we found something, the handle the args and call the handler. */
467 miracle_command_set_error( &cmd
, RESPONSE_SUCCESS
);
469 if ( vocabulary
[ index
].is_unit
)
471 cmd
.unit
= miracle_command_parse_unit( &cmd
, position
);
472 if ( cmd
.unit
== -1 )
473 miracle_command_set_error( &cmd
, RESPONSE_MISSING_ARG
);
477 if ( miracle_command_get_error( &cmd
) == RESPONSE_SUCCESS
)
479 cmd
.argument
= miracle_command_parse_argument( &cmd
, position
, vocabulary
[ index
].type
, command
);
480 if ( cmd
.argument
== NULL
&& vocabulary
[ index
].type
!= ATYPE_NONE
)
481 miracle_command_set_error( &cmd
, RESPONSE_MISSING_ARG
);
485 if ( miracle_command_get_error( &cmd
) == RESPONSE_SUCCESS
)
487 response_codes error
= vocabulary
[ index
].operation( &cmd
);
488 miracle_command_set_error( &cmd
, error
);
491 free( cmd
.argument
);
495 valerie_tokeniser_close( cmd
.tokeniser
);
500 /** Close the parser.
503 static void miracle_local_close( miracle_local local
)
505 miracle_delete_all_units();
507 pthread_kill_other_threads_np();
508 miracle_log( LOG_DEBUG
, "Clean shutdown." );
510 mlt_factory_close( );