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 7.3KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232
  1. .TH VIDEOHUBCTRL "1" "November 2014" "videohubctrl" "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 16x16
  10. router and probably will work 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. .SH MAIN OPTIONS
  18. .PP
  19. .TP
  20. \fB\-h\fR, \fB\-\-host\fR <host>
  21. Set the device host name. It can be an IP address or host name. You
  22. can set \fBVIDEOHUB_HOST\fR environment variable instead of using
  23. this option.
  24. .TP
  25. \fB\-p\fR, \fB\-\-port\fR <port>
  26. Set the device port. You can set \fBVIDEOHUB_PORT\fR environment
  27. variable instead of using this option. The default port is \fB9990\fR.
  28. .SH COMMANDS
  29. .PP
  30. .TP
  31. \fB\-i\fR, \fB\-\-info\fR
  32. Show full device info. This is the default command if none is set.
  33. The command shows the equivalent of running all \-\-list-XXX commands.
  34. .TP
  35. \fB\-m\fR, \fB\-\-monitor\fR
  36. Display the Videohub configuration and updates it in real-time as it
  37. is changed. The monitor shows config changes immediately as they happen.
  38. The device is not being polled, instead the videohub protocol is designed
  39. in such way that every client receives changes on the fly.
  40. .TP
  41. \fB\-b\fR, \fB\-\-backup\fR
  42. Show the command line that will restore the device to it's configuration.
  43. .TP
  44. \fB\-\-list\-device\fR
  45. Display main device info including model, number of ports, etc.
  46. .TP
  47. \fB\-\-list\-vinputs\fR
  48. Display device video inputs. Port numbers, names, how many outputs an
  49. input is being routed to, the list of the outputs and the port status
  50. (type).
  51. The port statuses (type) are reported by Universal Videohub and can be
  52. these:
  53. .nf
  54. - Empty means that the device do not support port status.
  55. x - The port type is "None". This means that the port is not
  56. installed in the device.
  57. B - The port type is "BNC".
  58. o - The port type is "Optical".
  59. T - The port type is "Thunderbolt".
  60. .fi
  61. .TP
  62. \fB\-\-list\-voutputs\fR
  63. Display device video outputs. Port numbers, names, locking status, which
  64. input is routed to a given output and the port status (type).
  65. There are two locking statuses:
  66. .nf
  67. L - The port is locked by another IP address (user)
  68. O - The port is locked by me (from my IP address)
  69. .fi
  70. The port status field (s) have the same format as input ports (described
  71. in \fB\-\-list\-vinputs\fR option).
  72. .TP
  73. \fB\-\-list\-moutputs\fR
  74. Display device monitoring outputs. Port numbers, names, locking status and
  75. which input is routed to a given output. The locking statuses are the
  76. same as video input and output ports.
  77. .TP
  78. \fB\-\-list\-serial\fR
  79. Display device serial ports. Port numbers, names, locking status, directions
  80. and how serial ports are routed. The locking statuses are the same as video
  81. input, output ports and monitoring ports.
  82. .SH CONFIGURATION COMMANDS
  83. .PP
  84. Everywhere where port needs to be set, you can use the port number or the
  85. port name. You can use only port names that were already configured in
  86. previous session. Trying to set a name and then reference it in the next
  87. command will fail. Using port numbers always works.
  88. .SH VIDEO INPUTS CONFIGURATION
  89. .PP
  90. .TP
  91. \fB\-\-vi\-name\fR <in_X> <name>
  92. Set video input port X name.
  93. .SH VIDEO OUTPUTS CONFIGURATION
  94. .PP
  95. .TP
  96. \fB\-\-vo\-name\fR <out_X> <name>
  97. Set video output port X name.
  98. .TP
  99. \fB\-\-vo\-input\fR <out_X> <in_Y>
  100. Connect video output X to video input Y.
  101. .TP
  102. \fB\-\-vo\-lock\fR <out_X>
  103. Lock output port X.
  104. .TP
  105. \fB\-\-vo\-unlock\fR <out_X>
  106. Unlock output port X. If the port is locked by somebody else the
  107. port would be forcefully unlocked.
  108. .SH MONITORING OUTPUTS CONFIGURATION
  109. .PP
  110. .TP
  111. \fB\-\-mo\-name\fR <mout_X> <name>
  112. Set monitoring output port X name.
  113. .TP
  114. \fB\-\-mo\-input\fR <mout_X> <in_Y>
  115. Connect monitoring output X to video input Y.
  116. .TP
  117. \fB\-\-mo\-lock\fR <mout_X>
  118. Lock monitoring output port X.
  119. .TP
  120. \fB\-\-mo\-unlock\fR <mout_X>
  121. Unlock monitoring output port X. If the port is locked by somebody
  122. else the port would be forcefully unlocked.
  123. .SH SERIAL PORTS CONFIGURATION
  124. .PP
  125. .TP
  126. \fB\-\-se\-name\fR <ser_X> <name>
  127. Set serial port X name.
  128. .TP
  129. \fB\-\-se\-connect\fR <ser_X> <ser_Y>
  130. Connect serial port X to serial port Y. This option have two aliases \fB\-\-se\-input\fR
  131. and \fB\-\-se\-route\fR.
  132. .TP
  133. \fB\-\-se\-clear\fR <ser_X>
  134. Disconnect serial port X from serial port Y.
  135. .TP
  136. \fB\-\-se\-lock\fR <ser_X>
  137. Lock serial port X.
  138. .TP
  139. \fB\-\-se\-unlock\fR <ser_X>
  140. Unlock serial port X. If the port is locked by somebody else the
  141. port would be forcefully unlocked.
  142. .TP
  143. \fB\-\-se\-dir\fR <set_X> <in|out|auto>
  144. Set serial port X direction. There are three possible settings for
  145. each port:
  146. \fBin\fR - input/control/Workstation
  147. \fBout\fR - output/slave/Deck
  148. \fBauto\fR - Automatic in/out
  149. .SH MISC OPTIONS
  150. .PP
  151. .TP
  152. \fB\-T\fR, \fB\-\-test\fR <file>
  153. Read commands from the <file> instead of connecting to a real
  154. device. This allows testing the program without having access
  155. to a device.
  156. .TP
  157. \fB\-d\fR, \fB\-\-debug\fR
  158. Enable debugging output. Use this option more times to increase
  159. the verbosity.
  160. .TP
  161. \fB\-q\fR, \fB\-\-quiet\fR
  162. Suppress warnings about unsupported commands.
  163. .TP
  164. \fB\-V\fR, \fB\-\-version\fR
  165. Show program name and version.
  166. .TP
  167. \fB\-H\fR, \fB\-\-help\fR
  168. Show program usage text.
  169. .SH ENVIRONMENT VARIABLES
  170. .PP
  171. .TP
  172. \fBVIDEOHUB_HOST\fR
  173. Set the device host name.
  174. .TP
  175. \fBVIDEOHUB_PORT\fR
  176. Set the device port.
  177. .SH EXAMPLES
  178. .PP
  179. To get a quick start here are some example command lines.
  180. .nf
  181. # Rename video output
  182. videohubctrl -h sdi --vo-name 8 "Output 8 - test"
  183. videohubctrl -h sdi --vo-name "Output 8 - test" "Output 8"
  184. # Rename video input
  185. videohubctrl -h sdi --vi-name 4 "Windows 4 HD"
  186. videohubctrl -h sdi --vi-name "Windows 4 HD" "CPlay4"
  187. # Lock and then unlock output 16 (unlock assumes that the port is
  188. # named Output 16). The host name is set via env variable.
  189. export VIDEOHUB_HOST=sdi
  190. videohubctrl --vo-lock 16
  191. videohubctrl --vo-unlock "Output 16"
  192. # Set two outputs to receive from the same input using port names
  193. videohubctrl -h sdi --vo-input "Output 8" "Windows 4 HD"
  194. videohubctrl -h sdi --vo-input "Output 7" "Windows 4 HD"
  195. # Run several commands at once
  196. # Rename video input 11 and 12
  197. # Rename video output 5,
  198. # Set output 5 to receive from input 12
  199. # Lock output 5
  200. videohubctrl --host sdi \\
  201. --vi-name 11 "Test input" \\
  202. --vi-name 12 "Playout input" \\
  203. --vo-name 5 "Encoder h264" \\
  204. --vo-input 5 12 \\
  205. --vo-lock 5
  206. # This fails. It tries to use name that is not previously configured.
  207. videohubctrl -h sdi --vo-name 1 "Test output" \\
  208. --vo-name "Test output" "Other name"
  209. .fi
  210. .SH SEE ALSO
  211. See the README file for more information. If you have questions,
  212. remarks, problems or you just want to contact the developer, write
  213. to:
  214. \fIgeorgi@unixsol.org\fP
  215. .TP
  216. For more info, see the website at
  217. .I http://georgi.unixsol.org/programs/videohubctrl/
  218. .SH AUTHORS
  219. Written by Georgi Chorbadzhiyski <\fBgeorgi@unixsol.org\fR>
  220. .SH LICENSE
  221. videohubctrl is released under MIT license.