[Win] Update Media Player logic for new Legible Output API
[WebKit-https.git] / Source / WebCore / platform / graphics / avfoundation / InbandTextTrackPrivateAVF.h
1 /*
2  * Copyright (C) 2012-2015 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 InbandTextTrackPrivateAVF_h
27 #define InbandTextTrackPrivateAVF_h
28
29 #if ENABLE(VIDEO) && (USE(AVFOUNDATION) || PLATFORM(IOS))
30
31 #include "InbandTextTrackPrivate.h"
32 #include "InbandTextTrackPrivateClient.h"
33 #include <wtf/text/StringBuilder.h>
34
35 typedef const struct opaqueCMFormatDescription* CMFormatDescriptionRef;
36
37 namespace JSC {
38 class ArrayBuffer;
39 }
40
41 namespace WebCore {
42
43 class AVFInbandTrackParent {
44 public:
45     virtual ~AVFInbandTrackParent();
46     
47     virtual void trackModeChanged() = 0;
48 };
49
50 class InbandTextTrackPrivateAVF : public InbandTextTrackPrivate {
51 public:
52     virtual ~InbandTextTrackPrivateAVF();
53
54     virtual void setMode(InbandTextTrackPrivate::Mode) override;
55
56     virtual int trackIndex() const override { return m_index; }
57     void setTextTrackIndex(int index) { m_index = index; }
58
59     virtual void disconnect();
60
61     bool hasBeenReported() const { return m_hasBeenReported; }
62     void setHasBeenReported(bool reported) { m_hasBeenReported = reported; }
63
64     virtual void processCue(CFArrayRef attributedStrings, CFArrayRef nativeSamples, const MediaTime&);
65     virtual void resetCueValues();
66
67     void beginSeeking();
68     void endSeeking() { m_seeking = false; }
69     bool seeking() const { return m_seeking; }
70     
71     enum Category {
72         LegacyClosedCaption,
73         OutOfBand,
74         InBand
75     };
76     virtual Category textTrackCategory() const = 0;
77     
78     virtual MediaTime startTimeVariance() const override { return MediaTime(1, 4); }
79
80     virtual bool readNativeSampleBuffer(CFArrayRef nativeSamples, CFIndex, RefPtr<JSC::ArrayBuffer>&, MediaTime&, CMFormatDescriptionRef&);
81     
82 protected:
83     InbandTextTrackPrivateAVF(AVFInbandTrackParent*, CueFormat);
84
85     void processCueAttributes(CFAttributedStringRef, GenericCueData&);
86     void processAttributedStrings(CFArrayRef, const MediaTime&);
87     void processNativeSamples(CFArrayRef, const MediaTime&);
88     void removeCompletedCues();
89
90     MediaTime m_currentCueStartTime;
91     MediaTime m_currentCueEndTime;
92
93     Vector<RefPtr<GenericCueData>> m_cues;
94     AVFInbandTrackParent* m_owner;
95
96     Vector<char> m_sampleInputBuffer;
97
98     enum PendingCueStatus {
99         None,
100         DeliveredDuringSeek,
101         Valid
102     };
103     PendingCueStatus m_pendingCueStatus;
104
105     int m_index;
106     bool m_hasBeenReported;
107     bool m_seeking;
108     bool m_haveReportedVTTHeader;
109 };
110
111 } // namespace WebCore
112
113 #endif //  ENABLE(VIDEO) && (USE(AVFOUNDATION) || PLATFORM(IOS))
114
115 #endif // InbandTextTrackPrivateAVF_h