Add support for frames (names, routing and locks)

It is not tested on a real hardware. The number of frame buffers
is assumed to be the same as number of serial ports (as good guess
as any).

ChangeLog

  * Display the undocumented "Friendly name" device setting.
  * Add support for processing units (routing and locks). It is not tested
    on a real hardware.
+ * Add support for frames (names, routing and locks). It is not tested on
+   a real hardware.
 
 2014-11-30 : Version 0.4
  * Add videohubctrl(1) man page.

README

   - Monitoring video output port names, routing and locking
   - Serial ports names, routing, locking and directions
   - Processing units
+  - Frames
 
 Configuration of Videohub's network settings can be made using
 Blackmagic's Windows program when the device is connected via USB.
  --pu-lock <pu_X>           | Lock processing unit X.
  --pu-unlock <pu_X>         | Unlock processing unit X.
 
+Frames configuration:
+ --fr-name <fr_X> <name>    | Set frame X name.
+ --fr-output <fr_X> <out_Y> | Output frame X to output Y.
+ --fr-clear <fr_X>          | Stop outputing frame X to the output.
+ --fr-lock <fr_X>           | Lock frame X.
+ --fr-unlock <rf_X>         | Unlock frame X.
+
 Misc options:
  -T --test-input <file>     | Read commands from <file>.
  -d --debug                 | Increase logging verbosity.
   |         4 |   | Windows 3                |
   --------------------------------------------
 
+Frames
+  -----------------------------------------------------------------
+  | ### | x | Frame name               | Connected output         |
+  -----------------------------------------------------------------
+  |   1 |   | Frame 1                  | Output 13                |
+  |   2 | L | Frame 2                  | Output 14                |
+  |   3 | O | Frame 3                  | Output 15                |
+  |   4 |   | Frame 4                  |                          |
+  |   5 |   | Frame 5                  |                          |
+  |   6 |   | Frame 6                  |                          |
+  |   7 |   | Frame 7                  |                          |
+  |   8 |   | Frame 8                  |                          |
+  -----------------------------------------------------------------
+
 
 |----------------------------------------------------------------------|
 

cmd.c

 	[CMD_SERIAL_PORT_DIRECTIONS] = "SERIAL PORT DIRECTIONS",
 	[CMD_PROCESSING_UNIT_ROUTING]= "PROCESSING UNIT ROUTING",
 	[CMD_PROCESSING_UNIT_LOCKS]  = "PROCESSING UNIT LOCKS",
+	[CMD_FRAME_LABELS]           = "FRAME LABELS",
+	[CMD_FRAME_BUFFER_ROUTING]   = "FRAME BUFFER ROUTING",
+	[CMD_FRAME_BUFFER_LOCKS]     = "FRAME BUFFER LOCKS",
 	[CMD_PING]                 = "PING",
 	[CMD_ACK]                  = "ACK",
 	[CMD_NAK]                  = "NAK",
 		.port_id1 = "proc unit",
 		.opt_prefix = "pu",
 	},
+	[CMD_FRAME_LABELS]  = { .cmd = CMD_FRAME_LABELS, .type = PARSE_LABEL,
+		.ports1 = OFS(frames),
+		.port_id1 = "frame",
+		.opt_prefix = "fr",
+	},
+	[CMD_FRAME_BUFFER_ROUTING] = { .cmd = CMD_FRAME_BUFFER_ROUTING, .type = PARSE_ROUTE,
+		.ports1 = OFS(frames),
+		.ports2 = OFS(outputs),
+		.port_id1 = "frame",
+		.port_id2 = "output",
+		.opt_prefix = "fr",
+		.allow_disconnect = true,
+	},
+	[CMD_FRAME_BUFFER_LOCKS] = { .cmd = CMD_FRAME_BUFFER_LOCKS, .type = PARSE_LOCK,
+		.ports1 = OFS(frames),
+		.port_id1 = "frame",
+		.opt_prefix = "fr",
+	},
 	[CMD_PING]                 = { .cmd = CMD_PING                , .type = PARSE_NONE },
 	[CMD_ACK]                  = { .cmd = CMD_ACK                 , .type = PARSE_NONE },
 	[CMD_NAK]                  = { .cmd = CMD_NAK                 , .type = PARSE_NONE },
 				d->outputs.num = strtoul(p, NULL, 10);
 			else if ((p = parse_text(line, "Video monitoring outputs: ")))
 				d->mon_outputs.num = strtoul(p, NULL, 10);
