]> git.sesse.net Git - bmusb/blobdiff - bmusb.h
Release v0.4, and add a pkg-config file.
[bmusb] / bmusb.h
diff --git a/bmusb.h b/bmusb.h
index 17b5bc082d7a4dc266d25d80d93dcf1e3123b242..506685dc4c6a7401d17143cdb611315981c7b187 100644 (file)
--- a/bmusb.h
+++ b/bmusb.h
@@ -1,18 +1,22 @@
 #ifndef _BMUSB_H
 #define _BMUSB_H
 
+#include <libusb.h>
 #include <stdint.h>
 #include <atomic>
 #include <condition_variable>
 #include <deque>
 #include <functional>
+#include <map>
 #include <mutex>
 #include <stack>
 #include <string>
 #include <thread>
 #include <vector>
 
-struct libusb_transfer;
+namespace bmusb {
+
+class BMUSBCapture;
 
 // An interface for frame allocators; if you do not specify one
 // (using set_video_frame_allocator), a default one that pre-allocates
@@ -78,6 +82,20 @@ private:
        std::stack<std::unique_ptr<uint8_t[]>> freelist;  // All of size <frame_size>.
 };
 
+// Represents an input mode you can tune a card to.
+struct VideoMode {
+       std::string name;
+       bool autodetect = false;  // If true, all the remaining fields are irrelevant.
+       unsigned width = 0, height = 0;
+       unsigned frame_rate_num = 0, frame_rate_den = 0;
+       bool interlaced = false;
+};
+
+// Represents the format of an actual frame coming in.
+// 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).
 struct VideoFormat {
        uint16_t id = 0;  // For debugging/logging only.
        unsigned width = 0, height = 0, second_field_start = 0;
@@ -85,6 +103,7 @@ struct VideoFormat {
        unsigned frame_rate_nom = 0, frame_rate_den = 0;
        bool interlaced = false;
        bool has_signal = false;
+       bool is_connected = true;  // If false, then has_signal makes no sense.
 };
 
 struct AudioFormat {
@@ -98,10 +117,25 @@ typedef std::function<void(uint16_t timecode,
                            FrameAllocator::Frame audio_frame, size_t audio_offset, AudioFormat audio_format)>
        frame_callback_t;
 
+typedef std::function<void(libusb_device *dev)> card_connected_callback_t;
+typedef std::function<void()> card_disconnected_callback_t;
+
 class CaptureInterface {
  public:
        virtual ~CaptureInterface() {}
 
+       virtual std::map<uint32_t, VideoMode> get_available_video_modes() const = 0;
+       virtual uint32_t get_current_video_mode() const = 0;
+       virtual void set_video_mode(uint32_t video_mode_id) = 0;
+
+       virtual std::map<uint32_t, std::string> get_available_video_inputs() const = 0;
+       virtual void set_video_input(uint32_t video_input_id) = 0;
+       virtual uint32_t get_current_video_input() const = 0;
+
+       virtual std::map<uint32_t, std::string> get_available_audio_inputs() const = 0;
+       virtual void set_audio_input(uint32_t audio_input_id) = 0;
+       virtual uint32_t get_current_audio_input() const = 0;
+
        // Does not take ownership.
        virtual void set_video_frame_allocator(FrameAllocator *allocator) = 0;
 
@@ -125,22 +159,41 @@ class CaptureInterface {
        virtual void start_bm_capture() = 0;
 
        virtual void stop_dequeue_thread() = 0;
+
+       // If a card is disconnected, it cannot come back; you should call stop_dequeue_thread()
+       // and delete it.
+       virtual bool get_disconnected() const = 0;
 };
 
 // The actual capturing class, representing capture from a single card.
 class BMUSBCapture : public CaptureInterface {
  public:
-       BMUSBCapture(int card_index)
-               : card_index(card_index)
+       BMUSBCapture(int card_index, libusb_device *dev = nullptr)
+               : card_index(card_index), dev(dev)
        {
        }
 
        ~BMUSBCapture() {}
 
+       std::map<uint32_t, VideoMode> get_available_video_modes() const override;
+       uint32_t get_current_video_mode() const override;
+       void set_video_mode(uint32_t video_mode_id) override;
+
+       virtual std::map<uint32_t, std::string> get_available_video_inputs() const override;
+       virtual void set_video_input(uint32_t video_input_id) override;
+       virtual uint32_t get_current_video_input() const override { return current_video_input; }
+
+       virtual std::map<uint32_t, std::string> get_available_audio_inputs() const override;
+       virtual void set_audio_input(uint32_t audio_input_id) override;
+       virtual uint32_t get_current_audio_input() const override { return current_audio_input; }
+
        // Does not take ownership.
        void set_video_frame_allocator(FrameAllocator *allocator) override
        {
                video_frame_allocator = allocator;
+               if (owned_video_frame_allocator.get() != allocator) {
+                       owned_video_frame_allocator.reset();
+               }
        }
 
        FrameAllocator *get_video_frame_allocator() override
@@ -152,6 +205,9 @@ class BMUSBCapture : public CaptureInterface {
        void set_audio_frame_allocator(FrameAllocator *allocator) override
        {
                audio_frame_allocator = allocator;
+               if (owned_audio_frame_allocator.get() != allocator) {
+                       owned_audio_frame_allocator.reset();
+               }
        }
 
        FrameAllocator *get_audio_frame_allocator() override
@@ -180,11 +236,34 @@ class BMUSBCapture : public CaptureInterface {
        void configure_card() override;
        void start_bm_capture() override;
        void stop_dequeue_thread() override;
+       bool get_disconnected() const override { return disconnected; }
 
        // TODO: It's rather messy to have these outside the interface.
        static void start_bm_thread();
        static void stop_bm_thread();
 
+       // Hotplug event (for devices being inserted between start_bm_thread()
+       // and stop_bm_thread()); entirely optional, but must be set before
+       // start_bm_capture(). Note that your callback should do as little work
+       // as possible, since the callback comes from the main USB handling
+       // thread, which is very time-sensitive.
+       //
+       // The callback function transfers ownership. If you don't want to hold
+       // on to the device given to you in the callback, you need to call
+       // libusb_unref_device().
+       static void set_card_connected_callback(card_connected_callback_t callback)
+       {
+               card_connected_callback = callback;
+       }
+
+       // Similar to set_card_connected_callback(), with the same caveats.
+       // (Note that this is set per-card and not global, as it is logically
+       // connected to an existing BMUSBCapture object.)
+       void set_card_disconnected_callback(card_disconnected_callback_t callback)
+       {
+               card_disconnected_callback = callback;
+       }
+
  private:
        struct QueuedFrame {
                uint16_t timecode;
@@ -200,6 +279,9 @@ class BMUSBCapture : public CaptureInterface {
 
        static void usb_thread_func();
        static void cb_xfr(struct libusb_transfer *xfr);
+       static int cb_hotplug(libusb_context *ctx, libusb_device *dev, libusb_hotplug_event event, void *user_data);
+
+       void update_capture_mode();
 
        std::string description;
 
@@ -213,7 +295,11 @@ class BMUSBCapture : public CaptureInterface {
 
        FrameAllocator *video_frame_allocator = nullptr;
        FrameAllocator *audio_frame_allocator = nullptr;
+       std::unique_ptr<FrameAllocator> owned_video_frame_allocator;
+       std::unique_ptr<FrameAllocator> owned_audio_frame_allocator;
        frame_callback_t frame_callback = nullptr;
+       static card_connected_callback_t card_connected_callback;
+       card_disconnected_callback_t card_disconnected_callback = nullptr;
 
        std::thread dequeue_thread;
        std::atomic<bool> dequeue_thread_should_quit;
@@ -226,16 +312,22 @@ class BMUSBCapture : public CaptureInterface {
        static constexpr int NUM_BMUSB_REGISTERS = 60;
        uint8_t register_file[NUM_BMUSB_REGISTERS];
 
-       int card_index;
+       // If <dev> is nullptr, will choose device number <card_index> from the list
+       // of available devices on the system. <dev> is not used after configure_card()
+       // (it will be unref-ed).
+       int card_index = -1;
+       libusb_device *dev = nullptr;
+
        std::vector<libusb_transfer *> iso_xfrs;
        int assumed_frame_width = 1280;
+
+       libusb_device_handle *devh = nullptr;
+       uint32_t current_video_input = 0x00000000;  // HDMI/SDI.
+       uint32_t current_audio_input = 0x00000000;  // Embedded.
+
+       bool disconnected = false;
 };
 
-// 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, VideoFormat *decoded_video_format);
+}  // namespace bmusb
 
 #endif