MediaStream API: Changing the device enumeration to be async
[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 "ScriptWrappable.h"
36 #include <wtf/RefCounted.h>
37 #include <wtf/RefPtr.h>
38 #include <wtf/Vector.h>
39 #include <wtf/text/WTFString.h>
40
41 namespace WebCore {
42
43 class MediaStreamComponent;
44 class MediaStreamTrackSourcesCallback;
45
46 class MediaStreamTrack : public RefCounted<MediaStreamTrack>, public ScriptWrappable, public ActiveDOMObject, public EventTarget, public MediaStreamSource::Observer {
47 public:
48     static PassRefPtr<MediaStreamTrack> create(ScriptExecutionContext*, MediaStreamComponent*);
49     virtual ~MediaStreamTrack();
50
51     AtomicString kind() const;
52     String id() const;
53     String label() const;
54
55     bool enabled() const;
56     void setEnabled(bool);
57
58     void didEndTrack();
59     
60     AtomicString readyState() const;
61
62     static void getSources(ScriptExecutionContext*, PassRefPtr<MediaStreamTrackSourcesCallback>, ExceptionCode&);
63
64     DEFINE_ATTRIBUTE_EVENT_LISTENER(mute);
65     DEFINE_ATTRIBUTE_EVENT_LISTENER(unmute);
66     DEFINE_ATTRIBUTE_EVENT_LISTENER(ended);
67
68     MediaStreamComponent* component();
69     bool ended() const;
70
71     // EventTarget
72     virtual const AtomicString& interfaceName() const OVERRIDE;
73     virtual ScriptExecutionContext* scriptExecutionContext() const OVERRIDE;
74
75     // ActiveDOMObject
76     virtual void stop() OVERRIDE;
77
78     using RefCounted<MediaStreamTrack>::ref;
79     using RefCounted<MediaStreamTrack>::deref;
80
81 private:
82     MediaStreamTrack(ScriptExecutionContext*, MediaStreamComponent*);
83
84     // EventTarget
85     virtual EventTargetData* eventTargetData() OVERRIDE;
86     virtual EventTargetData& ensureEventTargetData() OVERRIDE;
87     virtual void refEventTarget() OVERRIDE { ref(); }
88     virtual void derefEventTarget() OVERRIDE { deref(); }
89     EventTargetData m_eventTargetData;
90
91     // MediaStreamSourceObserver
92     virtual void sourceChangedState() OVERRIDE;
93
94     RefPtr<MediaStreamComponent> m_component;
95     bool m_stopped;
96 };
97
98 typedef Vector<RefPtr<MediaStreamTrack> > MediaStreamTrackVector;
99
100 } // namespace WebCore
101
102 #endif // ENABLE(MEDIA_STREAM)
103
104 #endif // MediaStreamTrack_h