Use "= default" to denote default constructor or destructor
[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 audioSamplesAvailable(MediaStreamTrackPrivate&, const MediaTime&, const PlatformAudioData&, const AudioStreamDescription&, size_t) { };
54         virtual void readyStateChanged(MediaStreamTrackPrivate&) { };
55     };
56
57     static Ref<MediaStreamTrackPrivate> create(Ref<RealtimeMediaSource>&&);
58     static Ref<MediaStreamTrackPrivate> create(Ref<RealtimeMediaSource>&&, String&& id);
59
60     virtual ~MediaStreamTrackPrivate();
61
62     const String& id() const { return m_id; }
63     const String& label() const;
64
65     bool ended() const { return m_isEnded; }
66
67     void startProducingData() { m_source->start(); }
68     void stopProducingData() { m_source->stop(); }
69     bool isProducingData() { return m_source->isProducingData(); }
70
71     bool isIsolated() const { return m_source->isIsolated(); }
72
73     bool muted() const;
74     void setMuted(bool muted) { m_source->setMuted(muted); }
75
76     bool isCaptureTrack() const;
77
78     bool enabled() const { return m_isEnabled; }
79     void setEnabled(bool);
80
81     Ref<MediaStreamTrackPrivate> clone();
82
83     RealtimeMediaSource& source() { return m_source.get(); }
84     RealtimeMediaSource::Type type() const;
85
86     void endTrack();
87
88     void addObserver(Observer&);
89     void removeObserver(Observer&);
90
91     const RealtimeMediaSourceSettings& settings() const;
92     const RealtimeMediaSourceCapabilities& capabilities() const;
93
94     void applyConstraints(const MediaConstraints&, RealtimeMediaSource::SuccessHandler&&, RealtimeMediaSource::FailureHandler&&);
95
96     AudioSourceProvider* audioSourceProvider();
97
98     void paintCurrentFrameInContext(GraphicsContext&, const FloatRect&);
99
100     enum class ReadyState { None, Live, Ended };
101     ReadyState readyState() const { return m_readyState; }
102
103 private:
104     MediaStreamTrackPrivate(Ref<RealtimeMediaSource>&&, String&& id);
105
106     // RealtimeMediaSourceObserver
107     void sourceStarted() final;
108     void sourceStopped() final;
109     void sourceMutedChanged() final;
110     void sourceSettingsChanged() final;
111     bool preventSourceFromStopping() final;
112     void videoSampleAvailable(MediaSample&) final;
113     void audioSamplesAvailable(const MediaTime&, const PlatformAudioData&, const AudioStreamDescription&, size_t) final;
114
115     void updateReadyState();
116
117     Vector<Observer*> m_observers;
118     Ref<RealtimeMediaSource> m_source;
119
120     String m_id;
121     ReadyState m_readyState { ReadyState::None };
122     bool m_isEnabled { true };
123     bool m_isEnded { false };
124     bool m_haveProducedData { false };
125     RefPtr<WebAudioSourceProvider> m_audioSourceProvider;
126 };
127
128 typedef Vector<RefPtr<MediaStreamTrackPrivate>> MediaStreamTrackPrivateVector;
129
130 } // namespace WebCore
131
132 #endif // ENABLE(MEDIA_STREAM)