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/gstformat.h>
30 #define GST_TYPE_SEGMENT (gst_segment_get_type())
32 typedef struct _GstSegment GstSegment;
36 * @GST_SEEK_TYPE_NONE: no change in position is required
37 * @GST_SEEK_TYPE_CUR: change relative to currently configured segment. This
38 * can't be used to seek relative to the current playback position - do a
39 * position query, calculate the desired position and then do an absolute
40 * position seek instead if that's what you want to do.
41 * @GST_SEEK_TYPE_SET: absolute position is requested
42 * @GST_SEEK_TYPE_END: relative position to duration is requested
44 * The different types of seek events. When constructing a seek event with
45 * gst_event_new_seek() or when doing gst_segment_do_seek ().
49 GST_SEEK_TYPE_NONE = 0,
50 GST_SEEK_TYPE_CUR = 1,
51 GST_SEEK_TYPE_SET = 2,
57 * @GST_SEEK_FLAG_NONE: no flag
58 * @GST_SEEK_FLAG_FLUSH: flush pipeline
59 * @GST_SEEK_FLAG_ACCURATE: accurate position is requested, this might
60 * be considerably slower for some formats.
61 * @GST_SEEK_FLAG_KEY_UNIT: seek to the nearest keyframe. This might be
62 * faster but less accurate.
63 * @GST_SEEK_FLAG_SEGMENT: perform a segment seek.
64 * @GST_SEEK_FLAG_SKIP: when doing fast foward or fast reverse playback, allow
65 * elements to skip frames instead of generating all
66 * frames. Since 0.10.22.
68 * Flags to be used with gst_element_seek() or gst_event_new_seek(). All flags
69 * can be used together.
71 * A non flushing seek might take some time to perform as the currently
72 * playing data in the pipeline will not be cleared.
74 * An accurate seek might be slower for formats that don't have any indexes
75 * or timestamp markers in the stream. Specifying this flag might require a
76 * complete scan of the file in those cases.
78 * When performing a segment seek: after the playback of the segment completes,
79 * no EOS will be emmited by the element that performed the seek, but a
80 * #GST_MESSAGE_SEGMENT_DONE message will be posted on the bus by the element.
81 * When this message is posted, it is possible to send a new seek event to
82 * continue playback. With this seek method it is possible to perform seemless
83 * looping or simple linear editing.
85 * When doing fast forward (rate > 1.0) or fast reverse (rate < -1.0) trickmode
86 * playback, the @GST_SEEK_FLAG_SKIP flag can be used to instruct decoders
87 * and demuxers to adjust the playback rate by skipping frames. This can improve
88 * performance and decrease CPU usage because not all frames need to be decoded.
90 * Also see part-seeking.txt in the GStreamer design documentation for more
91 * details on the meaning of these flags and the behaviour expected of
92 * elements that handle them.
95 GST_SEEK_FLAG_NONE = 0,
96 GST_SEEK_FLAG_FLUSH = (1 << 0),
97 GST_SEEK_FLAG_ACCURATE = (1 << 1),
98 GST_SEEK_FLAG_KEY_UNIT = (1 << 2),
99 GST_SEEK_FLAG_SEGMENT = (1 << 3),
100 GST_SEEK_FLAG_SKIP = (1 << 4)
105 * @flags: flags for this segment
106 * @rate: the rate of the segment
107 * @applied_rate: the already applied rate to the segment
108 * @format: the format of the segment values
109 * @base: the base time of the segment
110 * @start: the start of the segment
111 * @stop: the stop of the segment
112 * @time: the stream time of the segment
114 * A helper structure that holds the configured region of
115 * interest in a media file.
122 gdouble applied_rate;
134 GType gst_segment_get_type (void);
136 GstSegment * gst_segment_new (void);
137 GstSegment * gst_segment_copy (const GstSegment *segment);
138 void gst_segment_copy_into (const GstSegment *src, GstSegment *dest);
139 void gst_segment_free (GstSegment *segment);
141 void gst_segment_init (GstSegment *segment, GstFormat format);
143 guint64 gst_segment_to_stream_time (const GstSegment *segment, GstFormat format, guint64 position);
144 guint64 gst_segment_to_running_time (const GstSegment *segment, GstFormat format, guint64 position);
145 guint64 gst_segment_to_position (const GstSegment *segment, GstFormat format, guint64 running_time);
147 gboolean gst_segment_set_running_time (GstSegment *segment, GstFormat format, guint64 running_time);
149 gboolean gst_segment_clip (const GstSegment *segment, GstFormat format, guint64 start,
150 guint64 stop, guint64 *clip_start, guint64 *clip_stop);
153 gboolean gst_segment_do_seek (GstSegment * segment, gdouble rate,
154 GstFormat format, GstSeekFlags flags,
155 GstSeekType start_type, guint64 start,
156 GstSeekType stop_type, guint64 stop, gboolean * update);
160 #endif /* __GST_SEGMENT_H__ */