-			else if ((p = parse_text(line, "Serial ports: ")))
+			else if ((p = parse_text(line, "Serial ports: "))) {
 				d->serial.num = strtoul(p, NULL, 10);
-			else {
+				d->frames.num = d->serial.num;
+			} else {
 				q("WARNING: VIDEOHUB DEVICE command sent unknown line: '%s'\n", line);
 				q("Please report this line to author's email: georgi@unixsol.org\n");
 			}

cmd.h

 
 #include <stdbool.h>
 
-#define NUM_COMMANDS 21
+#define NUM_COMMANDS 24
 
 enum vcmd {
 	CMD_PROTOCOL_PREAMBLE,
 	CMD_SERIAL_PORT_DIRECTIONS,
 	CMD_PROCESSING_UNIT_ROUTING,
 	CMD_PROCESSING_UNIT_LOCKS,
+	CMD_FRAME_LABELS,
+	CMD_FRAME_BUFFER_ROUTING,
+	CMD_FRAME_BUFFER_LOCKS,
 	CMD_PING,
 	CMD_ACK,
 	CMD_NAK = (NUM_COMMANDS - 1),

data.h

 	struct port_set			mon_outputs;
 	struct port_set			serial;
 	struct port_set			proc_units;
+	struct port_set			frames;
 };
 
 extern int debug;

display.c

 	printf("\n");
 }
 
