[WTF] Import std::optional reference implementation as WTF::Optional
[WebKit-https.git] / Source / WebCore / Modules / mediastream / RTCDTMFSender.cpp
1 /*
2  * Copyright (C) 2013 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY GOOGLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL GOOGLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27
28 #if ENABLE(WEB_RTC)
29
30 #include "RTCDTMFSender.h"
31
32 #include "MediaStreamTrack.h"
33 #include "RTCDTMFSenderHandler.h"
34 #include "RTCDTMFToneChangeEvent.h"
35 #include "RTCPeerConnectionHandler.h"
36 #include "ScriptExecutionContext.h"
37
38 namespace WebCore {
39
40 static const long minToneDurationMs = 40;
41 static const long defaultToneDurationMs = 100;
42 static const long maxToneDurationMs = 6000;
43 static const long minInterToneGapMs = 30;
44 static const long defaultInterToneGapMs = 70;
45
46 ExceptionOr<Ref<RTCDTMFSender>> RTCDTMFSender::create(ScriptExecutionContext* context, RTCPeerConnectionHandler* peerConnectionHandler, RefPtr<MediaStreamTrack>&& track)
47 {
48     auto handler = peerConnectionHandler->createDTMFSender(&track->source());
49     if (!handler)
50         return Exception { NOT_SUPPORTED_ERR };
51
52     auto sender = adoptRef(*new RTCDTMFSender(*context, WTFMove(track), WTFMove(handler)));
53     sender->suspendIfNeeded();
54     return WTFMove(sender);
55 }
56
57 RTCDTMFSender::RTCDTMFSender(ScriptExecutionContext& context, RefPtr<MediaStreamTrack>&& track, std::unique_ptr<RTCDTMFSenderHandler> handler)
58     : ActiveDOMObject(&context)
59     , m_track(WTFMove(track))
60     , m_duration(defaultToneDurationMs)
61     , m_interToneGap(defaultInterToneGapMs)
62     , m_handler(WTFMove(handler))
63     , m_stopped(false)
64     , m_scheduledEventTimer(*this, &RTCDTMFSender::scheduledEventTimerFired)
65 {
66     m_handler->setClient(this);
67 }
68
69 RTCDTMFSender::~RTCDTMFSender()
70 {
71 }
72
73 bool RTCDTMFSender::canInsertDTMF() const
74 {
75     return m_handler->canInsertDTMF();
76 }
77
78 MediaStreamTrack* RTCDTMFSender::track() const
79 {
80     return m_track.get();
81 }
82
83 String RTCDTMFSender::toneBuffer() const
84 {
85     return m_handler->currentToneBuffer();
86 }
87
88 ExceptionOr<void> RTCDTMFSender::insertDTMF(const String& tones, std::optional<int> duration, std::optional<int> interToneGap)
89 {
90     if (!canInsertDTMF())
91         return Exception { NOT_SUPPORTED_ERR };
92
93     if (duration && (duration.value() > maxToneDurationMs || duration.value() < minToneDurationMs))
94         return Exception { SYNTAX_ERR };
95
96     if (interToneGap && interToneGap.value() < minInterToneGapMs)
97         return Exception { SYNTAX_ERR };
98
99     m_duration = duration.value_or(defaultToneDurationMs);
100     m_interToneGap = interToneGap.value_or(defaultInterToneGapMs);
101
102     if (!m_handler->insertDTMF(tones, m_duration, m_interToneGap))
103         return Exception { SYNTAX_ERR };
104
105     return { };
106 }
107
108 void RTCDTMFSender::didPlayTone(const String& tone)
109 {
110     scheduleDispatchEvent(RTCDTMFToneChangeEvent::create(tone));
111 }
112
113 void RTCDTMFSender::stop()
114 {
115     m_stopped = true;
116     m_handler->setClient(nullptr);
117 }
118
119 const char* RTCDTMFSender::activeDOMObjectName() const
120 {
121     return "RTCDTMFSender";
122 }
123
124 bool RTCDTMFSender::canSuspendForDocumentSuspension() const
125 {
126     // FIXME: We should try and do better here.
127     return false;
128 }
129
130 void RTCDTMFSender::scheduleDispatchEvent(Ref<Event>&& event)
131 {
132     m_scheduledEvents.append(WTFMove(event));
133
134     if (!m_scheduledEventTimer.isActive())
135         m_scheduledEventTimer.startOneShot(0);
136 }
137
138 void RTCDTMFSender::scheduledEventTimerFired()
139 {
140     if (m_stopped)
141         return;
142
143     Vector<Ref<Event>> events;
144     events.swap(m_scheduledEvents);
145
146     for (auto& event : events)
147         dispatchEvent(event);
148 }
149
150 } // namespace WebCore
151
152 #endif // ENABLE(WEB_RTC)