]> git.sesse.net Git - bmusb/blobdiff - bmusb.cpp
Add a way to get the current video mode.
[bmusb] / bmusb.cpp
index b3739caf28db7052ae9fe68024004d5ca526a299..3d2c9f018488e202dff12e9439ebe8be665fa376 100644 (file)
--- a/bmusb.cpp
+++ b/bmusb.cpp
 #include <memory>
 #include <mutex>
 #include <stack>
+#include <string>
 #include <thread>
 
 using namespace std;
 using namespace std::placeholders;
 
-#define WIDTH 1280
-#define HEIGHT 750  /* 30 lines ancillary data? */
-//#define WIDTH 1920
-//#define HEIGHT 1125  /* ??? lines ancillary data? */
+#define MIN_WIDTH 640
 #define HEADER_SIZE 44
 //#define HEADER_SIZE 0
 #define AUDIO_HEADER_SIZE 4
 
-//#define FRAME_SIZE (WIDTH * HEIGHT * 2 + HEADER_SIZE)  // UYVY
-//#define FRAME_SIZE (WIDTH * HEIGHT * 2 * 4 / 3 + HEADER_SIZE)  // v210
-#define FRAME_SIZE (8 << 20)
+#define FRAME_SIZE (8 << 20)  // 8 MB.
+#define USB_VIDEO_TRANSFER_SIZE (128 << 10)  // 128 kB.
+
+namespace {
 
 FILE *audiofp;
 
 thread usb_thread;
 atomic<bool> should_quit;
 
-FrameAllocator::~FrameAllocator() {}
-
-// Audio is more important than video, and also much cheaper.
-// By having many more audio frames available, hopefully if something
-// starts to drop, we'll have CPU load go down (from not having to
-// process as much video) before we have to drop audio.
-#define NUM_QUEUED_VIDEO_FRAMES 16
-#define NUM_QUEUED_AUDIO_FRAMES 64
+int find_xfer_size_for_width(int width)
+{
+       // Video seems to require isochronous packets scaled with the width;
+       // seemingly six lines is about right, rounded up to the required 1kB
+       // multiple.
+       int size = width * 2 * 6;
+       // Note that for 10-bit input, you'll need to increase size accordingly.
+       //size = size * 4 / 3;
+       if (size % 1024 != 0) {
+               size &= ~1023;
+               size += 1024;
+       }
+       return size;
+}
 
-class MallocFrameAllocator : public FrameAllocator {
-public:
-       MallocFrameAllocator(size_t frame_size, size_t num_queued_frames);
-       Frame alloc_frame() override;
-       void release_frame(Frame frame) override;
+void change_xfer_size_for_width(int width, libusb_transfer *xfr)
+{
+       assert(width >= MIN_WIDTH);
+       size_t size = find_xfer_size_for_width(width);
+       int num_iso_pack = xfr->length / size;
+       if (num_iso_pack != xfr->num_iso_packets ||
+           size != xfr->iso_packet_desc[0].length) {
+               xfr->num_iso_packets = num_iso_pack;
+               libusb_set_iso_packet_lengths(xfr, size);
+       }
+}
 
-private:
-       size_t frame_size;
+}  // namespace
 
-       mutex freelist_mutex;
-       stack<unique_ptr<uint8_t[]>> freelist;  // All of size <frame_size>.
-};
+FrameAllocator::~FrameAllocator() {}
 
 MallocFrameAllocator::MallocFrameAllocator(size_t frame_size, size_t num_queued_frames)
        : frame_size(frame_size)
