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.0KB

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