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