@@ -120,6 +128,7 @@ bool uint16_less_than_with_wraparound(uint16_t a, uint16_t b)
 
 void BMUSBCapture::queue_frame(uint16_t format, uint16_t timecode, FrameAllocator::Frame frame, deque<QueuedFrame> *q)
 {
+       unique_lock<mutex> lock(queue_lock);
        if (!q->empty() && !uint16_less_than_with_wraparound(q->back().timecode, timecode)) {
                printf("Blocks going backwards: prev=0x%04x, cur=0x%04x (dropped)\n",
                        q->back().timecode, timecode);
@@ -131,11 +140,7 @@ void BMUSBCapture::queue_frame(uint16_t format, uint16_t timecode, FrameAllocato
        qf.format = format;
        qf.timecode = timecode;
        qf.frame = frame;
-
-       {
-               unique_lock<mutex> lock(queue_lock);
-               q->push_back(move(qf));
-       }
+       q->push_back(move(qf));
        queues_not_empty.notify_one();  // might be spurious
 }
 
@@ -162,22 +167,36 @@ void BMUSBCapture::dequeue_thread_func()
                unique_lock<mutex> lock(queue_lock);
                queues_not_empty.wait(lock, [this]{ return dequeue_thread_should_quit || (!pending_video_frames.empty() && !pending_audio_frames.empty()); });
 
+               if (dequeue_thread_should_quit) break;
+
                uint16_t video_timecode = pending_video_frames.front().timecode;
                uint16_t audio_timecode = pending_audio_frames.front().timecode;
+               AudioFormat audio_format;
+               audio_format.bits_per_sample = 24;
+               audio_format.num_channels = 8;
                if (uint16_less_than_with_wraparound(video_timecode, audio_timecode)) {
                        printf("Video block 0x%04x without corresponding audio block, dropping.\n",
                                video_timecode);
-                       video_frame_allocator->release_frame(pending_video_frames.front().frame);
+                       QueuedFrame video_frame = pending_video_frames.front();
                        pending_video_frames.pop_front();
+                       lock.unlock();
+                       video_frame_allocator->release_frame(video_frame.frame);
                } else if (uint16_less_than_with_wraparound(audio_timecode, video_timecode)) {
                        printf("Audio block 0x%04x without corresponding video block, sending blank frame.\n",
                                audio_timecode);
                        QueuedFrame audio_frame = pending_audio_frames.front();
                        pending_audio_frames.pop_front();
                        lock.unlock();
+                       audio_format.id = audio_frame.format;
+
+                       // Use the video format of the pending frame.
+                       QueuedFrame video_frame = pending_video_frames.front();
+                       VideoFormat video_format;
+                       decode_video_format(video_frame.format, &video_format);
+
                        frame_callback(audio_timecode,
-                                      FrameAllocator::Frame(), 0, 0x0000,
-                                      audio_frame.frame, AUDIO_HEADER_SIZE, audio_frame.format);
+                                      FrameAllocator::Frame(), 0, video_format,
+                                      audio_frame.frame, AUDIO_HEADER_SIZE, audio_format);
                } else {
                        QueuedFrame video_frame = pending_video_frames.front();
                        QueuedFrame audio_frame = pending_audio_frames.front();
@@ -192,9 +211,17 @@ void BMUSBCapture::dequeue_thread_func()
                        dump_audio_block(audio_frame.frame.data, audio_frame.data_len); 
 #endif
 
-                       frame_callback(video_timecode,
-                                      video_frame.frame, HEADER_SIZE, video_frame.format,
-                                      audio_frame.frame, AUDIO_HEADER_SIZE, audio_frame.format);
+                       VideoFormat video_format;
+                       audio_format.id = audio_frame.format;
+                       if (decode_video_format(video_frame.format, &video_format)) {
+                               frame_callback(video_timecode,
+                                              video_frame.frame, HEADER_SIZE, video_format,
+                                              audio_frame.frame, AUDIO_HEADER_SIZE, audio_format);
+                       } else {
+                               frame_callback(video_timecode,
+                                              FrameAllocator::Frame(), 0, video_format,
+                                              audio_frame.frame, AUDIO_HEADER_SIZE, audio_format);
+                       }
                }
        }
        if (has_dequeue_callbacks) {
@@ -225,6 +252,13 @@ void BMUSBCapture::start_new_frame(const uint8_t *start)
                }
                //dump_frame();
                queue_frame(format, timecode, current_video_frame, &pending_video_frames);
+
+               // Update the assumed frame width. We might be one frame too late on format changes,
+               // but it's much better than asking the user to choose manually.
+               VideoFormat video_format;
+               if (decode_video_format(format, &video_format)) {
+                       assumed_frame_width = video_format.width;
+               }
        }
        //printf("Found frame start, format 0x%04x timecode 0x%04x, previous frame length was %d/%d\n",
        //      format, timecode,
@@ -596,6 +630,9 @@ void BMUSBCapture::cb_xfr(struct libusb_transfer *xfr)
                        decode_packs(xfr, "DeckLinkAudioResyncT", 20, &usb->current_audio_frame, "audio", bind(&BMUSBCapture::start_new_audio_block, usb, _1));
                } else {
                        decode_packs(xfr, "\x00\x00\xff\xff", 4, &usb->current_video_frame, "video", bind(&BMUSBCapture::start_new_frame, usb, _1));
+
+                       // Update the transfer with the new assumed width, if we're in the process of changing formats.
+                       change_xfer_size_for_width(usb->assumed_frame_width, xfr);
                }
        }
        if (xfr->type == LIBUSB_TRANSFER_TYPE_CONTROL) {
@@ -638,8 +675,9 @@ void BMUSBCapture::cb_xfr(struct libusb_transfer *xfr)
        }
 #endif
 
