/* * === Commands processing === * * 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 #include #include #include #include "data.h" #include "cmd.h" #include "util.h" const char *videohub_commands_text[NUM_COMMANDS] = { [CMD_PROTOCOL_PREAMBLE] = "PROTOCOL PREAMBLE", [CMD_VIDEOHUB_DEVICE] = "VIDEOHUB DEVICE", [CMD_INPUT_LABELS] = "INPUT LABELS", [CMD_OUTPUT_LABELS] = "OUTPUT LABELS", [CMD_VIDEO_OUTPUT_LOCKS] = "VIDEO OUTPUT LOCKS", [CMD_VIDEO_OUTPUT_ROUTING] = "VIDEO OUTPUT ROUTING", [CMD_VIDEO_INPUT_STATUS] = "VIDEO INPUT STATUS", [CMD_VIDEO_OUTPUT_STATUS] = "VIDEO OUTPUT STATUS", [CMD_MONITORING_OUTPUT_LABELS] = "MONITORING OUTPUT LABELS", [CMD_MONITORING_OUTPUT_LOCKS] = "MONITORING OUTPUT LOCKS", [CMD_MONITORING_OUTPUT_ROUTING] = "VIDEO MONITORING OUTPUT ROUTING", [CMD_PING] = "PING", [CMD_ACK] = "ACK", [CMD_NAK] = "NAK", }; #define OFS(X) offsetof(struct videohub_data, X) struct videohub_commands videohub_commands[NUM_COMMANDS] = { [CMD_PROTOCOL_PREAMBLE] = { .cmd = CMD_PROTOCOL_PREAMBLE , .type = PARSE_CUSTOM }, [CMD_VIDEOHUB_DEVICE] = { .cmd = CMD_VIDEOHUB_DEVICE , .type = PARSE_CUSTOM }, [CMD_INPUT_LABELS] = { .cmd = CMD_INPUT_LABELS , .type = PARSE_LABEL, .ports1 = OFS(inputs), .port_id1 = "video input", .opt_prefix = "vi", }, [CMD_OUTPUT_LABELS] = { .cmd = CMD_OUTPUT_LABELS , .type = PARSE_LABEL, .ports1 = OFS(outputs), .port_id1 = "video output", .opt_prefix = "vo", }, [CMD_VIDEO_OUTPUT_LOCKS] = { .cmd = CMD_VIDEO_OUTPUT_LOCKS , .type = PARSE_LOCK, .ports1 = OFS(outputs), .port_id1 = "video output", .opt_prefix = "vo", }, [CMD_VIDEO_OUTPUT_ROUTING] = { .cmd = CMD_VIDEO_OUTPUT_ROUTING, .type = PARSE_ROUTE, .ports1 = OFS(outputs), .ports2 = OFS(inputs), .port_id1 = "video output", .port_id2 = "video input", .opt_prefix = "vo", }, [CMD_VIDEO_INPUT_STATUS] = { .cmd = CMD_VIDEO_INPUT_STATUS , .type = PARSE_STATUS, .ports1 = OFS(inputs), .port_id1 = "video input", .opt_prefix = "vi", }, [CMD_VIDEO_OUTPUT_STATUS] = { .cmd = CMD_VIDEO_OUTPUT_STATUS , .type = PARSE_STATUS, .ports1 = OFS(outputs), .port_id1 = "video output", .opt_prefix = "vo", }, [CMD_MONITORING_OUTPUT_LABELS] = { .cmd = CMD_MONITORING_OUTPUT_LABELS , .type = PARSE_LABEL, .ports1 = OFS(mon_outputs), .port_id1 = "monitoring output", .opt_prefix = "mo", }, [CMD_MONITORING_OUTPUT_LOCKS] = { .cmd = CMD_MONITORING_OUTPUT_LOCKS , .type = PARSE_LOCK, .ports1 = OFS(mon_outputs), .port_id1 = "monitoring output", .opt_prefix = "mo", }, [CMD_MONITORING_OUTPUT_ROUTING] = { .cmd = CMD_MONITORING_OUTPUT_ROUTING, .type = PARSE_ROUTE, .ports1 = OFS(mon_outputs), .ports2 = OFS(inputs), .port_id1 = "monitoring output", .port_id2 = "video input", .opt_prefix = "mo", }, [CMD_PING] = { .cmd = CMD_PING , .type = PARSE_NONE }, [CMD_ACK] = { .cmd = CMD_ACK , .type = PARSE_NONE }, [CMD_NAK] = { .cmd = CMD_NAK , .type = PARSE_NONE }, }; static char *parse_text(char *line, char *cmd) { char *parsed_text = strstr(line, cmd); if (parsed_text == line) { return parsed_text + strlen(cmd); } return NULL; } bool parse_command(struct videohub_data *d, char *cmd) { unsigned int i; bool ret = true; if (!strlen(cmd)) return false; struct videohub_commands *v = NULL; const char *cmd_txt = NULL; for (i = 0; i < NUM_COMMANDS; i++) { const char *cmd_text = videohub_commands_text[i]; if (strstr(cmd, cmd_text) == cmd) { v = &videohub_commands[i]; cmd_txt = videohub_commands_text[i]; break; } } if (!v) { q("WARNING: Videohub sent unknown command!\n"); q(" Please report this command to author's email: georgi@unixsol.org\n"); q(" You may use -q or --quiet to suppress the message.\n"); q("---------8<-----------8<----------- cut here ---------8<------------8<---------\n"); q("%s\n", cmd); q("---------8<-----------8<----------- cut here ---------8<------------8<---------\n"); return false; } d("debug: Got '%s' command.\n", cmd_txt); if (debug > 1) d("----\n%s\n----\n", cmd); struct port_set *s_port = !v->ports1 ? NULL : (void *)d + v->ports1; struct port_set *d_port = !v->ports2 ? NULL : (void *)d + v->ports2; char *p, *cmd_data = xstrdup( cmd + strlen(cmd_txt) + 2 ); // +2 to compensate for :\n at the end of the command // Split line by line char *line, *saveptr = NULL; for(i = 0, line = strtok_r(cmd_data, "\n", &saveptr); line; line = strtok_r(NULL, "\n", &saveptr), i++) { // Parse command data response unsigned int port_num = 0; unsigned int dest_port_num = 0; char *port_data = NULL; if (v->type != PARSE_NONE && v->type != PARSE_CUSTOM) { port_data = strchr(line, ' '); if (!port_data) continue; port_data[0] = '\0'; // Separate port_num from port_data port_data++; port_num = strtoul(line, NULL, 10); if (port_num + 1 > s_port->num) { q("WARNING: %s: invalid %s port %u (valid 0..%u)\n", cmd_txt, v->port_id1, port_num, s_port->num - 1); continue; } } switch (v->type) { case PARSE_LABEL: snprintf(s_port->port[port_num].name, sizeof(s_port->port[port_num].name), "%s", port_data); break; case PARSE_STATUS: snprintf(s_port->port[port_num].status, sizeof(s_port->port[port_num].status), "%s", port_data); break; case PARSE_ROUTE: dest_port_num = strtoul(port_data, NULL, 10); if (dest_port_num + 1 > d_port->num) { q("WARNING: %s: invalid %s port %u (valid 0..%u)\n", cmd_txt, v->port_id2, dest_port_num, d_port->num - 1); continue; } s_port->port[port_num].routed_to = dest_port_num; break; case PARSE_LOCK: switch (port_data[0]) { case 'O': s_port->port[port_num].lock = PORT_LOCKED; break; case 'L': s_port->port[port_num].lock = PORT_LOCKED_OTHER; break; default : s_port->port[port_num].lock = PORT_UNLOCKED; break; } break; default: break; } // Parse custom commands switch (v->cmd) { case CMD_PROTOCOL_PREAMBLE: if ((p = parse_text(line, "Version: "))) snprintf(d->device.protocol_ver, sizeof(d->device.protocol_ver), "%s", p); break; case CMD_VIDEOHUB_DEVICE: if ((p = parse_text(line, "Device present: "))) { d->device.dev_present = streq(p, "true"); d->device.needs_fw_update = streq(p, "needs_update"); } if ((p = parse_text(line, "Model name: "))) snprintf(d->device.model_name, sizeof(d->device.model_name), "%s", p); if ((p = parse_text(line, "Unique ID: "))) snprintf(d->device.unique_id, sizeof(d->device.unique_id) , "%s", p); if ((p = parse_text(line, "Video inputs: "))) d->inputs.num = strtoul(p, NULL, 10); if ((p = parse_text(line, "Video processing units: "))) d->device.num_video_processing_units = strtoul(p, NULL, 10); if ((p = parse_text(line, "Video outputs: "))) d->outputs.num = strtoul(p, NULL, 10); if ((p = parse_text(line, "Video monitoring outputs: "))) d->mon_outputs.num = strtoul(p, NULL, 10); if ((p = parse_text(line, "Serial ports: "))) d->device.num_serial_ports = strtoul(p, NULL, 10); break; case CMD_NAK: ret = false; break; default: break; } } free(cmd_data); return ret; } int parse_text_buffer(struct videohub_data *d, char *cmd_buffer) { // The buffer contains only one command, no splitting is needed if (!strstr(cmd_buffer, "\n\n")) return parse_command(d, cmd_buffer); // Split commands and parse them one by one int ok_commands = 0; char *buf_copy = xstrdup(cmd_buffer); char *newcmd, *cmd = buf_copy; while(1) { newcmd = strstr(cmd, "\n\n"); // Find next command if (!newcmd) { if (parse_command(d, cmd)) // Parse current command ok_commands++; break; } newcmd[0] = '\0'; // Terminate previous command if (parse_command(d, cmd)) // Parse previous command ok_commands++; cmd = newcmd + 2; // Advance cmd to the next command } free(buf_copy); return ok_commands; } // Try to find port with certain name, return 0 on not found, pos + 1 is found static int get_port_by_name(struct port_set *p, char *name) { unsigned int i; for(i = 0; i < p->num; i++) { if (streq(name, p->port[i].name)) { return i + 1; } } return 0; } // Return 0 on error, number otherwise if it can parse the whole input static unsigned int my_atoi(char *txt) { char *endptr = NULL; if (!txt) return 0; unsigned int ret = strtoul(txt, &endptr, 10); if (endptr == txt || *endptr) return 0; return ret; } 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; // 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) { e->port_no1 = get_port_by_name(s_port, e->param1); if (!e->port_no1) die("Unknown %s port number/name: %s", e->cmd->port_id1, e->param1); } // ROUTE type needs parsing of the "destination port" if (e->cmd->type == PARSE_ROUTE) { e->port_no2 = my_atoi(e->param2); if (e->port_no2 == 0 || e->port_no2 > d_port->num) { e->port_no2 = get_port_by_name(d_port, e->param2); if (!e->port_no2) die("Unknown %s port number/name: %s", e->cmd->port_id2, e->param2); } } if (e->cmd->type == PARSE_LOCK) { e->lock = s_port->port[e->port_no1 - 1].lock; } } void format_cmd_text(struct vcmd_entry *e, char *buf, unsigned int bufsz) { switch (e->cmd->type) { case PARSE_LABEL: snprintf(buf, bufsz, "%s:\n%u %s\n\n", videohub_commands_text[e->cmd->cmd], e->port_no1 - 1, e->param2); break; case PARSE_LOCK: snprintf(buf, bufsz, "%s:\n%u %s\n\n", videohub_commands_text[e->cmd->cmd], e->port_no1 - 1, e->do_lock ? "O" : (e->lock == PORT_LOCKED_OTHER ? "F" : "U")); break; case PARSE_ROUTE: snprintf(buf, bufsz, "%s:\n%u %u\n\n", videohub_commands_text[e->cmd->cmd], e->port_no1 - 1, e->port_no2 - 1); break; default: break; } } 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: "; switch (e->cmd->type) { case PARSE_LABEL: printf("%srename %s %d \"%s\" to \"%s\"\n", prefix, e->cmd->port_id1, e->port_no1, s_port->port[e->port_no1 - 1].name, e->param2 ); break; case PARSE_LOCK: printf("%s%s %s %d \"%s\"\n", prefix, e->do_lock ? "lock" : (e->lock == PORT_LOCKED_OTHER ? "force unlock" : "unlock"), e->cmd->port_id1, e->port_no1, s_port->port[e->port_no1 - 1].name ); break; case PARSE_ROUTE: printf("%sset %s %d \"%s\" to read from %s %d \"%s\"\n", prefix, e->cmd->port_id1, e->port_no1, s_port->port[e->port_no1 - 1].name, e->cmd->port_id2, e->port_no2, d_port->port [e->port_no2 - 1].name ); break; default: break; } }