WebRTC: Remove AudioStreamTrack and VideoStreamTrack (removed in spec)
[WebKit-https.git] / Source / WebCore / Modules / mediastream / MediaStreamTrack.h
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  * Copyright (C) 2011 Ericsson AB. All rights reserved.
4  * Copyright (C) 2013 Apple Inc. All rights reserved.
5  * Copyright (C) 2013 Nokia Corporation and/or its subsidiary(-ies).
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  * 1.  Redistributions of source code must retain the above copyright
11  *     notice, this list of conditions and the following disclaimer.
12  * 2.  Redistributions in binary form must reproduce the above copyright
13  *     notice, this list of conditions and the following disclaimer in the
14  *     documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
23  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27
28 #ifndef MediaStreamTrack_h
29 #define MediaStreamTrack_h
30
31 #if ENABLE(MEDIA_STREAM)
32
33 #include "ActiveDOMObject.h"
34 #include "EventTarget.h"
35 #include "MediaStreamTrackPrivate.h"
36 #include "RealtimeMediaSource.h"
37 #include "ScriptWrappable.h"
38 #include <wtf/RefCounted.h>
39 #include <wtf/RefPtr.h>
40 #include <wtf/Vector.h>
41 #include <wtf/text/WTFString.h>
42
43 namespace WebCore {
44
45 class Dictionary;
46 class MediaConstraintsImpl;
47 class MediaSourceStates;
48 class MediaStreamTrackSourcesCallback;
49 class MediaStreamCapabilities;
50 class MediaTrackConstraints;
51
52 class MediaStreamTrack final : public RefCounted<MediaStreamTrack>, public ScriptWrappable, public ActiveDOMObject, public EventTargetWithInlineData, public MediaStreamTrackPrivateClient {
53 public:
54     class Observer {
55     public:
56         virtual ~Observer() { }
57         virtual void trackDidEnd() = 0;
58     };
59
60     static RefPtr<MediaStreamTrack> create(ScriptExecutionContext&, MediaStreamTrackPrivate&);
61     static RefPtr<MediaStreamTrack> create(MediaStreamTrack&);
62     virtual ~MediaStreamTrack();
63
64     const AtomicString& kind() const;
65     const String& id() const;
66     const String& label() const;
67
68     bool enabled() const;
69     void setEnabled(bool);
70
71     bool muted() const;
72     bool readonly() const;
73     bool remote() const;
74     bool stopped() const;
75
76     const AtomicString& readyState() const;
77
78     static void getSources(ScriptExecutionContext*, PassRefPtr<MediaStreamTrackSourcesCallback>, ExceptionCode&);
79
80     RefPtr<MediaTrackConstraints> getConstraints() const;
81     RefPtr<MediaSourceStates> states() const;
82     RefPtr<MediaStreamCapabilities> getCapabilities() const;
83     void applyConstraints(const Dictionary&);
84     void applyConstraints(PassRefPtr<MediaConstraints>);
85
86     RefPtr<MediaStreamTrack> clone();
87     void stopProducingData();
88
89     RealtimeMediaSource* source() const { return m_privateTrack->source(); }
90     MediaStreamTrackPrivate& privateTrack() { return m_privateTrack.get(); }
91
92     bool ended() const;
93
94     void addObserver(Observer*);
95     void removeObserver(Observer*);
96
97     // EventTarget
98     virtual EventTargetInterface eventTargetInterface() const override final { return MediaStreamTrackEventTargetInterfaceType; }
99     virtual ScriptExecutionContext* scriptExecutionContext() const override final { return ActiveDOMObject::scriptExecutionContext(); }
100
101     using RefCounted<MediaStreamTrack>::ref;
102     using RefCounted<MediaStreamTrack>::deref;
103
104 private:
105     MediaStreamTrack(ScriptExecutionContext&, MediaStreamTrackPrivate&);
106     explicit MediaStreamTrack(MediaStreamTrack&);
107
108     void setSource(PassRefPtr<RealtimeMediaSource>);
109
110     void configureTrackRendering();
111     void trackDidEnd();
112     void scheduleEventDispatch(PassRefPtr<Event>);
113
114     // ActiveDOMObject API.
115     void stop() override final;
116     const char* activeDOMObjectName() const override final;
117     bool canSuspendForPageCache() const override final;
118
119     // EventTarget
120     virtual void refEventTarget() override final { ref(); }
121     virtual void derefEventTarget() override final { deref(); }
122
123     // MediaStreamTrackPrivateClient
124     void trackReadyStateChanged();
125     void trackMutedChanged();
126     void trackEnabledChanged();
127
128     Vector<RefPtr<Event>> m_scheduledEvents;
129
130     RefPtr<MediaConstraintsImpl> m_constraints;
131     Mutex m_mutex;
132
133     Vector<Observer*> m_observers;
134
135     Ref<MediaStreamTrackPrivate> m_privateTrack;
136     bool m_eventDispatchScheduled;
137
138     bool m_stoppingTrack;
139 };
140
141 } // namespace WebCore
142
143 #endif // ENABLE(MEDIA_STREAM)
144
145 #endif // MediaStreamTrack_h