tdesktop/Telegram/lib_webrtc/webrtc/details/webrtc_openal_adm.h

// This file is part of Desktop App Toolkit,
// a set of libraries for developing nice desktop applications.
//
// For license and copyright information please follow this link:
// https://github.com/desktop-app/legal/blob/master/LEGAL
//
#pragma once

#include "webrtc/webrtc_device_common.h"

#include <modules/audio_device/include/audio_device.h>
#include <modules/audio_device/audio_device_buffer.h>

#include <crl/crl_time.h>
#include <al.h>
#include <alc.h>
#include <atomic>

#include <QtCore/QMutex>

namespace rtc {
class Thread;
} // namespace rtc

namespace Webrtc::details {

struct DeviceResolvedIds {
	QMutex mutex;
	DeviceResolvedId playback{ .type = DeviceType::Playback };
	DeviceResolvedId capture{ .type = DeviceType::Capture };
};

class AudioDeviceOpenAL : public webrtc::AudioDeviceModule {
public:
	explicit AudioDeviceOpenAL(webrtc::TaskQueueFactory *taskQueueFactory);
	~AudioDeviceOpenAL();

	[[nodiscard]] Fn<void(DeviceResolvedId)> setDeviceIdCallback();

	int32_t ActiveAudioLayer(AudioLayer *audioLayer) const override;
	int32_t RegisterAudioCallback(
		webrtc::AudioTransport *audioCallback) override;

	// Main initialization and termination
	int32_t Init() override;
	int32_t Terminate() override;
	bool Initialized() const override;

	// Device enumeration
	int16_t PlayoutDevices() override;
	int16_t RecordingDevices() override;
	int32_t PlayoutDeviceName(uint16_t index,
		char name[webrtc::kAdmMaxDeviceNameSize],
		char guid[webrtc::kAdmMaxGuidSize]) override;
	int32_t RecordingDeviceName(uint16_t index,
		char name[webrtc::kAdmMaxDeviceNameSize],
		char guid[webrtc::kAdmMaxGuidSize]) override;

	// Device selection
	int32_t SetPlayoutDevice(uint16_t index) override;
	int32_t SetPlayoutDevice(WindowsDeviceType device) override;
	int32_t SetRecordingDevice(uint16_t index) override;
	int32_t SetRecordingDevice(WindowsDeviceType device) override;

	// Audio transport initialization
	int32_t PlayoutIsAvailable(bool *available) override;
	int32_t InitPlayout() override;
	bool PlayoutIsInitialized() const override;
	int32_t RecordingIsAvailable(bool *available) override;
	int32_t InitRecording() override;
	bool RecordingIsInitialized() const override;

	// Audio transport control
	int32_t StartPlayout() override;
	int32_t StopPlayout() override;
	bool Playing() const override;
	int32_t StartRecording() override;
	int32_t StopRecording() override;
	bool Recording() const override;

	// Audio mixer initialization
	int32_t InitSpeaker() override;
	bool SpeakerIsInitialized() const override;
	int32_t InitMicrophone() override;
	bool MicrophoneIsInitialized() const override;

	// Speaker volume controls
	int32_t SpeakerVolumeIsAvailable(bool *available) override;
	int32_t SetSpeakerVolume(uint32_t volume) override;
	int32_t SpeakerVolume(uint32_t *volume) const override;
	int32_t MaxSpeakerVolume(uint32_t *maxVolume) const override;
	int32_t MinSpeakerVolume(uint32_t *minVolume) const override;

	// Microphone volume controls
	int32_t MicrophoneVolumeIsAvailable(bool *available) override;
	int32_t SetMicrophoneVolume(uint32_t volume) override;
	int32_t MicrophoneVolume(uint32_t *volume) const override;
	int32_t MaxMicrophoneVolume(uint32_t *maxVolume) const override;
	int32_t MinMicrophoneVolume(uint32_t *minVolume) const override;

	// Microphone mute control
	int32_t MicrophoneMuteIsAvailable(bool *available) override;
	int32_t SetMicrophoneMute(bool enable) override;
	int32_t MicrophoneMute(bool *enabled) const override;

	// Speaker mute control
	int32_t SpeakerMuteIsAvailable(bool *available) override;
	int32_t SetSpeakerMute(bool enable) override;
	int32_t SpeakerMute(bool *enabled) const override;

	// Stereo support
	int32_t StereoPlayoutIsAvailable(bool *available) const override;
	int32_t SetStereoPlayout(bool enable) override;
	int32_t StereoPlayout(bool *enabled) const override;
	int32_t StereoRecordingIsAvailable(bool *available) const override;
	int32_t SetStereoRecording(bool enable) override;
	int32_t StereoRecording(bool *enabled) const override;

	// Delay information and control
	int32_t PlayoutDelay(uint16_t *delayMS) const override;

	// Only supported on Android.
	bool BuiltInAECIsAvailable() const override;
	bool BuiltInAGCIsAvailable() const override;
	bool BuiltInNSIsAvailable() const override;

	// Enables the built-in audio effects. Only supported on Android.
	int32_t EnableBuiltInAEC(bool enable) override;
	int32_t EnableBuiltInAGC(bool enable) override;
	int32_t EnableBuiltInNS(bool enable) override;

private:
	struct Data;
	struct ExactQueuedTime {
		crl::time now = 0;
		crl::time queued = 0;
	};

	template <typename Callback>
	std::invoke_result_t<Callback> sync(Callback &&callback);

	void openRecordingDevice();
	void openPlayoutDevice();
	void closeRecordingDevice();

	// NB! stopPlayingOnThread should be called before this,
	// to clear the thread local context and event callback.
	void closePlayoutDevice();

	int restartPlayout();
	int restartRecording();
	void restartRecordingQueued();
	void restartPlayoutQueued();

	void ensureThreadStarted();
	void startCaptureOnThread();
	void stopCaptureOnThread();
	void startPlayingOnThread();

	// NB! closePlayoutDevice should be called after this, so that next time
	// we start playing, we set the thread local context and event callback.
	void stopPlayingOnThread();

	void processData();
	void processRecordingData();
	void processPlayoutData();
	bool processRecordedPart(bool firstInCycle);

	void clearProcessedBuffers();
	bool clearProcessedBuffer();
	void unqueueAllBuffers();

	void handleEvent(
		ALenum eventType,
		ALuint object,
		ALuint param,
		ALsizei length,
		const ALchar *message);

	[[nodiscard]] crl::time countExactQueuedMsForLatency(
		crl::time now,
		bool playing);
	[[nodiscard]] crl::time queryRecordingLatencyMs();

	rtc::Thread *_thread = nullptr;
	webrtc::AudioDeviceBuffer _audioDeviceBuffer;
	std::unique_ptr<Data> _data;

	std::shared_ptr<DeviceResolvedIds> _deviceResolvedIds;

	ALCdevice *_playoutDevice = nullptr;
	ALCcontext *_playoutContext = nullptr;
	crl::time _playoutLatency = 0;
	int _playoutChannels = 2;
	bool _playoutInitialized = false;
	bool _playoutFailed = false;

	ALCdevice *_recordingDevice = nullptr;
	crl::time _recordingLatency = 0;
	bool _recordingInitialized = false;
	bool _recordingFailed = false;

	bool _speakerInitialized = false;
	bool _microphoneInitialized = false;
	bool _initialized = false;

};

} // namespace Webrtc::details