4 // The actual video mixer, running in its own separate background thread.
11 #include <movit/effect_chain.h>
12 #include <movit/flat_input.h>
13 #include <zita-resampler/resampler.h>
15 #include <condition_variable>
24 #include "bmusb/bmusb.h"
25 #include "alsa_output.h"
26 #include "ebu_r128_proc.h"
27 #include "h264encode.h"
29 #include "pbo_frame_allocator.h"
30 #include "ref_counted_frame.h"
31 #include "ref_counted_gl_sync.h"
32 #include "resampling_queue.h"
35 #include "stereocompressor.h"
37 #include "input_state.h"
38 #include "correlation_measurer.h"
55 // For any card that's not the master (where we pick out the frames as they
56 // come, as fast as we can process), there's going to be a queue. The question
57 // is when we should drop frames from that queue (apart from the obvious
58 // dropping if the 16-frame queue should become full), especially given that
59 // the frame rate could be lower or higher than the master (either subtly or
60 // dramatically). We have two (conflicting) demands:
62 // 1. We want to avoid starving the queue.
63 // 2. We don't want to add more delay than is needed.
65 // Our general strategy is to drop as many frames as we can (helping for #2)
66 // that we think is safe for #1 given jitter. To this end, we set a lower floor N,
67 // where we assume that if we have N frames in the queue, we're always safe from
68 // starvation. (Typically, N will be 0 or 1. It starts off at 0.) If we have
69 // more than N frames in the queue after reading out the one we need, we head-drop
70 // them to reduce the queue.
72 // N is reduced as follows: If the queue has had at least one spare frame for
73 // at least 50 (master) frames (ie., it's been too conservative for a second),
74 // we reduce N by 1 and reset the timers.
76 // Whenever the queue is starved (we needed a frame but there was none), N was
77 // obviously too low, so we increment N. We will never set N above 5, though.
78 class QueueLengthPolicy {
80 QueueLengthPolicy() {}
81 void reset(unsigned card_index) {
82 this->card_index = card_index;
83 safe_queue_length = 0;
84 frames_with_at_least_one = 0;
87 void update_policy(int queue_length); // Give in -1 for starvation.
88 unsigned get_safe_queue_length() const { return safe_queue_length; }
91 unsigned card_index; // For debugging only.
92 unsigned safe_queue_length = 0; // Called N in the comments.
93 unsigned frames_with_at_least_one = 0;
98 // The surface format is used for offscreen destinations for OpenGL contexts we need.
99 Mixer(const QSurfaceFormat &format, unsigned num_cards);
104 void transition_clicked(int transition_num);
105 void channel_clicked(int preview_num);
110 OUTPUT_INPUT0, // 1, 2, 3, up to 15 follow numerically.
114 struct DisplayFrame {
115 // The chain for rendering this frame. To render a display frame,
116 // first wait for <ready_fence>, then call <setup_chain>
117 // to wire up all the inputs, and then finally call
118 // chain->render_to_screen() or similar.
119 movit::EffectChain *chain;
120 std::function<void()> setup_chain;
122 // Asserted when all the inputs are ready; you cannot render the chain
124 RefCountedGLsync ready_fence;
126 // Holds on to all the input frames needed for this display frame,
127 // so they are not released while still rendering.
128 std::vector<RefCountedFrame> input_frames;
130 // Textures that should be released back to the resource pool
131 // when this frame disappears, if any.
132 // TODO: Refcount these as well?
133 std::vector<GLuint> temp_textures;
135 // Implicitly frees the previous one if there's a new frame available.
136 bool get_display_frame(Output output, DisplayFrame *frame) {
137 return output_channel[output].get_display_frame(frame);
140 typedef std::function<void()> new_frame_ready_callback_t;
141 void set_frame_ready_callback(Output output, new_frame_ready_callback_t callback)
143 output_channel[output].set_frame_ready_callback(callback);
146 typedef std::function<void(float level_lufs, float peak_db,
147 float global_level_lufs, float range_low_lufs, float range_high_lufs,
148 float gain_staging_db, float final_makeup_gain_db,
149 float correlation)> audio_level_callback_t;
150 void set_audio_level_callback(audio_level_callback_t callback)
152 audio_level_callback = callback;
155 std::vector<std::string> get_transition_names()
157 return theme->get_transition_names(pts());
160 unsigned get_num_channels() const
162 return theme->get_num_channels();
165 std::string get_channel_name(unsigned channel) const
167 return theme->get_channel_name(channel);
170 int get_channel_signal(unsigned channel) const
172 return theme->get_channel_signal(channel);
175 int map_signal(unsigned channel)
177 return theme->map_signal(channel);
180 unsigned get_audio_source() const
182 return audio_source_channel;
185 void set_audio_source(unsigned channel)
187 audio_source_channel = channel;
190 unsigned get_master_clock() const
192 return master_clock_channel;
195 void set_master_clock(unsigned channel)
197 master_clock_channel = channel;
200 void set_signal_mapping(int signal, int card)
202 return theme->set_signal_mapping(signal, card);
205 bool get_supports_set_wb(unsigned channel) const
207 return theme->get_supports_set_wb(channel);
210 void set_wb(unsigned channel, double r, double g, double b) const
212 theme->set_wb(channel, r, g, b);
215 void set_locut_cutoff(float cutoff_hz)
217 locut_cutoff_hz = cutoff_hz;
220 void set_locut_enabled(bool enabled)
222 locut_enabled = enabled;
225 float get_limiter_threshold_dbfs()
227 return limiter_threshold_dbfs;
230 float get_compressor_threshold_dbfs()
232 return compressor_threshold_dbfs;
235 void set_limiter_threshold_dbfs(float threshold_dbfs)
237 limiter_threshold_dbfs = threshold_dbfs;
240 void set_compressor_threshold_dbfs(float threshold_dbfs)
242 compressor_threshold_dbfs = threshold_dbfs;
245 void set_limiter_enabled(bool enabled)
247 limiter_enabled = enabled;
250 void set_compressor_enabled(bool enabled)
252 compressor_enabled = enabled;
255 void set_gain_staging_db(float gain_db)
257 std::unique_lock<std::mutex> lock(compressor_mutex);
258 level_compressor_enabled = false;
259 gain_staging_db = gain_db;
262 void set_gain_staging_auto(bool enabled)
264 std::unique_lock<std::mutex> lock(compressor_mutex);
265 level_compressor_enabled = enabled;
268 void set_final_makeup_gain_db(float gain_db)
270 std::unique_lock<std::mutex> lock(compressor_mutex);
271 final_makeup_gain_auto = false;
272 final_makeup_gain = pow(10.0f, gain_db / 20.0f);
275 void set_final_makeup_gain_auto(bool enabled)
277 std::unique_lock<std::mutex> lock(compressor_mutex);
278 final_makeup_gain_auto = enabled;
288 unsigned get_num_cards() const { return num_cards; }
290 std::string get_card_description(unsigned card_index) const {
291 assert(card_index < num_cards);
292 return cards[card_index].capture->get_description();
295 std::map<uint32_t, VideoMode> get_available_video_modes(unsigned card_index) const {
296 assert(card_index < num_cards);
297 return cards[card_index].capture->get_available_video_modes();
300 uint32_t get_current_video_mode(unsigned card_index) const {
301 assert(card_index < num_cards);
302 return cards[card_index].capture->get_current_video_mode();
305 void set_video_mode(unsigned card_index, uint32_t mode) {
306 assert(card_index < num_cards);
307 cards[card_index].capture->set_video_mode(mode);
310 void start_mode_scanning(unsigned card_index);
312 std::map<uint32_t, std::string> get_available_video_inputs(unsigned card_index) const {
313 assert(card_index < num_cards);
314 return cards[card_index].capture->get_available_video_inputs();
317 uint32_t get_current_video_input(unsigned card_index) const {
318 assert(card_index < num_cards);
319 return cards[card_index].capture->get_current_video_input();
322 void set_video_input(unsigned card_index, uint32_t input) {
323 assert(card_index < num_cards);
324 cards[card_index].capture->set_video_input(input);
327 std::map<uint32_t, std::string> get_available_audio_inputs(unsigned card_index) const {
328 assert(card_index < num_cards);
329 return cards[card_index].capture->get_available_audio_inputs();
332 uint32_t get_current_audio_input(unsigned card_index) const {
333 assert(card_index < num_cards);
334 return cards[card_index].capture->get_current_audio_input();
337 void set_audio_input(unsigned card_index, uint32_t input) {
338 assert(card_index < num_cards);
339 cards[card_index].capture->set_audio_input(input);
343 void configure_card(unsigned card_index, const QSurfaceFormat &format, CaptureInterface *capture);
344 void bm_frame(unsigned card_index, uint16_t timecode,
345 FrameAllocator::Frame video_frame, size_t video_offset, VideoFormat video_format,
346 FrameAllocator::Frame audio_frame, size_t audio_offset, AudioFormat audio_format);
347 void place_rectangle(movit::Effect *resample_effect, movit::Effect *padding_effect, float x0, float y0, float x1, float y1);
349 void schedule_audio_resampling_tasks(unsigned dropped_frames, int num_samples_per_frame, int length_per_frame);
350 void render_one_frame();
351 void send_audio_level_callback();
352 void audio_thread_func();
353 void process_audio_one_frame(int64_t frame_pts_int, int num_samples);
354 void subsample_chroma(GLuint src_tex, GLuint dst_dst);
355 void release_display_frame(DisplayFrame *frame);
356 double pts() { return double(pts_int) / TIMEBASE; }
361 QSurface *mixer_surface, *h264_encoder_surface;
362 std::unique_ptr<movit::ResourcePool> resource_pool;
363 std::unique_ptr<Theme> theme;
364 std::atomic<unsigned> audio_source_channel{0};
365 std::atomic<unsigned> master_clock_channel{0};
366 std::unique_ptr<movit::EffectChain> display_chain;
367 GLuint cbcr_program_num; // Owned by <resource_pool>.
368 GLuint cbcr_vbo; // Holds position and texcoord data.
369 GLuint cbcr_position_attribute_index, cbcr_texcoord_attribute_index;
370 std::unique_ptr<H264Encoder> h264_encoder;
372 // Effects part of <display_chain>. Owned by <display_chain>.
373 movit::FlatInput *display_input;
375 int64_t pts_int = 0; // In TIMEBASE units.
377 std::mutex bmusb_mutex;
379 CaptureInterface *capture;
380 std::unique_ptr<PBOFrameAllocator> frame_allocator;
382 // Stuff for the OpenGL context (for texture uploading).
384 QOpenGLContext *context;
387 RefCountedFrame frame;
388 int64_t length; // In TIMEBASE units.
390 unsigned field; // Which field (0 or 1) of the frame to use. Always 0 for progressive.
391 GLsync ready_fence; // Whether frame is ready for rendering.
392 unsigned dropped_frames = 0; // Number of dropped frames before this one.
394 std::queue<NewFrame> new_frames;
395 bool should_quit = false;
396 std::condition_variable new_frames_changed; // Set whenever new_frames (or should_quit) is changed.
398 QueueLengthPolicy queue_length_policy; // Refers to the "new_frames" queue.
400 // Accumulated errors in number of 1/TIMEBASE samples. If OUTPUT_FREQUENCY divided by
401 // frame rate is integer, will always stay zero.
402 unsigned fractional_samples = 0;
404 std::mutex audio_mutex;
405 std::unique_ptr<ResamplingQueue> resampling_queue; // Under audio_mutex.
406 int last_timecode = -1; // Unwrapped.
407 int64_t next_local_pts = 0; // Beginning of next frame, in TIMEBASE units.
409 CaptureCard cards[MAX_CARDS]; // protected by <bmusb_mutex>
410 void get_one_frame_from_each_card(unsigned master_card_index, CaptureCard::NewFrame new_frames[MAX_CARDS], bool has_new_frame[MAX_CARDS], int num_samples[MAX_CARDS]);
412 InputState input_state;
414 class OutputChannel {
417 void output_frame(DisplayFrame frame);
418 bool get_display_frame(DisplayFrame *frame);
419 void set_frame_ready_callback(new_frame_ready_callback_t callback);
424 Mixer *parent = nullptr; // Not owned.
425 std::mutex frame_mutex;
426 DisplayFrame current_frame, ready_frame; // protected by <frame_mutex>
427 bool has_current_frame = false, has_ready_frame = false; // protected by <frame_mutex>
428 new_frame_ready_callback_t new_frame_ready_callback;
429 bool has_new_frame_ready_callback = false;
431 OutputChannel output_channel[NUM_OUTPUTS];
433 std::thread mixer_thread;
434 std::thread audio_thread;
435 std::atomic<bool> should_quit{false};
436 std::atomic<bool> should_cut{false};
438 audio_level_callback_t audio_level_callback = nullptr;
439 std::mutex compressor_mutex;
440 Ebu_r128_proc r128; // Under compressor_mutex.
441 CorrelationMeasurer correlation; // Under compressor_mutex.
443 Resampler peak_resampler;
444 std::atomic<float> peak{0.0f};
446 StereoFilter locut; // Default cutoff 120 Hz, 24 dB/oct.
447 std::atomic<float> locut_cutoff_hz;
448 std::atomic<bool> locut_enabled{true};
450 // First compressor; takes us up to about -12 dBFS.
451 StereoCompressor level_compressor; // Under compressor_mutex. Used to set/override gain_staging_db if <level_compressor_enabled>.
452 float gain_staging_db = 0.0f; // Under compressor_mutex.
453 bool level_compressor_enabled = true; // Under compressor_mutex.
455 static constexpr float ref_level_dbfs = -14.0f; // Chosen so that we end up around 0 LU in practice.
456 static constexpr float ref_level_lufs = -23.0f; // 0 LU, more or less by definition.
458 StereoCompressor limiter;
459 std::atomic<float> limiter_threshold_dbfs{ref_level_dbfs + 4.0f}; // 4 dB.
460 std::atomic<bool> limiter_enabled{true};
461 StereoCompressor compressor;
462 std::atomic<float> compressor_threshold_dbfs{ref_level_dbfs - 12.0f}; // -12 dB.
463 std::atomic<bool> compressor_enabled{true};
465 double final_makeup_gain = 1.0; // Under compressor_mutex. Read/write by the user. Note: Not in dB, we want the numeric precision so that we can change it slowly.
466 bool final_makeup_gain_auto = true; // Under compressor_mutex.
468 std::unique_ptr<ALSAOutput> alsa;
474 std::mutex audio_mutex;
475 std::condition_variable audio_task_queue_changed;
476 std::queue<AudioTask> audio_task_queue; // Under audio_mutex.
478 // For mode scanning.
479 bool is_mode_scanning[MAX_CARDS]{ false };
480 std::vector<uint32_t> mode_scanlist[MAX_CARDS];
481 unsigned mode_scanlist_index[MAX_CARDS]{ 0 };
482 timespec last_mode_scan_change[MAX_CARDS];
485 extern Mixer *global_mixer;
487 #endif // !defined(_MIXER_H)