1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
|
/*
* Copyright (C) 2011 Google Inc. All rights reserved.
* Copyright (C) 2011, 2015 Ericsson AB. All rights reserved.
* Copyright (C) 2013-2022 Apple Inc. All rights reserved.
* Copyright (C) 2013 Nokia Corporation and/or its subsidiary(-ies).
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#if ENABLE(MEDIA_STREAM)
#include "ActiveDOMObject.h"
#include "DoubleRange.h"
#include "EventTarget.h"
#include "LongRange.h"
#include "MediaProducer.h"
#include "MediaStreamTrackPrivate.h"
#include "MediaTrackCapabilities.h"
#include "MediaTrackConstraints.h"
#include "PlatformMediaSession.h"
#include <wtf/LoggerHelper.h>
namespace WebCore {
class AudioSourceProvider;
class Document;
struct MediaTrackConstraints;
template<typename IDLType> class DOMPromiseDeferred;
class MediaStreamTrack
: public RefCounted<MediaStreamTrack>
, public ActiveDOMObject
, public EventTarget
, private MediaStreamTrackPrivate::Observer
, private PlatformMediaSession::AudioCaptureSource
#if !RELEASE_LOG_DISABLED
, private LoggerHelper
#endif
{
WTF_MAKE_ISO_ALLOCATED(MediaStreamTrack);
public:
class Observer {
public:
virtual ~Observer() = default;
virtual void trackDidEnd() = 0;
};
static Ref<MediaStreamTrack> create(ScriptExecutionContext&, Ref<MediaStreamTrackPrivate>&&);
virtual ~MediaStreamTrack();
static void endCapture(Document&, MediaProducerMediaCaptureKind);
static MediaProducerMediaStateFlags captureState(Document&);
static void updateCaptureAccordingToMutedState(Document&);
virtual bool isCanvas() const { return false; }
const AtomString& kind() const;
WEBCORE_EXPORT const String& id() const;
const String& label() const;
const AtomString& contentHint() const;
void setContentHint(const String&);
bool enabled() const;
void setEnabled(bool);
bool muted() const;
bool mutedForBindings() const;
enum class State { Live, Ended };
State readyState() const { return m_readyState; }
bool ended() const;
virtual RefPtr<MediaStreamTrack> clone();
enum class StopMode { Silently, PostEvent };
void stopTrack(StopMode = StopMode::Silently);
bool isCaptureTrack() const { return m_isCaptureTrack; }
bool isVideo() const { return m_private->isVideo(); }
bool isAudio() const { return m_private->isAudio(); }
struct TrackSettings {
std::optional<int> width;
std::optional<int> height;
std::optional<double> aspectRatio;
std::optional<double> frameRate;
String facingMode;
std::optional<double> volume;
std::optional<int> sampleRate;
std::optional<int> sampleSize;
std::optional<bool> echoCancellation;
String displaySurface;
String deviceId;
String groupId;
std::optional<double> zoom;
};
TrackSettings getSettings() const;
using TrackCapabilities = MediaTrackCapabilities;
TrackCapabilities getCapabilities() const;
const MediaTrackConstraints& getConstraints() const { return m_constraints; }
void setConstraints(MediaTrackConstraints&& constraints) { m_constraints = WTFMove(constraints); }
void applyConstraints(const std::optional<MediaTrackConstraints>&, DOMPromiseDeferred<void>&&);
RealtimeMediaSource& source() const { return m_private->source(); }
MediaStreamTrackPrivate& privateTrack() { return m_private.get(); }
const MediaStreamTrackPrivate& privateTrack() const { return m_private.get(); }
RefPtr<WebAudioSourceProvider> createAudioSourceProvider();
MediaProducerMediaStateFlags mediaState() const;
void addObserver(Observer&);
void removeObserver(Observer&);
using RefCounted::ref;
using RefCounted::deref;
void setIdForTesting(String&& id) { m_private->setIdForTesting(WTFMove(id)); }
#if !RELEASE_LOG_DISABLED
const Logger& logger() const final { return m_private->logger(); }
const void* logIdentifier() const final { return m_private->logIdentifier(); }
#endif
void setShouldFireMuteEventImmediately(bool value) { m_shouldFireMuteEventImmediately = value; }
protected:
MediaStreamTrack(ScriptExecutionContext&, Ref<MediaStreamTrackPrivate>&&);
ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
Ref<MediaStreamTrackPrivate> m_private;
private:
explicit MediaStreamTrack(MediaStreamTrack&);
void configureTrackRendering();
void updateToPageMutedState();
// ActiveDOMObject API.
void stop() final { stopTrack(); }
const char* activeDOMObjectName() const override;
void suspend(ReasonForSuspension) final;
bool virtualHasPendingActivity() const final;
// EventTarget
void refEventTarget() final { ref(); }
void derefEventTarget() final { deref(); }
EventTargetInterface eventTargetInterface() const final { return MediaStreamTrackEventTargetInterfaceType; }
// MediaStreamTrackPrivate::Observer
void trackStarted(MediaStreamTrackPrivate&) final;
void trackEnded(MediaStreamTrackPrivate&) final;
void trackMutedChanged(MediaStreamTrackPrivate&) final;
void trackSettingsChanged(MediaStreamTrackPrivate&) final;
void trackEnabledChanged(MediaStreamTrackPrivate&) final;
void trackConfigurationChanged(MediaStreamTrackPrivate&) final;
// PlatformMediaSession::AudioCaptureSource
bool isCapturingAudio() const final;
void updateVideoCaptureAccordingMicrophoneInterruption(Document&, bool);
#if !RELEASE_LOG_DISABLED
const char* logClassName() const final { return "MediaStreamTrack"; }
WTFLogChannel& logChannel() const final;
#endif
Vector<Observer*> m_observers;
MediaTrackConstraints m_constraints;
String m_groupId;
State m_readyState { State::Live };
bool m_muted { false };
bool m_ended { false };
const bool m_isCaptureTrack { false };
bool m_isInterrupted { false };
bool m_shouldFireMuteEventImmediately { false };
};
typedef Vector<Ref<MediaStreamTrack>> MediaStreamTrackVector;
} // namespace WebCore
#endif // ENABLE(MEDIA_STREAM)
|