• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #ifndef WebMediaStreamSource_h
32 #define WebMediaStreamSource_h
33 
34 #include "WebCommon.h"
35 #include "WebNonCopyable.h"
36 #include "WebPrivatePtr.h"
37 #include "WebVector.h"
38 
39 namespace blink {
40 
41 class MediaStreamSource;
42 class WebAudioDestinationConsumer;
43 class WebMediaConstraints;
44 class WebString;
45 
46 class WebMediaStreamSource {
47 public:
48     class ExtraData {
49     public:
ExtraData()50         ExtraData() : m_owner(0) { }
~ExtraData()51         virtual ~ExtraData() { }
52 
53         BLINK_PLATFORM_EXPORT WebMediaStreamSource owner();
54 
55 #if INSIDE_BLINK
56         BLINK_PLATFORM_EXPORT void setOwner(MediaStreamSource*);
57 #endif
58 
59     private:
60         MediaStreamSource* m_owner;
61     };
62 
63     enum Type {
64         TypeAudio,
65         TypeVideo
66     };
67 
68     enum ReadyState {
69         ReadyStateLive = 0,
70         ReadyStateMuted = 1,
71         ReadyStateEnded = 2
72     };
73 
WebMediaStreamSource()74     WebMediaStreamSource() { }
WebMediaStreamSource(const WebMediaStreamSource & other)75     WebMediaStreamSource(const WebMediaStreamSource& other) { assign(other); }
~WebMediaStreamSource()76     ~WebMediaStreamSource() { reset(); }
77 
78     WebMediaStreamSource& operator=(const WebMediaStreamSource& other)
79     {
80         assign(other);
81         return *this;
82     }
83 
84     BLINK_PLATFORM_EXPORT void assign(const WebMediaStreamSource&);
85 
86     BLINK_PLATFORM_EXPORT void initialize(const WebString& id, Type, const WebString& name);
87     BLINK_PLATFORM_EXPORT void reset();
isNull()88     bool isNull() const { return m_private.isNull(); }
89 
90     BLINK_PLATFORM_EXPORT WebString id() const;
91     BLINK_PLATFORM_EXPORT Type type() const;
92     BLINK_PLATFORM_EXPORT WebString name() const;
93 
94     BLINK_PLATFORM_EXPORT void setReadyState(ReadyState);
95     BLINK_PLATFORM_EXPORT ReadyState readyState() const;
96 
97     // Extra data associated with this object.
98     // If non-null, the extra data pointer will be deleted when the object is destroyed.
99     // Setting the extra data pointer will cause any existing non-null
100     // extra data pointer to be deleted.
101     BLINK_PLATFORM_EXPORT ExtraData* extraData() const;
102     BLINK_PLATFORM_EXPORT void setExtraData(ExtraData*);
103 
104     BLINK_PLATFORM_EXPORT WebMediaConstraints constraints();
105 
106     // Only used if if this is a WebAudio source.
107     // The WebAudioDestinationConsumer is not owned, and has to be disposed of separately
108     // after calling removeAudioConsumer.
109     BLINK_PLATFORM_EXPORT bool requiresAudioConsumer() const;
110     BLINK_PLATFORM_EXPORT void addAudioConsumer(WebAudioDestinationConsumer*);
111     BLINK_PLATFORM_EXPORT bool removeAudioConsumer(WebAudioDestinationConsumer*);
112 
113 #if INSIDE_BLINK
114     BLINK_PLATFORM_EXPORT WebMediaStreamSource(const WTF::PassRefPtr<MediaStreamSource>&);
115     BLINK_PLATFORM_EXPORT WebMediaStreamSource& operator=(MediaStreamSource*);
116     BLINK_PLATFORM_EXPORT operator WTF::PassRefPtr<MediaStreamSource>() const;
117     BLINK_PLATFORM_EXPORT operator MediaStreamSource*() const;
118 #endif
119 
120 private:
121     WebPrivatePtr<MediaStreamSource> m_private;
122 };
123 
124 } // namespace blink
125 
126 #endif // WebMediaStreamSource_h
127