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 WebMediaStream_h
26#define WebMediaStream_h
27
28#include "WebCommon.h"
29#include "WebNonCopyable.h"
30#include "WebPrivatePtr.h"
31#include "WebVector.h"
32
33namespace blink {
34
35class MediaStreamDescriptor;
36class WebMediaStreamSource;
37class WebMediaStreamTrack;
38class WebString;
39
40class WebMediaStream {
41public:
42    class ExtraData {
43    public:
44        virtual ~ExtraData() { }
45    };
46
47    WebMediaStream() { }
48    WebMediaStream(const WebMediaStream& other) { assign(other); }
49    ~WebMediaStream() { reset(); }
50
51    WebMediaStream& operator=(const WebMediaStream& other)
52    {
53        assign(other);
54        return *this;
55    }
56
57    BLINK_PLATFORM_EXPORT void assign(const WebMediaStream&);
58
59    BLINK_PLATFORM_EXPORT void initialize(const WebVector<WebMediaStreamTrack>& audioTracks, const WebVector<WebMediaStreamTrack>& videoTracks);
60    BLINK_PLATFORM_EXPORT void initialize(const WebString& label, const WebVector<WebMediaStreamTrack>& audioTracks, const WebVector<WebMediaStreamTrack>& videoTracks);
61
62    BLINK_PLATFORM_EXPORT void reset();
63    bool isNull() const { return m_private.isNull(); }
64
65    BLINK_PLATFORM_EXPORT WebString id() const;
66
67    BLINK_PLATFORM_EXPORT void audioTracks(WebVector<WebMediaStreamTrack>&) const;
68    BLINK_PLATFORM_EXPORT void videoTracks(WebVector<WebMediaStreamTrack>&) const;
69
70    BLINK_PLATFORM_EXPORT void addTrack(const WebMediaStreamTrack&);
71    BLINK_PLATFORM_EXPORT void removeTrack(const WebMediaStreamTrack&);
72
73    // Extra data associated with this WebMediaStream.
74    // If non-null, the extra data pointer will be deleted when the object is destroyed.
75    // Setting the extra data pointer will cause any existing non-null
76    // extra data pointer to be deleted.
77    BLINK_PLATFORM_EXPORT ExtraData* extraData() const;
78    BLINK_PLATFORM_EXPORT void setExtraData(ExtraData*);
79
80#if INSIDE_BLINK
81    BLINK_PLATFORM_EXPORT WebMediaStream(MediaStreamDescriptor*);
82    BLINK_PLATFORM_EXPORT WebMediaStream(const WTF::PassRefPtr<MediaStreamDescriptor>&);
83    BLINK_PLATFORM_EXPORT operator WTF::PassRefPtr<MediaStreamDescriptor>() const;
84    BLINK_PLATFORM_EXPORT operator MediaStreamDescriptor*() const;
85    BLINK_PLATFORM_EXPORT WebMediaStream& operator=(const WTF::PassRefPtr<MediaStreamDescriptor>&);
86#endif
87
88private:
89    WebPrivatePtr<MediaStreamDescriptor> m_private;
90};
91
92} // namespace blink
93
94#endif // WebMediaStream_h
95