diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 17:32:43 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 17:32:43 +0000 |
commit | 6bf0a5cb5034a7e684dcc3500e841785237ce2dd (patch) | |
tree | a68f146d7fa01f0134297619fbe7e33db084e0aa /third_party/libwebrtc/pc/dtmf_sender.h | |
parent | Initial commit. (diff) | |
download | thunderbird-upstream.tar.xz thunderbird-upstream.zip |
Adding upstream version 1:115.7.0.upstream/1%115.7.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/libwebrtc/pc/dtmf_sender.h')
-rw-r--r-- | third_party/libwebrtc/pc/dtmf_sender.h | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/third_party/libwebrtc/pc/dtmf_sender.h b/third_party/libwebrtc/pc/dtmf_sender.h new file mode 100644 index 0000000000..c99c7bee50 --- /dev/null +++ b/third_party/libwebrtc/pc/dtmf_sender.h @@ -0,0 +1,118 @@ +/* + * Copyright 2012 The WebRTC project authors. All Rights Reserved. + * + * Use of this source code is governed by a BSD-style license + * that can be found in the LICENSE file in the root of the source + * tree. An additional intellectual property rights grant can be found + * in the file PATENTS. All contributing project authors may + * be found in the AUTHORS file in the root of the source tree. + */ + +#ifndef PC_DTMF_SENDER_H_ +#define PC_DTMF_SENDER_H_ + +#include <stdint.h> + +#include <string> + +#include "api/dtmf_sender_interface.h" +#include "api/scoped_refptr.h" +#include "api/sequence_checker.h" +#include "api/task_queue/pending_task_safety_flag.h" +#include "api/task_queue/task_queue_base.h" +#include "pc/proxy.h" +#include "rtc_base/ref_count.h" +#include "rtc_base/thread_annotations.h" + +// DtmfSender is the native implementation of the RTCDTMFSender defined by +// the WebRTC W3C Editor's Draft. +// https://w3c.github.io/webrtc-pc/#rtcdtmfsender + +namespace webrtc { + +// This interface is called by DtmfSender to talk to the actual audio channel +// to send DTMF. +class DtmfProviderInterface { + public: + // Returns true if the audio sender is capable of sending DTMF. Otherwise + // returns false. + virtual bool CanInsertDtmf() = 0; + // Sends DTMF `code`. + // The `duration` indicates the length of the DTMF tone in ms. + // Returns true on success and false on failure. + virtual bool InsertDtmf(int code, int duration) = 0; + + protected: + virtual ~DtmfProviderInterface() {} +}; + +class DtmfSender : public DtmfSenderInterface { + public: + static rtc::scoped_refptr<DtmfSender> Create(TaskQueueBase* signaling_thread, + DtmfProviderInterface* provider); + + void OnDtmfProviderDestroyed(); + + // Implements DtmfSenderInterface. + void RegisterObserver(DtmfSenderObserverInterface* observer) override; + void UnregisterObserver() override; + bool CanInsertDtmf() override; + bool InsertDtmf(const std::string& tones, + int duration, + int inter_tone_gap, + int comma_delay = kDtmfDefaultCommaDelayMs) override; + std::string tones() const override; + int duration() const override; + int inter_tone_gap() const override; + int comma_delay() const override; + + protected: + DtmfSender(TaskQueueBase* signaling_thread, DtmfProviderInterface* provider); + virtual ~DtmfSender(); + + DtmfSender(const DtmfSender&) = delete; + DtmfSender& operator=(const DtmfSender&) = delete; + + private: + DtmfSender(); + + void QueueInsertDtmf(uint32_t delay_ms) RTC_RUN_ON(signaling_thread_); + + // The DTMF sending task. + void DoInsertDtmf() RTC_RUN_ON(signaling_thread_); + + void StopSending() RTC_RUN_ON(signaling_thread_); + + DtmfSenderObserverInterface* observer_ RTC_GUARDED_BY(signaling_thread_); + TaskQueueBase* const signaling_thread_; + DtmfProviderInterface* provider_ RTC_GUARDED_BY(signaling_thread_); + std::string tones_ RTC_GUARDED_BY(signaling_thread_); + int duration_ RTC_GUARDED_BY(signaling_thread_); + int inter_tone_gap_ RTC_GUARDED_BY(signaling_thread_); + int comma_delay_ RTC_GUARDED_BY(signaling_thread_); + + // For cancelling the tasks which feed the DTMF provider one tone at a time. + rtc::scoped_refptr<PendingTaskSafetyFlag> safety_flag_ RTC_GUARDED_BY( + signaling_thread_) RTC_PT_GUARDED_BY(signaling_thread_) = nullptr; +}; + +// Define proxy for DtmfSenderInterface. +BEGIN_PRIMARY_PROXY_MAP(DtmfSender) + +PROXY_PRIMARY_THREAD_DESTRUCTOR() +PROXY_METHOD1(void, RegisterObserver, DtmfSenderObserverInterface*) +PROXY_METHOD0(void, UnregisterObserver) +PROXY_METHOD0(bool, CanInsertDtmf) +PROXY_METHOD4(bool, InsertDtmf, const std::string&, int, int, int) +PROXY_CONSTMETHOD0(std::string, tones) +PROXY_CONSTMETHOD0(int, duration) +PROXY_CONSTMETHOD0(int, inter_tone_gap) +PROXY_CONSTMETHOD0(int, comma_delay) +END_PROXY_MAP(DtmfSender) + +// Get DTMF code from the DTMF event character. +bool GetDtmfCode(char tone, int* code); + +} // namespace webrtc + +#endif // PC_DTMF_SENDER_H_ |