git.sesse.net Git - nageru/blob - nageru/ffmpeg_capture.h

   1 #ifndef _FFMPEG_CAPTURE_H
   2 #define _FFMPEG_CAPTURE_H 1
   3
   4 // FFmpegCapture looks much like a capture card, but the frames it spits out
   5 // come from a video in real time, looping. Because it decodes the video using
   6 // FFmpeg (thus the name), this means it can handle a very wide array of video
   7 // formats, and also things like network streaming and V4L capture, but it is
   8 // also significantly less integrated and optimized than the regular capture
   9 // cards. In particular, the frames are always scaled and converted to 8-bit
  10 // RGBA on the CPU before being sent on to the GPU.
  11 //
  12 // Since we don't really know much about the video when building the chains,
  13 // there are some limitations. In particular, frames are always assumed to be
  14 // sRGB even if the video container says something else. We could probably
  15 // try to load the video on startup and pick out the parameters at that point,
  16 // but it would require some more plumbing, and it would also fail if the file
  17 // changes parameters midway, which is allowed in some formats.
  18 //
  19 // You can get out the audio either as decoded or in raw form (Kaeru uses this).
  20 //
  21 // If there's a subtitle track, you can also get out the last subtitle at the
  22 // point of the frame. Note that once we get a video frame, we don't look for
  23 // subtitle, so if subtitles and a frame comes at the same time, you might not
  24 // see the subtitle until the next frame.
  25
  26 #include <assert.h>
  27 #include <stdint.h>
  28 #include <functional>
  29 #include <map>
  30 #include <memory>
  31 #include <mutex>
  32 #include <set>
  33 #include <string>
  34 #include <thread>
  35
  36 #include <movit/effect.h>
  37 #include <movit/ycbcr.h>
  38
  39 extern "C" {
  40 #include <libswresample/swresample.h>
  41 #include <libavutil/pixfmt.h>
  42 #include <libavutil/rational.h>
  43 #include <libavutil/samplefmt.h>
  44 }
  45
  46 #include "bmusb/bmusb.h"
  47 #include "shared/ffmpeg_raii.h"
  48 #include "ref_counted_frame.h"
  49 #include "quittable_sleeper.h"
  50
  51 struct AVFormatContext;
  52 struct AVFrame;
  53 struct AVRational;
  54 struct AVPacket;
  55
  56 class FFmpegCapture : public bmusb::CaptureInterface
  57 {
  58 public:
  59         FFmpegCapture(const std::string &filename, unsigned width, unsigned height);
  60 #ifdef HAVE_SRT
  61         // Takes ownership of the SRT client socket.
  62         FFmpegCapture(int srt_sock, const std::string &stream_id);
  63 #endif
  64         ~FFmpegCapture();
  65
  66         void set_card_index(int card_index)
  67         {
  68                 this->card_index = card_index;
  69         }
  70
  71         int get_card_index() const
  72         {
  73                 return card_index;
  74         }
  75
  76         void rewind()
  77         {
  78                 std::lock_guard<std::mutex> lock(queue_mu);
  79                 command_queue.push_back(QueuedCommand { QueuedCommand::REWIND });
  80                 producer_thread_should_quit.wakeup();
  81         }
  82
  83         void change_rate(double new_rate)
  84         {
  85                 std::lock_guard<std::mutex> lock(queue_mu);
  86                 command_queue.push_back(QueuedCommand { QueuedCommand::CHANGE_RATE, new_rate });
  87                 producer_thread_should_quit.wakeup();
  88         }
  89
  90         std::string get_filename() const
  91         {
  92                 std::lock_guard<std::mutex> lock(filename_mu);
  93                 return filename;
  94         }
  95
  96         void change_filename(const std::string &new_filename)
  97         {
  98                 std::lock_guard<std::mutex> lock(filename_mu);
  99                 filename = new_filename;
 100                 should_interrupt = true;
 101         }
 102
 103         // Will stop the stream even if it's hung on blocking I/O.
 104         void disconnect()
 105         {
 106                 should_interrupt = true;
 107         }
 108
 109         // CaptureInterface.
 110         void set_video_frame_allocator(bmusb::FrameAllocator *allocator) override
 111         {
 112                 video_frame_allocator = allocator;
 113                 if (owned_video_frame_allocator.get() != allocator) {
 114                         owned_video_frame_allocator.reset();
 115                 }
 116         }
 117
 118         bmusb::FrameAllocator *get_video_frame_allocator() override
 119         {
 120                 return video_frame_allocator;
 121         }
 122
 123         // Does not take ownership.
 124         void set_audio_frame_allocator(bmusb::FrameAllocator *allocator) override
 125         {
 126                 audio_frame_allocator = allocator;
 127                 if (owned_audio_frame_allocator.get() != allocator) {
 128                         owned_audio_frame_allocator.reset();
 129                 }
 130         }
 131
 132         bmusb::FrameAllocator *get_audio_frame_allocator() override
 133         {
 134                 return audio_frame_allocator;
 135         }
 136
 137         // FFmpegCapture-specific overload of set_frame_callback that also gives
 138         // the raw original pts from the video. Negative pts means a dummy frame.
 139         typedef std::function<void(int64_t video_pts, AVRational video_timebase, int64_t audio_pts, AVRational audio_timebase,
 140                                    uint16_t timecode,
 141                                    bmusb::FrameAllocator::Frame video_frame, size_t video_offset, bmusb::VideoFormat video_format,
 142                                    bmusb::FrameAllocator::Frame audio_frame, size_t audio_offset, bmusb::AudioFormat audio_format)>
 143                 frame_callback_t;
 144         void set_frame_callback(frame_callback_t callback)
 145         {
 146                 frame_callback = callback;
 147         }
 148
 149         void set_frame_callback(bmusb::frame_callback_t callback) override
 150         {
 151                 frame_callback = std::bind(
 152                         callback,
 153                         std::placeholders::_5,
 154                         std::placeholders::_6,
 155                         std::placeholders::_7,
 156                         std::placeholders::_8,
 157                         std::placeholders::_9,
 158                         std::placeholders::_10,
 159                         std::placeholders::_11);
 160         }
 161
 162         // FFmpegCapture-specific callback that gives the raw audio.
 163         typedef std::function<void(const AVPacket *pkt, const AVRational timebase)> audio_callback_t;
 164         void set_audio_callback(audio_callback_t callback)
 165         {
 166                 audio_callback = callback;
 167         }
 168
 169         // Used to get precise information about the Y'CbCr format used
 170         // for a given frame. Only valid to call during the frame callback,
 171         // and only when receiving a frame with pixel format PixelFormat_8BitYCbCrPlanar.
 172         movit::YCbCrFormat get_current_frame_ycbcr_format() const
 173         {
 174                 return current_frame_ycbcr_format;
 175         }
 176
 177         // Only valid to call during the frame callback.
 178         std::string get_last_subtitle() const
 179         {
 180                 return last_subtitle;
 181         }
 182
 183         // Same.
 184         bool get_has_last_subtitle() const
 185         {
 186                 return has_last_subtitle;
 187         }
 188
 189         // Same.
 190         movit::RGBTriplet get_last_neutral_color() const
 191         {
 192                 return last_neutral_color;
 193         }
 194
 195         void set_dequeue_thread_callbacks(std::function<void()> init, std::function<void()> cleanup) override
 196         {
 197                 dequeue_init_callback = init;
 198                 dequeue_cleanup_callback = cleanup;
 199                 has_dequeue_callbacks = true;
 200         }
 201
 202         void set_card_disconnected_callback(bmusb::card_disconnected_callback_t callback)
 203         {
 204                 card_disconnected_callback = callback;
 205         }
 206
 207         std::string get_description() const override
 208         {
 209                 return description;
 210         }
 211
 212         void configure_card() override;
 213         void start_bm_capture() override;
 214         void stop_dequeue_thread() override;
 215         bool get_disconnected() const override { return disconnected; }  // Only if play_once == true.
 216         int get_srt_sock() const { return srt_sock; }
 217
 218         std::map<uint32_t, bmusb::VideoMode> get_available_video_modes() const override;
 219         void set_video_mode(uint32_t video_mode_id) override {}  // Ignore.
 220         uint32_t get_current_video_mode() const override { return 0; }
 221
 222         static constexpr bmusb::PixelFormat PixelFormat_NV12 = static_cast<bmusb::PixelFormat>(100);  // In the private range.
 223         std::set<bmusb::PixelFormat> get_available_pixel_formats() const override {
 224                 return std::set<bmusb::PixelFormat>{ bmusb::PixelFormat_8BitBGRA, bmusb::PixelFormat_8BitYCbCrPlanar, PixelFormat_NV12 };
 225         }
 226         void set_pixel_format(bmusb::PixelFormat pixel_format) override {
 227                 this->pixel_format = pixel_format;
 228         }
 229         bmusb::PixelFormat get_current_pixel_format() const override {
 230                 return pixel_format;
 231         }
 232
 233         std::map<uint32_t, std::string> get_available_video_inputs() const override {
 234                 return { { 0, "Auto" } }; }
 235         void set_video_input(uint32_t video_input_id) override {}  // Ignore.
 236         uint32_t get_current_video_input() const override { return 0; }
 237
 238         std::map<uint32_t, std::string> get_available_audio_inputs() const override {
 239                 return { { 0, "Embedded" } };
 240         }
 241         void set_audio_input(uint32_t audio_input_id) override {}  // Ignore.
 242         uint32_t get_current_audio_input() const override { return 0; }
 243
 244 private:
 245         void producer_thread_func();
 246         void send_disconnected_frame();
 247         bool play_video(const std::string &pathname);
 248         void internal_rewind();
 249
 250         // Returns true if there was an error.
 251         bool process_queued_commands(AVFormatContext *format_ctx, const std::string &pathname, timespec last_modified, bool *rewound);
 252
 253         // Returns nullptr if no frame was decoded (e.g. EOF).
 254         AVFrameWithDeleter decode_frame(AVFormatContext *format_ctx, AVCodecContext *video_codec_ctx, AVCodecContext *audio_codec_ctx,
 255                                         const std::string &pathname, int video_stream_index, int audio_stream_index, int subtitle_stream_index,
 256                                         bmusb::FrameAllocator::Frame *audio_frame, bmusb::AudioFormat *audio_format, int64_t *audio_pts, bool *error);
 257         void convert_audio(const AVFrame *audio_avframe, bmusb::FrameAllocator::Frame *audio_frame, bmusb::AudioFormat *audio_format);
 258
 259         bmusb::VideoFormat construct_video_format(const AVFrame *frame, AVRational video_timebase);
 260         UniqueFrame make_video_frame(const AVFrame *frame, const std::string &pathname, bool *error);
 261
 262         static int interrupt_cb_thunk(void *opaque);
 263         int interrupt_cb();
 264
 265 #ifdef HAVE_SRT
 266         static int read_srt_thunk(void *opaque, uint8_t *buf, int buf_size);
 267         int read_srt(uint8_t *buf, int buf_size);
 268 #endif
 269
 270         inline unsigned frame_width(const AVFrame *frame) const;
 271         inline unsigned frame_height(const AVFrame *frame) const;
 272
 273         mutable std::mutex filename_mu;
 274         std::string description, filename;
 275         int srt_sock = -1;
 276         uint16_t timecode = 0;
 277         unsigned width, height;  // 0 means keep input size.
 278         bmusb::PixelFormat pixel_format = bmusb::PixelFormat_8BitBGRA;
 279         movit::YCbCrFormat current_frame_ycbcr_format;
 280         bool running = false;
 281         int card_index = -1;
 282         double rate = 1.0;
 283         bool play_as_fast_as_possible = false;  // Activated iff rate >= 10.0.
 284         std::atomic<bool> should_interrupt{false};
 285         bool last_frame_was_connected = true;
 286
 287         bool has_dequeue_callbacks = false;
 288         std::function<void()> dequeue_init_callback = nullptr;
 289         std::function<void()> dequeue_cleanup_callback = nullptr;
 290
 291         bmusb::card_disconnected_callback_t card_disconnected_callback = nullptr;
 292         bool play_once = false;  // End thread after playing. Only for SRT, since the socket is ephemeral.
 293         std::atomic<bool> disconnected{false};
 294
 295         bmusb::FrameAllocator *video_frame_allocator = nullptr;
 296         bmusb::FrameAllocator *audio_frame_allocator = nullptr;
 297         std::unique_ptr<bmusb::FrameAllocator> owned_video_frame_allocator;
 298         std::unique_ptr<bmusb::FrameAllocator> owned_audio_frame_allocator;
 299         frame_callback_t frame_callback = nullptr;
 300         audio_callback_t audio_callback = nullptr;
 301
 302         SwsContextWithDeleter sws_ctx;
 303         int sws_last_width = -1, sws_last_height = -1, sws_last_src_format = -1;
 304         AVPixelFormat sws_dst_format = AVPixelFormat(-1);  // In practice, always initialized.
 305         AVRational video_timebase, audio_timebase;
 306         bool is_mjpeg = false;
 307
 308         QuittableSleeper producer_thread_should_quit;
 309         std::thread producer_thread;
 310
 311         int64_t pts_origin, last_pts;
 312         std::chrono::steady_clock::time_point start, next_frame_start, last_frame;
 313
 314         std::mutex queue_mu;
 315         struct QueuedCommand {
 316                 enum Command { REWIND, CHANGE_RATE } command;
 317                 double new_rate;  // For CHANGE_RATE.
 318         };
 319         std::vector<QueuedCommand> command_queue;  // Protected by <queue_mu>.
 320
 321         // Audio resampler.
 322         SwrContext *resampler = nullptr;
 323         AVSampleFormat last_src_format, last_dst_format;
 324         int64_t last_channel_layout;
 325         int last_sample_rate;
 326
 327         // Subtitles (no decoding done, really).
 328         bool has_last_subtitle = false;
 329         std::string last_subtitle;
 330
 331         movit::RGBTriplet last_neutral_color{1.0f, 1.0f, 1.0f};
 332 };
 333
 334 #endif  // !defined(_FFMPEG_CAPTURE_H)