MediaStreamTrack.h [plain text]
#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 "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 EventTargetWithInlineData
, 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&);
static MediaProducer::MediaStateFlags 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;
bool ended() const;
virtual RefPtr<MediaStreamTrack> clone();
enum class StopMode { Silently, PostEvent };
void stopTrack(StopMode = StopMode::Silently);
bool isCaptureTrack() const { return m_isCaptureTrack; }
struct TrackSettings {
Optional<int> width;
Optional<int> height;
Optional<double> aspectRatio;
Optional<double> frameRate;
String facingMode;
Optional<double> volume;
Optional<int> sampleRate;
Optional<int> sampleSize;
Optional<bool> echoCancellation;
Optional<bool> displaySurface;
String logicalSurface;
String deviceId;
String groupId;
};
TrackSettings getSettings() const;
struct TrackCapabilities {
Optional<LongRange> width;
Optional<LongRange> height;
Optional<DoubleRange> aspectRatio;
Optional<DoubleRange> frameRate;
Optional<Vector<String>> facingMode;
Optional<DoubleRange> volume;
Optional<LongRange> sampleRate;
Optional<LongRange> sampleSize;
Optional<Vector<bool>> echoCancellation;
String deviceId;
String groupId;
};
TrackCapabilities getCapabilities() const;
const MediaTrackConstraints& getConstraints() const { return m_constraints; }
void applyConstraints(const Optional<MediaTrackConstraints>&, DOMPromiseDeferred<void>&&);
RealtimeMediaSource& source() const { return m_private->source(); }
MediaStreamTrackPrivate& privateTrack() { return m_private.get(); }
AudioSourceProvider* audioSourceProvider();
MediaProducer::MediaStateFlags mediaState() const;
void addObserver(Observer&);
void removeObserver(Observer&);
using RefCounted::ref;
using RefCounted::deref;
void setIdForTesting(String&& id) { m_private->setIdForTesting(WTFMove(id)); }
Document* document() const;
#if !RELEASE_LOG_DISABLED
const Logger& logger() const final { return m_private->logger(); }
const void* logIdentifier() const final { return m_private->logIdentifier(); }
#endif
protected:
MediaStreamTrack(ScriptExecutionContext&, Ref<MediaStreamTrackPrivate>&&);
ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
Ref<MediaStreamTrackPrivate> m_private;
private:
explicit MediaStreamTrack(MediaStreamTrack&);
void configureTrackRendering();
void updateToPageMutedState();
void stop() final { stopTrack(); }
const char* activeDOMObjectName() const override;
void suspend(ReasonForSuspension) final;
bool virtualHasPendingActivity() const final;
void refEventTarget() final { ref(); }
void derefEventTarget() final { deref(); }
EventTargetInterface eventTargetInterface() const final { return MediaStreamTrackEventTargetInterfaceType; }
void trackStarted(MediaStreamTrackPrivate&) final;
void trackEnded(MediaStreamTrackPrivate&) final;
void trackMutedChanged(MediaStreamTrackPrivate&) final;
void trackSettingsChanged(MediaStreamTrackPrivate&) final;
void trackEnabledChanged(MediaStreamTrackPrivate&) final;
bool isCapturingAudio() const final;
#if !RELEASE_LOG_DISABLED
const char* logClassName() const final { return "MediaStreamTrack"; }
WTFLogChannel& logChannel() const final;
#endif
Vector<Observer*> m_observers;
MediaTrackConstraints m_constraints;
std::unique_ptr<DOMPromiseDeferred<void>> m_promise;
bool m_muted { false };
bool m_ended { false };
const bool m_isCaptureTrack { false };
};
typedef Vector<RefPtr<MediaStreamTrack>> MediaStreamTrackVector;
}
#endif // ENABLE(MEDIA_STREAM)