src/third_party/WebKit/public/platform/WebMediaStreamTrack.h

   1 /*
   2  * Copyright (C) 2013 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
   6  * are met:
   7  * 1.  Redistributions of source code must retain the above copyright
   8  *     notice, this list of conditions and the following disclaimer.
   9  * 2.  Redistributions in binary form must reproduce the above copyright
  10  *     notice, this list of conditions and the following disclaimer in the
  11  *     documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  */
  24
  25 #ifndef WebMediaStreamTrack_h
  26 #define WebMediaStreamTrack_h
  27
  28 #include "WebCommon.h"
  29 #include "WebNonCopyable.h"
  30 #include "WebPrivatePtr.h"
  31
  32 namespace WebCore {
  33 class MediaStreamComponent;
  34 }
  35
  36 namespace blink {
  37 class WebAudioSourceProvider;
  38 class WebMediaStream;
  39 class WebMediaStreamSource;
  40 class WebString;
  41
  42 class WebMediaStreamTrack {
  43 public:
  44     class ExtraData {
  45     public:
  46         ExtraData() : m_owner(0) { }
  47         virtual ~ExtraData() { }
  48
  49         BLINK_PLATFORM_EXPORT WebMediaStreamTrack owner();
  50
  51 #if INSIDE_BLINK
  52         BLINK_PLATFORM_EXPORT void setOwner(WebCore::MediaStreamComponent*);
  53 #endif
  54
  55     private:
  56         WebCore::MediaStreamComponent* m_owner;
  57     };
  58
  59     WebMediaStreamTrack() { }
  60     WebMediaStreamTrack(const WebMediaStreamTrack& other) { assign(other); }
  61     ~WebMediaStreamTrack() { reset(); }
  62
  63     WebMediaStreamTrack& operator=(const WebMediaStreamTrack& other)
  64     {
  65         assign(other);
  66         return *this;
  67     }
  68     BLINK_PLATFORM_EXPORT void assign(const WebMediaStreamTrack&);
  69
  70     BLINK_PLATFORM_EXPORT void initialize(const WebMediaStreamSource&);
  71     BLINK_PLATFORM_EXPORT void initialize(const WebString& id, const WebMediaStreamSource&);
  72
  73     BLINK_PLATFORM_EXPORT void reset();
  74     bool isNull() const { return m_private.isNull(); }
  75
  76     BLINK_PLATFORM_EXPORT WebString id() const;
  77
  78     BLINK_PLATFORM_EXPORT WebMediaStream stream() const;
  79     BLINK_PLATFORM_EXPORT WebMediaStreamSource source() const;
  80     BLINK_PLATFORM_EXPORT bool isEnabled() const;
  81
  82     // Extra data associated with this WebMediaStream.
  83     // If non-null, the extra data pointer will be deleted when the object is destroyed.
  84     // Setting the extra data pointer will cause any existing non-null
  85     // extra data pointer to be deleted.
  86     BLINK_PLATFORM_EXPORT ExtraData* extraData() const;
  87     BLINK_PLATFORM_EXPORT void setExtraData(ExtraData*);
  88
  89     // The lifetime of the WebAudioSourceProvider should outlive the
  90     // WebMediaStreamTrack, and clients are responsible for calling
  91     // setSourceProvider(0) before the WebMediaStreamTrack is going away.
  92     BLINK_PLATFORM_EXPORT void setSourceProvider(WebAudioSourceProvider*);
  93
  94 #if INSIDE_BLINK
  95     BLINK_PLATFORM_EXPORT WebMediaStreamTrack(PassRefPtr<WebCore::MediaStreamComponent>);
  96     BLINK_PLATFORM_EXPORT WebMediaStreamTrack(WebCore::MediaStreamComponent*);
  97     BLINK_PLATFORM_EXPORT WebMediaStreamTrack& operator=(WebCore::MediaStreamComponent*);
  98     BLINK_PLATFORM_EXPORT operator WTF::PassRefPtr<WebCore::MediaStreamComponent>() const;
  99     BLINK_PLATFORM_EXPORT operator WebCore::MediaStreamComponent*() const;
 100 #endif
 101
 102 private:
 103     WebPrivatePtr<WebCore::MediaStreamComponent> m_private;
 104 };
 105
 106 } // namespace blink
 107
 108 #endif // WebMediaStreamTrack_h