9c7f03fc677ac02a85d1d68453af568f2386278a
[WebKit-https.git] / Source / WebCore / platform / mediastream / MediaStreamTrackPrivate.h
1 /*
2  *  Copyright (C) 2013 Nokia Corporation and/or its subsidiary(-ies).
3  *  Copyright (C) 2015 Ericsson AB. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
15  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
16  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
17  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
18  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
19  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
20  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #pragma once
28
29 #if ENABLE(MEDIA_STREAM)
30
31 #include "RealtimeMediaSource.h"
32
33 namespace WebCore {
34
35 class AudioSourceProvider;
36 class GraphicsContext;
37 class MediaSample;
38 class RealtimeMediaSourceCapabilities;
39 class WebAudioSourceProvider;
40
41 class MediaStreamTrackPrivate : public RefCounted<MediaStreamTrackPrivate>, public RealtimeMediaSource::Observer {
42 public:
43     class Observer {
44     public:
45         virtual ~Observer() = default;
46
47         virtual void trackStarted(MediaStreamTrackPrivate&) { };
48         virtual void trackEnded(MediaStreamTrackPrivate&) = 0;
49         virtual void trackMutedChanged(MediaStreamTrackPrivate&) = 0;
50         virtual void trackSettingsChanged(MediaStreamTrackPrivate&) = 0;
51         virtual void trackEnabledChanged(MediaStreamTrackPrivate&) = 0;
52         virtual void sampleBufferUpdated(MediaStreamTrackPrivate&, MediaSample&) { };
53         virtual void readyStateChanged(MediaStreamTrackPrivate&) { };
54
55         // May get called on a background thread.
56         virtual void audioSamplesAvailable(MediaStreamTrackPrivate&, const MediaTime&, const PlatformAudioData&, const AudioStreamDescription&, size_t) { };
57     };
58
59     static Ref<MediaStreamTrackPrivate> create(Ref<RealtimeMediaSource>&&);
60     static Ref<MediaStreamTrackPrivate> create(Ref<RealtimeMediaSource>&&, String&& id);
61
62     virtual ~MediaStreamTrackPrivate();
63
64     const String& id() const { return m_id; }
65     const String& label() const;
66
67     bool ended() const { return m_isEnded; }
68
69     enum class HintValue { Empty, Speech, Music, Motion, Detail, Text };
70     HintValue contentHint() const { return m_contentHint; }
71     void setContentHint(HintValue);
72     
73     void startProducingData() { m_source->start(); }
74     void stopProducingData() { m_source->stop(); }
75     bool isProducingData() { return m_source->isProducingData(); }
76
77     bool isIsolated() const { return m_source->isIsolated(); }
78
79     bool muted() const;
80     void setMuted(bool muted) { m_source->setMuted(muted); }
81
82     bool isCaptureTrack() const;
83
84     bool enabled() const { return m_isEnabled; }
85     void setEnabled(bool);
86
87     Ref<MediaStreamTrackPrivate> clone();
88
89     RealtimeMediaSource& source() { return m_source.get(); }
90     RealtimeMediaSource::Type type() const;
91
92     void endTrack();
93
94     void addObserver(Observer&);
95     void removeObserver(Observer&);
96
97     const RealtimeMediaSourceSettings& settings() const;
98     const RealtimeMediaSourceCapabilities& capabilities() const;
99
100     void applyConstraints(const MediaConstraints&, RealtimeMediaSource::ApplyConstraintsHandler&&);
101
102     AudioSourceProvider* audioSourceProvider();
103
104     void paintCurrentFrameInContext(GraphicsContext&, const FloatRect&);
105
106     enum class ReadyState { None, Live, Ended };
107     ReadyState readyState() const { return m_readyState; }
108
109     void setIdForTesting(String&& id) { m_id = WTFMove(id); }
110
111 private:
112     MediaStreamTrackPrivate(Ref<RealtimeMediaSource>&&, String&& id);
113
114     // RealtimeMediaSourceObserver
115     void sourceStarted() final;
116     void sourceStopped() final;
117     void sourceMutedChanged() final;
118     void sourceSettingsChanged() final;
119     bool preventSourceFromStopping() final;
120     void videoSampleAvailable(MediaSample&) final;
121     void audioSamplesAvailable(const MediaTime&, const PlatformAudioData&, const AudioStreamDescription&, size_t) final;
122
123     void updateReadyState();
124
125     void forEachObserver(const WTF::Function<void(Observer&)>&) const;
126
127     mutable RecursiveLock m_observersLock;
128     HashSet<Observer*> m_observers;
129     Ref<RealtimeMediaSource> m_source;
130
131     String m_id;
132     ReadyState m_readyState { ReadyState::None };
133     bool m_isEnabled { true };
134     bool m_isEnded { false };
135     bool m_haveProducedData { false };
136     HintValue m_contentHint { HintValue::Empty };
137     RefPtr<WebAudioSourceProvider> m_audioSourceProvider;
138 };
139
140 typedef Vector<RefPtr<MediaStreamTrackPrivate>> MediaStreamTrackPrivateVector;
141
142 } // namespace WebCore
143
144 #endif // ENABLE(MEDIA_STREAM)