Add support for reading commands from text file using -T / --test-input.

ChangeLog

@@ -3,6 +3,8 @@
  * Add videohubctrl(1) man page.
  * Add all, install, uninstall and help Makefile targets.
  * Display where each input is being routed.
+ * Add support for testing the program using pre-recorded commands
+   in text file by using -T / --test-input option.
 
 2014-11-28 : Version 0.3
  * Rename -v / --verbose parameter to -d / --debug.

README

@@ -69,6 +69,7 @@ Video input/output configuration:
    For <in_X/out_X/in_Y> you may use port number or port name.
 
 Misc options:
+ -T --test-input <file>     | Read commands from <file>.
  -d --debug                 | Increase logging verbosity.
  -q --quiet                 | Suppress warnings.
  -H --help                  | Show help screen.
@@ -136,10 +137,11 @@ Example usage
 Example output
 ==============
 
-Here is how videohubctrl output looks like:
+Here is how videohubctrl output looks like using the commands recorded
+in vh_test_commands.txt file.
 
 |----------------------------------------------------------------------|
-gf@gf:~/git/videohubctrl$ ./videohubctrl --host sdi-matrix
+$ videohubctrl --test vh_test_commands.txt
 Device info
   -----------------------------------------------------------
   | Device address             | sdi-matrix                 |
@@ -197,7 +199,6 @@ Video outputs
   | 16 | O | Loopback                 | Loopback                 |
   ----------------------------------------------------------------
 
-gf@gf:~/git/videohubctrl$
 |----------------------------------------------------------------------|
 
 Video outputs Legend

cmd.c

@@ -18,96 +18,6 @@
 #include "cmd.h"
 #include "util.h"
 
