src/third_party/WebKit/Source/core/html/track/TextTrackList.h

   1 /*
   2  * Copyright (C) 2011, 2012 Apple 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 COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef TextTrackList_h
  27 #define TextTrackList_h
  28
  29 #include "bindings/v8/ScriptWrappable.h"
  30 #include "core/events/EventListener.h"
  31 #include "core/events/EventTarget.h"
  32 #include "core/html/HTMLMediaElement.h"
  33 #include "platform/Timer.h"
  34 #include "platform/heap/Handle.h"
  35 #include "wtf/PassRefPtr.h"
  36 #include "wtf/RefCounted.h"
  37 #include "wtf/Vector.h"
  38
  39 namespace WebCore {
  40
  41 class GenericEventQueue;
  42 class TextTrack;
  43
  44 class TextTrackList FINAL : public RefCountedWillBeRefCountedGarbageCollected<TextTrackList>, public ScriptWrappable, public EventTargetWithInlineData {
  45     DEFINE_EVENT_TARGET_REFCOUNTING(RefCountedWillBeRefCountedGarbageCollected<TextTrackList>);
  46 public:
  47     static PassRefPtrWillBeRawPtr<TextTrackList> create(HTMLMediaElement* owner)
  48     {
  49         return adoptRefWillBeRefCountedGarbageCollected(new TextTrackList(owner));
  50     }
  51     virtual ~TextTrackList();
  52
  53     unsigned length() const;
  54     int getTrackIndex(TextTrack*);
  55     int getTrackIndexRelativeToRenderedTracks(TextTrack*);
  56     bool contains(TextTrack*) const;
  57
  58     TextTrack* item(unsigned index);
  59     TextTrack* getTrackById(const AtomicString& id);
  60     void append(PassRefPtrWillBeRawPtr<TextTrack>);
  61     void remove(TextTrack*);
  62
  63     // EventTarget
  64     virtual const AtomicString& interfaceName() const OVERRIDE;
  65     virtual ExecutionContext* executionContext() const OVERRIDE;
  66
  67     DEFINE_ATTRIBUTE_EVENT_LISTENER(addtrack);
  68     DEFINE_ATTRIBUTE_EVENT_LISTENER(change);
  69     DEFINE_ATTRIBUTE_EVENT_LISTENER(removetrack);
  70
  71 #if !ENABLE(OILPAN)
  72     void clearOwner();
  73 #endif
  74     HTMLMediaElement* owner() const;
  75
  76     void scheduleChangeEvent();
  77     void removeAllInbandTracks();
  78
  79     void trace(Visitor*);
  80
  81 private:
  82     explicit TextTrackList(HTMLMediaElement*);
  83
  84     void scheduleTrackEvent(const AtomicString& eventName, PassRefPtrWillBeRawPtr<TextTrack>);
  85
  86     void scheduleAddTrackEvent(PassRefPtrWillBeRawPtr<TextTrack>);
  87     void scheduleRemoveTrackEvent(PassRefPtrWillBeRawPtr<TextTrack>);
  88
  89     void invalidateTrackIndexesAfterTrack(TextTrack*);
  90
  91     RawPtrWillBeMember<HTMLMediaElement> m_owner;
  92
  93     OwnPtr<GenericEventQueue> m_asyncEventQueue;
  94
  95     WillBeHeapVector<RefPtrWillBeMember<TextTrack> > m_addTrackTracks;
  96     WillBeHeapVector<RefPtrWillBeMember<TextTrack> > m_elementTracks;
  97     WillBeHeapVector<RefPtrWillBeMember<TextTrack> > m_inbandTracks;
  98 };
  99
 100 } // namespace WebCore
 101
 102 #endif