Add support for setting device friendly name using --set-name

My Videohub Micro doesn't support this extra but I suppose the
bigger models do (at least the official software v6 reads this
value and shows it instead of the device model).

ChangeLog

@@ -1,6 +1,7 @@
 |-----------------------------------------------------------------------|
 xxxx-xx-xx : Version -next
  * Add support for --list-proc-units and --list-frames.
+ * Add support for setting device friendly name using --set-name option.
 
 2014-12-03 : Version 1.0
  * Add missing documentation for --list-moutputs parameter.

README

@@ -59,6 +59,8 @@ Commands:
  --list-proc-units          | List device processing units.
  --list-frames              | List device frame buffers.
 
+ --set-name <name>          | Set the device "friendly name".
+
 Video inputs configuration:
  --vi-name <in_X> <name>    | Set video input port X name.
 

cmd.c

@@ -382,6 +382,9 @@ void prepare_cmd_entry(struct videohub_data *d, struct vcmd_entry *e) {
 	struct port_set *s_port = !e->cmd->ports1 ? NULL : (void *)d + e->cmd->ports1;
 	struct port_set *d_port = !e->cmd->ports2 ? NULL : (void *)d + e->cmd->ports2;
 
+	if (e->cmd->type == PARSE_CUSTOM)
+		return;
+
 	// All command types needs parsing of the "source port"
 	e->port_no1 = my_atoi(e->param1);
 	if (e->port_no1 == 0 || e->port_no1 > s_port->num) {
@@ -430,6 +433,11 @@ static char *dir2txt(enum serial_dir dir) {
 }
 
 void format_cmd_text(struct vcmd_entry *e, char *buf, unsigned int bufsz) {
+	if (e->cmd->cmd == CMD_VIDEOHUB_DEVICE) {
+		snprintf(buf, bufsz, "%s:\n%s: %s\n\n", videohub_commands_text[e->cmd->cmd],
+			e->param1, e->param2);
+		return;
+	}
 	switch (e->cmd->type) {
 	case PARSE_LABEL:
 		snprintf(buf, bufsz, "%s:\n%u %s\n\n", videohub_commands_text[e->cmd->cmd],
@@ -455,6 +463,14 @@ void show_cmd(struct videohub_data *d, struct vcmd_entry *e) {
 	struct port_set *s_port = !e->cmd->ports1 ? NULL : (void *)d + e->cmd->ports1;
 	struct port_set *d_port = !e->cmd->ports2 ? NULL : (void *)d + e->cmd->ports2;
 	const char *prefix = "videohub: ";
+	if (e->cmd->cmd == CMD_VIDEOHUB_DEVICE) {
+		printf("%sset device \"%s\" to \"%s\"\n",
+			prefix,
+			e->param1,
+			e->param2
+		);
+		return;
+	}
 	switch (e->cmd->type) {
 	case PARSE_LABEL:
 		printf("%srename %s %d \"%s\" to \"%s\"\n",

display.c

@@ -260,6 +260,9 @@ static void __print_opt(struct videohub_data *d, enum vcmd vcmd) {
 void print_device_backup(struct videohub_data *d) {
 	unsigned int i;
 	printf("videohubctrl \\\n");
+	if (d->device.friendly_name[0]) {
+		printf("  --set-name \"%s\" \\\n", d->device.friendly_name);
+	}
 	for (i = 0; i < NUM_COMMANDS; i++) {
 		if (videohub_commands[i].type == PARSE_LABEL)
 			__print_opt(d, videohub_commands[i].cmd);

test/input-00.txt

@@ -4,6 +4,7 @@ Version: 2.4
 VIDEOHUB DEVICE:
 Device present: true
 Model name: Blackmagic Micro Videohub
+Friendly name: My Videohub
 Unique ID: 7c2e0d021714
 Video inputs: 16
 Video processing units: 4

test/run

@@ -32,6 +32,7 @@ check test/test-02 "Test --backup option output"
 check test/test-03 "Test --backup restore"
 
 videohubctrl --test-input test/input-00.txt \
+	--set-name "Test name" \
 	--vi-name "Windows 4 HD" "Windows 4 HighDef" \
 	--vi-name 5 "In 5" \
 	--vi-name "Input 6" "Camera 6" \
@@ -111,7 +112,8 @@ check test/test-05 "Test if --backup restored correct config."
 ./videohubctrl --test-input test/input-00.txt --se-unlock "Serial 18"                $@ >> test/test-06.out 2>&1
 ./videohubctrl --test-input test/input-00.txt --se-dir 1 err-dir                     $@ >> test/test-06.out 2>&1
 ./videohubctrl --test-input test/input-00.txt --se-dir "Serial 5" err-dir            $@ >> test/test-06.out 2>&1
-check test/test-06 "Test errors on commands with invalid ports."
+./videohubctrl --test-input test/input-00.txt --set-name                             $@ >> test/test-06.out 2>&1
+check test/test-06 "Test errors on commands with invalid parameters."
 
 videohubctrl --test-input test/input-00.txt --list-device $@ &> test/test-07.out
 check test/test-07 "Test --list-device option output"

test/test-01.ok

@@ -3,6 +3,7 @@ Device info
   | Device address             | sdi-matrix                         |
   | Device port                | 9990                               |
   | Model name                 | Blackmagic Micro Videohub          |
+  | Friendly name              | My Videohub                        |
   | Unique ID                  | 7c2e0d021714                       |
   | Protocol                   | 2.4                                |
   | Video inputs               | 16                                 |

test/test-02.ok

@@ -1,4 +1,5 @@
 videohubctrl \
+  --set-name "My Videohub" \
   --vi-name   1 "Windows 1" \
   --vi-name   2 "Windows 2" \
   --vi-name   3 "Windows 3" \

test/test-03.ok

@@ -1,3 +1,4 @@
+videohub: set device "Friendly name" to "My Videohub"
 videohub: rename video input 1 "" to "Windows 1"
 videohub: rename video input 2 "" to "Windows 2"
 videohub: rename video input 3 "" to "Windows 3"
@@ -147,6 +148,7 @@ Device info
   | Device address             | sdi-matrix                         |
   | Device port                | 9990                               |
   | Model name                 | Blackmagic Micro Videohub          |
+  | Friendly name              | My Videohub                        |
   | Unique ID                  | 7c2e0d021714                       |
   | Protocol                   | 2.4                                |
   | Video inputs               | 16                                 |

test/test-04.ok

@@ -1,3 +1,4 @@
+videohub: set device "Friendly name" to "Test name"
 videohub: rename video input 4 "Windows 4 HD" to "Windows 4 HighDef"
 videohub: rename video input 5 "Input 5" to "In 5"
 videohub: rename video input 6 "Input 6" to "Camera 6"
@@ -51,6 +52,7 @@ Device info
   | Device address             | sdi-matrix                         |
   | Device port                | 9990                               |
   | Model name                 | Blackmagic Micro Videohub          |
+  | Friendly name              | Test name                          |
   | Unique ID                  | 7c2e0d021714                       |
   | Protocol                   | 2.4                                |
   | Video inputs               | 16                                 |

test/test-05.ok

@@ -3,6 +3,7 @@ Device info
   | Device address             | sdi-matrix                         |
   | Device port                | 9990                               |
   | Model name                 | Blackmagic Micro Videohub          |
+  | Friendly name              | My Videohub                        |
   | Unique ID                  | 7c2e0d021714                       |
   | Protocol                   | 2.4                                |
   | Video inputs               | 16                                 |

test/test-06.ok

@@ -33,3 +33,4 @@ ERROR: Unknown serial port number/name: 18
 ERROR: Unknown serial port number/name: Serial 18
 ERROR: Invalid serial port direction 'err-dir'. Allowed are: in, out, auto.
 ERROR: Invalid serial port direction 'err-dir'. Allowed are: in, out, auto.
+./videohubctrl: option '--set-name' requires an argument

test/test-07.ok

@@ -3,6 +3,7 @@ Device info
   | Device address             | sdi-matrix                         |
   | Device port                | 9990                               |
   | Model name                 | Blackmagic Micro Videohub          |
+  | Friendly name              | My Videohub                        |
   | Unique ID                  | 7c2e0d021714                       |
   | Protocol                   | 2.4                                |
   | Video inputs               | 16                                 |

videohubctrl.1

@@ -92,6 +92,10 @@ video inputs.
 .TP
 \fB\-\-list\-frames\fR
 Display stored frame buffers.
+.TP
+\fB\-\-set\-name\fR <name>
+Set the device "friendly name". This name can be used as a device identifier.
+Only some Videohub models support this functionality.
 .SH CONFIGURATION COMMANDS
 .PP
 Everywhere where port needs to be set, you can use the port number or the

videohubctrl.c

@@ -69,6 +69,7 @@ static const struct option long_options[] = {
 	{ "list-serial",		no_argument,       NULL, 905 },
 	{ "list-proc-units",	no_argument,       NULL, 906 },
 	{ "list-frames",		no_argument,       NULL, 907 },
+	{ "set-name",			required_argument, NULL, 950 },
 	{ "vi-name",			required_argument, NULL, 1001 },
 	{ "vo-name",			required_argument, NULL, 2001 },
 	{ "vo-input",			required_argument, NULL, 2002 },
@@ -130,6 +131,8 @@ static void show_help(struct videohub_data *data) {
 	printf(" --list-proc-units          | List device processing units.\n");
 	printf(" --list-frames              | List device frame buffers.\n");
 	printf("\n");
+	printf(" --set-name <name>          | Set the device \"friendly name\".\n");
+	printf("\n");
 	printf("Video inputs configuration:\n");
 	printf(" --vi-name <in_X> <name>    | Set video input port X name.\n");
 	printf("\n");
@@ -224,6 +227,15 @@ static void parse_cmd1(int argc, char **argv, enum vcmd vcmd, bool do_lock) {
 	num_parsed_cmds++;
 }
 
+static void set_device_option(char *setting, char *value) {
+	check_num_parsed_cmds();
+	struct vcmd_entry *c = &parsed_cmds.entry[num_parsed_cmds];
+	c->cmd = &videohub_commands[CMD_VIDEOHUB_DEVICE];
+	c->param1 = setting;
+	c->param2 = value;
+	num_parsed_cmds++;
+}
+
 static void parse_options(struct videohub_data *data, int argc, char **argv) {
 	int j, err = 0;
 	// Check environment
@@ -281,6 +293,7 @@ static void parse_options(struct videohub_data *data, int argc, char **argv) {
 			case 905: show_list |= action_list_serial; break; // --list-serial
 			case 906: show_list |= action_list_proc_units; break; // --list-proc-units
 			case 907: show_list |= action_list_frames; break; // --list-frames
+			case 950: set_device_option("Friendly name", optarg); break; // --set-name
 			case 1001: parse_cmd2(argc, argv, CMD_INPUT_LABELS); break; // --vi-name
 			case 2001: parse_cmd2(argc, argv, CMD_OUTPUT_LABELS); break; // --vo-name
 			case 2002: parse_cmd2(argc, argv, CMD_VIDEO_OUTPUT_ROUTING); break; // --vo-input