-/*
-Example response from videohub (on connect)
-===========================================
-PROTOCOL PREAMBLE:
-Version: 2.4
-
-VIDEOHUB DEVICE:
-Device present: true
-Model name: Blackmagic Micro Videohub
-Unique ID: 7c2e0d021714
-Video inputs: 16
-Video processing units: 0
-Video outputs: 16
-Video monitoring outputs: 0
-Serial ports: 0
-
-INPUT LABELS:
-0 Windows 1
-1 Windows 2
-2 Windows 3
-3 Windows 4 HD
-4 Input 5
-5 Input 6
-6 Input 7
-7 Input 8
-8 Input 9
-9 Input 10
-10 Input 11
-11 DPlay1
-12 DPlay2
-13 Input 14
-14 Input 15
-15 Loopback
-
-OUTPUT LABELS:
-0 Enc1 1
-1 Enc1 2
-2 Enc1 3
-3 Enc1 4
-4 Output 5
-5 Output 6
-6 Output 7
-7 Output 8
-8 Enc2 1
-9 Output 10
-10 Output 11
-11 Denc
-12 Output 13
-13 Output 14
-14 Output 15
-15 Loopback
-
-VIDEO OUTPUT LOCKS:
-0 L
-1 L
-2 L
-3 L
-4 U
-5 U
-6 U
-7 U
-8 L
-9 U
-10 U
-11 L
-12 L
-13 O
-14 U
-15 O
-
-VIDEO OUTPUT ROUTING:
-0 2
-1 1
-2 0
-3 0
-4 4
-5 5
-6 6
-7 7
-8 3
-9 3
-10 10
-11 12
-12 11
-13 13
-14 14
-15 15
-
-*/
-
 static struct videohub_commands {
 	enum vcmd	cmd;
 	const char	*txt;

vh_test_commands.txt

@@ -0,0 +1,84 @@
+PROTOCOL PREAMBLE:
+Version: 2.4
+
+VIDEOHUB DEVICE:
+Device present: true
+Model name: Blackmagic Micro Videohub
+Unique ID: 7c2e0d021714
+Video inputs: 16
+Video processing units: 0
+Video outputs: 16
+Video monitoring outputs: 0
+Serial ports: 0
+
+INPUT LABELS:
+0 Windows 1
+1 Windows 2
+2 Windows 3
+3 Windows 4 HD
+4 Input 5
+5 Input 6
+6 Input 7
+7 Input 8
+8 Input 9
+9 Input 10
+10 Input 11
+11 DPlay1
+12 DPlay2
+13 Input 14
+14 Input 15
+15 Loopback
+
+OUTPUT LABELS:
+0 Enc1 1
+1 Enc1 2
+2 Enc1 3
+3 Enc1 4
+4 Output 5
+5 Output 6
+6 Output 7
+7 Output 8
+8 Enc2 1
+9 Output 10
+10 Output 11
+11 Denc
+12 Output 13
+13 Output 14
+14 Output 15
+15 Loopback
+
+VIDEO OUTPUT LOCKS:
+0 L
+1 L
+2 L
+3 L
+4 U
+5 U
+6 U
+7 U
+8 L
+9 U
+10 U
+11 L
+12 O
+13 U
+14 U
+15 O
+
+VIDEO OUTPUT ROUTING:
+0 2
+1 1
+2 0
+3 0
+4 4
+5 5
+6 6
+7 3
+8 3
+9 9
+10 10
+11 12
+12 11
+13 13
+14 14
+15 15

videohubctrl.1

@@ -76,6 +76,11 @@ port would be forcefully unlocked.
 .SH MISC OPTIONS
 .PP
 .TP
+\fB\-T\fR, \fB\-\-test\fR <file>
+Read commands from the <file> instead of connecting to a real
+device. This allows testing the program without having access
+to a device.
+.TP
 \fB\-d\fR, \fB\-\-debug\fR
 Enable debugging output. Use this option more times to increase
 the verbosity.

videohubctrl.c

@@ -13,6 +13,10 @@
 #include <string.h>
 #include <getopt.h>
 #include <unistd.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <unistd.h>
+#include <errno.h>
 
 #include "data.h"
 #include "cmd.h"
@@ -31,6 +35,7 @@ static int show_info = 1;
 static int show_monitor = 0;
 static int show_backup = 0;
 static int show_list = 0;
+static char *test_data;
 
 enum list_actions {
 	action_list_device		= (1 << 0),
@@ -40,11 +45,12 @@ enum list_actions {
 
 static const char *program_id = PROGRAM_NAME " Version: " VERSION " Git: " GIT_VER;
 
-static const char short_options[] = "h:p:qdHVimb";
+static const char short_options[] = "h:p:T:qdHVimb";
 
 static const struct option long_options[] = {
 	{ "host",				required_argument, NULL, 'h' },
 	{ "port",				required_argument, NULL, 'p' },
+	{ "test-input",			required_argument, NULL, 'T' },
 	{ "quiet",				no_argument,       NULL, 'q' },
 	{ "debug",				no_argument,       NULL, 'd' },
 	{ "help",				no_argument,       NULL, 'H' },
@@ -96,6 +102,7 @@ static void show_help(struct videohub_data *data) {
 	printf("   For <in_X/out_X/in_Y> you may use port number or port name.\n");
 	printf("\n");
 	printf("Misc options:\n");
+	printf(" -T --test-input <file>     | Read commands from <file>.\n");
 	printf(" -d --debug                 | Increase logging verbosity.\n");
 	printf(" -q --quiet                 | Suppress warnings.\n");
 	printf(" -H --help                  | Show help screen.\n");
@@ -127,6 +134,21 @@ static void parse_options(struct videohub_data *data, int argc, char **argv) {
 			case 'p': // --port
 				data->dev_port = optarg;
 				break;
+			case 'T': { // --test-input
+				struct stat st;
+				FILE *f;
+				if (stat(optarg, &st) != 0)
+					die("Can't stat %s: %s", optarg, strerror(errno));
+				f = fopen(optarg, "r");
+				if (!f)
+					die("Can't open %s: %s", optarg, strerror(errno));
+				test_data = xzalloc(st.st_size);
+				if (fread(test_data, st.st_size, 1, f) < 1)
+					die("Can't read from %s: %s", optarg, strerror(errno));
+				fclose(f);
+				data->dev_host = "sdi-matrix";
+				break;
+			}
 			case 'd': // --debug
 				debug++;
 				if (debug)
@@ -202,6 +224,8 @@ static void parse_options(struct videohub_data *data, int argc, char **argv) {
 static int read_device_command_stream(struct videohub_data *d) {
 	int ret, ncommands = 0;
 	char buf[8192 + 1];
+	if (test_data)
+		return 0;
 	memset(buf, 0, sizeof(buf));
 	while ((ret = fdread_ex(d->dev_fd, buf, sizeof(buf) - 1, 5, 0, 0)) >= 0) {
 		ncommands += parse_text_buffer(d, buf);
@@ -210,18 +234,28 @@ static int read_device_command_stream(struct videohub_data *d) {
 	return ncommands;
 }
 
+static void send_device_command(struct videohub_data *d, char *cmd_buffer) {
+	if (!test_data)
+		fdwrite(d->dev_fd, cmd_buffer, strlen(cmd_buffer));
+}
+
 int main(int argc, char **argv) {
 	struct videohub_data *data = &maindata;
 
 	parse_options(data, argc, argv);
 	set_log_io_errors(0);
 
-	data->dev_fd = connect_client(SOCK_STREAM, data->dev_host, data->dev_port);
-	if (data->dev_fd < 0)
-		exit(EXIT_FAILURE);
+	if (!test_data) {
+		data->dev_fd = connect_client(SOCK_STREAM, data->dev_host, data->dev_port);
+		if (data->dev_fd < 0)
+			exit(EXIT_FAILURE);
+	}
 
 	read_device_command_stream(data);
 
+	if (test_data)
+		parse_text_buffer(data, test_data);
+
 	if (!strlen(data->device.protocol_ver) || !strlen(data->device.model_name))
 		die("The device does not respond correctly. Is it Videohub?");
 
@@ -261,7 +295,7 @@ int main(int argc, char **argv) {
 			format_cmd_text(ve, cmd_buffer, sizeof(cmd_buffer));
 			if (strlen(cmd_buffer)) {
 				show_cmd(data, ve);
-				fdwrite(data->dev_fd, cmd_buffer, strlen(cmd_buffer));
+				send_device_command(data, cmd_buffer);
 				read_device_command_stream(data);
 			}
 		}
@@ -278,10 +312,8 @@ int main(int argc, char **argv) {
 			fflush(stdout);
 			do {
 				usleep(500000);
-				if (++sleeps >= 20) {
-					char *ping_cmd = "PING:\n\n";
-					fdwrite(data->dev_fd, ping_cmd, strlen(ping_cmd));
-				}
+				if (++sleeps >= 20)
+					send_device_command(data, "PING:\n\n");
 			} while (read_device_command_stream(data) == 0);
 		}
 	} else if (show_list) {
@@ -299,6 +331,7 @@ int main(int argc, char **argv) {
 	}
 
 	shutdown_fd(&data->dev_fd);
+	free(test_data);
 
 	return 0;
 }