[MediaStream] Simplify logic when changing RealtimeMediaSource settings
[WebKit-https.git] / Source / WebCore / platform / mediastream / mac / DisplayCaptureSourceCocoa.cpp
1 /*
2  * Copyright (C) 2017-2018 Apple 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 APPLE 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 APPLE 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 #include "DisplayCaptureSourceCocoa.h"
28
29 #if ENABLE(MEDIA_STREAM)
30
31 #include "Logging.h"
32 #include "RealtimeMediaSource.h"
33 #include "RealtimeMediaSourceCenter.h"
34 #include "RealtimeMediaSourceSettings.h"
35 #include "Timer.h"
36 #include <CoreMedia/CMSync.h>
37 #include <mach/mach_time.h>
38 #include <pal/avfoundation/MediaTimeAVFoundation.h>
39 #include <pal/cf/CoreMediaSoftLink.h>
40 #include <pal/spi/cf/CoreAudioSPI.h>
41 #include <sys/time.h>
42 #include <wtf/MainThread.h>
43 #include <wtf/NeverDestroyed.h>
44
45 #include "CoreVideoSoftLink.h"
46
47 namespace WebCore {
48 using namespace PAL;
49
50 DisplayCaptureSourceCocoa::DisplayCaptureSourceCocoa(const String& name)
51     : RealtimeMediaSource("", Type::Video, name)
52     , m_timer(RunLoop::current(), this, &DisplayCaptureSourceCocoa::emitFrame)
53 {
54 }
55
56 DisplayCaptureSourceCocoa::~DisplayCaptureSourceCocoa()
57 {
58 #if PLATFORM(IOS)
59     RealtimeMediaSourceCenter::singleton().videoFactory().unsetActiveSource(*this);
60 #endif
61 }
62
63 const RealtimeMediaSourceCapabilities& DisplayCaptureSourceCocoa::capabilities() const
64 {
65     if (!m_capabilities) {
66         RealtimeMediaSourceCapabilities capabilities(settings().supportedConstraints());
67
68         // FIXME: what should these be?
69         capabilities.setWidth(CapabilityValueOrRange(72, 2880));
70         capabilities.setHeight(CapabilityValueOrRange(45, 1800));
71         capabilities.setFrameRate(CapabilityValueOrRange(.01, 60.0));
72
73         m_capabilities = WTFMove(capabilities);
74     }
75     return m_capabilities.value();
76 }
77
78 const RealtimeMediaSourceSettings& DisplayCaptureSourceCocoa::settings() const
79 {
80     if (!m_currentSettings) {
81         RealtimeMediaSourceSettings settings;
82         settings.setFrameRate(frameRate());
83         auto size = this->size();
84         if (size.width() && size.height()) {
85             settings.setWidth(size.width());
86             settings.setHeight(size.height());
87         }
88
89         RealtimeMediaSourceSupportedConstraints supportedConstraints;
90         supportedConstraints.setSupportsFrameRate(true);
91         supportedConstraints.setSupportsWidth(true);
92         supportedConstraints.setSupportsHeight(true);
93         supportedConstraints.setSupportsAspectRatio(true);
94         settings.setSupportedConstraints(supportedConstraints);
95
96         m_currentSettings = WTFMove(settings);
97     }
98     return m_currentSettings.value();
99 }
100
101 void DisplayCaptureSourceCocoa::settingsDidChange(OptionSet<RealtimeMediaSourceSettings::Flag> settings)
102 {
103     if (settings.contains(RealtimeMediaSourceSettings::Flag::FrameRate) && m_timer.isActive())
104         m_timer.startRepeating(1_s / frameRate());
105
106     if (settings.containsAny({ RealtimeMediaSourceSettings::Flag::Width, RealtimeMediaSourceSettings::Flag::Height }))
107         m_bufferAttributes = nullptr;
108
109     m_currentSettings = std::nullopt;
110
111     RealtimeMediaSource::settingsDidChange(settings);
112 }
113
114 void DisplayCaptureSourceCocoa::startProducingData()
115 {
116 #if PLATFORM(IOS)
117     RealtimeMediaSourceCenter::singleton().videoFactory().setActiveSource(*this);
118 #endif
119
120     m_startTime = MonotonicTime::now();
121     m_timer.startRepeating(1_s / frameRate());
122 }
123
124 void DisplayCaptureSourceCocoa::stopProducingData()
125 {
126     m_timer.stop();
127     m_elapsedTime += MonotonicTime::now() - m_startTime;
128     m_startTime = MonotonicTime::nan();
129 }
130
131 Seconds DisplayCaptureSourceCocoa::elapsedTime()
132 {
133     if (std::isnan(m_startTime))
134         return m_elapsedTime;
135
136     return m_elapsedTime + (MonotonicTime::now() - m_startTime);
137 }
138
139 void DisplayCaptureSourceCocoa::emitFrame()
140 {
141     if (muted())
142         return;
143
144     generateFrame();
145 }
146
147 RetainPtr<CMSampleBufferRef> DisplayCaptureSourceCocoa::sampleBufferFromPixelBuffer(CVPixelBufferRef pixelBuffer)
148 {
149     if (!pixelBuffer)
150         return nullptr;
151
152     CMTime sampleTime = CMTimeMake(((elapsedTime() + 100_ms) * 100).seconds(), 100);
153     CMSampleTimingInfo timingInfo = { kCMTimeInvalid, sampleTime, sampleTime };
154
155     CMVideoFormatDescriptionRef formatDescription = nullptr;
156     auto status = CMVideoFormatDescriptionCreateForImageBuffer(kCFAllocatorDefault, (CVImageBufferRef)pixelBuffer, &formatDescription);
157     if (status) {
158         RELEASE_LOG(Media, "Failed to initialize CMVideoFormatDescription with error code: %d", static_cast<int>(status));
159         return nullptr;
160     }
161
162     CMSampleBufferRef sampleBuffer;
163     status = CMSampleBufferCreateReadyWithImageBuffer(kCFAllocatorDefault, (CVImageBufferRef)pixelBuffer, formatDescription, &timingInfo, &sampleBuffer);
164     CFRelease(formatDescription);
165     if (status) {
166         RELEASE_LOG(Media, "Failed to initialize CMSampleBuffer with error code: %d", static_cast<int>(status));
167         return nullptr;
168     }
169
170     return adoptCF(sampleBuffer);
171 }
172
173 #if HAVE(IOSURFACE) && PLATFORM(MAC)
174 static int32_t roundUpToMacroblockMultiple(int32_t size)
175 {
176     return (size + 15) & ~15;
177 }
178
179 RetainPtr<CVPixelBufferRef> DisplayCaptureSourceCocoa::pixelBufferFromIOSurface(IOSurfaceRef surface)
180 {
181     if (!m_bufferAttributes) {
182         m_bufferAttributes = adoptCF(CFDictionaryCreateMutable(nullptr, 0, &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks));
183
184         auto format = IOSurfaceGetPixelFormat(surface);
185         if (format == kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange || format == kCVPixelFormatType_420YpCbCr8BiPlanarFullRange) {
186
187             // If the width x height isn't a multiple of 16 x 16 and the surface has extra memory in the planes, set pixel buffer attributes to reflect it.
188             auto width = IOSurfaceGetWidth(surface);
189             auto height = IOSurfaceGetHeight(surface);
190             int32_t extendedRight = roundUpToMacroblockMultiple(width) - width;
191             int32_t extendedBottom = roundUpToMacroblockMultiple(height) - height;
192
193             if ((IOSurfaceGetBytesPerRowOfPlane(surface, 0) >= width + extendedRight)
194                 && (IOSurfaceGetBytesPerRowOfPlane(surface, 1) >= width + extendedRight)
195                 && (IOSurfaceGetAllocSize(surface) >= (height + extendedBottom) * IOSurfaceGetBytesPerRowOfPlane(surface, 0) * 3 / 2)) {
196                 auto cfInt = adoptCF(CFNumberCreate(nullptr,  kCFNumberIntType,  &extendedRight));
197                 CFDictionarySetValue(m_bufferAttributes.get(), kCVPixelBufferExtendedPixelsRightKey, cfInt.get());
198                 cfInt = adoptCF(CFNumberCreate(nullptr,  kCFNumberIntType,  &extendedBottom));
199                 CFDictionarySetValue(m_bufferAttributes.get(), kCVPixelBufferExtendedPixelsBottomKey, cfInt.get());
200             }
201         }
202
203         CFDictionarySetValue(m_bufferAttributes.get(), kCVPixelBufferOpenGLCompatibilityKey, kCFBooleanTrue);
204     }
205
206     CVPixelBufferRef pixelBuffer;
207     auto status = CVPixelBufferCreateWithIOSurface(kCFAllocatorDefault, surface, m_bufferAttributes.get(), &pixelBuffer);
208     if (status) {
209         RELEASE_LOG(Media, "CVPixelBufferCreateWithIOSurface failed with error code: %d", static_cast<int>(status));
210         return nullptr;
211     }
212
213     return adoptCF(pixelBuffer);
214 }
215 #endif
216
217 } // namespace WebCore
218
219 #endif // ENABLE(MEDIA_STREAM)