+void print_device_frame_buffers(struct videohub_data *d) {
+	unsigned int i, len = 65;
+	if (!d->frames.num)
+		return;
+	printf("Frames\n");
+	printf_line(len);
+	printf("  | ### | x | %-24s | %-24s |\n", "Frame name", "Connected output");
+	printf_line(len);
+	for(i = 0; i < d->frames.num; i++) {
+		printf("  | %3d | %c | %-24s | %-24s |\n",
+			i + 1,
+			port_lock_symbol(d->frames.port[i].lock),
+			d->frames.port[i].name,
+			d->frames.port[i].routed_to == NO_PORT ? "" : d->outputs.port[d->frames.port[i].routed_to].name
+		);
+	}
+	printf_line(len);
+	printf("\n");
+}
+
+
 static void __print_opt(struct videohub_data *d, enum vcmd vcmd) {
 	unsigned int i, last = 0;
 	struct videohub_commands *v = &videohub_commands[vcmd];

display.h

 void print_device_monitoring_outputs(struct videohub_data *d);
 void print_device_serial_ports(struct videohub_data *d);
 void print_device_processing_units(struct videohub_data *d);
+void print_device_frame_buffers(struct videohub_data *d);
 
 void print_device_backup(struct videohub_data *d);
 

test/input-00.txt

 2 O
 3 U
 
+FRAME LABELS:
+0 Frame 1
+1 Frame 2
+2 Frame 3
+3 Frame 4
+4 Frame 5
+5 Frame 6
+6 Frame 7
+7 Frame 8
+
+FRAME BUFFER ROUTING:
+0 12
+1 13
+2 14
+
+FRAME BUFFER LOCKS:
+0 U
+1 L
+2 O
+

test/input-14.txt

 2 Thunderbolt
 3 RS422
 
+FRAME LABELS:
+0 Pic 1
+1 Pic 2
+2 Pic 3
+3 Pic 4
+

test/run

 	--pu-clear 1 --pu-clear 3 --pu-clear 4 \
 	--pu-unlock 1 --pu-lock 1 --pu-connect 1 "Windows 4 HD" \
 	--pu-connect 4 "DPlay1" --pu-lock 4 \
+	--fr-name 1 "Pic 1" --fr-name 2 "Pic 2" \
+	--fr-output 1 13 --fr-output 2 14 --fr-output 3 15 \
+	--fr-clear 3 \
+	--fr-lock 1 --fr-lock 2 --fr-lock 8 --fr-unlock 8 \
 $@ &> test/test-04.out
 check test/test-04 "Test multiple configuration commands"
 

test/test-01.ok

   |         4 |   | Windows 3                |
   --------------------------------------------
 
+Frames
+  -----------------------------------------------------------------
+  | ### | x | Frame name               | Connected output         |
+  -----------------------------------------------------------------
+  |   1 |   | Frame 1                  | Output 13                |
+  |   2 | L | Frame 2                  | Output 14                |
+  |   3 | O | Frame 3                  | Output 15                |
+  |   4 |   | Frame 4                  |                          |
+  |   5 |   | Frame 5                  |                          |
+  |   6 |   | Frame 6                  |                          |
+  |   7 |   | Frame 7                  |                          |
+  |   8 |   | Frame 8                  |                          |
+  -----------------------------------------------------------------
+

test/test-02.ok

   --se-name   6 "Serial 6" \
   --se-name   7 "Serial 7" \
   --se-name   8 "Serial 8" \
+  --fr-name   1 "Frame 1" \
+  --fr-name   2 "Frame 2" \
+  --fr-name   3 "Frame 3" \
+  --fr-name   4 "Frame 4" \
+  --fr-name   5 "Frame 5" \
+  --fr-name   6 "Frame 6" \
+  --fr-name   7 "Frame 7" \
+  --fr-name   8 "Frame 8" \
   --vo-input   1   3 \
   --vo-input   2   2 \
   --vo-input   3   1 \
   --pu-input   1   4 \
   --pu-input   2   2 \
   --pu-input   4   3 \
+  --fr-input   1  13 \
+  --fr-input   2  14 \
+  --fr-input   3  15 \
   --se-dir   1 in \
   --se-dir   2 auto \
   --se-dir   3 out \
   --pu-unlock   2 \
   --pu-unlock   3 --pu-lock   3 \
   --pu-unlock   4
+  --fr-unlock   1 \
+  --fr-unlock   2 --fr-lock   2 \
+  --fr-unlock   3 --fr-lock   3 \
+  --fr-unlock   4 \
+  --fr-unlock   5 \
+  --fr-unlock   6 \
+  --fr-unlock   7 \
+  --fr-unlock   8
 

test/test-03.ok

 videohub: rename serial 6 "" to "Serial 6"
 videohub: rename serial 7 "" to "Serial 7"
 videohub: rename serial 8 "" to "Serial 8"
+videohub: rename frame 1 "" to "Frame 1"
+videohub: rename frame 2 "" to "Frame 2"
+videohub: rename frame 3 "" to "Frame 3"
+videohub: rename frame 4 "" to "Frame 4"
+videohub: rename frame 5 "" to "Frame 5"
+videohub: rename frame 6 "" to "Frame 6"
+videohub: rename frame 7 "" to "Frame 7"
+videohub: rename frame 8 "" to "Frame 8"
 videohub: set video output 1 "Enc1 1" to read from video input 3 "Windows 3"
 videohub: set video output 2 "Enc1 2" to read from video input 2 "Windows 2"
 videohub: set video output 3 "Enc1 3" to read from video input 1 "Windows 1"
 videohub: connect proc unit 1 "" to input 4 "Windows 4 HD"
 videohub: connect proc unit 2 "" to input 2 "Windows 2"
 videohub: connect proc unit 4 "" to input 3 "Windows 3"
+videohub: connect frame 1 "Frame 1" to output 13 "Output 13"
+videohub: connect frame 2 "Frame 2" to output 14 "Output 14"
+videohub: connect frame 3 "Frame 3" to output 15 "Output 15"
 videohub: set serial 1 "Serial Ctrl 1" direction to IN (Workstation)
 videohub: set serial 2 "Serial Ctrl 2" direction to AUTO
 videohub: set serial 3 "Deck 3" direction to OUT (Deck)
 videohub: unlock proc unit 3 ""
 videohub: lock proc unit 3 ""
 videohub: unlock proc unit 4 ""
+videohub: unlock frame 1 "Frame 1"
+videohub: unlock frame 2 "Frame 2"
+videohub: lock frame 2 "Frame 2"
+videohub: unlock frame 3 "Frame 3"
+videohub: lock frame 3 "Frame 3"
+videohub: unlock frame 4 "Frame 4"
+videohub: unlock frame 5 "Frame 5"
+videohub: unlock frame 6 "Frame 6"
+videohub: unlock frame 7 "Frame 7"
+videohub: unlock frame 8 "Frame 8"
 Device info
   -------------------------------------------------------------------
   | Device address             | sdi-matrix                         |
   |         4 |   | Windows 3                |
   --------------------------------------------
 
+Frames
+  -----------------------------------------------------------------
+  | ### | x | Frame name               | Connected output         |
+  -----------------------------------------------------------------
+  |   1 |   | Frame 1                  | Output 13                |
+  |   2 | O | Frame 2                  | Output 14                |
+  |   3 | O | Frame 3                  | Output 15                |
+  |   4 |   | Frame 4                  |                          |
+  |   5 |   | Frame 5                  |                          |
+  |   6 |   | Frame 6                  |                          |
+  |   7 |   | Frame 7                  |                          |
+  |   8 |   | Frame 8                  |                          |
+  -----------------------------------------------------------------
+

test/test-04.ok

 videohub: connect proc unit 1 "" to input 4 "Windows 4 HighDef"
 videohub: connect proc unit 4 "" to input 12 "DPlay1"
 videohub: lock proc unit 4 ""
+videohub: rename frame 1 "Frame 1" to "Pic 1"
+videohub: rename frame 2 "Frame 2" to "Pic 2"
+videohub: connect frame 1 "Pic 1" to output 13 "Output 13"
+videohub: connect frame 2 "Pic 2" to output 14 "Output 14"
+videohub: connect frame 3 "Frame 3" to output 15 "Output 15"
+videohub: lock frame 1 "Pic 1"
+videohub: lock frame 2 "Pic 2"
+videohub: lock frame 8 "Frame 8"
+videohub: unlock frame 8 "Frame 8"
 Device info
   -------------------------------------------------------------------
   | Device address             | sdi-matrix                         |
   |         4 | O | DPlay1                   |
   --------------------------------------------
 
+Frames
+  -----------------------------------------------------------------
+  | ### | x | Frame name               | Connected output         |
+  -----------------------------------------------------------------
+  |   1 | O | Pic 1                    | Output 13                |
+  |   2 | O | Pic 2                    | Output 14                |
+  |   3 | O | Frame 3                  | Output 15                |
+  |   4 |   | Frame 4                  |                          |
+  |   5 |   | Frame 5                  |                          |
+  |   6 |   | Frame 6                  |                          |
+  |   7 |   | Frame 7                  |                          |
+  |   8 |   | Frame 8                  |                          |
+  -----------------------------------------------------------------
+

test/test-05.ok

   |         4 |   | Windows 3                |
   --------------------------------------------
 
+Frames
+  -----------------------------------------------------------------
+  | ### | x | Frame name               | Connected output         |
+  -----------------------------------------------------------------
+  |   1 |   | Frame 1                  | Output 13                |
+  |   2 | O | Frame 2                  | Output 14                |
+  |   3 | O | Frame 3                  | Output 15                |
+  |   4 |   | Frame 4                  |                          |
+  |   5 |   | Frame 5                  |                          |
+  |   6 |   | Frame 6                  |                          |
+  |   7 |   | Frame 7                  |                          |
+  |   8 |   | Frame 8                  |                          |
+  -----------------------------------------------------------------
+

test/test-14.ok

   |   4 |   | auto | Remote 4           |                    | 4 |
   ----------------------------------------------------------------
 
+Frames
+  -----------------------------------------------------------------
+  | ### | x | Frame name               | Connected output         |
+  -----------------------------------------------------------------
+  |   1 |   | Pic 1                    |                          |
+  |   2 |   | Pic 2                    |                          |
+  |   3 |   | Pic 3                    |                          |
+  |   4 |   | Pic 4                    |                          |
+  -----------------------------------------------------------------
+

test/test-17.ok

          Please report this command to author's email: georgi@unixsol.org
          You may use -q or --quiet to suppress the message.
 ---------8<-----------8<----------- cut here ---------8<------------8<---------
-FRAME LABELS:
-0 gf-Frame 1
-1 Frame 2
-2 gf-Frame 3
-3 Frame 4
-4 gf-Frame 5
-5 Frame 6
-6 gf-Frame 7
-7 Frame 8
----------8<-----------8<----------- cut here ---------8<------------8<---------
-WARNING: Videohub sent unknown command!
-         Please report this command to author's email: georgi@unixsol.org
-         You may use -q or --quiet to suppress the message.
----------8<-----------8<----------- cut here ---------8<------------8<---------
-FRAME BUFFER ROUTING:
-0 Frame 4
-1 gf-Frame 3
-2 Frame 6
----------8<-----------8<----------- cut here ---------8<------------8<---------
-WARNING: Videohub sent unknown command!
-         Please report this command to author's email: georgi@unixsol.org
-         You may use -q or --quiet to suppress the message.
----------8<-----------8<----------- cut here ---------8<------------8<---------
-FRAME BUFFER LOCKS:
-0 U
----------8<-----------8<----------- cut here ---------8<------------8<---------
-WARNING: Videohub sent unknown command!
-         Please report this command to author's email: georgi@unixsol.org
-         You may use -q or --quiet to suppress the message.
----------8<-----------8<----------- cut here ---------8<------------8<---------
 ALARM STATUS:
 0 Error
 ---------8<-----------8<----------- cut here ---------8<------------8<---------
   |   8 |   |  out | Serial 8           |                    | x |
   ----------------------------------------------------------------
 
+Frames
+  -----------------------------------------------------------------
+  | ### | x | Frame name               | Connected output         |
+  -----------------------------------------------------------------
+  |   1 |   | gf-Frame 1               | Enc1 1                   |
+  |   2 |   | Frame 2                  | Enc1 1                   |
+  |   3 |   | gf-Frame 3               | Enc1 1                   |
+  |   4 |   | Frame 4                  |                          |
+  |   5 |   | gf-Frame 5               |                          |
+  |   6 |   | Frame 6                  |                          |
+  |   7 |   | gf-Frame 7               |                          |
+  |   8 |   | Frame 8                  |                          |
+  -----------------------------------------------------------------
+

videohubctrl.1

   - Monitoring video output port names, routing and locking
   - Serial ports names, routing, locking and directions
   - Processing units
+  - Frames
 .SH MAIN OPTIONS
 .PP
 .TP
 Lock processing unit port X.
 .TP
 \fB\-\-pu\-unlock\fR <pu_X>
-Unlock processing unit port X. If the port is locked by somebody else the
-port would be forcefully unlocked.
+Unlock processing unit port X. If the processing unit is locked by somebody
+else the port would be forcefully unlocked.
+.SH FRAMES CONFIGURATION
+.PP
+.TP
+\fB\-\-fr\-name\fR <fr_X> <name>
+Set frame X name.
+.TP
+\fB\-\-fr\-output\fR <fr_X> <out_Y>
+Output frame X to video output port Y.
+.TP
+\fB\-\-fr\-clear\fR <fr_X>
+Disconnect frame X from the connected output port.
+.TP
+\fB\-\-fr\-lock\fR <fr_X>
+Lock frame X.
+.TP
+\fB\-\-fr\-unlock\fR <fr_X>
+Unlock frame X. If the frame is locked by somebody else the port would be
+forcefully unlocked.
 .SH MISC OPTIONS
 .PP
 .TP

videohubctrl.c

 	action_list_moutputs	= (1 << 3),
 	action_list_serial		= (1 << 4),
 	action_list_proc_units	= (1 << 5),
+	action_list_frames		= (1 << 6),
 };
 
 static const char *program_id = PROGRAM_NAME " Version: " VERSION " Git: " GIT_VER;
 	{ "pu-lock",			required_argument, NULL, 5002 },
 	{ "pu-unlock",			required_argument, NULL, 5003 },
 	{ "pu-clear",			required_argument, NULL, 5004 },
