git.sesse.net Git - bmusb/blob - README

   1 bmusb is a free driver for BlackMagic's Intensity Shuttle and
   2 UltraStudio SDI USB3 cards, which have no official Linux driver.
   3 (The two seem to speak exactly the same protocol.) It runs in userspace
   4 through usbfs, which may mean it could also probably run on FreeBSD,
   5 but it's untested.
   6
   7 Current tested features (note, some of these are not exposed in the
   8 driver except by changing the source code):
   9
  10  * HDMI and SDI capture on 576p60, 720p60, 1080i60 (1080p60 is unfortunately
  11    not supported in newer firmwares; I haven't tried older), plus 24, 50
  12    and 59.97 Hz
  13  * 8-channel 24-bit 48 kHz locked audio capture
  14  * Analog audio capture, including setting levels
  15  * 8-bit 4:2:2 and 10-bit 4:2:2 capture
  16
  17 The BlackMagic cards follow a protocol whose exact format is still
  18 unknown, and the driver is still in alpha stage. (There is no API or
  19 ABI stability, for one, and everything is really messy and uncommented.)
  20 In particular, it will often do something on init that makes the card
  21 seemingly reset and disconnect off the bus (and then reset).
  22 This being said, once it's actually up, I've done ten-hour 720p60
  23 captures on my Lenovo X240 without a single drop.
  24
  25 It seems to want about 10–15% of one CPU core; a significant chunk of this is
  26 copying data from the kernel over to userspace. However, it supports custom
  27 memory allocators, so that once the USB packets are in userspace, you can
  28 decode directly into e.g. pinned GPU memory.
  29
  30 The driver itself lives in bmusb.cpp; main.cpp contains a very simple
  31 client that just checks for frame continuity. It's recommended to run
  32 as root or some other user that can run the USB thread at realtime
  33 priority, as USB3 isochronous transfers are very timing sensitive.
  34
  35 The driver has only been tested with the firmware from the 10.4.3/10.5.0
  36 series (seemingly the same), and there is currently no tool to
  37 upgrade or downgrade the firmware on the card.
  38
  39 bmusb is Copyright 2015 Steinar H. Gunderson <sgunderson@bigfoot.com>
  40 and licensed under the GNU General Public License, version 2, or at your
  41 option, any later version. See the COPYING file.