2 * Copyright (C) 2005 Wim Taymans <wim@fluendo.com>
4 * gstsegment.h: Header for GstSegment subsystem
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
23 #ifndef __GST_SEGMENT_H__
24 #define __GST_SEGMENT_H__
26 #include <gst/gstevent.h>
27 #include <gst/gstformat.h>
31 #define GST_TYPE_SEGMENT (gst_segment_get_type())
33 typedef struct _GstSegment GstSegment;
37 * @rate: the rate of the segment
38 * @format: the format of the segment values
39 * @flags: flags for this segment
40 * @start: the start of the segment
41 * @stop: the stop of the segment
42 * @time: the stream time of the segment
43 * @accum: accumulated segment
44 * @last_stop: last known stop time
45 * @duration: total duration of segment
46 * @applied_rate: the already applied rate to the segment
48 * A helper structure that holds the configured region of
49 * interest in a media file.
66 gpointer _gst_reserved[GST_PADDING];
69 GType gst_segment_get_type (void);
71 GstSegment * gst_segment_new (void);
72 GstSegment * gst_segment_copy (GstSegment *segment);
73 void gst_segment_free (GstSegment *segment);
75 void gst_segment_init (GstSegment *segment, GstFormat format);
77 void gst_segment_set_duration (GstSegment *segment, GstFormat format, gint64 duration);
78 void gst_segment_set_last_stop (GstSegment *segment, GstFormat format, gint64 position);
80 void gst_segment_set_seek (GstSegment *segment, gdouble rate,
81 GstFormat format, GstSeekFlags flags,
82 GstSeekType start_type, gint64 start,
83 GstSeekType stop_type, gint64 stop,
86 void gst_segment_set_newsegment (GstSegment *segment, gboolean update, gdouble rate,
87 GstFormat format, gint64 start, gint64 stop, gint64 time);
88 void gst_segment_set_newsegment_full (GstSegment *segment, gboolean update, gdouble rate,
89 gdouble applied_rate, GstFormat format, gint64 start,
90 gint64 stop, gint64 time);
92 gint64 gst_segment_to_stream_time (GstSegment *segment, GstFormat format, gint64 position);
93 gint64 gst_segment_to_running_time (GstSegment *segment, GstFormat format, gint64 position);
94 gint64 gst_segment_to_position (GstSegment *segment, GstFormat format, gint64 running_time);
96 gboolean gst_segment_clip (GstSegment *segment, GstFormat format, gint64 start,
97 gint64 stop, gint64 *clip_start, gint64 *clip_stop);
99 gboolean gst_segment_set_running_time (GstSegment *segment, GstFormat format, gint64 running_time);
104 #endif /* __GST_SEGMENT_H__ */