segment: Replaced gst_segment_to_position with gst_segment_position_from_running_time
[platform/upstream/gstreamer.git] / gst / gstsegment.c
1 /* GStreamer
2  * Copyright (C) 2005 Wim Taymans <wim@fluendo.com>
3  *
4  * gstsegment.c: GstSegment subsystem
5  *
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.
10  *
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.
15  *
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., 51 Franklin St, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #include "gst_private.h"
23
24 #include <math.h>
25
26 #include "gstutils.h"
27 #include "gstsegment.h"
28
29 /**
30  * SECTION:gstsegment
31  * @short_description: Structure describing the configured region of interest
32  *                     in a media file.
33  * @see_also: #GstEvent
34  *
35  * This helper structure holds the relevant values for tracking the region of
36  * interest in a media file, called a segment.
37  *
38  * The structure can be used for two purposes:
39  * <itemizedlist>
40  *   <listitem><para>performing seeks (handling seek events)</para></listitem>
41  *   <listitem><para>tracking playback regions (handling newsegment events)</para></listitem>
42  * </itemizedlist>
43  *
44  * The segment is usually configured by the application with a seek event which
45  * is propagated upstream and eventually handled by an element that performs the seek.
46  *
47  * The configured segment is then propagated back downstream with a newsegment event.
48  * This information is then used to clip media to the segment boundaries.
49  *
50  * A segment structure is initialized with gst_segment_init(), which takes a #GstFormat
51  * that will be used as the format of the segment values. The segment will be configured
52  * with a start value of 0 and a stop/duration of -1, which is undefined. The default
53  * rate and applied_rate is 1.0.
54  *
55  * The public duration field contains the duration of the segment. When using
56  * the segment for seeking, the start and time members should normally be left
57  * to their default 0 value. The stop position is left to -1 unless explicitly
58  * configured to a different value after a seek event.
59  *
60  * The current position in the segment should be set by changing the position
61  * member in the structure.
62  *
63  * For elements that perform seeks, the current segment should be updated with the
64  * gst_segment_do_seek() and the values from the seek event. This method will update
65  * all the segment fields. The position field will contain the new playback position.
66  * If the start_type was different from GST_SEEK_TYPE_NONE, playback continues from
67  * the position position, possibly with updated flags or rate.
68  *
69  * For elements that want to use #GstSegment to track the playback region,
70  * update the segment fields with the information from the newsegment event.
71  * The gst_segment_clip() method can be used to check and clip
72  * the media data to the segment boundaries.
73  *
74  * For elements that want to synchronize to the pipeline clock, gst_segment_to_running_time()
75  * can be used to convert a timestamp to a value that can be used to synchronize
76  * to the clock. This function takes into account the base as well as
77  * any rate or applied_rate conversions.
78  *
79  * For elements that need to perform operations on media data in stream_time,
80  * gst_segment_to_stream_time() can be used to convert a timestamp and the segment
81  * info to stream time (which is always between 0 and the duration of the stream).
82  */
83
84 /**
85  * gst_segment_copy:
86  * @segment: (transfer none): a #GstSegment
87  *
88  * Create a copy of given @segment.
89  *
90  * Free-function: gst_segment_free
91  *
92  * Returns: (transfer full): a new #GstSegment, free with gst_segment_free().
93  */
94 GstSegment *
95 gst_segment_copy (const GstSegment * segment)
96 {
97   GstSegment *result = NULL;
98
99   if (segment) {
100     result = (GstSegment *) g_slice_copy (sizeof (GstSegment), segment);
101   }
102   return result;
103 }
104
105 /**
106  * gst_segment_copy_into:
107  * @src: (transfer none): a #GstSegment
108  * @dest: (transfer none): a #GstSegment
109  *
110  * Copy the contents of @src into @dest.
111  */
112 void
113 gst_segment_copy_into (const GstSegment * src, GstSegment * dest)
114 {
115   memcpy (dest, src, sizeof (GstSegment));
116 }
117
118 G_DEFINE_BOXED_TYPE (GstSegment, gst_segment,
119     (GBoxedCopyFunc) gst_segment_copy, (GBoxedFreeFunc) gst_segment_free);
120
121 /**
122  * gst_segment_new:
123  *
124  * Allocate a new #GstSegment structure and initialize it using
125  * gst_segment_init().
126  *
127  * Free-function: gst_segment_free
128  *
129  * Returns: (transfer full): a new #GstSegment, free with gst_segment_free().
130  */
131 GstSegment *
132 gst_segment_new (void)
133 {
134   GstSegment *result;
135
136   result = g_slice_new0 (GstSegment);
137   gst_segment_init (result, GST_FORMAT_UNDEFINED);
138
139   return result;
140 }
141
142 /**
143  * gst_segment_free:
144  * @segment: (in) (transfer full): a #GstSegment
145  *
146  * Free the allocated segment @segment.
147  */
148 void
149 gst_segment_free (GstSegment * segment)
150 {
151   g_slice_free (GstSegment, segment);
152 }
153
154 /**
155  * gst_segment_init:
156  * @segment: a #GstSegment structure.
157  * @format: the format of the segment.
158  *
159  * The start/position fields are set to 0 and the stop/duration
160  * fields are set to -1 (unknown). The default rate of 1.0 and no
161  * flags are set.
162  *
163  * Initialize @segment to its default values.
164  */
165 void
166 gst_segment_init (GstSegment * segment, GstFormat format)
167 {
168   g_return_if_fail (segment != NULL);
169
170   segment->flags = GST_SEGMENT_FLAG_NONE;
171   segment->rate = 1.0;
172   segment->applied_rate = 1.0;
173   segment->format = format;
174   segment->base = 0;
175   segment->offset = 0;
176   segment->start = 0;
177   segment->stop = -1;
178   segment->time = 0;
179   segment->position = 0;
180   segment->duration = -1;
181 }
182
183 /**
184  * gst_segment_do_seek:
185  * @segment: a #GstSegment structure.
186  * @rate: the rate of the segment.
187  * @format: the format of the segment.
188  * @flags: the segment flags for the segment
189  * @start_type: the seek method
190  * @start: the seek start value
191  * @stop_type: the seek method
192  * @stop: the seek stop value
193  * @update: boolean holding whether position was updated.
194  *
195  * Update the segment structure with the field values of a seek event (see
196  * gst_event_new_seek()).
197  *
198  * After calling this method, the segment field position and time will
199  * contain the requested new position in the segment. The new requested
200  * position in the segment depends on @rate and @start_type and @stop_type.
201  *
202  * For positive @rate, the new position in the segment is the new @segment
203  * start field when it was updated with a @start_type different from
204  * #GST_SEEK_TYPE_NONE. If no update was performed on @segment start position
205  * (#GST_SEEK_TYPE_NONE), @start is ignored and @segment position is
206  * unmodified.
207  *
208  * For negative @rate, the new position in the segment is the new @segment
209  * stop field when it was updated with a @stop_type different from
210  * #GST_SEEK_TYPE_NONE. If no stop was previously configured in the segment, the
211  * duration of the segment will be used to update the stop position.
212  * If no update was performed on @segment stop position (#GST_SEEK_TYPE_NONE),
213  * @stop is ignored and @segment position is unmodified.
214  *
215  * The applied rate of the segment will be set to 1.0 by default.
216  * If the caller can apply a rate change, it should update @segment
217  * rate and applied_rate after calling this function.
218  *
219  * @update will be set to %TRUE if a seek should be performed to the segment
220  * position field. This field can be %FALSE if, for example, only the @rate
221  * has been changed but not the playback position.
222  *
223  * Returns: %TRUE if the seek could be performed.
224  */
225 gboolean
226 gst_segment_do_seek (GstSegment * segment, gdouble rate,
227     GstFormat format, GstSeekFlags flags,
228     GstSeekType start_type, guint64 start,
229     GstSeekType stop_type, guint64 stop, gboolean * update)
230 {
231   gboolean update_stop, update_start;
232   guint64 position, base;
233
234   g_return_val_if_fail (rate != 0.0, FALSE);
235   g_return_val_if_fail (segment != NULL, FALSE);
236   g_return_val_if_fail (segment->format == format, FALSE);
237
238   update_start = update_stop = TRUE;
239
240   position = segment->position;
241
242   /* segment->start is never invalid */
243   switch (start_type) {
244     case GST_SEEK_TYPE_NONE:
245       /* no update to segment, take previous start */
246       start = segment->start;
247       update_start = FALSE;
248       break;
249     case GST_SEEK_TYPE_SET:
250       /* start holds desired position, map -1 to the start */
251       if (start == -1)
252         start = 0;
253       break;
254     case GST_SEEK_TYPE_END:
255       if (segment->duration != -1) {
256         /* add start to total length */
257         start = segment->duration + start;
258       } else {
259         /* no update if duration unknown */
260         start = segment->start;
261         update_start = FALSE;
262       }
263       break;
264   }
265   /* bring in sane range */
266   if (segment->duration != -1)
267     start = MIN (start, segment->duration);
268   else
269     start = MAX ((gint64) start, 0);
270
271   /* stop can be -1 if we have not configured a stop. */
272   switch (stop_type) {
273     case GST_SEEK_TYPE_NONE:
274       stop = segment->stop;
275       update_stop = FALSE;
276       break;
277     case GST_SEEK_TYPE_SET:
278       /* stop holds required value */
279       break;
280     case GST_SEEK_TYPE_END:
281       if (segment->duration != -1) {
282         stop = segment->duration + stop;
283       } else {
284         stop = segment->stop;
285         update_stop = FALSE;
286       }
287       break;
288   }
289
290   /* if we have a valid stop time, make sure it is clipped */
291   if (stop != -1) {
292     if (segment->duration != -1)
293       stop = CLAMP ((gint64) stop, 0, (gint64) segment->duration);
294     else
295       stop = MAX ((gint64) stop, 0);
296   }
297
298   /* we can't have stop before start */
299   if (stop != -1) {
300     if (start > stop) {
301       GST_WARNING ("segment update failed: start(%" G_GUINT64_FORMAT
302           ") > stop(%" G_GUINT64_FORMAT ")", start, stop);
303       g_return_val_if_fail (start <= stop, FALSE);
304       return FALSE;
305     }
306   }
307
308   if (flags & GST_SEEK_FLAG_FLUSH) {
309     /* flush resets the running_time */
310     base = 0;
311   } else {
312     /* make sure the position is inside the segment start/stop */
313     position = CLAMP (position, segment->start, segment->stop);
314
315     /* remember the elapsed time */
316     base = gst_segment_to_running_time (segment, format, position);
317     GST_DEBUG ("updated segment.base: %" G_GUINT64_FORMAT, base);
318   }
319
320   if (update_start && rate > 0.0) {
321     position = start;
322   }
323   if (update_stop && rate < 0.0) {
324     if (stop != -1)
325       position = stop;
326     else {
327       if (segment->duration != -1)
328         position = segment->duration;
329       else
330         position = 0;
331     }
332   }
333
334   /* set update arg to reflect update of position */
335   if (update)
336     *update = position != segment->position;
337
338   /* update new values */
339   /* be explicit about our GstSeekFlag -> GstSegmentFlag conversion */
340   segment->flags = GST_SEGMENT_FLAG_NONE;
341   if ((flags & GST_SEEK_FLAG_FLUSH) != 0)
342     segment->flags |= GST_SEGMENT_FLAG_RESET;
343   if ((flags & GST_SEEK_FLAG_TRICKMODE) != 0)
344     segment->flags |= GST_SEGMENT_FLAG_TRICKMODE;
345   if ((flags & GST_SEEK_FLAG_SEGMENT) != 0)
346     segment->flags |= GST_SEGMENT_FLAG_SEGMENT;
347   if ((flags & GST_SEEK_FLAG_TRICKMODE_KEY_UNITS) != 0)
348     segment->flags |= GST_SEGMENT_FLAG_TRICKMODE_KEY_UNITS;
349   if ((flags & GST_SEEK_FLAG_TRICKMODE_NO_AUDIO) != 0)
350     segment->flags |= GST_SEGMENT_FLAG_TRICKMODE_NO_AUDIO;
351
352   segment->rate = rate;
353   segment->applied_rate = 1.0;
354
355   segment->base = base;
356   if (rate > 0.0)
357     segment->offset = position - start;
358   else {
359     if (stop != -1)
360       segment->offset = stop - position;
361     else if (segment->duration != -1)
362       segment->offset = segment->duration - position;
363     else
364       segment->offset = 0;
365   }
366
367   segment->start = start;
368   segment->stop = stop;
369   segment->time = start;
370   segment->position = position;
371
372   GST_INFO ("segment updated: %" GST_SEGMENT_FORMAT, segment);
373
374   return TRUE;
375 }
376
377 /**
378  * gst_segment_to_stream_time:
379  * @segment: a #GstSegment structure.
380  * @format: the format of the segment.
381  * @position: the position in the segment
382  *
383  * Translate @position to stream time using the currently configured
384  * segment. The @position value must be between @segment start and
385  * stop value.
386  *
387  * This function is typically used by elements that need to operate on
388  * the stream time of the buffers it receives, such as effect plugins.
389  * In those use cases, @position is typically the buffer timestamp or
390  * clock time that one wants to convert to the stream time.
391  * The stream time is always between 0 and the total duration of the
392  * media stream.
393  *
394  * Returns: the position in stream_time or -1 when an invalid position
395  * was given.
396  */
397 guint64
398 gst_segment_to_stream_time (const GstSegment * segment, GstFormat format,
399     guint64 position)
400 {
401   guint64 stream_time, start, stop, time;
402   gdouble abs_applied_rate;
403
404   /* format does not matter for -1 */
405   if (G_UNLIKELY (position == -1))
406     return -1;
407
408   g_return_val_if_fail (segment != NULL, -1);
409   g_return_val_if_fail (segment->format == format, -1);
410
411   stop = segment->stop;
412
413   /* outside of the segment boundary stop */
414   if (G_UNLIKELY (stop != -1 && position > stop))
415     return -1;
416
417   start = segment->start;
418
419   /* before the segment boundary */
420   if (G_UNLIKELY (position < start))
421     return -1;
422
423   time = segment->time;
424
425   /* time must be known */
426   if (G_UNLIKELY (time == -1))
427     return -1;
428
429   /* bring to uncorrected position in segment */
430   stream_time = position - start;
431
432   abs_applied_rate = ABS (segment->applied_rate);
433
434   /* correct for applied rate if needed */
435   if (G_UNLIKELY (abs_applied_rate != 1.0))
436     stream_time *= abs_applied_rate;
437
438   /* add or subtract from segment time based on applied rate */
439   if (G_LIKELY (segment->applied_rate > 0.0)) {
440     /* correct for segment time */
441     stream_time += time;
442   } else {
443     /* correct for segment time, clamp at 0. Streams with a negative
444      * applied_rate have timestamps between start and stop, as usual, but have
445      * the time member starting high and going backwards.  */
446     if (G_LIKELY (time > stream_time))
447       stream_time = time - stream_time;
448     else
449       stream_time = 0;
450   }
451
452   return stream_time;
453 }
454
455 /**
456  * gst_segment_position_from_stream_time:
457  * @segment: a #GstSegment structure.
458  * @format: the format of the segment.
459  * @stream_time: the stream_time in the segment
460  *
461  * Convert @stream_time into a position in the segment so that
462  * gst_segment_to_stream_time() with that position returns @stream_time.
463  *
464  * Returns: the position in the segment for @stream_time. This function returns
465  * -1 when @stream_time is -1 or when it is not inside @segment.
466  *
467  * Since: 1.8
468  */
469 guint64
470 gst_segment_position_from_stream_time (const GstSegment * segment,
471     GstFormat format, guint64 stream_time)
472 {
473   guint64 position, start, stop, time;
474   gdouble abs_applied_rate;
475
476   /* format does not matter for -1 */
477   if (G_UNLIKELY (stream_time == -1))
478     return -1;
479
480   g_return_val_if_fail (segment != NULL, -1);
481   g_return_val_if_fail (segment->format == format, -1);
482
483   start = segment->start;
484   time = segment->time;
485   /* this stream time was for a previous segment */
486   if (G_UNLIKELY (stream_time < segment->time))
487     return -1;
488
489   /* time must be known */
490   if (G_UNLIKELY (time == -1))
491     return -1;
492
493   if (G_LIKELY (segment->applied_rate > 0.0)) {
494     position = stream_time - time;
495   } else {
496     if (G_LIKELY (time > stream_time))
497       position = time - stream_time;
498     else
499       return -1;
500   }
501
502   abs_applied_rate = ABS (segment->applied_rate);
503
504   /* correct for applied rate if needed */
505   if (G_UNLIKELY (abs_applied_rate != 1.0))
506     position /= abs_applied_rate;
507
508   position += start;
509
510   stop = segment->stop;
511   /* outside of the segment boundary stop */
512   if (G_UNLIKELY (stop != -1 && position > stop))
513     return -1;
514
515   return position;
516 }
517
518 /**
519  * gst_segment_to_running_time_full:
520  * @segment: a #GstSegment structure.
521  * @format: the format of the segment.
522  * @position: the position in the segment
523  * @running_time: result running-time
524  *
525  * Translate @position to the total running time using the currently configured
526  * segment. Compared to gst_segment_to_running_time() this function can return
527  * negative running-time.
528  *
529  * This function is typically used by elements that need to synchronize buffers
530  * against the clock or eachother.
531  *
532  * @position can be any value and the result of this function for values outside
533  * of the segment is extrapolated.
534  *
535  * When 1 is returned, @position resulted in a positive running-time returned
536  * in @running_time.
537  *
538  * When this function returns -1, the returned @running_time should be negated
539  * to get the real negative running time.
540  *
541  * Returns: a 1 or -1 on success, 0 on failure.
542  *
543  * Since: 1.6
544  */
545 gint
546 gst_segment_to_running_time_full (const GstSegment * segment, GstFormat format,
547     guint64 position, guint64 * running_time)
548 {
549   gint res = 0;
550   guint64 result;
551   guint64 start, stop, offset;
552   gdouble abs_rate;
553
554   if (G_UNLIKELY (position == -1)) {
555     GST_DEBUG ("invalid position (-1)");
556     goto done;
557   }
558
559   g_return_val_if_fail (segment != NULL, 0);
560   g_return_val_if_fail (segment->format == format, 0);
561
562   offset = segment->offset;
563
564   if (G_LIKELY (segment->rate > 0.0)) {
565     start = segment->start + offset;
566
567     /* bring to uncorrected position in segment */
568     if (position < start) {
569       /* negative value */
570       result = start - position;
571       res = -1;
572     } else {
573       result = position - start;
574       res = 1;
575     }
576   } else {
577     stop = segment->stop;
578
579     /* cannot continue if no stop position set or invalid offset */
580     g_return_val_if_fail (stop != -1, 0);
581     g_return_val_if_fail (stop >= offset, 0);
582
583     stop -= offset;
584
585     /* bring to uncorrected position in segment */
586     if (position > stop) {
587       /* negative value */
588       result = position - stop;
589       res = -1;
590     } else {
591       result = stop - position;
592       res = 1;
593     }
594   }
595
596   if (running_time) {
597     /* scale based on the rate, avoid division by and conversion to
598      * float when not needed */
599     abs_rate = ABS (segment->rate);
600     if (G_UNLIKELY (abs_rate != 1.0))
601       result /= abs_rate;
602
603     /* correct for base of the segment */
604     if (res == 1)
605       /* positive, add base */
606       *running_time = result + segment->base;
607     else if (segment->base >= result) {
608       /* negative and base is bigger, subtract from base and we have a
609        * positive value again */
610       *running_time = segment->base - result;
611       res = 1;
612     } else {
613       /* negative and base is smaller, subtract base and remainder is
614        * negative */
615       *running_time = result - segment->base;
616     }
617   }
618   return res;
619
620 done:
621   {
622     if (running_time)
623       *running_time = -1;
624     return 0;
625   }
626 }
627
628 /**
629  * gst_segment_to_running_time:
630  * @segment: a #GstSegment structure.
631  * @format: the format of the segment.
632  * @position: the position in the segment
633  *
634  * Translate @position to the total running time using the currently configured
635  * segment. Position is a value between @segment start and stop time.
636  *
637  * This function is typically used by elements that need to synchronize to the
638  * global clock in a pipeline. The running time is a constantly increasing value
639  * starting from 0. When gst_segment_init() is called, this value will reset to
640  * 0.
641  *
642  * This function returns -1 if the position is outside of @segment start and stop.
643  *
644  * Returns: the position as the total running time or -1 when an invalid position
645  * was given.
646  */
647 guint64
648 gst_segment_to_running_time (const GstSegment * segment, GstFormat format,
649     guint64 position)
650 {
651   guint64 result;
652
653   g_return_val_if_fail (segment != NULL, -1);
654   g_return_val_if_fail (segment->format == format, -1);
655
656   /* before the segment boundary */
657   if (G_UNLIKELY (position < segment->start)) {
658     GST_DEBUG ("position(%" G_GUINT64_FORMAT ") < start(%" G_GUINT64_FORMAT
659         ")", position, segment->start);
660     return -1;
661   }
662   /* after the segment boundary */
663   if (G_UNLIKELY (segment->stop != -1 && position > segment->stop)) {
664     GST_DEBUG ("position(%" G_GUINT64_FORMAT ") > stop(%" G_GUINT64_FORMAT
665         ")", position, segment->stop);
666     return -1;
667   }
668
669   if (gst_segment_to_running_time_full (segment, format, position,
670           &result) == 1)
671     return result;
672
673   return -1;
674 }
675
676 /**
677  * gst_segment_clip:
678  * @segment: a #GstSegment structure.
679  * @format: the format of the segment.
680  * @start: the start position in the segment
681  * @stop: the stop position in the segment
682  * @clip_start: (out) (allow-none): the clipped start position in the segment
683  * @clip_stop: (out) (allow-none): the clipped stop position in the segment
684  *
685  * Clip the given @start and @stop values to the segment boundaries given
686  * in @segment. @start and @stop are compared and clipped to @segment
687  * start and stop values.
688  *
689  * If the function returns %FALSE, @start and @stop are known to fall
690  * outside of @segment and @clip_start and @clip_stop are not updated.
691  *
692  * When the function returns %TRUE, @clip_start and @clip_stop will be
693  * updated. If @clip_start or @clip_stop are different from @start or @stop
694  * respectively, the region fell partially in the segment.
695  *
696  * Note that when @stop is -1, @clip_stop will be set to the end of the
697  * segment. Depending on the use case, this may or may not be what you want.
698  *
699  * Returns: %TRUE if the given @start and @stop times fall partially or
700  *     completely in @segment, %FALSE if the values are completely outside
701  *     of the segment.
702  */
703 gboolean
704 gst_segment_clip (const GstSegment * segment, GstFormat format, guint64 start,
705     guint64 stop, guint64 * clip_start, guint64 * clip_stop)
706 {
707   g_return_val_if_fail (segment != NULL, FALSE);
708   g_return_val_if_fail (segment->format == format, FALSE);
709
710   /* if we have a stop position and a valid start and start is bigger,
711    * we're outside of the segment */
712   if (G_UNLIKELY (segment->stop != -1 && start != -1 && start >= segment->stop))
713     return FALSE;
714
715   /* if a stop position is given and is before the segment start,
716    * we're outside of the segment. Special case is were start
717    * and stop are equal to the segment start. In that case we
718    * are inside the segment. */
719   if (G_UNLIKELY (stop != -1 && (stop < segment->start || (start != stop
720                   && stop == segment->start))))
721     return FALSE;
722
723   if (clip_start) {
724     if (start == -1)
725       *clip_start = -1;
726     else
727       *clip_start = MAX (start, segment->start);
728   }
729
730   if (clip_stop) {
731     if (stop == -1)
732       *clip_stop = segment->stop;
733     else if (segment->stop == -1)
734       *clip_stop = stop;
735     else
736       *clip_stop = MIN (stop, segment->stop);
737   }
738
739   return TRUE;
740 }
741
742 /**
743  * gst_segment_position_from_running_time:
744  * @segment: a #GstSegment structure.
745  * @format: the format of the segment.
746  * @running_time: the running_time in the segment
747  *
748  * Convert @running_time into a position in the segment so that
749  * gst_segment_to_running_time() with that position returns @running_time.
750  *
751  * Returns: the position in the segment for @running_time. This function returns
752  * -1 when @running_time is -1 or when it is not inside @segment.
753  *
754  * Since: 1.8
755  */
756 guint64
757 gst_segment_position_from_running_time (const GstSegment * segment,
758     GstFormat format, guint64 running_time)
759 {
760   guint64 result;
761   guint64 start, stop, base;
762   gdouble abs_rate;
763
764   if (G_UNLIKELY (running_time == -1))
765     return -1;
766
767   g_return_val_if_fail (segment != NULL, -1);
768   g_return_val_if_fail (segment->format == format, FALSE);
769
770   base = segment->base;
771
772   /* this running_time was for a previous segment */
773   if (running_time < base)
774     return -1;
775
776   /* start by subtracting the base time */
777   result = running_time - base;
778
779   /* move into the segment at the right rate */
780   abs_rate = ABS (segment->rate);
781   if (G_UNLIKELY (abs_rate != 1.0))
782     result = ceil (result * abs_rate);
783
784   start = segment->start;
785   stop = segment->stop;
786
787   if (G_LIKELY (segment->rate > 0.0)) {
788     /* bring to corrected position in segment */
789     result += start + segment->offset;
790
791     /* outside of the segment boundary stop */
792     if (G_UNLIKELY (stop != -1 && result > stop))
793       return -1;
794   } else {
795     /* cannot continue if no stop position set or outside of
796      * the segment. */
797     if (G_UNLIKELY (stop == -1 || result + start > stop))
798       return -1;
799
800     /* bring to corrected position in segment */
801     result = stop - result - segment->offset;
802   }
803   return result;
804 }
805
806 /**
807  * gst_segment_to_position:
808  * @segment: a #GstSegment structure.
809  * @format: the format of the segment.
810  * @running_time: the running_time in the segment
811  *
812  * Convert @running_time into a position in the segment so that
813  * gst_segment_to_running_time() with that position returns @running_time.
814  *
815  * Returns: the position in the segment for @running_time. This function returns
816  * -1 when @running_time is -1 or when it is not inside @segment.
817  *
818  * Deprecated. Use gst_segment_position_from_running_time() instead.
819  */
820 #ifndef GST_REMOVE_DEPRECATED
821 #ifdef GST_DISABLE_DEPRECATED
822 guint64 gst_segment_to_position (const GstSegment * segment, GstFormat format,
823     guint64 running_time);
824 #endif
825 guint64
826 gst_segment_to_position (const GstSegment * segment, GstFormat format,
827     guint64 running_time)
828 {
829   return gst_segment_position_from_running_time (segment, format, running_time);
830 }
831 #endif
832
833 /**
834  * gst_segment_set_running_time:
835  * @segment: a #GstSegment structure.
836  * @format: the format of the segment.
837  * @running_time: the running_time in the segment
838  *
839  * Adjust the start/stop and base values of @segment such that the next valid
840  * buffer will be one with @running_time.
841  *
842  * Returns: %TRUE if the segment could be updated successfully. If %FALSE is
843  * returned, @running_time is -1 or not in @segment.
844  */
845 gboolean
846 gst_segment_set_running_time (GstSegment * segment, GstFormat format,
847     guint64 running_time)
848 {
849   guint64 position;
850   guint64 start, stop;
851
852   /* start by bringing the running_time into the segment position */
853   position =
854       gst_segment_position_from_running_time (segment, format, running_time);
855
856   /* we must have a valid position now */
857   if (G_UNLIKELY (position == -1))
858     return FALSE;
859
860   start = segment->start;
861   stop = segment->stop;
862
863   if (G_LIKELY (segment->rate > 0.0)) {
864     /* update the start and time values */
865     start = position;
866   } else {
867     /* reverse, update stop */
868     stop = position;
869   }
870   /* and base time is exactly the running time */
871   segment->time = gst_segment_to_stream_time (segment, format, start);
872   segment->start = start;
873   segment->stop = stop;
874   segment->base = running_time;
875
876   return TRUE;
877 }
878
879 /**
880  * gst_segment_offset_running_time:
881  * @segment: a #GstSegment structure.
882  * @format: the format of the segment.
883  * @offset: the offset to apply in the segment
884  *
885  * Adjust the values in @segment so that @offset is applied to all
886  * future running-time calculations.
887  *
888  * Since: 1.2.3
889  *
890  * Returns: %TRUE if the segment could be updated successfully. If %FALSE is
891  * returned, @offset is not in @segment.
892  */
893 gboolean
894 gst_segment_offset_running_time (GstSegment * segment, GstFormat format,
895     gint64 offset)
896 {
897   g_return_val_if_fail (segment != NULL, FALSE);
898   g_return_val_if_fail (segment->format == format, FALSE);
899
900   if (offset == 0)
901     return TRUE;
902
903   if (offset > 0) {
904     /* positive offset, we can simply apply to the base time */
905     segment->base += offset;
906   } else {
907     offset = -offset;
908     /* negative offset, first try to subtract from base */
909     if (segment->base > offset) {
910       segment->base -= offset;
911     } else {
912       guint64 position;
913
914       /* subtract all from segment.base, remainder in offset */
915       offset -= segment->base;
916       segment->base = 0;
917       position =
918           gst_segment_position_from_running_time (segment, format, offset);
919       if (position == -1)
920         return FALSE;
921
922       segment->offset = position - segment->start;
923     }
924   }
925   return TRUE;
926 }
927
928 /**
929  * gst_segment_is_equal:
930  * @s0: a #GstSegment structure.
931  * @s1: a #GstSegment structure.
932  *
933  * Checks for two segments being equal. Equality here is defined
934  * as perfect equality, including floating point values.
935  *
936  * Since: 1.6
937  *
938  * Returns: %TRUE if the segments are equal, %FALSE otherwise.
939  */
940 gboolean
941 gst_segment_is_equal (const GstSegment * s0, const GstSegment * s1)
942 {
943   if (s0->flags != s1->flags)
944     return FALSE;
945   if (s0->rate != s1->rate)
946     return FALSE;
947   if (s0->applied_rate != s1->applied_rate)
948     return FALSE;
949   if (s0->format != s1->format)
950     return FALSE;
951   if (s0->base != s1->base)
952     return FALSE;
953   if (s0->offset != s1->offset)
954     return FALSE;
955   if (s0->start != s1->start)
956     return FALSE;
957   if (s0->stop != s1->stop)
958     return FALSE;
959   if (s0->time != s1->time)
960     return FALSE;
961   if (s0->position != s1->position)
962     return FALSE;
963   if (s0->duration != s1->duration)
964     return FALSE;
965   return TRUE;
966 }