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

   1 #ifndef _BMUSB_H
   2 #define _BMUSB_H
   3
   4 #include <stdint.h>
   5 #include <atomic>
   6 #include <condition_variable>
   7 #include <deque>
   8 #include <functional>
   9 #include <mutex>
  10 #include <string>
  11 #include <thread>
  12 #include <vector>
  13
  14 struct libusb_transfer;
  15
  16 // An interface for frame allocators; if you do not specify one
  17 // (using set_video_frame_allocator), a default one that pre-allocates
  18 // a freelist of eight frames using new[] will be used. Specifying
  19 // your own can be useful if you have special demands for where you want the
  20 // frame to end up and don't want to spend the extra copy to get it there, for
  21 // instance GPU memory.
  22 class FrameAllocator {
  23  public:
  24         struct Frame {
  25                 uint8_t *data = nullptr;
  26                 uint8_t *data2 = nullptr;  // Only if interleaved == true.
  27                 size_t len = 0;  // Number of bytes we actually have.
  28                 size_t size = 0;  // Number of bytes we have room for.
  29                 size_t overflow = 0;
  30                 void *userdata = nullptr;
  31                 FrameAllocator *owner = nullptr;
  32
  33                 // If set to true, every other byte will go to data and to data2.
  34                 // If so, <len> and <size> are still about the number of total bytes
  35                 // so if size == 1024, there's 512 bytes in data and 512 in data2.
  36                 bool interleaved = false;
  37         };
  38
  39         virtual ~FrameAllocator();
  40
  41         // Request a video frame. Note that this is called from the
  42         // USB thread, which runs with realtime priority and is
  43         // very sensitive to delays. Thus, you should not do anything
  44         // here that might sleep, including calling malloc().
  45         // (Taking a mutex is borderline.)
  46         //
  47         // The Frame object will be given to the frame callback,
  48         // which is responsible for releasing the video frame back
  49         // once it is usable for new frames (ie., it will no longer
  50         // be read from). You can use the "userdata" pointer for
  51         // whatever you want to identify this frame if you need to.
  52         //
  53         // Returning a Frame with data==nullptr is allowed;
  54         // if so, the frame in progress will be dropped.
  55         virtual Frame alloc_frame() = 0;
  56
  57         virtual void release_frame(Frame frame) = 0;
  58 };
  59
  60 struct VideoFormat {
  61         uint16_t id = 0;  // For debugging/logging only.
  62         unsigned width = 0, height = 0, second_field_start = 0;
  63         unsigned extra_lines_top = 0, extra_lines_bottom = 0;
  64         unsigned frame_rate_nom = 0, frame_rate_den = 0;
  65         bool interlaced = false;
  66 };
  67
  68 typedef std::function<void(uint16_t timecode,
  69                            FrameAllocator::Frame video_frame, size_t video_offset, VideoFormat video_format,
  70                            FrameAllocator::Frame audio_frame, size_t audio_offset, uint16_t audio_format)>
  71         frame_callback_t;
  72
  73 // The actual capturing class, representing capture from a single card.
  74 class BMUSBCapture {
  75  public:
  76         BMUSBCapture(int card_index)
  77                 : card_index(card_index)
  78         {
  79         }
  80
  81         // Does not take ownership.
  82         void set_video_frame_allocator(FrameAllocator *allocator)
  83         {
  84                 video_frame_allocator = allocator;
  85         }
  86
  87         FrameAllocator *get_video_frame_allocator()
  88         {
  89                 return video_frame_allocator;
  90         }
  91
  92         // Does not take ownership.
  93         void set_audio_frame_allocator(FrameAllocator *allocator)
  94         {
  95                 audio_frame_allocator = allocator;
  96         }
  97
  98         FrameAllocator *get_audio_frame_allocator()
  99         {
 100                 return audio_frame_allocator;
 101         }
 102
 103         void set_frame_callback(frame_callback_t callback)
 104         {
 105                 frame_callback = callback;
 106         }
 107
 108         // Needs to be run before configure_card().
 109         void set_dequeue_thread_callbacks(std::function<void()> init, std::function<void()> cleanup)
 110         {
 111                 dequeue_init_callback = init;
 112                 dequeue_cleanup_callback = cleanup;
 113                 has_dequeue_callbacks = true;
 114         }
 115
 116         // Only valid after configure_card().
 117         std::string get_description() const {
 118                 return description;
 119         }
 120
 121         void configure_card();
 122         void start_bm_capture();
 123         void stop_dequeue_thread();
 124
 125         static void start_bm_thread();
 126         static void stop_bm_thread();
 127
 128  private:
 129         struct QueuedFrame {
 130                 uint16_t timecode;
 131                 uint16_t format;
 132                 FrameAllocator::Frame frame;
 133         };
 134
 135         void start_new_audio_block(const uint8_t *start);
 136         void start_new_frame(const uint8_t *start);
 137
 138         void queue_frame(uint16_t format, uint16_t timecode, FrameAllocator::Frame frame, std::deque<QueuedFrame> *q);
 139         void dequeue_thread_func();
 140
 141         static void usb_thread_func();
 142         static void cb_xfr(struct libusb_transfer *xfr);
 143
 144         std::string description;
 145
 146         FrameAllocator::Frame current_video_frame;
 147         FrameAllocator::Frame current_audio_frame;
 148
 149         std::mutex queue_lock;
 150         std::condition_variable queues_not_empty;
 151         std::deque<QueuedFrame> pending_video_frames;
 152         std::deque<QueuedFrame> pending_audio_frames;
 153
 154         FrameAllocator *video_frame_allocator = nullptr;
 155         FrameAllocator *audio_frame_allocator = nullptr;
 156         frame_callback_t frame_callback = nullptr;
 157
 158         std::thread dequeue_thread;
 159         std::atomic<bool> dequeue_thread_should_quit;
 160         bool has_dequeue_callbacks = false;
 161         std::function<void()> dequeue_init_callback = nullptr;
 162         std::function<void()> dequeue_cleanup_callback = nullptr;
 163
 164         int current_register = 0;
 165
 166         static constexpr int NUM_BMUSB_REGISTERS = 60;
 167         uint8_t register_file[NUM_BMUSB_REGISTERS];
 168
 169         int card_index;
 170         std::vector<libusb_transfer *> iso_xfrs;
 171         int assumed_frame_width = 1280;
 172 };
 173
 174 // Get details for the given video format; returns false if detection was incomplete.
 175 // Note: Frame rate is _frame_ rate, not field rate. So 1080i60 gets 30/1, _not_ 60/1.
 176 // "second_field_start" is only valid for interlaced modes; it signifies
 177 // how many lines from the very top of the frame there are before the second field
 178 // starts (so it will always be >= height/2 + extra_lines_top).
 179 bool decode_video_format(uint16_t video_format, VideoFormat *decoded_video_format);
 180
 181 #endif