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>
16 #include <condition_variable>
25 #include "bmusb/bmusb.h"
26 #include "alsa_output.h"
27 #include "ebu_r128_proc.h"
28 #include "video_encoder.h"
30 #include "pbo_frame_allocator.h"
31 #include "ref_counted_frame.h"
32 #include "ref_counted_gl_sync.h"
33 #include "resampling_queue.h"
36 #include "stereocompressor.h"
38 #include "input_state.h"
39 #include "correlation_measurer.h"
41 class QuickSyncEncoder;
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. TODO: Only do this if N ever actually
77 // Whenever the queue is starved (we needed a frame but there was none),
78 // and we've been at N since the last starvation, N was obviously too low,
79 // so we increment it. We will never set N above 5, though.
80 class QueueLengthPolicy {
82 QueueLengthPolicy() {}
83 void reset(unsigned card_index) {
84 this->card_index = card_index;
85 safe_queue_length = 0;
86 frames_with_at_least_one = 0;
87 been_at_safe_point_since_last_starvation = false;
90 void update_policy(int queue_length); // Give in -1 for starvation.
91 unsigned get_safe_queue_length() const { return safe_queue_length; }
94 unsigned card_index; // For debugging only.
95 unsigned safe_queue_length = 0; // Called N in the comments.
96 unsigned frames_with_at_least_one = 0;
97 bool been_at_safe_point_since_last_starvation = false;
102 // The surface format is used for offscreen destinations for OpenGL contexts we need.
103 Mixer(const QSurfaceFormat &format, unsigned num_cards);
108 void transition_clicked(int transition_num);
109 void channel_clicked(int preview_num);
114 OUTPUT_INPUT0, // 1, 2, 3, up to 15 follow numerically.
118 struct DisplayFrame {
119 // The chain for rendering this frame. To render a display frame,
120 // first wait for <ready_fence>, then call <setup_chain>
121 // to wire up all the inputs, and then finally call
122 // chain->render_to_screen() or similar.
123 movit::EffectChain *chain;
124 std::function<void()> setup_chain;
126 // Asserted when all the inputs are ready; you cannot render the chain
128 RefCountedGLsync ready_fence;
130 // Holds on to all the input frames needed for this display frame,
131 // so they are not released while still rendering.
132 std::vector<RefCountedFrame> input_frames;
134 // Textures that should be released back to the resource pool
135 // when this frame disappears, if any.
136 // TODO: Refcount these as well?
137 std::vector<GLuint> temp_textures;
139 // Implicitly frees the previous one if there's a new frame available.
140 bool get_display_frame(Output output, DisplayFrame *frame) {
141 return output_channel[output].get_display_frame(frame);
144 typedef std::function<void()> new_frame_ready_callback_t;
145 void set_frame_ready_callback(Output output, new_frame_ready_callback_t callback)
147 output_channel[output].set_frame_ready_callback(callback);
150 // TODO: Should this really be per-channel? Shouldn't it just be called for e.g. the live output?
151 typedef std::function<void(const std::vector<std::string> &)> transition_names_updated_callback_t;
152 void set_transition_names_updated_callback(Output output, transition_names_updated_callback_t callback)
154 output_channel[output].set_transition_names_updated_callback(callback);
157 typedef std::function<void(const std::string &)> name_updated_callback_t;
158 void set_name_updated_callback(Output output, name_updated_callback_t callback)
160 output_channel[output].set_name_updated_callback(callback);
163 typedef std::function<void(const std::string &)> color_updated_callback_t;
164 void set_color_updated_callback(Output output, color_updated_callback_t callback)
166 output_channel[output].set_color_updated_callback(callback);
169 typedef std::function<void(float level_lufs, float peak_db,
170 float global_level_lufs, float range_low_lufs, float range_high_lufs,
171 float gain_staging_db, float final_makeup_gain_db,
172 float correlation)> audio_level_callback_t;
173 void set_audio_level_callback(audio_level_callback_t callback)
175 audio_level_callback = callback;
178 std::vector<std::string> get_transition_names()
180 return theme->get_transition_names(pts());
183 unsigned get_num_channels() const
185 return theme->get_num_channels();
188 std::string get_channel_name(unsigned channel) const
190 return theme->get_channel_name(channel);
193 std::string get_channel_color(unsigned channel) const
195 return theme->get_channel_color(channel);
198 int get_channel_signal(unsigned channel) const
200 return theme->get_channel_signal(channel);
203 int map_signal(unsigned channel)
205 return theme->map_signal(channel);
208 unsigned get_audio_source() const
210 return audio_source_channel;
213 void set_audio_source(unsigned channel)
215 audio_source_channel = channel;
218 unsigned get_master_clock() const
220 return master_clock_channel;
223 void set_master_clock(unsigned channel)
225 master_clock_channel = channel;
228 void set_signal_mapping(int signal, int card)
230 return theme->set_signal_mapping(signal, card);
233 bool get_supports_set_wb(unsigned channel) const
235 return theme->get_supports_set_wb(channel);
238 void set_wb(unsigned channel, double r, double g, double b) const
240 theme->set_wb(channel, r, g, b);
243 void set_locut_cutoff(float cutoff_hz)
245 locut_cutoff_hz = cutoff_hz;
248 void set_locut_enabled(bool enabled)
250 locut_enabled = enabled;
253 bool get_locut_enabled() const
255 return locut_enabled;
258 float get_limiter_threshold_dbfs()
260 return limiter_threshold_dbfs;
263 float get_compressor_threshold_dbfs()
265 return compressor_threshold_dbfs;
268 void set_limiter_threshold_dbfs(float threshold_dbfs)
270 limiter_threshold_dbfs = threshold_dbfs;
273 void set_compressor_threshold_dbfs(float threshold_dbfs)
275 compressor_threshold_dbfs = threshold_dbfs;
278 void set_limiter_enabled(bool enabled)
280 limiter_enabled = enabled;
283 bool get_limiter_enabled() const
285 return limiter_enabled;
288 void set_compressor_enabled(bool enabled)
290 compressor_enabled = enabled;
293 bool get_compressor_enabled() const
295 return compressor_enabled;
298 void set_gain_staging_db(float gain_db)
300 std::unique_lock<std::mutex> lock(compressor_mutex);
301 level_compressor_enabled = false;
302 gain_staging_db = gain_db;
305 float get_gain_staging_db() const
307 std::unique_lock<std::mutex> lock(compressor_mutex);
308 return gain_staging_db;
311 void set_gain_staging_auto(bool enabled)
313 std::unique_lock<std::mutex> lock(compressor_mutex);
314 level_compressor_enabled = enabled;
317 bool get_gain_staging_auto() const
319 std::unique_lock<std::mutex> lock(compressor_mutex);
320 return level_compressor_enabled;
323 void set_final_makeup_gain_db(float gain_db)
325 std::unique_lock<std::mutex> lock(compressor_mutex);
326 final_makeup_gain_auto = false;
327 final_makeup_gain = pow(10.0f, gain_db / 20.0f);
330 void set_final_makeup_gain_auto(bool enabled)
332 std::unique_lock<std::mutex> lock(compressor_mutex);
333 final_makeup_gain_auto = enabled;
336 bool get_final_makeup_gain_auto() const
338 std::unique_lock<std::mutex> lock(compressor_mutex);
339 return final_makeup_gain_auto;
349 unsigned get_num_cards() const { return num_cards; }
351 std::string get_card_description(unsigned card_index) const {
352 assert(card_index < num_cards);
353 return cards[card_index].capture->get_description();
356 std::map<uint32_t, bmusb::VideoMode> get_available_video_modes(unsigned card_index) const {
357 assert(card_index < num_cards);
358 return cards[card_index].capture->get_available_video_modes();
361 uint32_t get_current_video_mode(unsigned card_index) const {
362 assert(card_index < num_cards);
363 return cards[card_index].capture->get_current_video_mode();
366 void set_video_mode(unsigned card_index, uint32_t mode) {
367 assert(card_index < num_cards);
368 cards[card_index].capture->set_video_mode(mode);
371 void start_mode_scanning(unsigned card_index);
373 std::map<uint32_t, std::string> get_available_video_inputs(unsigned card_index) const {
374 assert(card_index < num_cards);
375 return cards[card_index].capture->get_available_video_inputs();
378 uint32_t get_current_video_input(unsigned card_index) const {
379 assert(card_index < num_cards);
380 return cards[card_index].capture->get_current_video_input();
383 void set_video_input(unsigned card_index, uint32_t input) {
384 assert(card_index < num_cards);
385 cards[card_index].capture->set_video_input(input);
388 std::map<uint32_t, std::string> get_available_audio_inputs(unsigned card_index) const {
389 assert(card_index < num_cards);
390 return cards[card_index].capture->get_available_audio_inputs();
393 uint32_t get_current_audio_input(unsigned card_index) const {
394 assert(card_index < num_cards);
395 return cards[card_index].capture->get_current_audio_input();
398 void set_audio_input(unsigned card_index, uint32_t input) {
399 assert(card_index < num_cards);
400 cards[card_index].capture->set_audio_input(input);
403 void change_x264_bitrate(unsigned rate_kbit) {
404 video_encoder->change_x264_bitrate(rate_kbit);
408 void configure_card(unsigned card_index, bmusb::CaptureInterface *capture, bool is_fake_capture);
409 void bm_frame(unsigned card_index, uint16_t timecode,
410 bmusb::FrameAllocator::Frame video_frame, size_t video_offset, bmusb::VideoFormat video_format,
411 bmusb::FrameAllocator::Frame audio_frame, size_t audio_offset, bmusb::AudioFormat audio_format);
412 void bm_hotplug_add(libusb_device *dev);
413 void bm_hotplug_remove(unsigned card_index);
414 void place_rectangle(movit::Effect *resample_effect, movit::Effect *padding_effect, float x0, float y0, float x1, float y1);
416 void handle_hotplugged_cards();
417 void schedule_audio_resampling_tasks(unsigned dropped_frames, int num_samples_per_frame, int length_per_frame);
418 void render_one_frame(int64_t duration);
419 void send_audio_level_callback();
420 void audio_thread_func();
421 void process_audio_one_frame(int64_t frame_pts_int, int num_samples, bool adjust_rate);
422 void subsample_chroma(GLuint src_tex, GLuint dst_dst);
423 void release_display_frame(DisplayFrame *frame);
424 double pts() { return double(pts_int) / TIMEBASE; }
429 QSurface *mixer_surface, *h264_encoder_surface;
430 std::unique_ptr<movit::ResourcePool> resource_pool;
431 std::unique_ptr<Theme> theme;
432 std::atomic<unsigned> audio_source_channel{0};
433 std::atomic<unsigned> master_clock_channel{0};
434 std::unique_ptr<movit::EffectChain> display_chain;
435 GLuint cbcr_program_num; // Owned by <resource_pool>.
436 GLuint cbcr_vbo; // Holds position and texcoord data.
437 GLuint cbcr_position_attribute_index, cbcr_texcoord_attribute_index;
438 std::unique_ptr<VideoEncoder> video_encoder;
440 // Effects part of <display_chain>. Owned by <display_chain>.
441 movit::FlatInput *display_input;
443 int64_t pts_int = 0; // In TIMEBASE units.
445 std::mutex bmusb_mutex;
446 bool has_bmusb_thread = false;
448 bmusb::CaptureInterface *capture = nullptr;
449 bool is_fake_capture;
450 std::unique_ptr<PBOFrameAllocator> frame_allocator;
452 // Stuff for the OpenGL context (for texture uploading).
453 QSurface *surface = nullptr;
456 RefCountedFrame frame;
457 int64_t length; // In TIMEBASE units.
459 unsigned field; // Which field (0 or 1) of the frame to use. Always 0 for progressive.
460 std::function<void()> upload_func; // Needs to be called to actually upload the texture to OpenGL.
461 unsigned dropped_frames = 0; // Number of dropped frames before this one.
463 std::queue<NewFrame> new_frames;
464 bool should_quit = false;
465 std::condition_variable new_frames_changed; // Set whenever new_frames (or should_quit) is changed.
467 QueueLengthPolicy queue_length_policy; // Refers to the "new_frames" queue.
469 // Accumulated errors in number of 1/TIMEBASE samples. If OUTPUT_FREQUENCY divided by
470 // frame rate is integer, will always stay zero.
471 unsigned fractional_samples = 0;
473 std::mutex audio_mutex;
474 std::unique_ptr<ResamplingQueue> resampling_queue; // Under audio_mutex.
475 int last_timecode = -1; // Unwrapped.
476 int64_t next_local_pts = 0; // Beginning of next frame, in TIMEBASE units.
478 CaptureCard cards[MAX_CARDS]; // protected by <bmusb_mutex>
479 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]);
481 InputState input_state;
483 // Cards we have been noticed about being hotplugged, but haven't tried adding yet.
484 // Protected by its own mutex.
485 std::mutex hotplug_mutex;
486 std::vector<libusb_device *> hotplugged_cards;
488 class OutputChannel {
491 void output_frame(DisplayFrame frame);
492 bool get_display_frame(DisplayFrame *frame);
493 void set_frame_ready_callback(new_frame_ready_callback_t callback);
494 void set_transition_names_updated_callback(transition_names_updated_callback_t callback);
495 void set_name_updated_callback(name_updated_callback_t callback);
496 void set_color_updated_callback(color_updated_callback_t callback);
502 Mixer *parent = nullptr; // Not owned.
503 std::mutex frame_mutex;
504 DisplayFrame current_frame, ready_frame; // protected by <frame_mutex>
505 bool has_current_frame = false, has_ready_frame = false; // protected by <frame_mutex>
506 new_frame_ready_callback_t new_frame_ready_callback;
507 transition_names_updated_callback_t transition_names_updated_callback;
508 name_updated_callback_t name_updated_callback;
509 color_updated_callback_t color_updated_callback;
511 std::vector<std::string> last_transition_names;
512 std::string last_name, last_color;
514 OutputChannel output_channel[NUM_OUTPUTS];
516 std::thread mixer_thread;
517 std::thread audio_thread;
518 std::atomic<bool> should_quit{false};
519 std::atomic<bool> should_cut{false};
521 audio_level_callback_t audio_level_callback = nullptr;
522 mutable std::mutex compressor_mutex;
523 Ebu_r128_proc r128; // Under compressor_mutex.
524 CorrelationMeasurer correlation; // Under compressor_mutex.
526 Resampler peak_resampler;
527 std::atomic<float> peak{0.0f};
529 StereoFilter locut; // Default cutoff 120 Hz, 24 dB/oct.
530 std::atomic<float> locut_cutoff_hz;
531 std::atomic<bool> locut_enabled{true};
533 // First compressor; takes us up to about -12 dBFS.
534 StereoCompressor level_compressor; // Under compressor_mutex. Used to set/override gain_staging_db if <level_compressor_enabled>.
535 float gain_staging_db = 0.0f; // Under compressor_mutex.
536 bool level_compressor_enabled = true; // Under compressor_mutex.
538 static constexpr float ref_level_dbfs = -14.0f; // Chosen so that we end up around 0 LU in practice.
539 static constexpr float ref_level_lufs = -23.0f; // 0 LU, more or less by definition.
541 StereoCompressor limiter;
542 std::atomic<float> limiter_threshold_dbfs{ref_level_dbfs + 4.0f}; // 4 dB.
543 std::atomic<bool> limiter_enabled{true};
544 StereoCompressor compressor;
545 std::atomic<float> compressor_threshold_dbfs{ref_level_dbfs - 12.0f}; // -12 dB.
546 std::atomic<bool> compressor_enabled{true};
548 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.
549 bool final_makeup_gain_auto = true; // Under compressor_mutex.
551 std::unique_ptr<ALSAOutput> alsa;
558 std::mutex audio_mutex;
559 std::condition_variable audio_task_queue_changed;
560 std::queue<AudioTask> audio_task_queue; // Under audio_mutex.
562 // For mode scanning.
563 bool is_mode_scanning[MAX_CARDS]{ false };
564 std::vector<uint32_t> mode_scanlist[MAX_CARDS];
565 unsigned mode_scanlist_index[MAX_CARDS]{ 0 };
566 std::chrono::steady_clock::time_point last_mode_scan_change[MAX_CARDS];
569 extern Mixer *global_mixer;
570 extern bool uses_mlock;
572 #endif // !defined(_MIXER_H)