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

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