Home | History | Annotate | Download | only in mediastream 
      1 /*
      2  * Copyright (C) 2011 Ericsson AB. All rights reserved.
      3  * Copyright (C) 2012 Google Inc. All rights reserved.
      4  *
      5  * Redistribution and use in source and binary forms, with or without
      6  * modification, are permitted provided that the following conditions
      7  * are met:
      8  *
      9  * 1. Redistributions of source code must retain the above copyright
     10  *    notice, this list of conditions and the following disclaimer.
     11  * 2. Redistributions in binary form must reproduce the above copyright
     12  *    notice, this list of conditions and the following disclaimer
     13  *    in the documentation and/or other materials provided with the
     14  *    distribution.
     15  * 3. Neither the name of Ericsson nor the names of its contributors
     16  *    may be used to endorse or promote products derived from this
     17  *    software without specific prior written permission.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 #ifndef MediaStreamDescriptor_h
     33 #define MediaStreamDescriptor_h
     34 
     35 #include "platform/mediastream/MediaStreamComponent.h"
     36 #include "platform/mediastream/MediaStreamSource.h"
     37 #include "wtf/PassOwnPtr.h"
     38 #include "wtf/RefCounted.h"
     39 #include "wtf/Vector.h"
     40 
     41 namespace WebCore {
     42 
     43 class MediaStreamDescriptorClient {
     44 public:
     45     virtual ~MediaStreamDescriptorClient() { }
     46 
     47     virtual void streamEnded() = 0;
     48     virtual void addRemoteTrack(MediaStreamComponent*) = 0;
     49     virtual void removeRemoteTrack(MediaStreamComponent*) = 0;
     50 };
     51 
     52 class PLATFORM_EXPORT MediaStreamDescriptor FINAL : public RefCounted<MediaStreamDescriptor> {
     53 public:
     54     class ExtraData {
     55     public:
     56         virtual ~ExtraData() { }
     57     };
     58 
     59     // Only used for AudioDestinationNode.
     60     static PassRefPtr<MediaStreamDescriptor> create(const MediaStreamSourceVector& audioSources, const MediaStreamSourceVector& videoSources);
     61 
     62     static PassRefPtr<MediaStreamDescriptor> create(const MediaStreamComponentVector& audioComponents, const MediaStreamComponentVector& videoComponents);
     63 
     64     static PassRefPtr<MediaStreamDescriptor> create(const String& id, const MediaStreamComponentVector& audioComponents, const MediaStreamComponentVector& videoComponents);
     65 
     66     MediaStreamDescriptorClient* client() const { return m_client; }
     67     void setClient(MediaStreamDescriptorClient* client) { m_client = client; }
     68 
     69     String id() const { return m_id; }
     70 
     71     unsigned numberOfAudioComponents() const { return m_audioComponents.size(); }
     72     MediaStreamComponent* audioComponent(unsigned index) const { return m_audioComponents[index].get(); }
     73 
     74     unsigned numberOfVideoComponents() const { return m_videoComponents.size(); }
     75     MediaStreamComponent* videoComponent(unsigned index) const { return m_videoComponents[index].get(); }
     76 
     77     void addComponent(PassRefPtr<MediaStreamComponent>);
     78     void removeComponent(PassRefPtr<MediaStreamComponent>);
     79 
     80     void addRemoteTrack(MediaStreamComponent*);
     81     void removeRemoteTrack(MediaStreamComponent*);
     82 
     83     bool ended() const { return m_ended; }
     84     void setEnded() { m_ended = true; }
     85 
     86     ExtraData* extraData() const { return m_extraData.get(); }
     87     void setExtraData(PassOwnPtr<ExtraData> extraData) { m_extraData = extraData; }
     88 
     89 private:
     90     MediaStreamDescriptor(const String& id, const MediaStreamSourceVector& audioSources, const MediaStreamSourceVector& videoSources);
     91     MediaStreamDescriptor(const String& id, const MediaStreamComponentVector& audioComponents, const MediaStreamComponentVector& videoComponents);
     92 
     93     MediaStreamDescriptorClient* m_client;
     94     String m_id;
     95     Vector<RefPtr<MediaStreamComponent> > m_audioComponents;
     96     Vector<RefPtr<MediaStreamComponent> > m_videoComponents;
     97     bool m_ended;
     98 
     99     OwnPtr<ExtraData> m_extraData;
    100 };
    101 
    102 typedef Vector<RefPtr<MediaStreamDescriptor> > MediaStreamDescriptorVector;
    103 
    104 } // namespace WebCore
    105 
    106 #endif // MediaStreamDescriptor_h
    107