Added gst-plugins-base-subtitles0.10-0.10.34 for Meego Harmattan 1.2
[mafwsubrenderer] / gst-plugins-base-subtitles0.10 / gst-libs / gst / rtsp / gstrtsprange.h
1 /* GStreamer
2  * Copyright (C) <2005,2006> Wim Taymans <wim@fluendo.com>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19 /*
20  * Unless otherwise indicated, Source Code is licensed under MIT license.
21  * See further explanation attached in License Statement (distributed in the file
22  * LICENSE).
23  *
24  * Permission is hereby granted, free of charge, to any person obtaining a copy of
25  * this software and associated documentation files (the "Software"), to deal in
26  * the Software without restriction, including without limitation the rights to
27  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
28  * of the Software, and to permit persons to whom the Software is furnished to do
29  * so, subject to the following conditions:
30  *
31  * The above copyright notice and this permission notice shall be included in all
32  * copies or substantial portions of the Software.
33  *
34  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
35  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
36  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
37  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
38  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
39  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
40  * SOFTWARE.
41  */
42
43 #ifndef __GST_RTSP_RANGE_H__
44 #define __GST_RTSP_RANGE_H__
45
46 #include <glib.h>
47
48 #include <gst/rtsp/gstrtspdefs.h>
49
50 G_BEGIN_DECLS
51
52 /**
53  * GstRTSPRangeUnit:
54  * @GST_RTSP_RANGE_SMPTE: SMPTE timecode
55  * @GST_RTSP_RANGE_SMPTE_30_DROP: 29.97 frames per second
56  * @GST_RTSP_RANGE_SMPTE_25: 25 frames per second
57  * @GST_RTSP_RANGE_NPT: Normal play time 
58  * @GST_RTSP_RANGE_CLOCK: Absolute time expressed as ISO 8601 timestamps
59  *
60  * Different possible time range units.
61  */
62 typedef enum
63 {
64   GST_RTSP_RANGE_SMPTE,
65   GST_RTSP_RANGE_SMPTE_30_DROP,
66   GST_RTSP_RANGE_SMPTE_25,
67   GST_RTSP_RANGE_NPT,
68   GST_RTSP_RANGE_CLOCK
69 } GstRTSPRangeUnit;
70
71 typedef struct _GstRTSPTimeRange GstRTSPTimeRange;
72 typedef struct _GstRTSPTime GstRTSPTime;
73
74 /**
75  * GstRTSPTimeType:
76  * @GST_RTSP_TIME_SECONDS: seconds
77  * @GST_RTSP_TIME_NOW: now
78  * @GST_RTSP_TIME_END: end
79  *
80  * Possible time types.
81  */
82 typedef enum {
83   GST_RTSP_TIME_SECONDS,
84   GST_RTSP_TIME_NOW,
85   GST_RTSP_TIME_END
86 } GstRTSPTimeType;
87
88 /**
89  * GstRTSPTime:
90  * @type: the time of the time
91  * @seconds: seconds when @type is GST_RTSP_TIME_SECONDS 
92  *
93  * A time indication.
94  */
95 struct _GstRTSPTime {
96   GstRTSPTimeType type;
97   gdouble         seconds;
98 };
99
100 /**
101  * GstRTSPTimeRange:
102  * @unit: the time units used
103  * @min: the minimum interval
104  * @max: the maximum interval
105  *
106  * A time range.
107  */
108 struct _GstRTSPTimeRange {
109   GstRTSPRangeUnit unit;
110
111   GstRTSPTime min;
112   GstRTSPTime max;
113 };
114
115 GstRTSPResult   gst_rtsp_range_parse        (const gchar *rangestr, GstRTSPTimeRange **range);
116 gchar *         gst_rtsp_range_to_string    (const GstRTSPTimeRange *range);
117 void            gst_rtsp_range_free         (GstRTSPTimeRange *range);
118
119 G_END_DECLS
120
121 #endif /* __GST_RTSP_RANGE_H__ */