blob: 5a8b12124279cf36faf6a450bc4803283e810dcc [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.
*/
#include "config.h"
#include "MediaStreamTrackPrivate.h"
#if ENABLE(MEDIA_STREAM)
#include "GraphicsContext.h"
#include "IntRect.h"
#include "Logging.h"
#include <wtf/UUID.h>
#if PLATFORM(COCOA)
#include "WebAudioSourceProviderAVFObjC.h"
#elif ENABLE(WEB_AUDIO) && ENABLE(MEDIA_STREAM) && USE(LIBWEBRTC) && USE(GSTREAMER)
#include "AudioSourceProviderGStreamer.h"
#else
#include "WebAudioSourceProvider.h"
#endif
namespace WebCore {
Ref<MediaStreamTrackPrivate> MediaStreamTrackPrivate::create(Ref<const Logger>&& logger, Ref<RealtimeMediaSource>&& source)
{
return create(WTFMove(logger), WTFMove(source), createCanonicalUUIDString());
}
Ref<MediaStreamTrackPrivate> MediaStreamTrackPrivate::create(Ref<const Logger>&& logger, Ref<RealtimeMediaSource>&& source, String&& id)
{
return adoptRef(*new MediaStreamTrackPrivate(WTFMove(logger), WTFMove(source), WTFMove(id)));
}
MediaStreamTrackPrivate::MediaStreamTrackPrivate(Ref<const Logger>&& logger, Ref<RealtimeMediaSource>&& source, String&& id)
: m_source(WTFMove(source))
, m_id(WTFMove(id))
, m_logger(WTFMove(logger))
#if !RELEASE_LOG_DISABLED
, m_logIdentifier(uniqueLogIdentifier())
#endif
{
ASSERT(isMainThread());
UNUSED_PARAM(logger);
#if !RELEASE_LOG_DISABLED
m_source->setLogger(m_logger.copyRef(), m_logIdentifier);
#endif
m_source->addObserver(*this);
}
MediaStreamTrackPrivate::~MediaStreamTrackPrivate()
{
ASSERT(isMainThread());
m_source->removeObserver(*this);
}
void MediaStreamTrackPrivate::forEachObserver(const WTF::Function<void(Observer&)>& apply) const
{
Vector<Observer*> observersCopy;
{
auto locker = holdLock(m_observersLock);
observersCopy = copyToVector(m_observers);
}
for (auto* observer : observersCopy) {
auto locker = holdLock(m_observersLock);
// Make sure the observer has not been destroyed.
if (!m_observers.contains(observer))
continue;
apply(*observer);
}
}
void MediaStreamTrackPrivate::addObserver(MediaStreamTrackPrivate::Observer& observer)
{
auto locker = holdLock(m_observersLock);
m_observers.add(&observer);
}
void MediaStreamTrackPrivate::removeObserver(MediaStreamTrackPrivate::Observer& observer)
{
auto locker = holdLock(m_observersLock);
m_observers.remove(&observer);
}
const String& MediaStreamTrackPrivate::label() const
{
return m_source->name();
}
void MediaStreamTrackPrivate::setContentHint(HintValue hintValue)
{
m_contentHint = hintValue;
}
bool MediaStreamTrackPrivate::muted() const
{
return m_source->muted();
}
bool MediaStreamTrackPrivate::isCaptureTrack() const
{
return m_source->isCaptureSource();
}
void MediaStreamTrackPrivate::setEnabled(bool enabled)
{
if (m_isEnabled == enabled)
return;
// Always update the enabled state regardless of the track being ended.
m_isEnabled = enabled;
forEachObserver([this](auto& observer) {
observer.trackEnabledChanged(*this);
});
}
void MediaStreamTrackPrivate::endTrack()
{
if (m_isEnded)
return;
// Set m_isEnded to true before telling the source it can stop, so if this is the
// only track using the source and it does stop, we will only call each observer's
// trackEnded method once.
m_isEnded = true;
updateReadyState();
m_source->requestToEnd(*this);
forEachObserver([this](auto& observer) {
observer.trackEnded(*this);
});
}
Ref<MediaStreamTrackPrivate> MediaStreamTrackPrivate::clone()
{
auto clonedMediaStreamTrackPrivate = create(m_logger.copyRef(), m_source->clone());
clonedMediaStreamTrackPrivate->m_isEnabled = this->m_isEnabled;
clonedMediaStreamTrackPrivate->m_isEnded = this->m_isEnded;
clonedMediaStreamTrackPrivate->m_contentHint = this->m_contentHint;
clonedMediaStreamTrackPrivate->updateReadyState();
if (isProducingData())
clonedMediaStreamTrackPrivate->startProducingData();
return clonedMediaStreamTrackPrivate;
}
RealtimeMediaSource::Type MediaStreamTrackPrivate::type() const
{
return m_source->type();
}
const RealtimeMediaSourceSettings& MediaStreamTrackPrivate::settings() const
{
return m_source->settings();
}
const RealtimeMediaSourceCapabilities& MediaStreamTrackPrivate::capabilities() const
{
return m_source->capabilities();
}
void MediaStreamTrackPrivate::applyConstraints(const MediaConstraints& constraints, RealtimeMediaSource::ApplyConstraintsHandler&& completionHandler)
{
m_source->applyConstraints(constraints, WTFMove(completionHandler));
}
AudioSourceProvider* MediaStreamTrackPrivate::audioSourceProvider()
{
#if PLATFORM(COCOA)
if (!m_audioSourceProvider)
m_audioSourceProvider = WebAudioSourceProviderAVFObjC::create(*this);
#elif USE(LIBWEBRTC) && USE(GSTREAMER)
if (!m_audioSourceProvider)
m_audioSourceProvider = AudioSourceProviderGStreamer::create(*this);
#endif
return m_audioSourceProvider.get();
}
void MediaStreamTrackPrivate::sourceStarted()
{
forEachObserver([this](auto& observer) {
observer.trackStarted(*this);
});
}
void MediaStreamTrackPrivate::sourceStopped()
{
if (m_isEnded)
return;
m_isEnded = true;
updateReadyState();
forEachObserver([this](auto& observer) {
observer.trackEnded(*this);
});
}
void MediaStreamTrackPrivate::sourceMutedChanged()
{
forEachObserver([this](auto& observer) {
observer.trackMutedChanged(*this);
});
}
void MediaStreamTrackPrivate::sourceSettingsChanged()
{
forEachObserver([this](auto& observer) {
observer.trackSettingsChanged(*this);
});
}
bool MediaStreamTrackPrivate::preventSourceFromStopping()
{
// Do not allow the source to stop if we are still using it.
return !m_isEnded;
}
void MediaStreamTrackPrivate::videoSampleAvailable(MediaSample& mediaSample)
{
ASSERT(isMainThread());
if (!m_haveProducedData) {
m_haveProducedData = true;
updateReadyState();
}
if (!enabled())
return;
mediaSample.setTrackID(id());
forEachObserver([&](auto& observer) {
observer.sampleBufferUpdated(*this, mediaSample);
});
}
// May get called on a background thread.
void MediaStreamTrackPrivate::audioSamplesAvailable(const MediaTime& mediaTime, const PlatformAudioData& data, const AudioStreamDescription& description, size_t sampleCount)
{
if (!m_hasSentStartProducedData) {
callOnMainThread([this, weakThis = makeWeakPtr(this)] {
if (!weakThis)
return;
if (!m_haveProducedData) {
m_haveProducedData = true;
updateReadyState();
}
m_hasSentStartProducedData = true;
});
return;
}
forEachObserver([&](auto& observer) {
observer.audioSamplesAvailable(*this, mediaTime, data, description, sampleCount);
});
}
void MediaStreamTrackPrivate::updateReadyState()
{
ReadyState state = ReadyState::None;
if (m_isEnded)
state = ReadyState::Ended;
else if (m_haveProducedData)
state = ReadyState::Live;
if (state == m_readyState)
return;
ALWAYS_LOG(LOGIDENTIFIER);
m_readyState = state;
forEachObserver([this](auto& observer) {
observer.readyStateChanged(*this);
});
}
#if !RELEASE_LOG_DISABLED
WTFLogChannel& MediaStreamTrackPrivate::logChannel() const
{
return LogWebRTC;
}
#endif
} // namespace WebCore
#endif // ENABLE(MEDIA_STREAM)