summaryrefslogtreecommitdiffstats
path: root/libdash/include/ITimeline.h
diff options
context:
space:
mode:
authorLuca Muscariello <lumuscar+fdio@cisco.com>2017-02-25 23:42:31 +0100
committerLuca Muscariello <lumuscar+fdio@cisco.com>2017-02-25 23:42:31 +0100
commit05c1a838c881ea502888659848d8792843b28718 (patch)
treecf0b05b58bd725a1eb6c80325ba986c63dea42aa /libdash/include/ITimeline.h
parent9b30fc10fb1cbebe651e5a107e8ca5b24de54675 (diff)
Initial commit: video player - viper
Change-Id: Id5aa33598ce34659bad4a7a9ae5006bfb84f9bd1 Signed-off-by: Luca Muscariello <lumuscar+fdio@cisco.com>
Diffstat (limited to 'libdash/include/ITimeline.h')
-rw-r--r--libdash/include/ITimeline.h66
1 files changed, 66 insertions, 0 deletions
diff --git a/libdash/include/ITimeline.h b/libdash/include/ITimeline.h
new file mode 100644
index 00000000..e1f8e953
--- /dev/null
+++ b/libdash/include/ITimeline.h
@@ -0,0 +1,66 @@
+/**
+ * @class dash::mpd::ITimeline
+ * @brief This interface is needed for accessing the attributes of <b><tt>S</tt></b> elements, as specified in <em>ISO/IEC 23009-1, Part 1, 2012</em>, section 5.3.9.6.1
+ * @details dash::mpd::ITimeline objects correspond to <b><tt>S</tt></b> elements of the <tt><b>SegmentTimeline</b></tt> \n \n
+ * The <b><tt>S</tt></b> element contains a mandatory \c \@d attribute specifying the MPD duration,
+ * an optional \c \@r repeat count attribute specifying the number of contiguous Segments with identical MPD duration minus one
+ * and an optional \c \@t time attribute specifying the MPD start time of the first Segment in the series.
+ * @see dash::mpd::ISegmentTimeline dash::mpd::IMultipleSegmentBase dash::mpd::IMPDElement
+ *
+ * @author bitmovin Softwareentwicklung OG \n
+ * Email: libdash-dev@vicky.bitmovin.net
+ * @version 2.1
+ * @date 2013
+ * @copyright bitmovin Softwareentwicklung OG, All Rights Reserved \n\n
+ * This source code and its use and distribution, is subject to the terms
+ * and conditions of the applicable license agreement.
+ */
+
+#ifndef ITIMELINE_H_
+#define ITIMELINE_H_
+
+#include "config.h"
+
+#include "IMPDElement.h"
+
+namespace dash
+{
+ namespace mpd
+ {
+ class ITimeline : public virtual IMPDElement
+ {
+ public:
+ virtual ~ITimeline(){}
+
+ /**
+ * Returns an integer that specifies the MPD start time, in \c \@timescale units, the first Segment in the series starts relative to the beginning of the Period.\n
+ * The value of this attribute must be equal to or greater than the sum of the previous <tt><b>S</b></tt> element earliest presentation time and
+ * the sum of the contiguous Segment durations. \n
+ * If the value of the attribute is greater than what is expressed by the previous <tt><b>S</b></tt> element, it expresses discontinuities in the timeline.\n
+ * If not present then the value shall be assumed to be zero for the first S element and for the subsequent <tt><b>S</b></tt> elements,
+ * the value shall be assumed to be the sum of the previous <tt><b>S</b></tt> element's earliest presentation time and contiguous duration
+ * (i.e. previous <tt><b>S</b>\@t</tt> + \c \@d * (\c \@r + 1)).\n\n
+ * \em StartTime corresponds to the \c \@t attribute.
+ * @return an unsigned integer
+ */
+ virtual uint32_t GetStartTime () const = 0;
+
+ /**
+ * Returns the integer that specifies the Segment duration, in units of the value of the \c \@timescale. \n\n
+ * \em Duration corresponds to the \c \@d attribute.
+ * @return an unsigned integer
+ */
+ virtual uint32_t GetDuration () const = 0;
+
+ /**
+ * Returns an integer that specifies the repeat count of the number of following contiguous Segments with the same duration expressed by the value of \c \@d.
+ * This value is zero-based (e.g. a value of three means four Segments in the contiguous series). \n\n
+ * \em RepeatCount corresponds to the \c \@r attribute.
+ * @return an unsigned integer
+ */
+ virtual uint32_t GetRepeatCount () const = 0;
+ };
+ }
+}
+
+#endif /* ITIMELINE_H_ */ \ No newline at end of file