*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
*/
#include "gst_private.h"
* with a start value of 0 and a stop/duration of -1, which is undefined. The default
* rate and applied_rate is 1.0.
*
- * If the segment is used for managing seeks, the segment duration should be set with
- * gst_segment_set_duration(). The public duration field contains the duration of the
- * segment. When using the segment for seeking, the start and time members should
- * normally be left to their default 0 value. The stop position is left to -1 unless
- * explicitly configured to a different value after a seek event.
+ * The public duration field contains the duration of the segment. When using
+ * the segment for seeking, the start and time members should normally be left
+ * to their default 0 value. The stop position is left to -1 unless explicitly
+ * configured to a different value after a seek event.
*
- * The current position in the segment should be set with the gst_segment_set_last_stop().
- * The public last_stop field contains the last set stop position in the segment.
+ * The current position in the segment should be set by changing the position
+ * member in the structure.
*
* For elements that perform seeks, the current segment should be updated with the
- * gst_segment_set_seek() and the values from the seek event. This method will update
- * all the segment fields. The last_stop field will contain the new playback position.
- * If the cur_type was different from GST_SEEK_TYPE_NONE, playback continues from
- * the last_stop position, possibly with updated flags or rate.
- *
- * For elements that want to use #GstSegment to track the playback region, use
- * gst_segment_set_newsegment() to update the segment fields with the information from
- * the newsegment event. The gst_segment_clip() method can be used to check and clip
+ * gst_segment_do_seek() and the values from the seek event. This method will update
+ * all the segment fields. The position field will contain the new playback position.
+ * If the start_type was different from GST_SEEK_TYPE_NONE, playback continues from
+ * the position position, possibly with updated flags or rate.
+ *
+ * For elements that want to use #GstSegment to track the playback region,
+ * update the segment fields with the information from the newsegment event.
+ * The gst_segment_clip() method can be used to check and clip
* the media data to the segment boundaries.
*
* For elements that want to synchronize to the pipeline clock, gst_segment_to_running_time()
* can be used to convert a timestamp to a value that can be used to synchronize
- * to the clock. This function takes into account all accumulated segments as well as
+ * to the clock. This function takes into account the base as well as
* any rate or applied_rate conversions.
*
* For elements that need to perform operations on media data in stream_time,
* gst_segment_to_stream_time() can be used to convert a timestamp and the segment
* info to stream time (which is always between 0 and the duration of the stream).
- *
- * Last reviewed on 2007-05-17 (0.10.13)
*/
/**
* Free-function: gst_segment_free
*
* Returns: (transfer full): a new #GstSegment, free with gst_segment_free().
- *
- * Since: 0.10.20
*/
GstSegment *
gst_segment_copy (const GstSegment * segment)
return result;
}
+/**
+ * gst_segment_copy_into:
+ * @src: (transfer none): a #GstSegment
+ * @dest: (transfer none): a #GstSegment
+ *
+ * Copy the contents of @src into @dest.
+ */
void
gst_segment_copy_into (const GstSegment * src, GstSegment * dest)
{
memcpy (dest, src, sizeof (GstSegment));
}
-GType
-gst_segment_get_type (void)
-{
- static GType gst_segment_type = 0;
-
- if (G_UNLIKELY (gst_segment_type == 0)) {
- gst_segment_type = g_boxed_type_register_static ("GstSegment",
- (GBoxedCopyFunc) gst_segment_copy, (GBoxedFreeFunc) gst_segment_free);
- }
-
- return gst_segment_type;
-}
+G_DEFINE_BOXED_TYPE (GstSegment, gst_segment,
+ (GBoxedCopyFunc) gst_segment_copy, (GBoxedFreeFunc) gst_segment_free);
/**
* gst_segment_new:
* @segment: a #GstSegment structure.
* @format: the format of the segment.
*
- * The start/last_stop positions are set to 0 and the stop/duration
+ * The start/position fields are set to 0 and the stop/duration
* fields are set to -1 (unknown). The default rate of 1.0 and no
* flags are set.
*
{
g_return_if_fail (segment != NULL);
- segment->flags = GST_SEEK_FLAG_NONE;
+ segment->flags = GST_SEGMENT_FLAG_NONE;
segment->rate = 1.0;
segment->applied_rate = 1.0;
segment->format = format;
segment->base = 0;
+ segment->offset = 0;
segment->start = 0;
segment->stop = -1;
segment->time = 0;
* If the caller can apply a rate change, it should update @segment
* rate and applied_rate after calling this function.
*
- * @update will be set to TRUE if a seek should be performed to the segment
- * position field. This field can be FALSE if, for example, only the @rate
+ * @update will be set to %TRUE if a seek should be performed to the segment
+ * position field. This field can be %FALSE if, for example, only the @rate
* has been changed but not the playback position.
*
* Returns: %TRUE if the seek could be performed.
position = segment->position;
- if (flags & GST_SEEK_FLAG_FLUSH) {
- /* flush resets the running_time */
- base = 0;
- } else {
- base = gst_segment_to_running_time (segment, format, position);
- }
-
/* segment->start is never invalid */
switch (start_type) {
case GST_SEEK_TYPE_NONE:
if (segment->duration != -1)
start = MIN (start, segment->duration);
else
- start = MAX (start, 0);
+ start = MAX ((gint64) start, 0);
/* stop can be -1 if we have not configured a stop. */
switch (stop_type) {
/* if we have a valid stop time, make sure it is clipped */
if (stop != -1) {
if (segment->duration != -1)
- stop = CLAMP (stop, 0, segment->duration);
+ stop = CLAMP ((gint64) stop, 0, (gint64) segment->duration);
else
- stop = MAX (stop, 0);
+ stop = MAX ((gint64) stop, 0);
}
/* we can't have stop before start */
if (stop != -1) {
if (start > stop) {
+ GST_WARNING ("segment update failed: start(%" G_GUINT64_FORMAT
+ ") > stop(%" G_GUINT64_FORMAT ")", start, stop);
g_return_val_if_fail (start <= stop, FALSE);
return FALSE;
}
}
- segment->rate = rate;
- segment->applied_rate = 1.0;
- segment->base = base;
- segment->flags = (GstSegmentFlags) flags;
- segment->start = start;
- segment->stop = stop;
- segment->time = start;
+ if (flags & GST_SEEK_FLAG_FLUSH) {
+ /* flush resets the running_time */
+ base = 0;
+ } else {
+ /* make sure the position is inside the segment start/stop */
+ position = CLAMP (position, segment->start, segment->stop);
+
+ /* remember the elapsed time */
+ base = gst_segment_to_running_time (segment, format, position);
+ GST_DEBUG ("updated segment.base: %" G_GUINT64_FORMAT, base);
+ }
if (update_start && rate > 0.0) {
position = start;
position = 0;
}
}
+
/* set update arg to reflect update of position */
if (update)
*update = position != segment->position;
- /* update new position */
+ /* update new values */
+ /* be explicit about our GstSeekFlag -> GstSegmentFlag conversion */
+ segment->flags = GST_SEGMENT_FLAG_NONE;
+ if ((flags & GST_SEEK_FLAG_FLUSH) != 0)
+ segment->flags |= GST_SEGMENT_FLAG_RESET;
+ if ((flags & GST_SEEK_FLAG_SKIP) != 0)
+ segment->flags |= GST_SEGMENT_FLAG_SKIP;
+ if ((flags & GST_SEEK_FLAG_SEGMENT) != 0)
+ segment->flags |= GST_SEGMENT_FLAG_SEGMENT;
+
+ segment->rate = rate;
+ segment->applied_rate = 1.0;
+
+ segment->base = base;
+ if (rate > 0.0)
+ segment->offset = position - start;
+ else {
+ if (stop != -1)
+ segment->offset = stop - position;
+ else if (segment->duration != -1)
+ segment->offset = segment->duration - position;
+ else
+ segment->offset = 0;
+ }
+
+ segment->start = start;
+ segment->stop = stop;
+ segment->time = start;
segment->position = position;
+ GST_INFO ("segment updated: %" GST_SEGMENT_FORMAT, segment);
+
return TRUE;
}
g_return_val_if_fail (segment != NULL, -1);
g_return_val_if_fail (segment->format == format, -1);
- /* if we have the position for the same format as the segment, we can compare
- * the start and stop values, otherwise we assume 0 and -1 */
- if (G_LIKELY (segment->format == format)) {
- start = segment->start;
- stop = segment->stop;
- time = segment->time;
- } else {
- start = 0;
- stop = -1;
- time = 0;
- }
+ stop = segment->stop;
/* outside of the segment boundary stop */
if (G_UNLIKELY (stop != -1 && position > stop))
return -1;
+ start = segment->start;
+
/* before the segment boundary */
if (G_UNLIKELY (position < start))
return -1;
+ time = segment->time;
+
/* time must be known */
if (G_UNLIKELY (time == -1))
return -1;
* @position: the position in the segment
*
* Translate @position to the total running time using the currently configured
- * and previously accumulated segments. Position is a value between @segment
- * start and stop time.
+ * segment. Position is a value between @segment start and stop time.
*
* This function is typically used by elements that need to synchronize to the
- * global clock in a pipeline. The runnning time is a constantly increasing value
+ * global clock in a pipeline. The running time is a constantly increasing value
* starting from 0. When gst_segment_init() is called, this value will reset to
* 0.
*
guint64 position)
{
guint64 result;
- guint64 start, stop, base;
+ guint64 start, stop;
gdouble abs_rate;
- if (G_UNLIKELY (position == -1))
+ if (G_UNLIKELY (position == -1)) {
+ GST_DEBUG ("invalid position (-1)");
return -1;
+ }
g_return_val_if_fail (segment != NULL, -1);
g_return_val_if_fail (segment->format == format, -1);
- /* if we have the position for the same format as the segment, we can compare
- * the start and stop values, otherwise we assume 0 and -1 */
- if (G_LIKELY (segment->format == format)) {
- start = segment->start;
- stop = segment->stop;
- base = segment->base;
- } else {
- start = 0;
- stop = -1;
- base = 0;
- }
+ start = segment->start;
+
+ if (segment->rate > 0.0)
+ start += segment->offset;
/* before the segment boundary */
- if (G_UNLIKELY (position < start))
+ if (G_UNLIKELY (position < start)) {
+ GST_DEBUG ("position(%" G_GUINT64_FORMAT ") < start(%" G_GUINT64_FORMAT
+ ")", position, start);
return -1;
+ }
+
+ stop = segment->stop;
if (G_LIKELY (segment->rate > 0.0)) {
- /* outside of the segment boundary stop */
- if (G_UNLIKELY (stop != -1 && position > stop))
+ /* after of the segment boundary */
+ if (G_UNLIKELY (stop != -1 && position > stop)) {
+ GST_DEBUG ("position(%" G_GUINT64_FORMAT ") > stop(%" G_GUINT64_FORMAT
+ ")", position, stop);
return -1;
+ }
/* bring to uncorrected position in segment */
result = position - start;
} else {
/* cannot continue if no stop position set or outside of
* the segment. */
- if (G_UNLIKELY (stop == -1 || position > stop))
+ if (G_UNLIKELY (stop == -1)) {
+ GST_DEBUG ("invalid stop (-1)");
+ return -1;
+ }
+
+ stop -= segment->offset;
+ if (G_UNLIKELY (position > stop)) {
+ GST_DEBUG ("position(%" G_GUINT64_FORMAT ") > stop(%" G_GUINT64_FORMAT
+ ")", position, stop);
return -1;
+ }
/* bring to uncorrected position in segment */
result = stop - position;
result /= abs_rate;
/* correct for base of the segment */
- result += base;
+ result += segment->base;
return result;
}
* in @segment. @start and @stop are compared and clipped to @segment
* start and stop values.
*
- * If the function returns FALSE, @start and @stop are known to fall
+ * If the function returns %FALSE, @start and @stop are known to fall
* outside of @segment and @clip_start and @clip_stop are not updated.
*
- * When the function returns TRUE, @clip_start and @clip_stop will be
+ * When the function returns %TRUE, @clip_start and @clip_stop will be
* updated. If @clip_start or @clip_stop are different from @start or @stop
* respectively, the region fell partially in the segment.
*
* Note that when @stop is -1, @clip_stop will be set to the end of the
* segment. Depending on the use case, this may or may not be what you want.
*
- * Returns: TRUE if the given @start and @stop times fall partially or
- * completely in @segment, FALSE if the values are completely outside
+ * Returns: %TRUE if the given @start and @stop times fall partially or
+ * completely in @segment, %FALSE if the values are completely outside
* of the segment.
*/
gboolean
*clip_stop = stop;
else
*clip_stop = MIN (stop, segment->stop);
-
- if (segment->duration != -1 && *clip_stop != -1)
- *clip_stop = MIN (*clip_stop, segment->duration);
}
return TRUE;
*
* Returns: the position in the segment for @running_time. This function returns
* -1 when @running_time is -1 or when it is not inside @segment.
- *
- * Since: 0.10.24
*/
guint64
gst_segment_to_position (const GstSegment * segment, GstFormat format,
g_return_val_if_fail (segment != NULL, -1);
g_return_val_if_fail (segment->format == format, FALSE);
- /* if we have the position for the same format as the segment, we can compare
- * the start and stop values, otherwise we assume 0 and -1 */
- if (G_LIKELY (segment->format == format)) {
- start = segment->start;
- stop = segment->stop;
- base = segment->base;
- } else {
- start = 0;
- stop = -1;
- base = 0;
- }
+ base = segment->base;
/* this running_time was for a previous segment */
if (running_time < base)
if (G_UNLIKELY (abs_rate != 1.0))
result = ceil (result * abs_rate);
+ start = segment->start;
+ stop = segment->stop;
+
if (G_LIKELY (segment->rate > 0.0)) {
/* bring to corrected position in segment */
- result += start;
+ result += start + segment->offset;
/* outside of the segment boundary stop */
if (G_UNLIKELY (stop != -1 && result > stop))
return -1;
/* bring to corrected position in segment */
- result = stop - result;
+ result = stop - result - segment->offset;
}
return result;
}
-
/**
* gst_segment_set_running_time:
* @segment: a #GstSegment structure.
*
* Returns: %TRUE if the segment could be updated successfully. If %FALSE is
* returned, @running_time is -1 or not in @segment.
- *
- * Since: 0.10.24
*/
gboolean
gst_segment_set_running_time (GstSegment * segment, GstFormat format,
return TRUE;
}
+
+/**
+ * gst_segment_offset_running_time:
+ * @segment: a #GstSegment structure.
+ * @format: the format of the segment.
+ * @offset: the offset to apply in the segment
+ *
+ * Adjust the values in @segment so that @offset is applied to all
+ * future running-time calculations.
+ *
+ * Since: 1.2.3
+ *
+ * Returns: %TRUE if the segment could be updated successfully. If %FALSE is
+ * returned, @offset is not in @segment.
+ */
+gboolean
+gst_segment_offset_running_time (GstSegment * segment, GstFormat format,
+ gint64 offset)
+{
+ g_return_val_if_fail (segment != NULL, FALSE);
+ g_return_val_if_fail (segment->format == format, FALSE);
+
+ if (offset == 0)
+ return TRUE;
+
+ if (offset > 0) {
+ /* positive offset, we can simply apply to the base time */
+ segment->base += offset;
+ } else {
+ offset = -offset;
+ /* negative offset, first try to subtract from base */
+ if (segment->base > offset) {
+ segment->base -= offset;
+ } else {
+ guint64 position;
+
+ /* subtract all from segment.base, remainder in offset */
+ offset -= segment->base;
+ segment->base = 0;
+ position = gst_segment_to_position (segment, format, offset);
+ if (position == -1)
+ return FALSE;
+
+ segment->offset = position;
+ }
+ }
+ return TRUE;
+}