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 "core/events/EventListener.h"
  30 #include "core/events/EventTarget.h"
  31 #include "core/html/HTMLMediaElement.h"
  32 #include "platform/Timer.h"
  33 #include "platform/heap/Handle.h"
  34 #include "wtf/PassRefPtr.h"
  35 #include "wtf/RefCounted.h"
  36 #include "wtf/Vector.h"
  37
  38 namespace blink {
  39
  40 class GenericEventQueue;
  41 class TextTrack;
  42
  43 class TextTrackList final : public RefCountedWillBeGarbageCollectedFinalized<TextTrackList>, public EventTargetWithInlineData {
  44     DEFINE_WRAPPERTYPEINFO();
  45     REFCOUNTED_EVENT_TARGET(TextTrackList);
  46     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(TextTrackList);
  47 public:
  48     static PassRefPtrWillBeRawPtr<TextTrackList> create(HTMLMediaElement* owner)
  49     {
  50         return adoptRefWillBeNoop(new TextTrackList(owner));
  51     }
  52     virtual ~TextTrackList();
  53
  54     unsigned length() const;
  55     int getTrackIndex(TextTrack*);
  56     int getTrackIndexRelativeToRenderedTracks(TextTrack*);
  57     bool contains(TextTrack*) const;
  58
  59     TextTrack* item(unsigned index);
  60     TextTrack* getTrackById(const AtomicString& id);
  61     void append(PassRefPtrWillBeRawPtr<TextTrack>);
  62     void remove(TextTrack*);
  63
  64     // EventTarget
  65     virtual const AtomicString& interfaceName() const override;
  66     virtual ExecutionContext* executionContext() const override;
  67
  68     DEFINE_ATTRIBUTE_EVENT_LISTENER(addtrack);
  69     DEFINE_ATTRIBUTE_EVENT_LISTENER(change);
  70     DEFINE_ATTRIBUTE_EVENT_LISTENER(removetrack);
  71
  72 #if !ENABLE(OILPAN)
  73     void clearOwner();
  74 #endif
  75     HTMLMediaElement* owner() const;
  76
  77     void scheduleChangeEvent();
  78     void removeAllInbandTracks();
  79
  80     virtual void trace(Visitor*) override;
  81
  82 private:
  83     explicit TextTrackList(HTMLMediaElement*);
  84
  85     void scheduleTrackEvent(const AtomicString& eventName, PassRefPtrWillBeRawPtr<TextTrack>);
  86
  87     void scheduleAddTrackEvent(PassRefPtrWillBeRawPtr<TextTrack>);
  88     void scheduleRemoveTrackEvent(PassRefPtrWillBeRawPtr<TextTrack>);
  89
  90     void invalidateTrackIndexesAfterTrack(TextTrack*);
  91
  92     RawPtrWillBeMember<HTMLMediaElement> m_owner;
  93
  94     OwnPtrWillBeMember<GenericEventQueue> m_asyncEventQueue;
  95
  96     WillBeHeapVector<RefPtrWillBeMember<TextTrack>> m_addTrackTracks;
  97     WillBeHeapVector<RefPtrWillBeMember<TextTrack>> m_elementTracks;
  98     WillBeHeapVector<RefPtrWillBeMember<TextTrack>> m_inbandTracks;
  99 };
 100
 101 } // namespace blink
 102
 103 #endif // TextTrackList_h