2 #define _AUDIO_MIXER_H 1
4 // The audio mixer, dealing with extracting the right signals from
5 // each capture card, resampling signals so that they are in sync,
6 // processing them with effects (if desired), and then mixing them
7 // all together into one final audio signal.
9 // All operations on AudioMixer (except destruction) are thread-safe.
13 #include <zita-resampler/resampler.h>
25 #include "alsa_pool.h"
26 #include "card_type.h"
27 #include "correlation_measurer.h"
30 #include "ebu_r128_proc.h"
32 #include "input_mapping.h"
33 #include "resampling_queue.h"
34 #include "stereocompressor.h"
35 #include "shared/shared_defs.h"
37 class DeviceSpecProto;
43 // Convert the given audio from {16,24,32}-bit M-channel to 32-bit N-channel PCM.
44 // Assumes little-endian and chunky, signed PCM throughout.
45 std::vector<int32_t> convert_audio_to_fixed32(const uint8_t *data, unsigned num_samples, bmusb::AudioFormat audio_format, unsigned num_destination_channels);
57 void reset_resampler(DeviceSpec device_spec);
60 // Add audio (or silence) to the given device's queue. Can return false if
61 // the lock wasn't successfully taken; if so, you should simply try again.
62 // (This is to avoid a deadlock where a card hangs on the mutex in add_audio()
63 // while we are trying to shut it down from another thread that also holds
65 bool add_audio(DeviceSpec device_spec, const uint8_t *data, unsigned num_samples, bmusb::AudioFormat audio_format, std::chrono::steady_clock::time_point frame_time);
66 bool add_silence(DeviceSpec device_spec, unsigned samples_per_frame, unsigned num_frames);
68 // If a given device is offline for whatever reason and cannot deliver audio
69 // (by means of add_audio() or add_silence()), you can call put it in silence mode,
70 // where it will be taken to only output silence. Note that when taking it _out_
71 // of silence mode, the resampler will be reset, so that old audio will not
72 // affect it. Same true/false behavior as add_audio().
73 bool silence_card(DeviceSpec device_spec, bool silence);
75 std::vector<float> get_output(std::chrono::steady_clock::time_point ts, unsigned num_samples, ResamplingQueue::RateAdjustmentPolicy rate_adjustment_policy);
77 float get_fader_volume(unsigned bus_index) const { return fader_volume_db[bus_index]; }
78 void set_fader_volume(unsigned bus_index, float level_db) { fader_volume_db[bus_index] = level_db; }
80 bool get_mute(unsigned bus_index) const { return mute[bus_index]; }
81 void set_mute(unsigned bus_index, bool muted) { mute[bus_index] = muted; }
83 // Note: This operation holds all ALSA devices (see ALSAPool::get_devices()).
84 // You will need to call set_input_mapping() to get the hold state correctly,
85 // or every card will be held forever.
86 std::map<DeviceSpec, DeviceInfo> get_devices();
88 // See comments on ALSAPool::get_card_state().
89 ALSAPool::Device::State get_alsa_card_state(unsigned index)
91 return alsa_pool.get_card_state(index);
94 // See comments on ALSAPool::create_dead_card().
95 DeviceSpec create_dead_card(const std::string &name, const std::string &info, unsigned num_channels)
97 unsigned dead_card_index = alsa_pool.create_dead_card(name, info, num_channels);
98 return DeviceSpec{InputSourceType::ALSA_INPUT, dead_card_index};
101 // NOTE: The display name is not overridden if active == false.
102 void set_device_parameters(DeviceSpec device_spec, const std::string &display_name, CardType card_type, unsigned num_channels, bool active);
103 bool get_active(DeviceSpec device_spec);
105 // Note: The card should be held (currently this isn't enforced, though).
106 void serialize_device(DeviceSpec device_spec, DeviceSpecProto *device_spec_proto);
108 enum class MappingMode {
109 // A single bus, only from a video card (no ALSA devices),
110 // only channel 1 and 2, locked to +0 dB. Note that this is
111 // only an UI abstraction around exactly the same audio code
112 // as MULTICHANNEL; it's just less flexible.
115 // Full, arbitrary mappings.
119 // Automatically sets mapping mode to MappingMode::SIMPLE.
120 void set_simple_input(unsigned card_index);
122 // If mapping mode is not representable as a MappingMode::SIMPLE type
123 // mapping, returns numeric_limits<unsigned>::max().
124 unsigned get_simple_input() const;
126 // Implicitly sets mapping mode to MappingMode::MULTICHANNEL.
127 void set_input_mapping(const InputMapping &input_mapping);
129 MappingMode get_mapping_mode() const;
130 InputMapping get_input_mapping() const;
132 unsigned num_buses() const;
134 void set_locut_cutoff(float cutoff_hz)
136 locut_cutoff_hz = cutoff_hz;
139 float get_locut_cutoff() const
141 return locut_cutoff_hz;
144 void set_locut_enabled(unsigned bus, bool enabled)
146 locut_enabled[bus] = enabled;
149 bool get_locut_enabled(unsigned bus)
151 return locut_enabled[bus];
154 bool is_mono(unsigned bus_index);
156 void set_stereo_width(unsigned bus_index, float width)
158 stereo_width[bus_index] = width;
161 float get_stereo_width(unsigned bus_index)
163 return stereo_width[bus_index];
166 void set_eq(unsigned bus_index, EQBand band, float db_gain)
168 assert(band >= 0 && band < NUM_EQ_BANDS);
169 eq_level_db[bus_index][band] = db_gain;
172 float get_eq(unsigned bus_index, EQBand band) const
174 assert(band >= 0 && band < NUM_EQ_BANDS);
175 return eq_level_db[bus_index][band];
178 float get_limiter_threshold_dbfs() const
180 return limiter_threshold_dbfs;
183 float get_compressor_threshold_dbfs(unsigned bus_index) const
185 return compressor_threshold_dbfs[bus_index];
188 void set_limiter_threshold_dbfs(float threshold_dbfs)
190 limiter_threshold_dbfs = threshold_dbfs;
193 void set_compressor_threshold_dbfs(unsigned bus_index, float threshold_dbfs)
195 compressor_threshold_dbfs[bus_index] = threshold_dbfs;
198 void set_limiter_enabled(bool enabled)
200 limiter_enabled = enabled;
203 bool get_limiter_enabled() const
205 return limiter_enabled;
208 void set_compressor_enabled(unsigned bus_index, bool enabled)
210 compressor_enabled[bus_index] = enabled;
213 bool get_compressor_enabled(unsigned bus_index) const
215 return compressor_enabled[bus_index];
218 void set_gain_staging_db(unsigned bus_index, float gain_db)
220 std::lock_guard<std::mutex> lock(compressor_mutex);
221 level_compressor_enabled[bus_index] = false;
222 gain_staging_db[bus_index] = gain_db;
225 float get_gain_staging_db(unsigned bus_index) const
227 std::lock_guard<std::mutex> lock(compressor_mutex);
228 return gain_staging_db[bus_index];
231 void set_gain_staging_auto(unsigned bus_index, bool enabled)
233 std::lock_guard<std::mutex> lock(compressor_mutex);
234 level_compressor_enabled[bus_index] = enabled;
237 bool get_gain_staging_auto(unsigned bus_index) const
239 std::lock_guard<std::mutex> lock(compressor_mutex);
240 return level_compressor_enabled[bus_index];
243 void set_final_makeup_gain_db(float gain_db)
245 std::lock_guard<std::mutex> lock(compressor_mutex);
246 final_makeup_gain_auto = false;
247 final_makeup_gain = from_db(gain_db);
250 float get_final_makeup_gain_db()
252 std::lock_guard<std::mutex> lock(compressor_mutex);
253 return to_db(final_makeup_gain);
256 void set_final_makeup_gain_auto(bool enabled)
258 std::lock_guard<std::mutex> lock(compressor_mutex);
259 final_makeup_gain_auto = enabled;
262 bool get_final_makeup_gain_auto() const
264 std::lock_guard<std::mutex> lock(compressor_mutex);
265 return final_makeup_gain_auto;
268 void reset_peak(unsigned bus_index);
271 float current_level_dbfs[2]; // Digital peak of last frame, left and right.
272 float peak_level_dbfs[2]; // Digital peak with hold, left and right.
273 float historic_peak_dbfs;
274 float gain_staging_db;
275 float compressor_attenuation_db; // A positive number; 0.0 for no attenuation.
278 typedef std::function<void(float level_lufs, float peak_db,
279 std::vector<BusLevel> bus_levels,
280 float global_level_lufs, float range_low_lufs, float range_high_lufs,
281 float final_makeup_gain_db,
282 float correlation)> audio_level_callback_t;
283 void set_audio_level_callback(audio_level_callback_t callback)
285 audio_level_callback = callback;
288 typedef std::function<void()> state_changed_callback_t;
289 void set_state_changed_callback(state_changed_callback_t callback)
291 state_changed_callback = callback;
294 state_changed_callback_t get_state_changed_callback() const
296 return state_changed_callback;
299 void trigger_state_changed_callback()
301 if (state_changed_callback != nullptr) {
302 state_changed_callback();
306 // A combination of all settings for a bus. Useful if you want to get
307 // or store them as a whole without bothering to call all of the get_*
308 // or set_* functions for that bus.
310 float fader_volume_db;
314 float eq_level_db[NUM_EQ_BANDS];
315 float gain_staging_db;
316 bool level_compressor_enabled;
317 float compressor_threshold_dbfs;
318 bool compressor_enabled;
320 static BusSettings get_default_bus_settings();
321 BusSettings get_bus_settings(unsigned bus_index) const;
322 void set_bus_settings(unsigned bus_index, const BusSettings &settings);
326 std::unique_ptr<ResamplingQueue> resampling_queue;
327 std::string display_name;
328 unsigned capture_frequency = OUTPUT_FREQUENCY;
329 // Which channels we consider interesting (ie., are part of some input_mapping).
330 std::set<unsigned> interesting_channels;
331 bool silenced = false;
333 unsigned num_channels = 2; // Ignored for ALSA cards, which check the device directly.
334 bool active = false; // Only really relevant for capture cards (not ALSA cards).
337 const AudioDevice *find_audio_device(DeviceSpec device_spec) const
339 return const_cast<AudioMixer *>(this)->find_audio_device(device_spec);
342 AudioDevice *find_audio_device(DeviceSpec device_spec);
344 void find_sample_src_from_device(const std::map<DeviceSpec, std::vector<float>> &samples_card, DeviceSpec device_spec, int source_channel, const float **srcptr, unsigned *stride);
345 void fill_audio_bus(const std::map<DeviceSpec, std::vector<float>> &samples_card, const InputMapping::Bus &bus, unsigned num_samples, float stereo_width, float *output);
346 void reset_resampler_mutex_held(DeviceSpec device_spec);
347 void apply_eq(unsigned bus_index, std::vector<float> *samples_bus);
348 void update_meters(const std::vector<float> &samples);
349 void add_bus_to_master(unsigned bus_index, const std::vector<float> &samples_bus, std::vector<float> *samples_out);
350 void measure_bus_levels(unsigned bus_index, const std::vector<float> &left, const std::vector<float> &right);
351 void send_audio_level_callback();
352 std::vector<DeviceSpec> get_active_devices() const;
353 void set_input_mapping_lock_held(const InputMapping &input_mapping);
354 std::string spec_to_string(DeviceSpec device_spec) const;
356 mutable std::timed_mutex audio_mutex;
359 AudioDevice video_cards[MAX_VIDEO_CARDS]; // Under audio_mutex.
360 AudioDevice alsa_inputs[MAX_ALSA_CARDS]; // Under audio_mutex.
362 std::atomic<float> locut_cutoff_hz{120};
363 StereoFilter locut[MAX_BUSES]; // Default cutoff 120 Hz, 24 dB/oct.
364 std::atomic<bool> locut_enabled[MAX_BUSES];
365 StereoFilter eq[MAX_BUSES][NUM_EQ_BANDS]; // The one for EQBand::MID isn't actually used (see comments in apply_eq()).
367 // First compressor; takes us up to about -12 dBFS.
368 mutable std::mutex compressor_mutex;
369 std::unique_ptr<StereoCompressor> level_compressor[MAX_BUSES]; // Under compressor_mutex. Used to set/override gain_staging_db if <level_compressor_enabled>.
370 float gain_staging_db[MAX_BUSES]; // Under compressor_mutex.
371 float last_gain_staging_db[MAX_BUSES]; // Under compressor_mutex.
372 bool level_compressor_enabled[MAX_BUSES]; // Under compressor_mutex.
374 static constexpr float ref_level_dbfs = -14.0f; // Chosen so that we end up around 0 LU in practice.
375 static constexpr float ref_level_lufs = -23.0f; // 0 LU, more or less by definition.
377 StereoCompressor limiter;
378 std::atomic<float> limiter_threshold_dbfs{ref_level_dbfs + 4.0f}; // 4 dB.
379 std::atomic<bool> limiter_enabled{true};
380 std::unique_ptr<StereoCompressor> compressor[MAX_BUSES];
381 std::atomic<float> compressor_threshold_dbfs[MAX_BUSES];
382 std::atomic<bool> compressor_enabled[MAX_BUSES];
384 // Note: The values here are not in dB.
386 float current_level = 0.0f; // Peak of the last frame.
387 float historic_peak = 0.0f; // Highest peak since last reset; no falloff.
388 float current_peak = 0.0f; // Current peak of the peak meter.
389 float last_peak = 0.0f;
390 float age_seconds = 0.0f; // Time since "last_peak" was set.
392 PeakHistory peak_history[MAX_BUSES][2]; // Separate for each channel. Under audio_mutex.
394 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.
395 bool final_makeup_gain_auto = true; // Under compressor_mutex.
397 MappingMode current_mapping_mode; // Under audio_mutex.
398 InputMapping input_mapping; // Under audio_mutex.
399 std::atomic<float> fader_volume_db[MAX_BUSES] {{ 0.0f }};
400 std::atomic<bool> mute[MAX_BUSES] {{ false }};
401 float last_fader_volume_db[MAX_BUSES] { 0.0f }; // Under audio_mutex.
402 std::atomic<float> stereo_width[MAX_BUSES] {{ 0.0f }}; // Default 1.0f (is set in constructor).
403 std::atomic<float> eq_level_db[MAX_BUSES][NUM_EQ_BANDS] {{{ 0.0f }}};
404 float last_eq_level_db[MAX_BUSES][NUM_EQ_BANDS] {{ 0.0f }};
406 audio_level_callback_t audio_level_callback = nullptr;
407 state_changed_callback_t state_changed_callback = nullptr;
408 mutable std::mutex audio_measure_mutex;
409 Ebu_r128_proc r128; // Under audio_measure_mutex.
410 CorrelationMeasurer correlation; // Under audio_measure_mutex.
411 Resampler peak_resampler; // Under audio_measure_mutex.
412 std::atomic<float> peak{0.0f};
415 std::atomic<double> metric_audio_loudness_short_lufs{0.0 / 0.0};
416 std::atomic<double> metric_audio_loudness_integrated_lufs{0.0 / 0.0};
417 std::atomic<double> metric_audio_loudness_range_low_lufs{0.0 / 0.0};
418 std::atomic<double> metric_audio_loudness_range_high_lufs{0.0 / 0.0};
419 std::atomic<double> metric_audio_peak_dbfs{0.0 / 0.0};
420 std::atomic<double> metric_audio_final_makeup_gain_db{0.0};
421 std::atomic<double> metric_audio_correlation{0.0};
423 // These are all gauges corresponding to the elements of BusLevel.
424 // In a sense, they'd probably do better as histograms, but that's an
425 // awful lot of time series when you have many buses.
427 std::vector<std::pair<std::string, std::string>> labels;
428 std::atomic<double> current_level_dbfs[2]{{0.0/0.0},{0.0/0.0}};
429 std::atomic<double> peak_level_dbfs[2]{{0.0/0.0},{0.0/0.0}};
430 std::atomic<double> historic_peak_dbfs{0.0/0.0};
431 std::atomic<double> gain_staging_db{0.0/0.0};
432 std::atomic<double> compressor_attenuation_db{0.0/0.0};
434 std::unique_ptr<BusMetrics[]> bus_metrics; // One for each bus in <input_mapping>.
437 extern AudioMixer *global_audio_mixer;
439 #endif // !defined(_AUDIO_MIXER_H)