Make some things that return never-null pointers return references instead.
[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  *
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 APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
21  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef MediaStreamTrack_h
27 #define MediaStreamTrack_h
28
29 #if ENABLE(MEDIA_STREAM)
30
31 #include "ActiveDOMObject.h"
32 #include "EventTarget.h"
33 #include "MediaStreamDescriptor.h"
34 #include "MediaStreamSource.h"
35 #include <wtf/RefCounted.h>
36 #include <wtf/RefPtr.h>
37 #include <wtf/Vector.h>
38 #include <wtf/text/WTFString.h>
39
40 namespace WebCore {
41
42 class MediaStreamComponent;
43
44 class MediaStreamTrack : public RefCounted<MediaStreamTrack>, public ActiveDOMObject, public EventTarget, public MediaStreamSource::Observer {
45 public:
46     static PassRefPtr<MediaStreamTrack> create(ScriptExecutionContext*, MediaStreamComponent*);
47     virtual ~MediaStreamTrack();
48
49     String kind() const;
50     String id() const;
51     String label() const;
52
53     bool enabled() const;
54     void setEnabled(bool);
55
56     String readyState() const;
57
58     DEFINE_ATTRIBUTE_EVENT_LISTENER(mute);
59     DEFINE_ATTRIBUTE_EVENT_LISTENER(unmute);
60     DEFINE_ATTRIBUTE_EVENT_LISTENER(ended);
61
62     MediaStreamComponent* component();
63     bool ended() const;
64
65     // EventTarget
66     virtual const AtomicString& interfaceName() const OVERRIDE;
67     virtual ScriptExecutionContext* scriptExecutionContext() const OVERRIDE;
68
69     // ActiveDOMObject
70     virtual void stop() OVERRIDE;
71
72     using RefCounted<MediaStreamTrack>::ref;
73     using RefCounted<MediaStreamTrack>::deref;
74
75 private:
76     MediaStreamTrack(ScriptExecutionContext*, MediaStreamComponent*);
77
78     // EventTarget
79     virtual EventTargetData* eventTargetData() OVERRIDE;
80     virtual EventTargetData& ensureEventTargetData() OVERRIDE;
81     virtual void refEventTarget() OVERRIDE { ref(); }
82     virtual void derefEventTarget() OVERRIDE { deref(); }
83     EventTargetData m_eventTargetData;
84
85     // MediaStreamSourceObserver
86     virtual void sourceChangedState() OVERRIDE;
87
88     bool m_stopped;
89     RefPtr<MediaStreamComponent> m_component;
90 };
91
92 typedef Vector<RefPtr<MediaStreamTrack> > MediaStreamTrackVector;
93
94 } // namespace WebCore
95
96 #endif // ENABLE(MEDIA_STREAM)
97
98 #endif // MediaStreamTrack_h