Home | History | Annotate | Download | only in platform 
      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 WebCore {
     40 class MediaStreamSource;
     41 }
     42 
     43 namespace WebKit {
     44 class WebAudioDestinationConsumer;
     45 class WebMediaConstraints;
     46 class WebString;
     47 
     48 class WebMediaStreamSource {
     49 public:
     50     class ExtraData {
     51     public:
     52         ExtraData() : m_owner(0) { }
     53         virtual ~ExtraData() { }
     54 
     55         WEBKIT_EXPORT WebMediaStreamSource owner();
     56 
     57 #if WEBKIT_IMPLEMENTATION
     58         void setOwner(WebCore::MediaStreamSource*);
     59 #endif
     60 
     61     private:
     62         WebCore::MediaStreamSource* m_owner;
     63     };
     64 
     65     enum Type {
     66         TypeAudio,
     67         TypeVideo
     68     };
     69 
     70     enum ReadyState {
     71         ReadyStateLive = 0,
     72         ReadyStateMuted = 1,
     73         ReadyStateEnded = 2
     74     };
     75 
     76     WebMediaStreamSource() { }
     77     WebMediaStreamSource(const WebMediaStreamSource& other) { assign(other); }
     78     ~WebMediaStreamSource() { reset(); }
     79 
     80     WebMediaStreamSource& operator=(const WebMediaStreamSource& other)
     81     {
     82         assign(other);
     83         return *this;
     84     }
     85 
     86     WEBKIT_EXPORT void assign(const WebMediaStreamSource&);
     87 
     88     WEBKIT_EXPORT void initialize(const WebString& id, Type, const WebString& name);
     89     WEBKIT_EXPORT void reset();
     90     bool isNull() const { return m_private.isNull(); }
     91 
     92     WEBKIT_EXPORT WebString id() const;
     93     WEBKIT_EXPORT Type type() const;
     94     WEBKIT_EXPORT WebString name() const;
     95 
     96     WEBKIT_EXPORT void setReadyState(ReadyState);
     97     WEBKIT_EXPORT ReadyState readyState() const;
     98 
     99     // Extra data associated with this object.
    100     // If non-null, the extra data pointer will be deleted when the object is destroyed.
    101     // Setting the extra data pointer will cause any existing non-null
    102     // extra data pointer to be deleted.
    103     WEBKIT_EXPORT ExtraData* extraData() const;
    104     WEBKIT_EXPORT void setExtraData(ExtraData*);
    105 
    106     WEBKIT_EXPORT WebMediaConstraints constraints();
    107 
    108     WEBKIT_EXPORT WebString deviceId() const;
    109     WEBKIT_EXPORT void setDeviceId(const WebString&);
    110 
    111     // Only used if if this is a WebAudio source.
    112     // The WebAudioDestinationConsumer is not owned, and has to be disposed of separately
    113     // after calling removeAudioConsumer.
    114     WEBKIT_EXPORT bool requiresAudioConsumer() const;
    115     WEBKIT_EXPORT void addAudioConsumer(WebAudioDestinationConsumer*);
    116     WEBKIT_EXPORT bool removeAudioConsumer(WebAudioDestinationConsumer*);
    117 
    118 #if WEBKIT_IMPLEMENTATION
    119     WebMediaStreamSource(const WTF::PassRefPtr<WebCore::MediaStreamSource>&);
    120     WebMediaStreamSource& operator=(WebCore::MediaStreamSource*);
    121     operator WTF::PassRefPtr<WebCore::MediaStreamSource>() const;
    122     operator WebCore::MediaStreamSource*() const;
    123 #endif
    124 
    125 private:
    126     WebPrivatePtr<WebCore::MediaStreamSource> m_private;
    127 };
    128 
    129 } // namespace WebKit
    130 
    131 #endif // WebMediaStreamSource_h
    132