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 "platform/Timer.h"
33#include "wtf/PassRefPtr.h"
34#include "wtf/RefCounted.h"
35#include "wtf/Vector.h"
36
37namespace WebCore {
38
39class GenericEventQueue;
40class HTMLMediaElement;
41class TextTrack;
42class TextTrackList;
43
44class TextTrackList : public RefCounted<TextTrackList>, public ScriptWrappable, public EventTargetWithInlineData {
45    REFCOUNTED_EVENT_TARGET(TextTrackList);
46public:
47    static PassRefPtr<TextTrackList> create(HTMLMediaElement* owner)
48    {
49        return adoptRef(new TextTrackList(owner));
50    }
51    ~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(PassRefPtr<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    void clearOwner() { m_owner = 0; }
72    Node* owner() const;
73
74    void scheduleChangeEvent();
75
76private:
77    explicit TextTrackList(HTMLMediaElement*);
78
79    void scheduleTrackEvent(const AtomicString& eventName, PassRefPtr<TextTrack>);
80
81    void scheduleAddTrackEvent(PassRefPtr<TextTrack>);
82    void scheduleRemoveTrackEvent(PassRefPtr<TextTrack>);
83
84    void invalidateTrackIndexesAfterTrack(TextTrack*);
85
86    HTMLMediaElement* m_owner;
87
88    OwnPtr<GenericEventQueue> m_asyncEventQueue;
89
90    Vector<RefPtr<TextTrack> > m_addTrackTracks;
91    Vector<RefPtr<TextTrack> > m_elementTracks;
92    Vector<RefPtr<TextTrack> > m_inbandTracks;
93};
94
95} // namespace WebCore
96
97#endif
98