+	{ "fr-name",			required_argument, NULL, 6001 },
+	{ "fr-output",			required_argument, NULL, 6002 },
+	{ "fr-connect",			required_argument, NULL, 6002 }, // Alias of --fr-output
+	{ "fr-input",			required_argument, NULL, 6002 }, // Alias of --fr-output
+	{ "fr-route",			required_argument, NULL, 6002 }, // Alias of --fr-output
+	{ "fr-lock",			required_argument, NULL, 6003 },
+	{ "fr-unlock",			required_argument, NULL, 6004 },
+	{ "fr-clear",			required_argument, NULL, 6006 },
 	{ 0, 0, 0, 0 }
 };
 
 	printf(" --list-moutputs            | List device monitoring outputs.\n");
 	printf(" --list-serial              | List device serial ports.\n");
 	printf(" --list-proc-units          | List device processing units.\n");
+	printf(" --list-frames              | List device frame buffers.\n");
 	printf("\n");
 	printf("Video inputs configuration:\n");
 	printf(" --vi-name <in_X> <name>    | Set video input port X name.\n");
 	printf(" --pu-lock <pu_X>           | Lock processing unit X.\n");
 	printf(" --pu-unlock <pu_X>         | Unlock processing unit X.\n");
 	printf("\n");
+	printf("Frames configuration:\n");
+	printf(" --fr-name <fr_X> <name>    | Set frame X name.\n");
+	printf(" --fr-output <fr_X> <out_Y> | Output frame X to output Y.\n");
+	printf(" --fr-clear <fr_X>          | Stop outputing frame X to the output.\n");
+	printf(" --fr-lock <fr_X>           | Lock frame X.\n");
+	printf(" --fr-unlock <rf_X>         | Unlock frame X.\n");
+	printf("\n");
 	printf("Misc options:\n");
 	printf(" -T --test-input <file>     | Read commands from <file>.\n");
 	printf(" -d --debug                 | Increase logging verbosity.\n");
 			case 5002: parse_cmd1(argc, argv, CMD_PROCESSING_UNIT_LOCKS, true); break; // --pu-lock
 			case 5003: parse_cmd1(argc, argv, CMD_PROCESSING_UNIT_LOCKS, false); break; // --pu-unlock
 			case 5004: parse_cmd2s(argc, argv, CMD_PROCESSING_UNIT_ROUTING); break; // --pu-clear
