[Mac] process raw VTT in-band captions
[WebKit-https.git] / Source / WebCore / platform / graphics / ISOVTTCue.h
1 /*
2  * Copyright (C) 2014 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 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 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 ISOVTTCue_h
27 #define ISOVTTCue_h
28
29 #include <wtf/MediaTime.h>
30 #include <wtf/text/WTFString.h>
31
32 namespace JSC {
33 class ArrayBuffer;
34 }
35
36 namespace WebCore {
37
38 // An ISOBox represents a ISO-BMFF box. Data in the structure is big-endian. The layout of the data structure as follows:
39 // 4 bytes : 4CC : identifier
40 // 4 bytes : unsigned : length
41 class ISOBox {
42 public:
43     static String peekType(JSC::ArrayBuffer*);
44     static size_t peekLength(JSC::ArrayBuffer*);
45     static String peekString(JSC::ArrayBuffer*, unsigned offset, unsigned length);
46     static unsigned boxHeaderSize() { return 2 * sizeof(uint32_t); }
47
48     size_t length() const { return m_length; }
49     const AtomicString& type() const { return m_type; }
50
51 protected:
52     ISOBox(JSC::ArrayBuffer*);
53     
54 private:
55     size_t m_length;
56     AtomicString m_type;
57 };
58
59 // 4 bytes : 4CC : identifier = 'vttc'
60 // 4 bytes : unsigned : length
61 // N bytes :CueSourceIDBox : box : optional
62 // N bytes :CueIDBox : box : optional
63 // N bytes :CueTimeBox : box : optional
64 // N bytes :CueSettingsBox : box : optional
65 // N bytes :CuePayloadBox : box : required
66 class ISOWebVTTCue : public ISOBox {
67 public:
68     ISOWebVTTCue(const MediaTime& presentationTime, const MediaTime& duration, JSC::ArrayBuffer*);
69
70     static const AtomicString& boxType();
71
72     const MediaTime& presentationTime() const { return m_presentationTime; }
73     const MediaTime& duration() const { return m_duration; }
74
75     const String& sourceID() const { return m_sourceID; }
76     const String& id() const { return m_identifer; }
77     const String& originalStartTime() const { return m_originalStartTime; }
78     const String& settings() const { return m_settings; }
79     const String& cueText() const { return m_cueText; }
80
81 private:
82     MediaTime m_presentationTime;
83     MediaTime m_duration;
84
85     String m_sourceID;
86     String m_identifer;
87     String m_originalStartTime;
88     String m_settings;
89     String m_cueText;
90 };
91
92 }
93
94 #endif // ISOVTTCue_h