1 #ifndef _FFMPEG_CAPTURE_H
2 #define _FFMPEG_CAPTURE_H 1
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.
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.
19 // You can get out the audio either as decoded or in raw form (Kaeru uses this).
31 #include <movit/ycbcr.h>
34 #include <libavresample/avresample.h>
35 #include <libavutil/pixfmt.h>
36 #include <libavutil/rational.h>
37 #include <libavutil/samplefmt.h>
40 #include "bmusb/bmusb.h"
41 #include "ffmpeg_raii.h"
42 #include "ref_counted_frame.h"
43 #include "quittable_sleeper.h"
45 struct AVFormatContext;
50 class FFmpegCapture : public bmusb::CaptureInterface
53 FFmpegCapture(const std::string &filename, unsigned width, unsigned height);
56 void set_card_index(int card_index)
58 this->card_index = card_index;
61 int get_card_index() const
68 std::lock_guard<std::mutex> lock(queue_mu);
69 command_queue.push_back(QueuedCommand { QueuedCommand::REWIND });
70 producer_thread_should_quit.wakeup();
73 void change_rate(double new_rate)
75 std::lock_guard<std::mutex> lock(queue_mu);
76 command_queue.push_back(QueuedCommand { QueuedCommand::CHANGE_RATE, new_rate });
77 producer_thread_should_quit.wakeup();
80 // Will stop the stream even if it's hung on blocking I/O.
83 should_interrupt = true;
87 void set_video_frame_allocator(bmusb::FrameAllocator *allocator) override
89 video_frame_allocator = allocator;
90 if (owned_video_frame_allocator.get() != allocator) {
91 owned_video_frame_allocator.reset();
95 bmusb::FrameAllocator *get_video_frame_allocator() override
97 return video_frame_allocator;
100 // Does not take ownership.
101 void set_audio_frame_allocator(bmusb::FrameAllocator *allocator) override
103 audio_frame_allocator = allocator;
104 if (owned_audio_frame_allocator.get() != allocator) {
105 owned_audio_frame_allocator.reset();
109 bmusb::FrameAllocator *get_audio_frame_allocator() override
111 return audio_frame_allocator;
114 // FFmpegCapture-specific overload of set_frame_callback that also gives
115 // the raw original pts from the video. Negative pts means a dummy frame.
116 typedef std::function<void(int64_t video_pts, AVRational video_timebase, int64_t audio_pts, AVRational audio_timebase,
118 bmusb::FrameAllocator::Frame video_frame, size_t video_offset, bmusb::VideoFormat video_format,
119 bmusb::FrameAllocator::Frame audio_frame, size_t audio_offset, bmusb::AudioFormat audio_format)>
121 void set_frame_callback(frame_callback_t callback)
123 frame_callback = callback;
126 void set_frame_callback(bmusb::frame_callback_t callback) override
128 frame_callback = std::bind(
130 std::placeholders::_5,
131 std::placeholders::_6,
132 std::placeholders::_7,
133 std::placeholders::_8,
134 std::placeholders::_9,
135 std::placeholders::_10,
136 std::placeholders::_11);
139 // FFmpegCapture-specific callback that gives the raw audio.
140 typedef std::function<void(const AVPacket *pkt, const AVRational timebase)> audio_callback_t;
141 void set_audio_callback(audio_callback_t callback)
143 audio_callback = callback;
146 // Used to get precise information about the Y'CbCr format used
147 // for a given frame. Only valid to call during the frame callback,
148 // and only when receiving a frame with pixel format PixelFormat_8BitYCbCrPlanar.
149 movit::YCbCrFormat get_current_frame_ycbcr_format() const
151 return current_frame_ycbcr_format;
154 void set_dequeue_thread_callbacks(std::function<void()> init, std::function<void()> cleanup) override
156 dequeue_init_callback = init;
157 dequeue_cleanup_callback = cleanup;
158 has_dequeue_callbacks = true;
161 std::string get_description() const override
166 void configure_card() override;
167 void start_bm_capture() override;
168 void stop_dequeue_thread() override;
169 bool get_disconnected() const override { return false; } // We never unplug.
171 std::map<uint32_t, bmusb::VideoMode> get_available_video_modes() const override;
172 void set_video_mode(uint32_t video_mode_id) override {} // Ignore.
173 uint32_t get_current_video_mode() const override { return 0; }
175 static constexpr bmusb::PixelFormat PixelFormat_NV12 = static_cast<bmusb::PixelFormat>(100); // In the private range.
176 std::set<bmusb::PixelFormat> get_available_pixel_formats() const override {
177 return std::set<bmusb::PixelFormat>{ bmusb::PixelFormat_8BitBGRA, bmusb::PixelFormat_8BitYCbCrPlanar, PixelFormat_NV12 };
179 void set_pixel_format(bmusb::PixelFormat pixel_format) override {
180 this->pixel_format = pixel_format;
182 bmusb::PixelFormat get_current_pixel_format() const override {
186 std::map<uint32_t, std::string> get_available_video_inputs() const override {
187 return { { 0, "Auto" } }; }
188 void set_video_input(uint32_t video_input_id) override {} // Ignore.
189 uint32_t get_current_video_input() const override { return 0; }
191 std::map<uint32_t, std::string> get_available_audio_inputs() const override {
192 return { { 0, "Embedded" } };
194 void set_audio_input(uint32_t audio_input_id) override {} // Ignore.
195 uint32_t get_current_audio_input() const override { return 0; }
198 void producer_thread_func();
199 void send_disconnected_frame();
200 bool play_video(const std::string &pathname);
201 void internal_rewind();
203 // Returns true if there was an error.
204 bool process_queued_commands(AVFormatContext *format_ctx, const std::string &pathname, timespec last_modified, bool *rewound);
206 // Returns nullptr if no frame was decoded (e.g. EOF).
207 AVFrameWithDeleter decode_frame(AVFormatContext *format_ctx, AVCodecContext *video_codec_ctx, AVCodecContext *audio_codec_ctx,
208 const std::string &pathname, int video_stream_index, int audio_stream_index,
209 bmusb::FrameAllocator::Frame *audio_frame, bmusb::AudioFormat *audio_format, int64_t *audio_pts, bool *error);
210 void convert_audio(const AVFrame *audio_avframe, bmusb::FrameAllocator::Frame *audio_frame, bmusb::AudioFormat *audio_format);
212 bmusb::VideoFormat construct_video_format(const AVFrame *frame, AVRational video_timebase);
213 UniqueFrame make_video_frame(const AVFrame *frame, const std::string &pathname, bool *error);
215 static int interrupt_cb_thunk(void *unique);
218 std::string description, filename;
219 uint16_t timecode = 0;
220 unsigned width, height;
221 bmusb::PixelFormat pixel_format = bmusb::PixelFormat_8BitBGRA;
222 movit::YCbCrFormat current_frame_ycbcr_format;
223 bool running = false;
226 std::atomic<bool> should_interrupt{false};
227 bool last_frame_was_connected = true;
229 bool has_dequeue_callbacks = false;
230 std::function<void()> dequeue_init_callback = nullptr;
231 std::function<void()> dequeue_cleanup_callback = nullptr;
233 bmusb::FrameAllocator *video_frame_allocator = nullptr;
234 bmusb::FrameAllocator *audio_frame_allocator = nullptr;
235 std::unique_ptr<bmusb::FrameAllocator> owned_video_frame_allocator;
236 std::unique_ptr<bmusb::FrameAllocator> owned_audio_frame_allocator;
237 frame_callback_t frame_callback = nullptr;
238 audio_callback_t audio_callback = nullptr;
240 SwsContextWithDeleter sws_ctx;
241 int sws_last_width = -1, sws_last_height = -1, sws_last_src_format = -1;
242 AVPixelFormat sws_dst_format = AVPixelFormat(-1); // In practice, always initialized.
243 AVRational video_timebase, audio_timebase;
245 QuittableSleeper producer_thread_should_quit;
246 std::thread producer_thread;
248 int64_t pts_origin, last_pts;
249 std::chrono::steady_clock::time_point start, next_frame_start, last_frame;
252 struct QueuedCommand {
253 enum Command { REWIND, CHANGE_RATE } command;
254 double new_rate; // For CHANGE_RATE.
256 std::vector<QueuedCommand> command_queue; // Protected by <queue_mu>.
259 AVAudioResampleContext *resampler = nullptr;
260 AVSampleFormat last_src_format, last_dst_format;
261 int64_t last_channel_layout;
262 int last_sample_rate;
266 #endif // !defined(_FFMPEG_CAPTURE_H)