+			case 6001: parse_cmd2(argc, argv, CMD_FRAME_LABELS); break; // --fr-name
+			case 6002: parse_cmd2(argc, argv, CMD_FRAME_BUFFER_ROUTING); break; // --fr-input
+			case 6003: parse_cmd1(argc, argv, CMD_FRAME_BUFFER_LOCKS, true); break; // --fr-lock
+			case 6004: parse_cmd1(argc, argv, CMD_FRAME_BUFFER_LOCKS, false); break; // --fr-unlock
+			case 6005: parse_cmd2s(argc, argv, CMD_FRAME_BUFFER_ROUTING); break; // --fr-clear
 			case 'H': // --help
 				show_help(data);
 				exit(EXIT_SUCCESS);
 	print_device_monitoring_outputs(d);
 	print_device_serial_ports(d);
 	print_device_processing_units(d);
+	print_device_frame_buffers(d);
 	fflush(stdout);
 }
 
 
 	reset_routed_to(&data->serial);
 	reset_routed_to(&data->proc_units);
+	reset_routed_to(&data->frames);
 	read_device_command_stream(data);
 
 	if (test_data)
 	check_number_of_ports(&data->mon_outputs);
 	check_number_of_ports(&data->serial);
 	check_number_of_ports(&data->proc_units);
+	check_number_of_ports(&data->frames);
 
 	if (num_parsed_cmds) {
 		unsigned int i;
 		if (show_list & action_list_moutputs)	print_device_monitoring_outputs(data);
 		if (show_list & action_list_serial)		print_device_serial_ports(data);
 		if (show_list & action_list_proc_units)	print_device_processing_units(data);
+		if (show_list & action_list_frames)		print_device_frame_buffers(data);
 		fflush(stdout);
 	} else if (show_backup) {
 		print_device_backup(data);