Source/WebCore/html/track/TextTrackList.h

   1 /*
   2  * Copyright (C) 2011 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 #if ENABLE(VIDEO_TRACK)
  30
  31 #include "EventListener.h"
  32 #include "EventTarget.h"
  33 #include "Timer.h"
  34 #include <algorithm>
  35 #include <wtf/PassRefPtr.h>
  36 #include <wtf/RefCounted.h>
  37 #include <wtf/Vector.h>
  38
  39 namespace WebCore {
  40
  41 class HTMLMediaElement;
  42 class TextTrack;
  43 class TextTrackList;
  44
  45 class TextTrackList : public RefCounted<TextTrackList>, public EventTarget {
  46 public:
  47     static PassRefPtr<TextTrackList> create(HTMLMediaElement* owner, ScriptExecutionContext* context)
  48     {
  49         return adoptRef(new TextTrackList(owner, context));
  50     }
  51     ~TextTrackList();
  52
  53     unsigned length() const;
  54     TextTrack* item(unsigned index);
  55     void append(PassRefPtr<TextTrack>);
  56     void remove(PassRefPtr<TextTrack>);
  57
  58     // EventTarget
  59     virtual const AtomicString& interfaceName() const;
  60     using RefCounted<TextTrackList>::ref;
  61     using RefCounted<TextTrackList>::deref;
  62     virtual ScriptExecutionContext* scriptExecutionContext() const { return m_context; }
  63
  64     DEFINE_ATTRIBUTE_EVENT_LISTENER(addtrack);
  65
  66     void clearOwner() { m_owner = 0; }
  67     HTMLMediaElement* owner() { return m_owner; }
  68
  69     bool isFiringEventListeners() { return m_dispatchingEvents; }
  70
  71 private:
  72     TextTrackList(HTMLMediaElement*, ScriptExecutionContext*);
  73
  74     // EventTarget
  75     virtual void refEventTarget() { ref(); }
  76     virtual void derefEventTarget() { deref(); }
  77     virtual EventTargetData* eventTargetData() { return &m_eventTargetData; }
  78     virtual EventTargetData* ensureEventTargetData() { return &m_eventTargetData; }
  79
  80     void scheduleAddTrackEvent(PassRefPtr<TextTrack>);
  81     void asyncEventTimerFired(Timer<TextTrackList>*);
  82
  83     ScriptExecutionContext* m_context;
  84     HTMLMediaElement* m_owner;
  85
  86     Vector<RefPtr<Event> > m_pendingEvents;
  87     Timer<TextTrackList> m_pendingEventTimer;
  88
  89     EventTargetData m_eventTargetData;
  90     Vector<RefPtr<TextTrack> > m_addTrackTracks;
  91     Vector<RefPtr<TextTrack> > m_elementTracks;
  92
  93     int m_dispatchingEvents;
  94 };
  95
  96 } // namespace WebCore
  97
  98 #endif
  99 #endif