WeakPtrFactory should populate m_ref lazily.
[WebKit-https.git] / Source / WebCore / platform / mediastream / MediaStreamPrivate.h
1 /*
2  * Copyright (C) 2011, 2015 Ericsson AB. All rights reserved.
3  * Copyright (C) 2012 Google Inc. All rights reserved.
4  * Copyright (C) 2013 Nokia Corporation and/or its subsidiary(-ies).
5  * Copyright (C) 2015 Apple Inc. All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer
15  *    in the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of Ericsson nor the names of its contributors
18  *    may be used to endorse or promote products derived from this
19  *    software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #ifndef MediaStreamPrivate_h
35 #define MediaStreamPrivate_h
36
37 #if ENABLE(MEDIA_STREAM)
38
39 #include "FloatSize.h"
40 #include "MediaStreamTrack.h"
41 #include "MediaStreamTrackPrivate.h"
42 #include <wtf/Function.h>
43 #include <wtf/HashMap.h>
44 #include <wtf/MediaTime.h>
45 #include <wtf/RefCounted.h>
46 #include <wtf/RefPtr.h>
47 #include <wtf/UUID.h>
48 #include <wtf/Vector.h>
49 #include <wtf/WeakPtr.h>
50
51 #if USE(GSTREAMER)
52 #include "GRefPtrGStreamer.h"
53 #include <owr/owr_gst_video_renderer.h>
54 #endif
55
56 namespace WebCore {
57
58 class MediaStream;
59 class OrientationNotifier;
60
61 class MediaStreamPrivate : public MediaStreamTrackPrivate::Observer, public RefCounted<MediaStreamPrivate> {
62 public:
63     class Observer {
64     public:
65         virtual ~Observer() { }
66
67         virtual void characteristicsChanged() { }
68         virtual void activeStatusChanged() { }
69         virtual void didAddTrack(MediaStreamTrackPrivate&) { }
70         virtual void didRemoveTrack(MediaStreamTrackPrivate&) { }
71     };
72
73     static Ref<MediaStreamPrivate> create(const Vector<Ref<RealtimeMediaSource>>& audioSources, const Vector<Ref<RealtimeMediaSource>>& videoSources);
74     static Ref<MediaStreamPrivate> create(const MediaStreamTrackPrivateVector& tracks, String&& id = createCanonicalUUIDString()) { return adoptRef(*new MediaStreamPrivate(tracks, WTFMove(id))); }
75
76     virtual ~MediaStreamPrivate();
77
78     enum class NotifyClientOption { Notify, DontNotify };
79
80     void addObserver(Observer&);
81     void removeObserver(Observer&);
82
83     String id() const { return m_id; }
84
85     MediaStreamTrackPrivateVector tracks() const;
86     MediaStreamTrackPrivate* activeVideoTrack() { return m_activeVideoTrack; }
87
88     bool active() const { return m_isActive; }
89     void updateActiveState(NotifyClientOption);
90
91     void addTrack(RefPtr<MediaStreamTrackPrivate>&&, NotifyClientOption = NotifyClientOption::Notify);
92     void removeTrack(MediaStreamTrackPrivate&, NotifyClientOption = NotifyClientOption::Notify);
93
94     void startProducingData();
95     void stopProducingData();
96     bool isProducingData() const;
97
98     void endStream();
99
100     bool hasVideo() const;
101     bool hasAudio() const;
102     bool muted() const;
103
104     bool hasCaptureVideoSource() const;
105     bool hasCaptureAudioSource() const;
106     void setCaptureTracksMuted(bool);
107
108     FloatSize intrinsicSize() const;
109
110     WeakPtr<MediaStreamPrivate> createWeakPtr() { return m_weakPtrFactory.createWeakPtr(*this); }
111
112     void monitorOrientation(OrientationNotifier&);
113
114 #if USE(GSTREAMER)
115     void setVideoRenderer(OwrGstVideoRenderer* renderer, GstElement* sink) { m_gstVideoRenderer = renderer; m_gstVideoSinkElement = sink; }
116     GRefPtr<GstElement> getVideoSinkElement() const { return m_gstVideoSinkElement; }
117     GRefPtr<OwrGstVideoRenderer> getVideoRenderer() const { return m_gstVideoRenderer; }
118
119 private:
120     GRefPtr<GstElement> m_gstVideoSinkElement;
121     GRefPtr<OwrGstVideoRenderer> m_gstVideoRenderer;
122 #endif
123
124 private:
125     MediaStreamPrivate(const MediaStreamTrackPrivateVector&, String&&);
126
127     // MediaStreamTrackPrivate::Observer
128     void trackStarted(MediaStreamTrackPrivate&) override;
129     void trackEnded(MediaStreamTrackPrivate&) override;
130     void trackMutedChanged(MediaStreamTrackPrivate&) override;
131     void trackSettingsChanged(MediaStreamTrackPrivate&) override;
132     void trackEnabledChanged(MediaStreamTrackPrivate&) override;
133
134     void characteristicsChanged();
135     void updateActiveVideoTrack();
136
137     void scheduleDeferredTask(Function<void ()>&&);
138
139     WeakPtrFactory<MediaStreamPrivate> m_weakPtrFactory;
140     Vector<Observer*> m_observers;
141     String m_id;
142     MediaStreamTrackPrivate* m_activeVideoTrack { nullptr };
143     HashMap<String, RefPtr<MediaStreamTrackPrivate>> m_trackSet;
144     bool m_isActive { false };
145 };
146
147 typedef Vector<RefPtr<MediaStreamPrivate>> MediaStreamPrivateVector;
148
149 } // namespace WebCore
150
151 #endif // ENABLE(MEDIA_STREAM)
152
153 #endif // MediaStreamPrivate_h