Add an option to get a textual description of each card.

[bmusb] / bmusb.h

diff --git a/bmusb.h b/bmusb.h
index 9b74730cb056721dfa7038fbc1010d0a61e221fb..6fdddedeb6e1d5781d8a9128cf67b5525fd5ef33 100644 (file)
--- a/bmusb.h
+++ b/bmusb.h
@@ -7,9 +7,12 @@
 #include <deque>
 #include <functional>
 #include <mutex>
+#include <string>
 #include <thread>
 #include <vector>
 
+struct libusb_transfer;
+
 // An interface for frame allocators; if you do not specify one
 // (using set_video_frame_allocator), a default one that pre-allocates
 // a freelist of eight frames using new[] will be used. Specifying
@@ -23,6 +26,7 @@ class FrameAllocator {
                uint8_t *data2 = nullptr;  // Only if interleaved == true.
                size_t len = 0;  // Number of bytes we actually have.
                size_t size = 0;  // Number of bytes we have room for.
+               size_t overflow = 0;
                void *userdata = nullptr;
                FrameAllocator *owner = nullptr;
 
@@ -61,8 +65,8 @@ typedef std::function<void(uint16_t timecode,
 // The actual capturing class, representing capture from a single card.
 class BMUSBCapture {
  public:
-       BMUSBCapture(int vid = 0x1edb, int pid = 0xbd3b)
-               : vid(vid), pid(pid)
+       BMUSBCapture(int card_index)
+               : card_index(card_index)
        {
        }
 
@@ -93,8 +97,22 @@ class BMUSBCapture {
                frame_callback = callback;
        }
 
+       // Needs to be run before configure_card().
+       void set_dequeue_thread_callbacks(std::function<void()> init, std::function<void()> cleanup)
+       {
+               dequeue_init_callback = init;
+               dequeue_cleanup_callback = cleanup;
+               has_dequeue_callbacks = true;
+       }
+
+       // Only valid after configure_card().
+       std::string get_description() const {
+               return description;
+       }
+
        void configure_card();
        void start_bm_capture();
+       void stop_dequeue_thread();
 
        static void start_bm_thread();
        static void stop_bm_thread();
@@ -110,11 +128,13 @@ class BMUSBCapture {
        void start_new_frame(const uint8_t *start);
 
        void queue_frame(uint16_t format, uint16_t timecode, FrameAllocator::Frame frame, std::deque<QueuedFrame> *q);
-       void dequeue_thread();
+       void dequeue_thread_func();
 
        static void usb_thread_func();
        static void cb_xfr(struct libusb_transfer *xfr);
 
+       std::string description;
+
        FrameAllocator::Frame current_video_frame;
        FrameAllocator::Frame current_audio_frame;
 
@@ -127,13 +147,29 @@ class BMUSBCapture {
        FrameAllocator *audio_frame_allocator = nullptr;
        frame_callback_t frame_callback = nullptr;
 
+       std::thread dequeue_thread;
+       std::atomic<bool> dequeue_thread_should_quit;
+       bool has_dequeue_callbacks = false;
+       std::function<void()> dequeue_init_callback = nullptr;
+       std::function<void()> dequeue_cleanup_callback = nullptr;
+
        int current_register = 0;
 
        static constexpr int NUM_BMUSB_REGISTERS = 60;
        uint8_t register_file[NUM_BMUSB_REGISTERS];
 
-       int vid, pid;
+       int card_index;
        std::vector<libusb_transfer *> iso_xfrs;
+       int assumed_frame_width = 1280;
 };
 
+// Get details for the given video format; returns false if detection was incomplete.
+// Note: Frame rate is _frame_ rate, not field rate. So 1080i60 gets 30/1, _not_ 60/1.
+// "second_field_start" is only valid for interlaced modes; it signifies
+// how many lines from the very top of the frame there are before the second field
+// starts (so it will always be >= height/2 + extra_lines_top).
+bool decode_video_format(uint16_t video_format, unsigned *width, unsigned *height, unsigned *second_field_start,
+                         unsigned *extra_lines_top, unsigned *extra_lines_bottom,
+                         unsigned *frame_rate_nom, unsigned *frame_rate_den, bool *interlaced);
+
 #endif