-       if (libusb_submit_transfer(xfr) < 0) {
-               fprintf(stderr, "error re-submitting URB\n");
+       int rc = libusb_submit_transfer(xfr);
+       if (rc < 0) {
+               fprintf(stderr, "error re-submitting URB: %s\n", libusb_error_name(rc));
                exit(1);
        }
 }
@@ -665,7 +703,7 @@ struct USBCardDevice {
        libusb_device *device;
 };
 
-libusb_device_handle *open_card(int card_index)
+libusb_device_handle *open_card(int card_index, string *description)
 {      
        libusb_device **devices;
        ssize_t num_devices = libusb_get_device_list(nullptr, &devices);
@@ -704,14 +742,22 @@ libusb_device_handle *open_card(int card_index)
        });
 
        for (size_t i = 0; i < found_cards.size(); ++i) {
-               fprintf(stderr, "Card %d: Bus %03u Device %03u ", int(i), found_cards[i].bus, found_cards[i].port);
+               const char *product_name = nullptr;
                if (found_cards[i].product == 0xbd3b) {
-                       fprintf(stderr, "Intensity Shuttle\n");
+                       product_name = "Intensity Shuttle";
                } else if (found_cards[i].product == 0xbd4f) {
-                       fprintf(stderr, "UltraStudio SDI\n");
+                       product_name = "UltraStudio SDI";
                } else {
                        assert(false);
                }
+
+               char buf[256];
+               snprintf(buf, sizeof(buf), "Card %d: Bus %03u Device %03u  %s",
+                       int(i), found_cards[i].bus, found_cards[i].port, product_name);
+               if (i == size_t(card_index)) {
+                       *description = buf;
+               }
+               fprintf(stderr, "%s\n", buf);
        }
 
        if (size_t(card_index) >= found_cards.size()) {
@@ -753,7 +799,7 @@ void BMUSBCapture::configure_card()
                exit(1);
        }
 
-       libusb_device_handle *devh = open_card(card_index);
+       libusb_device_handle *devh = open_card(card_index, &description);
        if (!devh) {
                fprintf(stderr, "Error finding USB device\n");
                exit(1);
@@ -765,6 +811,8 @@ void BMUSBCapture::configure_card()
                fprintf(stderr, "Error getting configuration: %s\n", libusb_error_name(rc));
                exit(1);
        }
+
+#if 0
        printf("%d interface\n", config->bNumInterfaces);
        for (int interface_number = 0; interface_number < config->bNumInterfaces; ++interface_number) {
                printf("  interface %d\n", interface_number);
@@ -778,6 +826,7 @@ void BMUSBCapture::configure_card()
                        }
                }
        }
+#endif
 
        rc = libusb_set_configuration(devh, /*configuration=*/1);
        if (rc < 0) {
@@ -906,12 +955,18 @@ void BMUSBCapture::configure_card()
                        fprintf(stderr, "Error on control %d: %s\n", ctrls[req].index, libusb_error_name(rc));
                        exit(1);
                }
-               
+
+               if (ctrls[req].index == 16 && rc == 4) {
+                       printf("Card firmware version: 0x%02x%02x\n", value[2], value[3]);
+               }
+
+#if 0
                printf("rc=%d: ep=%d@%d %d -> 0x", rc, ctrls[req].endpoint, ctrls[req].request, ctrls[req].index);
                for (int i = 0; i < rc; ++i) {
                        printf("%02x", value[i]);
                }
                printf("\n");
+#endif
        }
 
 #if 0
