Source/core/html/track/TextTrackCue.h

/*
 * Copyright (C) 2011 Google Inc.  All rights reserved.
 * Copyright (C) 2012, 2013 Apple Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef TextTrackCue_h
#define TextTrackCue_h

#include "core/events/EventTarget.h"
#include "core/html/HTMLDivElement.h"
#include "wtf/RefCounted.h"

namespace WebCore {

class Document;
class ExceptionState;
class TextTrackCue;

// ----------------------------

class TextTrackCueBox : public HTMLDivElement {
public:
    static const AtomicString& textTrackCueBoxShadowPseudoId()
    {
        DEFINE_STATIC_LOCAL(const AtomicString, trackDisplayBoxShadowPseudoId, ("-webkit-media-text-track-display", AtomicString::ConstructFromLiteral));
        return trackDisplayBoxShadowPseudoId;
    }

protected:
    TextTrackCueBox(Document&);
};

// ----------------------------

class TextTrackCue : public RefCounted<TextTrackCue>, public EventTargetWithInlineData {
    REFCOUNTED_EVENT_TARGET(TextTrackCue);
public:
    static bool isInfiniteOrNonNumber(double value, const char* method, ExceptionState&);

    static const AtomicString& cueShadowPseudoId()
    {
        DEFINE_STATIC_LOCAL(const AtomicString, cue, ("cue", AtomicString::ConstructFromLiteral));
        return cue;
    }

    virtual ~TextTrackCue() { }

    TextTrack* track() const;
    void setTrack(TextTrack*);

    const String& id() const { return m_id; }
    void setId(const String&);

    double startTime() const { return m_startTime; }
    void setStartTime(double, ExceptionState&);

    double endTime() const { return m_endTime; }
    void setEndTime(double, ExceptionState&);

    bool pauseOnExit() const { return m_pauseOnExit; }
    void setPauseOnExit(bool);

    int cueIndex();
    void invalidateCueIndex();

    using EventTarget::dispatchEvent;
    virtual bool dispatchEvent(PassRefPtr<Event>) OVERRIDE;

    bool isActive();
    void setIsActive(bool);

    virtual void updateDisplay(const IntSize& videoSize, HTMLDivElement& container) = 0;

    // FIXME: Consider refactoring to eliminate or merge the following three members.
    // https://code.google.com/p/chromium/issues/detail?id=322434
    virtual void updateDisplayTree(double movieTime) { }
    virtual void removeDisplayTree() { }
    virtual void notifyRegionWhenRemovingDisplayTree(bool notifyRegion) { }

    virtual const AtomicString& interfaceName() const OVERRIDE;

    DEFINE_ATTRIBUTE_EVENT_LISTENER(enter);
    DEFINE_ATTRIBUTE_EVENT_LISTENER(exit);

    virtual bool isVTTCue() const { return false; }

    virtual String toString() const;

protected:
    TextTrackCue(double start, double end);

    void cueWillChange();
    virtual void cueDidChange();

private:
    String m_id;
    double m_startTime;
    double m_endTime;
    int m_cueIndex;

    TextTrack* m_track;

    bool m_isActive;
    bool m_pauseOnExit;
};

} // namespace WebCore

#endif