blob: f9b5d101514e71f23c7b6a3af2ce21690d4e52b3 [file] [log] [blame]
/*
* Copyright (C) 2013 Nokia Corporation and/or its subsidiary(-ies).
* Copyright (C) 2015 Ericsson AB. All rights reserved.
* Copyright (C) 2013-2019 Apple Inc. All rights reserved.
*
* 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 THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT
* OWNER OR 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 "RealtimeMediaSource.h"
#include <wtf/LoggerHelper.h>
#include <wtf/RefCounted.h>
#include <wtf/WeakPtr.h>
namespace WebCore {
class AudioSourceProvider;
class GraphicsContext;
class MediaSample;
class RealtimeMediaSourceCapabilities;
class WebAudioSourceProvider;
class MediaStreamTrackPrivate final
: public RefCounted<MediaStreamTrackPrivate>
, public CanMakeWeakPtr<MediaStreamTrackPrivate, WeakPtrFactoryInitialization::Eager>
, public RealtimeMediaSource::Observer
#if !RELEASE_LOG_DISABLED
, public LoggerHelper
#endif
{
public:
class Observer {
public:
virtual ~Observer() = default;
virtual void trackStarted(MediaStreamTrackPrivate&) { };
virtual void trackEnded(MediaStreamTrackPrivate&) = 0;
virtual void trackMutedChanged(MediaStreamTrackPrivate&) = 0;
virtual void trackSettingsChanged(MediaStreamTrackPrivate&) = 0;
virtual void trackEnabledChanged(MediaStreamTrackPrivate&) = 0;
virtual void sampleBufferUpdated(MediaStreamTrackPrivate&, MediaSample&) { };
virtual void readyStateChanged(MediaStreamTrackPrivate&) { };
// May get called on a background thread.
virtual void audioSamplesAvailable(MediaStreamTrackPrivate&, const MediaTime&, const PlatformAudioData&, const AudioStreamDescription&, size_t) { };
};
static Ref<MediaStreamTrackPrivate> create(Ref<const Logger>&&, Ref<RealtimeMediaSource>&&);
static Ref<MediaStreamTrackPrivate> create(Ref<const Logger>&&, Ref<RealtimeMediaSource>&&, String&& id);
virtual ~MediaStreamTrackPrivate();
const String& id() const { return m_id; }
const String& label() const;
bool isActive() const { return enabled() && !ended() && !muted(); }
bool ended() const { return m_isEnded; }
enum class HintValue { Empty, Speech, Music, Motion, Detail, Text };
HintValue contentHint() const { return m_contentHint; }
void setContentHint(HintValue);
void startProducingData() { m_source->start(); }
void stopProducingData() { m_source->stop(); }
bool isProducingData() { return m_source->isProducingData(); }
bool isIsolated() const { return m_source->isIsolated(); }
bool muted() const;
void setMuted(bool muted) { m_source->setMuted(muted); }
bool isCaptureTrack() const;
bool enabled() const { return m_isEnabled; }
void setEnabled(bool);
Ref<MediaStreamTrackPrivate> clone();
RealtimeMediaSource& source() { return m_source.get(); }
WEBCORE_EXPORT RealtimeMediaSource::Type type() const;
void endTrack();
void addObserver(Observer&);
void removeObserver(Observer&);
#if ASSERT_ENABLED
bool hasObserver(Observer&) const;
#endif
WEBCORE_EXPORT const RealtimeMediaSourceSettings& settings() const;
const RealtimeMediaSourceCapabilities& capabilities() const;
void applyConstraints(const MediaConstraints&, RealtimeMediaSource::ApplyConstraintsHandler&&);
AudioSourceProvider* audioSourceProvider();
void paintCurrentFrameInContext(GraphicsContext&, const FloatRect&);
enum class ReadyState { None, Live, Ended };
ReadyState readyState() const { return m_readyState; }
void setIdForTesting(String&& id) { m_id = WTFMove(id); }
#if !RELEASE_LOG_DISABLED
const Logger& logger() const final { return m_logger; }
const void* logIdentifier() const final { return m_logIdentifier; }
#endif
private:
MediaStreamTrackPrivate(Ref<const Logger>&&, Ref<RealtimeMediaSource>&&, String&& id);
// RealtimeMediaSourceObserver
void sourceStarted() final;
void sourceStopped() final;
void sourceMutedChanged() final;
void sourceSettingsChanged() final;
bool preventSourceFromStopping() final;
void videoSampleAvailable(MediaSample&) final;
void audioSamplesAvailable(const MediaTime&, const PlatformAudioData&, const AudioStreamDescription&, size_t) final;
void audioUnitWillStart() final;
void updateReadyState();
void forEachObserver(const WTF::Function<void(Observer&)>&) const;
#if !RELEASE_LOG_DISABLED
const char* logClassName() const final { return "MediaStreamTrackPrivate"; }
WTFLogChannel& logChannel() const final;
#endif
mutable RecursiveLock m_observersLock;
HashSet<Observer*> m_observers;
Ref<RealtimeMediaSource> m_source;
String m_id;
ReadyState m_readyState { ReadyState::None };
bool m_isEnabled { true };
bool m_isEnded { false };
bool m_haveProducedData { false };
bool m_hasSentStartProducedData { false };
HintValue m_contentHint { HintValue::Empty };
RefPtr<WebAudioSourceProvider> m_audioSourceProvider;
Ref<const Logger> m_logger;
#if !RELEASE_LOG_DISABLED
const void* m_logIdentifier;
#endif
};
typedef Vector<RefPtr<MediaStreamTrackPrivate>> MediaStreamTrackPrivateVector;
#if ASSERT_ENABLED
inline bool MediaStreamTrackPrivate::hasObserver(Observer& observer) const
{
auto locker = holdLock(m_observersLock);
return m_observers.contains(&observer);
}
#endif
} // namespace WebCore
#endif // ENABLE(MEDIA_STREAM)