Home | History | Annotate | Download | only in mediastream 
      1 /*
      2  * Copyright (C) 2011 Google Inc. All rights reserved.
      3  * Copyright (C) 2011 Ericsson AB. 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  * 1.  Redistributions of source code must retain the above copyright
      9  *     notice, this list of conditions and the following disclaimer.
     10  * 2.  Redistributions in binary form must reproduce the above copyright
     11  *     notice, this list of conditions and the following disclaimer in the
     12  *     documentation and/or other materials provided with the distribution.
     13  *
     14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
     15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     17  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
     18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
     21  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     23  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     24  */
     25 
     26 #ifndef MediaStreamTrack_h
     27 #define MediaStreamTrack_h
     28 
     29 #include "bindings/v8/ScriptWrappable.h"
     30 #include "core/dom/ActiveDOMObject.h"
     31 #include "modules/EventTargetModules.h"
     32 #include "modules/mediastream/SourceInfo.h"
     33 #include "platform/mediastream/MediaStreamDescriptor.h"
     34 #include "platform/mediastream/MediaStreamSource.h"
     35 #include "wtf/PassOwnPtr.h"
     36 #include "wtf/RefCounted.h"
     37 #include "wtf/RefPtr.h"
     38 #include "wtf/Vector.h"
     39 #include "wtf/text/WTFString.h"
     40 
     41 namespace WebCore {
     42 
     43 class AudioSourceProvider;
     44 class ExceptionState;
     45 class MediaStreamComponent;
     46 class MediaStreamTrackSourcesCallback;
     47 
     48 class MediaStreamTrack FINAL : public RefCountedWillBeRefCountedGarbageCollected<MediaStreamTrack>, public ScriptWrappable, public ActiveDOMObject, public EventTargetWithInlineData, public MediaStreamSource::Observer {
     49     REFCOUNTED_EVENT_TARGET(MediaStreamTrack);
     50     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(MediaStreamTrack);
     51 public:
     52     static PassRefPtrWillBeRawPtr<MediaStreamTrack> create(ExecutionContext*, MediaStreamComponent*);
     53     virtual ~MediaStreamTrack();
     54 
     55     String kind() const;
     56     String id() const;
     57     String label() const;
     58 
     59     bool enabled() const;
     60     void setEnabled(bool);
     61 
     62     String readyState() const;
     63 
     64     static void getSources(ExecutionContext*, PassOwnPtr<MediaStreamTrackSourcesCallback>, ExceptionState&);
     65     void stopTrack(ExceptionState&);
     66     PassRefPtrWillBeRawPtr<MediaStreamTrack> clone(ExecutionContext*);
     67 
     68     DEFINE_ATTRIBUTE_EVENT_LISTENER(mute);
     69     DEFINE_ATTRIBUTE_EVENT_LISTENER(unmute);
     70     DEFINE_ATTRIBUTE_EVENT_LISTENER(ended);
     71 
     72     MediaStreamComponent* component();
     73     bool ended() const;
     74 
     75     void registerMediaStream(MediaStream*);
     76     void unregisterMediaStream(MediaStream*);
     77 
     78     // EventTarget
     79     virtual const AtomicString& interfaceName() const OVERRIDE;
     80     virtual ExecutionContext* executionContext() const OVERRIDE;
     81 
     82     // ActiveDOMObject
     83     virtual void stop() OVERRIDE;
     84 
     85     PassOwnPtr<AudioSourceProvider> createWebAudioSource();
     86 
     87     virtual void trace(Visitor*) OVERRIDE;
     88 
     89 private:
     90     MediaStreamTrack(ExecutionContext*, MediaStreamComponent*);
     91 
     92     MediaStreamSource::ReadyState m_readyState;
     93 
     94     // MediaStreamSourceObserver
     95     virtual void sourceChangedState() OVERRIDE;
     96 
     97     void propagateTrackEnded();
     98     WillBeHeapHashSet<RawPtrWillBeMember<MediaStream> > m_registeredMediaStreams;
     99     bool m_isIteratingRegisteredMediaStreams;
    100 
    101     bool m_stopped;
    102     RefPtr<MediaStreamComponent> m_component;
    103 };
    104 
    105 typedef WillBeHeapVector<RefPtrWillBeMember<MediaStreamTrack> > MediaStreamTrackVector;
    106 
    107 } // namespace WebCore
    108 
    109 #endif // MediaStreamTrack_h
    110