1/*
2 * Copyright (C) 2012-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 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
35namespace WebCore {
36
37class AVFInbandTrackParent {
38public:
39    virtual ~AVFInbandTrackParent();
40
41    virtual void trackModeChanged() = 0;
42};
43
44class InbandTextTrackPrivateAVF : public InbandTextTrackPrivate {
45public:
46    virtual ~InbandTextTrackPrivateAVF();
47
48    virtual void setMode(InbandTextTrackPrivate::Mode) override;
49
50    virtual int trackIndex() const override { return m_index; }
51    void setTextTrackIndex(int index) { m_index = index; }
52
53    virtual void disconnect();
54
55    bool hasBeenReported() const { return m_hasBeenReported; }
56    void setHasBeenReported(bool reported) { m_hasBeenReported = reported; }
57
58    virtual void processCue(CFArrayRef attributedStrings, CFArrayRef nativeSamples, double);
59    virtual void resetCueValues();
60
61    void beginSeeking();
62    void endSeeking() { m_seeking = false; }
63    bool seeking() const { return m_seeking; }
64
65    enum Category {
66        LegacyClosedCaption,
67        OutOfBand,
68        InBand
69    };
70    virtual Category textTrackCategory() const = 0;
71
72    virtual double startTimeVariance() const override { return 0.25; }
73
74protected:
75    InbandTextTrackPrivateAVF(AVFInbandTrackParent*, CueFormat);
76
77    void processCueAttributes(CFAttributedStringRef, GenericCueData&);
78    void processAttributedStrings(CFArrayRef, double);
79    void processNativeSamples(CFArrayRef, double);
80    void removeCompletedCues();
81
82    double m_currentCueStartTime;
83    double m_currentCueEndTime;
84
85    Vector<RefPtr<GenericCueData>> m_cues;
86    AVFInbandTrackParent* m_owner;
87
88    Vector<char> m_sampleInputBuffer;
89
90    enum PendingCueStatus {
91        None,
92        DeliveredDuringSeek,
93        Valid
94    };
95    PendingCueStatus m_pendingCueStatus;
96
97    int m_index;
98    bool m_hasBeenReported;
99    bool m_seeking;
100    bool m_haveReportedVTTHeader;
101};
102
103} // namespace WebCore
104
105#endif //  ENABLE(VIDEO) && (USE(AVFOUNDATION) || PLATFORM(IOS))
106
107#endif // InbandTextTrackPrivateAVF_h
108