Part 2 of removing PlatformString.h, remove PlatformString.h
[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     enum ReadyState {
47         LIVE = 0,
48         MUTED = 1,
49         ENDED = 2
50     };
51
52     static PassRefPtr<MediaStreamTrack> create(ScriptExecutionContext*, PassRefPtr<MediaStreamDescriptor>, MediaStreamComponent*);
53     virtual ~MediaStreamTrack();
54
55     String kind() const;
56     String label() const;
57
58     bool enabled() const;
59     void setEnabled(bool);
60
61     ReadyState readyState() const;
62
63     DEFINE_ATTRIBUTE_EVENT_LISTENER(mute);
64     DEFINE_ATTRIBUTE_EVENT_LISTENER(unmute);
65     DEFINE_ATTRIBUTE_EVENT_LISTENER(ended);
66
67     MediaStreamComponent* component();
68
69     // EventTarget
70     virtual const AtomicString& interfaceName() const OVERRIDE;
71     virtual ScriptExecutionContext* scriptExecutionContext() const OVERRIDE;
72
73     // ActiveDOMObject
74     virtual void stop() OVERRIDE;
75
76     using RefCounted<MediaStreamTrack>::ref;
77     using RefCounted<MediaStreamTrack>::deref;
78
79 private:
80     MediaStreamTrack(ScriptExecutionContext*, PassRefPtr<MediaStreamDescriptor>, MediaStreamComponent*);
81
82     // EventTarget
83     virtual EventTargetData* eventTargetData() OVERRIDE;
84     virtual EventTargetData* ensureEventTargetData() OVERRIDE;
85     virtual void refEventTarget() OVERRIDE { ref(); }
86     virtual void derefEventTarget() OVERRIDE { deref(); }
87     EventTargetData m_eventTargetData;
88
89     // MediaStreamSourceObserver
90     virtual void sourceChangedState() OVERRIDE;
91
92     bool m_stopped;
93     RefPtr<MediaStreamDescriptor> m_streamDescriptor;
94     RefPtr<MediaStreamComponent> m_component;
95 };
96
97 typedef Vector<RefPtr<MediaStreamTrack> > MediaStreamTrackVector;
98
99 } // namespace WebCore
100
101 #endif // ENABLE(MEDIA_STREAM)
102
103 #endif // MediaStreamTrack_h