@@ -977,28 +1032,24 @@ void BMUSBCapture::configure_card()
        // set up isochronous transfers for audio and video
        for (int e = 3; e <= 4; ++e) {
                //int num_transfers = (e == 3) ? 6 : 6;
-               int num_transfers = 6;
+               int num_transfers = 10;
                for (int i = 0; i < num_transfers; ++i) {
+                       size_t buf_size;
                        int num_iso_pack, size;
                        if (e == 3) {
-                               // Video seems to require isochronous packets scaled with the width; 
-                               // seemingly six lines is about right, rounded up to the required 1kB
-                               // multiple.
-                               size = WIDTH * 2 * 6;
-                               // Note that for 10-bit input, you'll need to increase size accordingly.
-                               //size = size * 4 / 3;
-                               if (size % 1024 != 0) {
-                                       size &= ~1023;
-                                       size += 1024;
-                               }
-                               num_iso_pack = (2 << 18) / size;  // 512 kB.
-                               printf("Picking %d packets of 0x%x bytes each\n", num_iso_pack, size);
+                               // Allocate for minimum width (because that will give us the most
+                               // number of packets, so we don't need to reallocated, but we'll
+                               // default to 720p for the first frame.
+                               size = find_xfer_size_for_width(MIN_WIDTH);
+                               num_iso_pack = USB_VIDEO_TRANSFER_SIZE / size;
+                               buf_size = USB_VIDEO_TRANSFER_SIZE;
                        } else {
                                size = 0xc0;
                                num_iso_pack = 80;
+                               buf_size = num_iso_pack * size;
                        }
-                       int num_bytes = num_iso_pack * size;
-                       uint8_t *buf = new uint8_t[num_bytes];
+                       assert(size_t(num_iso_pack * size) <= buf_size);
+                       uint8_t *buf = new uint8_t[buf_size];
 
                        xfr = libusb_alloc_transfer(num_iso_pack);
                        if (!xfr) {
@@ -1007,10 +1058,15 @@ void BMUSBCapture::configure_card()
                        }
 
                        int ep = LIBUSB_ENDPOINT_IN | e;
-                       libusb_fill_iso_transfer(xfr, devh, ep, buf, num_bytes,
+                       libusb_fill_iso_transfer(xfr, devh, ep, buf, buf_size,
                                num_iso_pack, cb_xfr, nullptr, 0);
                        libusb_set_iso_packet_lengths(xfr, size);
                        xfr->user_data = this;
+
+                       if (e == 3) {
+                               change_xfer_size_for_width(assumed_frame_width, xfr);
+                       }
+
                        iso_xfrs.push_back(xfr);
                }
        }
@@ -1018,10 +1074,8 @@ void BMUSBCapture::configure_card()
 
 void BMUSBCapture::start_bm_capture()
 {
-       printf("starting capture\n");
        int i = 0;
        for (libusb_transfer *xfr : iso_xfrs) {
-               printf("submitting transfer...\n");
                int rc = libusb_submit_transfer(xfr);
                ++i;
                if (rc < 0) {
@@ -1061,3 +1115,137 @@ void BMUSBCapture::stop_bm_thread()
        should_quit = true;
        usb_thread.join();
 }
+
+struct VideoFormatEntry {
+       uint16_t normalized_video_format;
+       unsigned width, height, second_field_start;
+       unsigned extra_lines_top, extra_lines_bottom;
+       unsigned frame_rate_nom, frame_rate_den;
+       bool interlaced;
+};
+
+bool decode_video_format(uint16_t video_format, VideoFormat *decoded_video_format)
+{
+       decoded_video_format->id = video_format;
+       decoded_video_format->interlaced = false;
+
+       // TODO: Add these for all formats as we find them.
+       decoded_video_format->extra_lines_top = decoded_video_format->extra_lines_bottom = decoded_video_format->second_field_start = 0;
+
+       if (video_format == 0x0800) {
+               // No video signal. These green pseudo-frames seem to come at about 30.13 Hz.
+               // It's a strange thing, but what can you do.
+               decoded_video_format->width = 720;
+               decoded_video_format->height = 525;
+               decoded_video_format->extra_lines_top = 0;
+               decoded_video_format->extra_lines_bottom = 0;
+               decoded_video_format->frame_rate_nom = 3013;
+               decoded_video_format->frame_rate_den = 100;
+               decoded_video_format->has_signal = false;
+               return true;
+       }
+       if ((video_format & 0xe800) != 0xe800) {
+               printf("Video format 0x%04x does not appear to be a video format. Assuming 60 Hz.\n",
+                       video_format);
+               decoded_video_format->width = 0;
+               decoded_video_format->height = 0;
+               decoded_video_format->extra_lines_top = 0;
+               decoded_video_format->extra_lines_bottom = 0;
+               decoded_video_format->frame_rate_nom = 60;
+               decoded_video_format->frame_rate_den = 1;
+               decoded_video_format->has_signal = false;
+               return false;
+       }
+
+       decoded_video_format->has_signal = true;
+
+       // NTSC (480i59.94, I suppose). A special case, see below.
+       if (video_format == 0xe901 || video_format == 0xe9c1 || video_format == 0xe801) {
+               decoded_video_format->width = 720;
+               decoded_video_format->height = 480;
+               decoded_video_format->extra_lines_top = 17;
+               decoded_video_format->extra_lines_bottom = 28;
+               decoded_video_format->frame_rate_nom = 30000;
+               decoded_video_format->frame_rate_den = 1001;
+               decoded_video_format->second_field_start = 280;
+               decoded_video_format->interlaced = true;
+               return true;
+       }
+
+       // PAL (576i50, I suppose). A special case, see below.
+       if (video_format == 0xe909 || video_format == 0xe9c9 || video_format == 0xe809 || video_format == 0xebe9 || video_format == 0xebe1) {
+               decoded_video_format->width = 720;
+               decoded_video_format->height = 576;
+               decoded_video_format->extra_lines_top = 22;
+               decoded_video_format->extra_lines_bottom = 27;
+               decoded_video_format->frame_rate_nom = 25;
+               decoded_video_format->frame_rate_den = 1;
+               decoded_video_format->second_field_start = 335;
+               decoded_video_format->interlaced = true;
+               return true;
+       }
+
+       // 0x8 seems to be a flag about availability of deep color on the input,
+       // except when it's not (e.g. it's the only difference between NTSC
+       // and PAL). Rather confusing. But we clear it here nevertheless, because
+       // usually it doesn't mean anything.
+       //
+       // 0x4 is a flag I've only seen from the D4. I don't know what it is.
+       uint16_t normalized_video_format = video_format & ~0xe80c;
+       constexpr VideoFormatEntry entries[] = {
+               { 0x01f1,  720,  480,   0, 40,  5, 60000, 1001, false },  // 480p59.94 (believed).
+               { 0x0131,  720,  576,   0, 44,  5,    50,    1, false },  // 576p50.
+               { 0x0011,  720,  576,   0, 44,  5,    50,    1, false },  // 576p50 (5:4).
+               { 0x0143, 1280,  720,   0, 25,  5,    50,    1, false },  // 720p50.
+               { 0x0103, 1280,  720,   0, 25,  5,    60,    1, false },  // 720p60.
+               { 0x0125, 1280,  720,   0, 25,  5,    60,    1, false },  // 720p60.
+               { 0x0121, 1280,  720,   0, 25,  5, 60000, 1001, false },  // 720p59.94.
+               { 0x01c3, 1920, 1080,   0,  0,  0,    30,    1, false },  // 1080p30.
+               { 0x0003, 1920, 1080, 583, 20, 25,    30,    1,  true },  // 1080i60.
+               { 0x01e1, 1920, 1080,   0,  0,  0, 30000, 1001, false },  // 1080p29.97.
+               { 0x0021, 1920, 1080, 583, 20, 25, 30000, 1001,  true },  // 1080i59.94.
+               { 0x0063, 1920, 1080,   0,  0,  0,    25,    1, false },  // 1080p25.
+               { 0x0043, 1920, 1080,   0,  0,  0,    25,    1,  true },  // 1080p50.
+               { 0x008e, 1920, 1080,   0,  0,  0,    24,    1, false },  // 1080p24.
+               { 0x00a1, 1920, 1080,   0,  0,  0, 24000, 1001, false },  // 1080p23.98.
+       };
+       for (const VideoFormatEntry &entry : entries) {
+               if (normalized_video_format == entry.normalized_video_format) {
+                       decoded_video_format->width = entry.width;
+                       decoded_video_format->height = entry.height;
+                       decoded_video_format->second_field_start = entry.second_field_start;
+                       decoded_video_format->extra_lines_top = entry.extra_lines_top;
+                       decoded_video_format->extra_lines_bottom = entry.extra_lines_bottom;
+                       decoded_video_format->frame_rate_nom = entry.frame_rate_nom;
+                       decoded_video_format->frame_rate_den = entry.frame_rate_den;
+                       decoded_video_format->interlaced = entry.interlaced;
+                       return true;
+               }
+       }
+
+       printf("Unknown video format 0x%04x (normalized 0x%04x). Assuming 720p60.\n", video_format, normalized_video_format);
+       decoded_video_format->width = 1280;
+       decoded_video_format->height = 720;
+       decoded_video_format->frame_rate_nom = 60;
+       decoded_video_format->frame_rate_den = 1;
+       return false;
+}
+
+map<uint32_t, VideoMode> BMUSBCapture::get_available_video_modes() const
+{
+       // The USB3 cards autodetect, and seem to have no provision for forcing modes.
+       VideoMode auto_mode;
+       auto_mode.name = "Autodetect";
+       auto_mode.autodetect = true;
+       return {{ 0, auto_mode }};
+}
+
+uint32_t BMUSBCapture::get_current_video_mode() const
+{
+       return 0;  // Matches get_available_video_modes().
+}
+
+void BMUSBCapture::set_video_mode(uint32_t video_mode_id)
+{
+       assert(video_mode_id == 0);  // Matches get_available_video_modes().
+}