da73830b72836ad88afe2f7957f39224f3f7b435
[WebKit-https.git] / Source / WebCore / Modules / mediastream / MediaStreamTrack.h
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  * Copyright (C) 2011, 2015 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 AudioSourceProvider;
46 class Dictionary;
47 class MediaConstraintsImpl;
48 class MediaSourceSettings;
49 class MediaTrackConstraints;
50
51 class MediaStreamTrack final : public RefCounted<MediaStreamTrack>, public ActiveDOMObject, public EventTargetWithInlineData, public MediaStreamTrackPrivate::Observer {
52 public:
53     class Observer {
54     public:
55         virtual ~Observer() { }
56         virtual void trackDidEnd() = 0;
57     };
58
59     static Ref<MediaStreamTrack> create(ScriptExecutionContext&, MediaStreamTrackPrivate&);
60     virtual ~MediaStreamTrack();
61
62     const AtomicString& kind() const;
63     const String& id() const;
64     const String& label() const;
65
66     bool enabled() const;
67     void setEnabled(bool);
68
69     bool muted() const;
70     bool readonly() const;
71     bool remote() const;
72
73     const AtomicString& readyState() const;
74
75     bool ended() const;
76
77     RefPtr<MediaStreamTrack> clone();
78     void stopProducingData();
79
80     RefPtr<MediaTrackConstraints> getConstraints() const;
81     RefPtr<MediaSourceSettings> getSettings() const;
82     RefPtr<RealtimeMediaSourceCapabilities> getCapabilities() const;
83     void applyConstraints(const Dictionary&);
84     void applyConstraints(const MediaConstraints&);
85
86     RealtimeMediaSource& source() const { return m_private->source(); }
87     MediaStreamTrackPrivate& privateTrack() { return m_private.get(); }
88
89     AudioSourceProvider* audioSourceProvider();
90
91     void addObserver(Observer*);
92     void removeObserver(Observer*);
93
94     // EventTarget
95     EventTargetInterface eventTargetInterface() const final { return MediaStreamTrackEventTargetInterfaceType; }
96     ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
97
98     using RefCounted<MediaStreamTrack>::ref;
99     using RefCounted<MediaStreamTrack>::deref;
100
101 private:
102     MediaStreamTrack(ScriptExecutionContext&, MediaStreamTrackPrivate&);
103     explicit MediaStreamTrack(MediaStreamTrack&);
104
105     void configureTrackRendering();
106
107     // ActiveDOMObject API.
108     void stop() final;
109     const char* activeDOMObjectName() const final;
110     bool canSuspendForDocumentSuspension() const final;
111
112     // EventTarget
113     void refEventTarget() final { ref(); }
114     void derefEventTarget() final { deref(); }
115
116     // MediaStreamTrackPrivate::Observer
117     void trackEnded(MediaStreamTrackPrivate&) override;
118     void trackMutedChanged(MediaStreamTrackPrivate&) override;
119     void trackSettingsChanged(MediaStreamTrackPrivate&) override;
120     void trackEnabledChanged(MediaStreamTrackPrivate&) override;
121
122     Vector<Observer*> m_observers;
123     Ref<MediaStreamTrackPrivate> m_private;
124
125     RefPtr<MediaConstraintsImpl> m_constraints;
126
127     bool m_ended { false };
128 };
129
130 typedef Vector<RefPtr<MediaStreamTrack>> MediaStreamTrackVector;
131
132 } // namespace WebCore
133
134 #endif // ENABLE(MEDIA_STREAM)
135
136 #endif // MediaStreamTrack_h