Add --list-{device,vinputs,voutputs} parameters and change output formating.

ChangeLog

@@ -6,6 +6,7 @@ xxxx-xx-xx : Version next
  * Change output formatting to better show port locks and numbers.
  * Add support for setting video input/output names, video output locking
    and video output routing.
+ * Add --list-device, --list-vinputs and --list-voutputs parameters.
 
 2014-11-27 : Version 0.2
  * Fix port routing. Previously it was reversed and incorrect.

Makefile

@@ -31,6 +31,7 @@ videohubctrl_SRC = \
 	cmd.c \
 	net.c \
 	util.c \
+	display.c \
 	videohubctrl.c
 videohubctrl_LIBS = -lpthread
 videohubctrl_OBJS = $(FUNCS_LIB) $(videohubctrl_SRC:.c=.o)

README

@@ -115,49 +115,73 @@ Here is how videohubctrl output looks like:
 
 |----------------------------------------------------------------------|
 gf@gf:~/git/videohubctrl$ ./videohubctrl --host sdi-matrix
-Protocol version: 2.4
-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
+Device info
+  -----------------------------------------------------------
+  | Device address             | sdi-matrix                 |
+  | Device port                | 9990                       |
+  | Model name                 | Blackmagic Micro Videohub  |
+  | Unique ID                  | 7c2e0d021714               |
+  | Protocol                   | 2.4                        |
+  | Video inputs               | 16                         |
+  | Video outputs              | 16                         |
+  -----------------------------------------------------------
 
------------------------------------------------------------------------
-| i# | Input name                | o# | x | Output name               |
------------------------------------------------------------------------
-|  1 | Windows 3                 |  1 | L | Enc1 1                    |
-|  2 | Windows 2                 |  2 | L | Enc1 2                    |
-|  3 | Windows 1                 |  3 | L | Enc1 3                    |
-|  4 | Windows 1                 |  4 | L | Enc1 4                    |
-|  5 | Input 5                   |  5 |   | Output 5                  |
-|  6 | Input 6                   |  6 |   | Output 6                  |
-|  7 | Input 7                   |  7 |   | Output 7                  |
-|  8 | Input 8                   |  8 |   | Output 8                  |
-|  9 | Windows 4 HD              |  9 | L | Enc2 1                    |
-| 10 | Input 10                  | 10 |   | Output 10                 |
-| 11 | Input 11                  | 11 |   | Output 11                 |
-| 12 | DPlay2                    | 12 | L | Denc                      |
-| 13 | DPlay1                    | 13 | O | Output 13                 |
-| 14 | Input 14                  | 14 |   | Output 14                 |
-| 15 | Input 15                  | 15 |   | Output 15                 |
-| 16 | Loopback                  | 16 |   | Loopback                  |
------------------------------------------------------------------------
+Video inputs
+  ---------------------------------
+  | ## | Video input name         |
+  ---------------------------------
+  |  1 | Windows 1                |
+  |  2 | Windows 2                |
+  |  3 | Windows 3                |
+  |  4 | Windows 4 HD             |
+  |  5 | Input 5                  |
+  |  6 | Input 6                  |
+  |  7 | Input 7                  |
+  |  8 | Input 8                  |
+  |  9 | Input 9                  |
+  | 10 | Input 10                 |
+  | 11 | Input 11                 |
+  | 12 | DPlay1                   |
+  | 13 | DPlay2                   |
+  | 14 | Input 14                 |
+  | 15 | Input 15                 |
+  | 16 | Loopback                 |
+  ---------------------------------
+
+Video outputs
+  ----------------------------------------------------------------
+  | ## | x | Video output name        | Connected video input    |
+  ----------------------------------------------------------------
+  |  1 | L | Enc1 1                   | Windows 3                |
+  |  2 | L | Enc1 2                   | Windows 2                |
+  |  3 | L | Enc1 3                   | Windows 1                |
+  |  4 | L | Enc1 4                   | Windows 1                |
+  |  5 |   | Output 5                 | Input 5                  |
+  |  6 |   | Output 6                 | Input 6                  |
+  |  7 |   | Output 7                 | Input 7                  |
+  |  8 |   | Output 8                 | Input 8                  |
+  |  9 | L | Enc2 1                   | Windows 4 HD             |
+  | 10 |   | Output 10                | Input 10                 |
+  | 11 |   | Output 11                | Input 11                 |
+  | 12 | L | Denc                     | DPlay2                   |
+  | 13 | O | Output 13                | DPlay1                   |
+  | 14 |   | Output 14                | Input 14                 |
+  | 15 |   | Output 15                | Input 15                 |
+  | 16 | O | Loopback                 | Loopback                 |
+  ----------------------------------------------------------------
 
 gf@gf:~/git/videohubctrl$
 |----------------------------------------------------------------------|
 
-Output Legend
-=============
+Video outputs Legend
+====================
 
