48af164d985c36195b57195e2179264d7f839fed
[WebKit-https.git] / Source / WTF / wtf / MediaTime.h
1 /*
2  * Copyright (C) 2012 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef MediaTime_h
30 #define MediaTime_h
31
32 #include <wtf/FastMalloc.h>
33
34 #include <cmath>
35 #include <limits>
36 #include <math.h>
37 #include <stdint.h>
38
39 namespace WTF {
40
41 class WTF_EXPORT_PRIVATE MediaTime {
42     WTF_MAKE_FAST_ALLOCATED;
43 public:
44     enum {
45         Valid = 1 << 0,
46         HasBeenRounded = 1 << 1,
47         PositiveInfinite = 1 << 2,
48         NegativeInfinite = 1 << 3,
49         Indefinite = 1 << 4,
50     };
51
52     MediaTime();
53     MediaTime(int64_t value, int32_t scale = DefaultTimeScale, uint32_t flags = Valid);
54     MediaTime(const MediaTime& rhs);
55     ~MediaTime();
56
57     static MediaTime createWithFloat(float floatTime, int32_t timeScale = DefaultTimeScale);
58     static MediaTime createWithDouble(double doubleTime, int32_t timeScale = DefaultTimeScale);
59
60     float toFloat() const;
61     double toDouble() const;
62
63     MediaTime& operator=(const MediaTime& rhs);
64     MediaTime operator+(const MediaTime& rhs) const;
65     MediaTime operator-(const MediaTime& rhs) const;
66     bool operator<(const MediaTime& rhs) const;
67     bool operator>(const MediaTime& rhs) const;
68     bool operator==(const MediaTime& rhs) const;
69     bool operator>=(const MediaTime& rhs) const;
70     bool operator<=(const MediaTime& rhs) const;
71
72     typedef enum {
73         LessThan = -1,
74         EqualTo = 0,
75         GreaterThan = 1,
76     } ComparisonFlags;
77
78     ComparisonFlags compare(const MediaTime& rhs) const;
79
80     bool isValid() const { return m_timeFlags & Valid; }
81     bool isInvalid() const { return !isValid(); }
82     bool hasBeenRounded() const { return m_timeFlags & HasBeenRounded; }
83     bool isPositiveInfinite() const { return m_timeFlags & PositiveInfinite; }
84     bool isNegativeInfinite() const { return m_timeFlags & NegativeInfinite; }
85     bool isIndefinite() const { return m_timeFlags & Indefinite; }
86
87     static const MediaTime& zeroTime();
88     static const MediaTime& invalidTime();
89     static const MediaTime& positiveInfiniteTime();
90     static const MediaTime& negativeInfiniteTime();
91     static const MediaTime& indefiniteTime();
92
93     const int64_t& timeValue() const { return m_timeValue; }
94     const int32_t& timeScale() const { return m_timeScale; }
95
96     friend WTF_EXPORT_PRIVATE MediaTime abs(const MediaTime& rhs);
97 private:
98     static const int32_t DefaultTimeScale = 6000;
99     static const int32_t MaximumTimeScale;
100
101     void setTimeScale(int32_t);
102
103     int64_t m_timeValue;
104     int32_t m_timeScale;
105     uint32_t m_timeFlags;
106 };
107
108 WTF_EXPORT_PRIVATE extern MediaTime abs(const MediaTime& rhs);
109 }
110
111 using WTF::MediaTime;
112 using WTF::abs;
113
114 #endif