videohubctrl can be used to control Blackmagic Design Videohub SDI router device over the network.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

videohubctrl.1 9.1KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294
  1. .TH VIDEOHUBCTRL "1" "December 2014" "videohubctrl 2.0" "User Commands"
  2. .SH NAME
  3. videohubctrl - Blackmagic Design Videohub SDI router control
  4. .SH SYNOPSIS
  5. .B videohubctrl --host <host> \fI..other options..\fR
  6. .SH DESCRIPTION
  7. videohubctrl implements the simple text based network protocol for
  8. controlling Blackmagic Design Videohub SDI router devices. The
  9. program is tested with Blackmagic Design Micro Videohub and
  10. probably works with other Videohub models.
  11. videohubctrl currently displays and can configure:
  12. - Video input port names
  13. - Video output port names, routing and locking
  14. - Input/Output port statuses
  15. - Monitoring video output port names, routing and locking
  16. - Serial ports names, routing, locking and directions
  17. - Processing units
  18. - Frames
  19. .SH MAIN OPTIONS
  20. .PP
  21. .TP
  22. \fB\-h\fR, \fB\-\-host\fR <host>
  23. Set the device host name. It can be an IP address or host name. You
  24. can set \fBVIDEOHUB_HOST\fR environment variable instead of using
  25. this option.
  26. .TP
  27. \fB\-p\fR, \fB\-\-port\fR <port>
  28. Set the device port. You can set \fBVIDEOHUB_PORT\fR environment
  29. variable instead of using this option. The default port is \fB9990\fR.
  30. .TP
  31. \fB\-t\fR, \fB\-\-timeout <seconds>\fR
  32. Set the timeout in seconds for connect and read. The default is 15 seconds,
  33. min vlue is 1 and max value is 60
  34. .SH COMMANDS
  35. .PP
  36. .TP
  37. \fB\-i\fR, \fB\-\-info\fR
  38. Show full device info. This is the default command if none is set.
  39. The command shows the equivalent of running all \-\-list-XXX commands.
  40. .TP
  41. \fB\-m\fR, \fB\-\-monitor\fR
  42. Display the Videohub configuration and updates it in real-time as it
  43. is changed. The monitor shows config changes immediately as they happen.
  44. The device is not being polled, instead the videohub protocol is designed
  45. in such way that every client receives changes on the fly.
  46. .TP
  47. \fB\-b\fR, \fB\-\-backup\fR
  48. Show the command line that will restore the device to it's configuration.
  49. .TP
  50. \fB\-\-list\-device\fR
  51. Display main device info including model, number of ports, etc.
  52. .TP
  53. \fB\-\-list\-vinputs\fR
  54. Display device video inputs. Port numbers, names, how many outputs an
  55. input is being routed to, the list of the outputs and the port status
  56. (type).
  57. The port statuses (type) are reported by Universal Videohub and can be
  58. these:
  59. .nf
  60. - Empty means that the device do not support port status.
  61. x - The port type is "None". This means that the port is not
  62. installed in the device.
  63. B - The port type is "BNC".
  64. o - The port type is "Optical".
  65. T - The port type is "Thunderbolt".
  66. .fi
  67. .TP
  68. \fB\-\-list\-voutputs\fR
  69. Display device video outputs. Port numbers, names, locking status, which
  70. input is routed to a given output and the port status (type).
  71. There are two locking statuses:
  72. .nf
  73. L - The port is locked by another IP address (user)
  74. O - The port is locked by me (from my IP address)
  75. .fi
  76. The port status field (s) have the same format as input ports (described
  77. in \fB\-\-list\-vinputs\fR option).
  78. .TP
  79. \fB\-\-list\-moutputs\fR
  80. Display device monitoring outputs. Port numbers, names, locking status and
  81. which input is routed to a given output. The locking statuses are the
  82. same as video input and output ports.
  83. .TP
  84. \fB\-\-list\-serial\fR
  85. Display device serial ports. Port numbers, names, locking status, directions
  86. and how serial ports are routed. The locking statuses are the same as video
  87. input, output ports and monitoring ports.
  88. .TP
  89. \fB\-\-list\-proc-units\fR
  90. Display device procesing units. Unit numbers, locking status and connected
  91. video inputs.
  92. .TP
  93. \fB\-\-list\-frames\fR
  94. Display stored frame buffers.
  95. .TP
  96. \fB\-\-set\-name\fR <name>
  97. Set the device "friendly name". This name can be used as a device identifier.
  98. Only some Videohub models support this functionality.
  99. .SH CONFIGURATION COMMANDS
  100. .PP
  101. Everywhere where port needs to be set, you can use the port number or the
  102. port name. You can use only port names that were already configured in
  103. previous session. Trying to set a name and then reference it in the next
  104. command will fail. Using port numbers always works.
  105. .SH INPUTS CONFIGURATION
  106. .PP
  107. .TP
  108. \fB\-\-in\-name\fR <in_X> <name>
  109. Set video input port X name.
  110. .TP
  111. \fB\-\-in\-output\fR <in_X> <out_Y>
  112. Set video input X to be outputted via output Y.
  113. .TP
  114. \fB\-\-in\-monitor\fR <in_X> <mout_Y>
  115. Set video input X to be outputted via monitoring port Y.
  116. .SH OUTPUTS CONFIGURATION
  117. .PP
  118. .TP
  119. \fB\-\-out\-name\fR <out_X> <name>
  120. Set video output port X name.
  121. .TP
  122. \fB\-\-out\-input\fR <out_X> <in_Y>
  123. Connect video output X to video input Y.
  124. .TP
  125. \fB\-\-out\-lock\fR <out_X>
  126. Lock output port X.
  127. .TP
  128. \fB\-\-out\-unlock\fR <out_X>
  129. Unlock output port X. If the port is locked by somebody else the
  130. port would be forcefully unlocked.
  131. .SH MONITORING OUTPUTS CONFIGURATION
  132. .PP
  133. .TP
  134. \fB\-\-mon\-name\fR <mout_X> <name>
  135. Set monitoring output port X name.
  136. .TP
  137. \fB\-\-mon\-input\fR <mout_X> <in_Y>
  138. Connect monitoring output X to video input Y.
  139. .TP
  140. \fB\-\-mon\-lock\fR <mout_X>
  141. Lock monitoring output port X.
  142. .TP
  143. \fB\-\-mon\-unlock\fR <mout_X>
  144. Unlock monitoring output port X. If the port is locked by somebody
  145. else the port would be forcefully unlocked.
  146. .SH SERIAL PORTS CONFIGURATION
  147. .PP
  148. .TP
  149. \fB\-\-ser\-name\fR <ser_X> <name>
  150. Set serial port X name.
  151. .TP
  152. \fB\-\-ser\-connect\fR <ser_X> <ser_Y>
  153. Connect serial port X to serial port Y. This option have two aliases \fB\-\-ser\-input\fR
  154. and \fB\-\-ser\-route\fR.
  155. .TP
  156. \fB\-\-ser\-clear\fR <ser_X>
  157. Disconnect serial port X from the connected serial port.
  158. .TP
  159. \fB\-\-ser\-lock\fR <ser_X>
  160. Lock serial port X.
  161. .TP
  162. \fB\-\-ser\-unlock\fR <ser_X>
  163. Unlock serial port X. If the port is locked by somebody else the
  164. port would be forcefully unlocked.
  165. .TP
  166. \fB\-\-ser\-dir\fR <ser_X> <in|out|auto>
  167. Set serial port X direction. There are three possible settings for
  168. each port:
  169. \fBin\fR - input/control/Workstation
  170. \fBout\fR - output/slave/Deck
  171. \fBauto\fR - Automatic in/out
  172. .SH PROCESSING UNITS CONFIGURATION
  173. .PP
  174. .TP
  175. \fB\-\-pu\-input\fR <pu_X> <in_Y>
  176. Connect processing unit X to video input port Y.
  177. .TP
  178. \fB\-\-pu\-clear\fR <pu_X>
  179. Disconnect processing unit X from the connected input port.
  180. .TP
  181. \fB\-\-pu\-lock\fR <pu_X>
  182. Lock processing unit port X.
  183. .TP
  184. \fB\-\-pu\-unlock\fR <pu_X>
  185. Unlock processing unit port X. If the processing unit is locked by somebody
  186. else the port would be forcefully unlocked.
  187. .SH FRAMES CONFIGURATION
  188. .PP
  189. .TP
  190. \fB\-\-fr\-name\fR <fr_X> <name>
  191. Set frame X name.
  192. .TP
  193. \fB\-\-fr\-output\fR <fr_X> <out_Y>
  194. Output frame X to video output port Y.
  195. .TP
  196. \fB\-\-fr\-clear\fR <fr_X>
  197. Disconnect frame X from the connected output port.
  198. .TP
  199. \fB\-\-fr\-lock\fR <fr_X>
  200. Lock frame X.
  201. .TP
  202. \fB\-\-fr\-unlock\fR <fr_X>
  203. Unlock frame X. If the frame is locked by somebody else the port would be
  204. forcefully unlocked.
  205. .SH MISC OPTIONS
  206. .PP
  207. .TP
  208. \fB\-T\fR, \fB\-\-test\fR <file>
  209. Read commands from the <file> instead of connecting to a real
  210. device. This allows testing the program without having access
  211. to a device.
  212. .TP
  213. \fB\-d\fR, \fB\-\-debug\fR
  214. Enable debugging output. Use this option more times to increase
  215. the verbosity.
  216. .TP
  217. \fB\-q\fR, \fB\-\-quiet\fR
  218. Suppress warnings about unsupported commands.
  219. .TP
  220. \fB\-V\fR, \fB\-\-version\fR
  221. Show program name and version.
  222. .TP
  223. \fB\-H\fR, \fB\-\-help\fR
  224. Show program usage text.
  225. .SH ENVIRONMENT VARIABLES
  226. .PP
  227. .TP
  228. \fBVIDEOHUB_HOST\fR
  229. Set the device host name.
  230. .TP
  231. \fBVIDEOHUB_PORT\fR
  232. Set the device port.
  233. .SH EXAMPLES
  234. .PP
  235. To get a quick start here are some example command lines.
  236. .nf
  237. # Rename video output
  238. videohubctrl -h sdi --out-name 8 "Output 8 - test"
  239. videohubctrl -h sdi --out-name "Output 8 - test" "Output 8"
  240. # Rename video input
  241. videohubctrl -h sdi --in-name 4 "Windows 4 HD"
  242. videohubctrl -h sdi --in-name "Windows 4 HD" "CPlay4"
  243. # Lock and then unlock output 16 (unlock assumes that the port is
  244. # named Output 16). The host name is set via env variable.
  245. export VIDEOHUB_HOST=sdi
  246. videohubctrl --out-lock 16
  247. videohubctrl --out-unlock "Output 16"
  248. # Set two outputs to receive from the same input using port names
  249. videohubctrl -h sdi --out-input "Output 8" "Windows 4 HD"
  250. videohubctrl -h sdi --out-input "Output 7" "Windows 4 HD"
  251. # Set one input to go out two outputs and two monitoring ports
  252. videohubctrl -h sdi --in-output "Windows 4 HD" "Output 8" \\
  253. --in-output "Windows 4 HD" "Output 7" \\
  254. --in-monitor "Windows 4 HD" "Monitor 1" \\
  255. --in-monitor "Windows 4 HD" "Monitor 2"
  256. # Run several commands at once
  257. # Rename video input 11 and 12
  258. # Rename video output 5,
  259. # Set output 5 to receive from input 12
  260. # Lock output 5
  261. videohubctrl --host sdi \\
  262. --in-name 11 "Test input" \\
  263. --in-name 12 "Playout input" \\
  264. --out-name 5 "Encoder h264" \\
  265. --out-input 5 12 \\
  266. --out-lock 5
  267. # This fails. It tries to use name that is not previously configured.
  268. videohubctrl -h sdi --out-name 1 "Test output" \\
  269. --out-name "Test output" "Other name"
  270. .fi
  271. .SH SEE ALSO
  272. See the README file for more information. If you have questions,
  273. remarks, problems or you just want to contact the developer, write
  274. to:
  275. \fIgeorgi@unixsol.org\fP
  276. .TP
  277. For more info, see the website at
  278. .I http://georgi.unixsol.org/programs/videohubctrl/
  279. .SH AUTHORS
  280. Written by Georgi Chorbadzhiyski <\fBgeorgi@unixsol.org\fR>
  281. .SH LICENSE
  282. videohubctrl is released under MIT license.