- Column 1 (i#) - Input port number
- Column 2 (..) - Input port names
- Column 3 (o#) - Output port number
- Column 4 (x)  - Output port lock status
+ Column 1 (##) - Input port number
+ Column 2 (x)  - Output port lock status
                   L - The port is locked by another IP address (user)
                   O - The port is locked by me (from my IP address)
- Column 5      - Output port names
+ Column 3      - Output port names
+ Column 4      - Which input port is routed to this output
 
 
 Reporting bugs

display.c

@@ -0,0 +1,79 @@
+/*
+ * === Display functions ===
+ *
+ * Blackmagic Design Videohub control application
+ * Copyright (C) 2014 Unix Solutions Ltd.
+ * Written by Georgi Chorbadzhiyski
+ *
+ * Released under MIT license.
+ * See LICENSE-MIT.txt for license terms.
+ *
+ */
+
+#include <stdio.h>
+
+#include "data.h"
+#include "display.h"
+
+static void printf_line(int len) {
+	int i;
+	printf("  ");
+	for (i = 0; i < len; i++)
+		printf("-");
+	printf("\n");
+}
+
+void print_device_info(struct videohub_data *d) {
+	int len = 59;
+	printf("Device info\n");
+	printf_line(len);
+	printf("  | %-26s | %-26s |\n", "Device address", d->dev_host);
+	printf("  | %-26s | %-26s |\n", "Device port", d->dev_port);
+	printf("  | %-26s | %-26s |\n", "Model name", d->device.model_name);
+	printf("  | %-26s | %-26s |\n", "Unique ID", d->device.unique_id);
+	printf("  | %-26s | %-26s |\n", "Protocol", d->device.protocol_ver);
+	printf("  | %-26s | %-26u |\n", "Video inputs", d->device.num_video_inputs);
+	printf("  | %-26s | %-26u |\n", "Video outputs", d->device.num_video_outputs);
+	if (d->device.num_serial_ports)
+		printf("  | %-26s | %-26u |\n", "Serial ports", d->device.num_serial_ports);
+	if (d->device.num_video_processing_units)
+		printf("  | %-26s | %-26u |\n", "Video processing units", d->device.num_video_processing_units);
+	if (d->device.num_video_monitoring_outputs)
+		printf("  | %-26s | %-26u |\n", "Video monitoring outputs", d->device.num_video_monitoring_outputs);
+	printf_line(len);
+	printf("\n");
+}
+
+void print_device_video_inputs(struct videohub_data *d) {
+	unsigned int i, len = 33;
+	printf("Video inputs\n");
+	printf_line(len);
+	printf("  | ## | %-24s |\n", "Video input name");
+	printf_line(len);
+	for(i = 0; i < d->device.num_video_inputs; i++) {
+		printf("  | %2d | %-24s |\n",
+			i + 1,
+			d->inputs[i].name
+		);
+	}
+	printf_line(len);
+	printf("\n");
+}
+
+void print_device_video_outputs(struct videohub_data *d) {
+	unsigned int i, len = 64;
+	printf("Video outputs\n");
+	printf_line(len);
+	printf("  | ## | x | %-24s | %-24s |\n", "Video output name", "Connected video input");
+	printf_line(len);
+	for(i = 0; i < MIN(d->device.num_video_outputs, ARRAY_SIZE(d->outputs)); i++) {
+		printf("  | %2d | %c | %-24s | %-24s |\n",
+			i + 1,
+			d->outputs[i].locked ? (d->outputs[i].locked_other ? 'L' : 'O') : ' ',
+			d->outputs[i].name,
+			d->inputs[d->outputs[i].routed_to].name
+		);
+	}
+	printf_line(len);
+	printf("\n");
+}

display.h

@@ -0,0 +1,20 @@
+/*
+ * === Display functions ===
+ *
+ * Blackmagic Design Videohub control application
+ * Copyright (C) 2014 Unix Solutions Ltd.
+ * Written by Georgi Chorbadzhiyski
+ *
+ * Released under MIT license.
+ * See LICENSE-MIT.txt for license terms.
+ *
+ */
+
+#ifndef DISPLAY_H
+#define DISPLAY_H
+
+void print_device_info(struct videohub_data *d);
+void print_device_video_inputs(struct videohub_data *d);
+void print_device_video_outputs(struct videohub_data *d);
+
+#endif

videohubctrl.c

@@ -18,6 +18,7 @@
 #include "cmd.h"
 #include "net.h"
 #include "util.h"
+#include "display.h"
 #include "version.h"
 
 #include "libfuncs/libfuncs.h"
@@ -28,6 +29,13 @@ int quiet;
 static struct videohub_data maindata;
 static int show_info = 1;
 static int show_monitor = 0;
+static int show_list = 0;
+
+enum list_actions {
+	action_list_device		= (1 << 0),
+	action_list_vinputs		= (1 << 1),
+	action_list_voutputs	= (1 << 2),
+};
 
 static const char *program_id = PROGRAM_NAME " Version: " VERSION " Git: " GIT_VER;
 
@@ -42,6 +50,9 @@ static const struct option long_options[] = {
 	{ "version",			no_argument,       NULL, 'V' },
 	{ "info",				no_argument,       NULL, 'i' },
 	{ "monitor",			no_argument,       NULL, 'm' },
+	{ "list-device",		no_argument,       NULL, 901 },
+	{ "list-vinputs",		no_argument,       NULL, 902 },
+	{ "list-voutputs",		no_argument,       NULL, 903 },
 	{ "vi-name",			required_argument, NULL, 1001 },
 	{ "vo-name",			required_argument, NULL, 1002 },
 	{ "vo-route",			required_argument, NULL, 1011 },
@@ -66,8 +77,14 @@ static void show_help(struct videohub_data *data) {
 	printf(" -V --version               | Show program version.\n");
 	printf("\n");
 	printf("Commands:\n");
-	printf(" -i --info                  | Show device info (default command).\n");
-	printf(" -m --monitor               | Show real time monitor for config changes.\n");
+	printf(" -i --info                  | Show full device info (default command).\n");
+	printf("                            . This command is shows the equivallent of\n");
+	printf("                            .  running all --list-XXX commands.\n");
+	printf(" -m --monitor               | Display real-time config changes monitor.\n");
+	printf("\n");
+	printf(" --list-device              | Display device info.\n");
+	printf(" --list-vinputs             | List device video inputs.\n");
+	printf(" --list-voutputs            | List device video outputs.\n");
 	printf("\n");
 	printf("Configuration:\n");
 	printf(" --vi-name <in_X> <name>    | Set input <name> to input port X.\n");
@@ -116,6 +133,9 @@ static void parse_options(struct videohub_data *data, int argc, char **argv) {
 			case 'm': // --monitor
 				show_monitor = 1;
 				break;
+			case 901: show_list |= action_list_device; break; // --list-device
+			case 902: show_list |= action_list_vinputs; break; // --list-vinputs
+			case 903: show_list |= action_list_voutputs; break; // --list-voutputs
 			case 1001: // --vi-name
 			case 1002: // --vo-name
 			case 1011: // --vi-route
@@ -168,43 +188,6 @@ static void parse_options(struct videohub_data *data, int argc, char **argv) {
 	d("Device address: %s:%s\n", data->dev_host, data->dev_port);
 }
 
-static void print_device_desc(struct device_desc *d) {
-	printf("\n");
-	printf("Protocol version: %s\n", d->protocol_ver);
-	printf("Model name: %s\n", d->model_name);
-	printf("Unique ID: %s\n", d->unique_id);
-	printf("Video inputs: %u\n", d->num_video_inputs);
-	printf("Video processing units: %u\n", d->num_video_processing_units);
-	printf("Video outputs: %u\n", d->num_video_outputs);
-	printf("Video monitoring outputs: %u\n", d->num_video_monitoring_outputs);
-	printf("Serial ports: %u\n", d->num_serial_ports);
-}
-
-static void printf_line(int len) {
-	int i;
-	for (i = 0; i < len; i++)
-		printf("-");
-	printf("\n");
-}
-
-static void print_device_settings(struct videohub_data *d) {
-	unsigned int i;
-	printf("\n");
-	printf_line(71);
-	printf("| i# | %-25s | o# | x | %-25s |\n", "Input name", "Output name");
-	printf_line(71);
-	for(i = 0; i < MIN(d->device.num_video_outputs, ARRAY_SIZE(d->outputs)); i++) {
-		printf("| %2d | %-25s | %2d | %c | %-25s |\n",
-			i + 1,
-			d->inputs[d->outputs[i].routed_to].name,
-			i + 1,
-			d->outputs[i].locked ? (d->outputs[i].locked_other ? 'L' : 'O') : ' ',
-			d->outputs[i].name
-		);
-	}
-	printf_line(71);
-}
-
 static int read_device_command_stream(struct videohub_data *d) {
 	int ret, ncommands = 0;
 	char buf[8192 + 1];
@@ -277,17 +260,23 @@ int main(int argc, char **argv) {
 	} else if (show_monitor) {
 		while (1) {
 			printf("\e[2J\e[H"); // Clear screen
-			printf("%s\n", program_id);
-			print_device_desc(&data->device);
-			print_device_settings(data);
+			print_device_info(data);
+			print_device_video_inputs(data);
+			print_device_video_outputs(data);
 			fflush(stdout);
 			do {
 				sleep(1);
 			} while (read_device_command_stream(data) == 0);
 		}
+	} else if (show_list) {
+		if (show_list & action_list_device)		print_device_info(data);
+		if (show_list & action_list_vinputs)	print_device_video_inputs(data);
+		if (show_list & action_list_voutputs)	print_device_video_outputs(data);
+		fflush(stdout);
 	} else if (show_info) {
-		print_device_desc(&data->device);
-		print_device_settings(data);
+		print_device_info(data);
+		print_device_video_inputs(data);
+		print_device_video_outputs(data);
 		fflush(stdout);
 	}