src/third_party/WebKit/Source/core/html/track/TrackBase.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 TrackBase_h
  27 #define TrackBase_h
  28
  29 #include "platform/heap/Handle.h"
  30 #include "public/platform/WebMediaPlayer.h"
  31 #include "wtf/RefCounted.h"
  32 #include "wtf/text/AtomicString.h"
  33
  34 namespace blink {
  35
  36 class HTMLMediaElement;
  37
  38 class TrackBase : public RefCountedWillBeGarbageCollectedFinalized<TrackBase> {
  39 public:
  40     virtual ~TrackBase();
  41
  42     blink::WebMediaPlayer::TrackId trackId() const { return m_trackId; }
  43
  44     enum Type { TextTrack, AudioTrack, VideoTrack };
  45     Type type() const { return m_type; }
  46
  47     const AtomicString& kind() const { return m_kind; }
  48     virtual void setKind(const AtomicString&);
  49
  50     AtomicString label() const { return m_label; }
  51     void setLabel(const AtomicString& label) { m_label = label; }
  52
  53     AtomicString language() const { return m_language; }
  54     void setLanguage(const AtomicString& language) { m_language = language; }
  55
  56     String id() const { return m_id; }
  57     void setId(const String& id) { m_id = id; }
  58
  59     void setMediaElement(HTMLMediaElement* mediaElement) { m_mediaElement = mediaElement; }
  60     HTMLMediaElement* mediaElement() const { return m_mediaElement; }
  61     Node* owner() const;
  62
  63     virtual void trace(Visitor*);
  64
  65 protected:
  66     TrackBase(Type, const AtomicString& label, const AtomicString& language, const String& id);
  67
  68     virtual bool isValidKind(const AtomicString&) const = 0;
  69     virtual AtomicString defaultKind() const = 0;
  70
  71 private:
  72     blink::WebMediaPlayer::TrackId m_trackId;
  73     Type m_type;
  74     AtomicString m_kind;
  75     AtomicString m_label;
  76     AtomicString m_language;
  77     String m_id;
  78     RawPtrWillBeMember<HTMLMediaElement> m_mediaElement;
  79 };
  80
  81 #define DEFINE_TRACK_TYPE_CASTS(thisType, predicate) \
  82     DEFINE_TYPE_CASTS(thisType, TrackBase, track, track->type() == predicate, track.type() == predicate)
  83
  84 } // namespace blink
  85
  86 #endif // TrackBase_h