gst/gstsegment.c: Also accumulate time correctly when doing reverse playback. Fixes...
[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., 59 Temple Place - Suite 330,
19  * Boston, MA 02111-1307, USA.
20  */
21
22
23 #include "gst_private.h"
24
25 #include "gstutils.h"
26 #include "gstsegment.h"
27
28 /**
29  * SECTION:gstsegment
30  * @short_description: Structure describing the configured region of interest
31  *                     in a media file.
32  * @see_also: #GstEvent
33  *
34  * This helper structure holds the relevant values for tracking the region of
35  * interest in a media file, called a segment. 
36  *
37  * The structure can be used for two purposes:
38  * <itemizedlist>
39  *   <listitem><para>performing seeks (handling seek events)</para></listitem>
40  *   <listitem><para>tracking playback regions (handling newsegment events)</para></listitem>
41  * </itemizedlist>
42  *
43  * The segment is usually configured by the application with a seek event which 
44  * is propagated upstream and eventually handled by an element that performs the seek.
45  *
46  * The configured segment is then propagated back downstream with a newsegment event.
47  * This information is then used to clip media to the segment boundaries.
48  *
49  * A segment structure is initialized with gst_segment_init(), which takes a #GstFormat
50  * that will be used as the format of the segment values. The segment will be configured
51  * with a start value of 0 and a stop/duration of -1, which is undefined. The default
52  * rate and applied_rate is 1.0.
53  *
54  * If the segment is used for managing seeks, the segment duration should be set with
55  * gst_segment_set_duration(). The public duration field contains the duration of the
56  * segment. When using the segment for seeking, the start and time members should 
57  * normally be left to their default 0 value. The stop position is left to -1 unless
58  * explicitly configured to a different value after a seek event.
59  *
60  * The current position in the segment should be set with the gst_segment_set_last_stop().
61  * The public last_stop field contains the last set stop position in the segment.
62  *
63  * For elements that perform seeks, the current segment should be updated with the
64  * gst_segment_set_seek() and the values from the seek event. This method will update
65  * all the segment fields. The last_stop field will contain the new playback position.
66  * If the cur_type was different from GST_SEEK_TYPE_NONE, playback continues from
67  * the last_stop position, possibly with updated flags or rate.
68  *
69  * For elements that want to use #GstSegment to track the playback region, use
70  * gst_segment_set_newsegment() to update the segment fields with the information from
71  * the newsegment event. 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 all accumulated segments 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  * Last reviewed on 2007-05-17 (0.10.13)
84  */
85
86 static GstSegment *
87 gst_segment_copy (GstSegment * segment)
88 {
89   GstSegment *result = NULL;
90
91   if (segment) {
92     result = gst_segment_new ();
93     memcpy (result, segment, sizeof (GstSegment));
94   }
95   return result;
96 }
97
98 GType
99 gst_segment_get_type (void)
100 {
101   static GType gst_segment_type = 0;
102
103   if (G_UNLIKELY (gst_segment_type == 0)) {
104     gst_segment_type = g_boxed_type_register_static ("GstSegment",
105         (GBoxedCopyFunc) gst_segment_copy, (GBoxedFreeFunc) gst_segment_free);
106   }
107
108   return gst_segment_type;
109 }
110
111 /**
112  * gst_segment_new:
113  *
114  * Allocate a new #GstSegment structure and initialize it using 
115  * gst_segment_init().
116  *
117  * Returns: a new #GstSegment, free with gst_segment_free().
118  */
119 GstSegment *
120 gst_segment_new (void)
121 {
122   GstSegment *result;
123
124   result = g_new0 (GstSegment, 1);
125   gst_segment_init (result, GST_FORMAT_UNDEFINED);
126
127   return result;
128 }
129
130 /**
131  * gst_segment_free:
132  * @segment: a #GstSegment
133  *
134  * Free the allocated segment @segment.
135  */
136 void
137 gst_segment_free (GstSegment * segment)
138 {
139   g_free (segment);
140 }
141
142 /**
143  * gst_segment_init:
144  * @segment: a #GstSegment structure.
145  * @format: the format of the segment.
146  *
147  * The start/last_stop positions are set to 0 and the stop/duration
148  * fields are set to -1 (unknown). The default rate of 1.0 and no
149  * flags are set.
150  *
151  * Initialize @segment to its default values.
152  */
153 void
154 gst_segment_init (GstSegment * segment, GstFormat format)
155 {
156   g_return_if_fail (segment != NULL);
157
158   segment->rate = 1.0;
159   segment->abs_rate = 1.0;
160   segment->applied_rate = 1.0;
161   segment->format = format;
162   segment->flags = 0;
163   segment->start = 0;
164   segment->stop = -1;
165   segment->time = 0;
166   segment->accum = 0;
167   segment->last_stop = 0;
168   segment->duration = -1;
169 }
170
171 /**
172  * gst_segment_set_duration:
173  * @segment: a #GstSegment structure.
174  * @format: the format of the segment.
175  * @duration: the duration of the segment info or -1 if unknown.
176  *
177  * Set the duration of the segment to @duration. This function is mainly
178  * used by elements that perform seeking and know the total duration of the
179  * segment. 
180  * 
181  * This field should be set to allow seeking requests relative to the
182  * duration.
183  */
184 void
185 gst_segment_set_duration (GstSegment * segment, GstFormat format,
186     gint64 duration)
187 {
188   g_return_if_fail (segment != NULL);
189
190   if (G_UNLIKELY (segment->format == GST_FORMAT_UNDEFINED))
191     segment->format = format;
192   else
193     g_return_if_fail (segment->format == format);
194
195   segment->duration = duration;
196 }
197
198 /**
199  * gst_segment_set_last_stop:
200  * @segment: a #GstSegment structure.
201  * @format: the format of the segment.
202  * @position: the position 
203  *
204  * Set the last observed stop position in the segment to @position.
205  *
206  * This field should be set to allow seeking requests relative to the
207  * current playing position.
208  */
209 void
210 gst_segment_set_last_stop (GstSegment * segment, GstFormat format,
211     gint64 position)
212 {
213   g_return_if_fail (segment != NULL);
214
215   if (G_UNLIKELY (segment->format == GST_FORMAT_UNDEFINED))
216     segment->format = format;
217   else
218     g_return_if_fail (segment->format == format);
219
220   segment->last_stop = MAX (segment->start, position);
221 }
222
223 /**
224  * gst_segment_set_seek:
225  * @segment: a #GstSegment structure.
226  * @rate: the rate of the segment.
227  * @format: the format of the segment.
228  * @flags: the seek flags for the segment
229  * @start_type: the seek method
230  * @start: the seek start value
231  * @stop_type: the seek method
232  * @stop: the seek stop value
233  * @update: boolean holding whether last_stop was updated.
234  *
235  * Update the segment structure with the field values of a seek event (see
236  * gst_event_new_seek()).
237  *
238  * After calling this method, the segment field last_stop and time will
239  * contain the requested new position in the segment. The new requested
240  * position in the segment depends on @rate and @start_type and @stop_type. 
241  *
242  * For positive @rate, the new position in the segment is the new @segment
243  * start field when it was updated with a @start_type different from
244  * #GST_SEEK_TYPE_NONE. If no update was performed on @segment start position
245  * (#GST_SEEK_TYPE_NONE), @start is ignored and @segment last_stop is
246  * unmodified.
247  *
248  * For negative @rate, the new position in the segment is the new @segment
249  * stop field when it was updated with a @stop_type different from
250  * #GST_SEEK_TYPE_NONE. If no stop was previously configured in the segment, the
251  * duration of the segment will be used to update the stop position.
252  * If no update was performed on @segment stop position (#GST_SEEK_TYPE_NONE),
253  * @stop is ignored and @segment last_stop is unmodified.
254  *
255  * The applied rate of the segment will be set to 1.0 by default.
256  * If the caller can apply a rate change, it should update @segment
257  * rate and applied_rate after calling this function.
258  *
259  * @update will be set to TRUE if a seek should be performed to the segment 
260  * last_stop field. This field can be FALSE if, for example, only the @rate
261  * has been changed but not the playback position.
262  */
263 void
264 gst_segment_set_seek (GstSegment * segment, gdouble rate,
265     GstFormat format, GstSeekFlags flags,
266     GstSeekType start_type, gint64 start,
267     GstSeekType stop_type, gint64 stop, gboolean * update)
268 {
269   gboolean update_stop, update_start;
270   gint64 last_stop;
271
272   g_return_if_fail (rate != 0.0);
273   g_return_if_fail (segment != NULL);
274
275   if (G_UNLIKELY (segment->format == GST_FORMAT_UNDEFINED))
276     segment->format = format;
277   else
278     g_return_if_fail (segment->format == format);
279
280   update_start = update_stop = TRUE;
281
282   /* start is never invalid */
283   switch (start_type) {
284     case GST_SEEK_TYPE_NONE:
285       /* no update to segment */
286       start = segment->start;
287       update_start = FALSE;
288       break;
289     case GST_SEEK_TYPE_SET:
290       /* start holds desired position, map -1 to the start */
291       if (start == -1)
292         start = 0;
293       break;
294     case GST_SEEK_TYPE_CUR:
295       /* add start to currently configure segment */
296       start = segment->start + start;
297       break;
298     case GST_SEEK_TYPE_END:
299       if (segment->duration != -1) {
300         /* add start to total length */
301         start = segment->duration + start;
302       } else {
303         /* no update if duration unknown */
304         start = segment->start;
305         update_start = FALSE;
306       }
307       break;
308   }
309   /* bring in sane range */
310   if (segment->duration != -1)
311     start = CLAMP (start, 0, segment->duration);
312   else
313     start = MAX (start, 0);
314
315   /* stop can be -1 if we have not configured a stop. */
316   switch (stop_type) {
317     case GST_SEEK_TYPE_NONE:
318       stop = segment->stop;
319       update_stop = FALSE;
320       break;
321     case GST_SEEK_TYPE_SET:
322       /* stop holds required value */
323       break;
324     case GST_SEEK_TYPE_CUR:
325       if (segment->stop != -1)
326         stop = segment->stop + stop;
327       else
328         stop = -1;
329       break;
330     case GST_SEEK_TYPE_END:
331       if (segment->duration != -1)
332         stop = segment->duration + stop;
333       else {
334         stop = segment->stop;
335         update_stop = FALSE;
336       }
337       break;
338   }
339
340   /* if we have a valid stop time, make sure it is clipped */
341   if (stop != -1) {
342     if (segment->duration != -1)
343       stop = CLAMP (stop, 0, segment->duration);
344     else
345       stop = MAX (stop, 0);
346   }
347
348   /* we can't have stop before start */
349   if (stop != -1)
350     g_return_if_fail (start <= stop);
351
352   segment->rate = rate;
353   segment->abs_rate = ABS (rate);
354   segment->applied_rate = 1.0;
355   segment->flags = flags;
356   segment->start = start;
357   last_stop = segment->last_stop;
358   if (update_start && rate > 0.0) {
359     last_stop = start;
360   }
361   if (update_stop && rate < 0.0) {
362     if (stop != -1)
363       last_stop = stop;
364     else {
365       if (segment->duration != -1)
366         last_stop = segment->duration;
367       else
368         last_stop = 0;
369     }
370   }
371   /* set update arg to reflect update of last_stop */
372   if (update)
373     *update = last_stop != segment->last_stop;
374
375   /* update new position */
376   if (last_stop != segment->last_stop)
377     segment->last_stop = last_stop;
378
379   segment->time = start;
380   segment->stop = stop;
381 }
382
383 /**
384  * gst_segment_set_newsegment:
385  * @segment: a #GstSegment structure.
386  * @update: flag indicating a new segment is started or updated
387  * @rate: the rate of the segment.
388  * @format: the format of the segment.
389  * @start: the new start value
390  * @stop: the new stop value
391  * @time: the new stream time
392  *
393  * Update the segment structure with the field values of a new segment event and
394  * with a default applied_rate of 1.0.
395  *
396  * Since: 0.10.6
397  */
398 void
399 gst_segment_set_newsegment (GstSegment * segment, gboolean update, gdouble rate,
400     GstFormat format, gint64 start, gint64 stop, gint64 time)
401 {
402   gst_segment_set_newsegment_full (segment, update, rate, 1.0, format, start,
403       stop, time);
404 }
405
406 /**
407  * gst_segment_set_newsegment_full:
408  * @segment: a #GstSegment structure.
409  * @update: flag indicating a new segment is started or updated
410  * @rate: the rate of the segment.
411  * @applied_rate: the applied rate of the segment.
412  * @format: the format of the segment.
413  * @start: the new start value
414  * @stop: the new stop value
415  * @time: the new stream time
416  *
417  * Update the segment structure with the field values of a new segment event.
418  */
419 void
420 gst_segment_set_newsegment_full (GstSegment * segment, gboolean update,
421     gdouble rate, gdouble applied_rate, GstFormat format, gint64 start,
422     gint64 stop, gint64 time)
423 {
424   gint64 duration;
425
426   g_return_if_fail (rate != 0.0);
427   g_return_if_fail (applied_rate != 0.0);
428   g_return_if_fail (segment != NULL);
429
430   if (G_UNLIKELY (segment->format == GST_FORMAT_UNDEFINED))
431     segment->format = format;
432
433   /* any other format with 0 also gives time 0, the other values are
434    * invalid in the format though. */
435   if (format != segment->format && start == 0) {
436     format = segment->format;
437     if (stop != 0)
438       stop = -1;
439     if (time != 0)
440       time = -1;
441   }
442
443   g_return_if_fail (segment->format == format);
444
445   if (update) {
446     if (segment->rate > 0.0) {
447       /* an update to the current segment is done, elapsed time is
448        * difference between the old start and new start. */
449       if (start > segment->start)
450         duration = start - segment->start;
451       else
452         duration = 0;
453     } else {
454       /* for negative rates, the elapsed duration is the diff between the stop
455        * positions */
456       if (stop != -1 && stop < segment->stop)
457         duration = segment->stop - stop;
458       else
459         duration = 0;
460     }
461   } else {
462     /* the new segment has to be aligned with the old segment.
463      * We first update the accumulated time of the previous
464      * segment. the accumulated time is used when syncing to the
465      * clock. 
466      */
467     if (segment->stop != -1) {
468       duration = segment->stop - segment->start;
469     } else if (segment->last_stop != -1) {
470       /* else use last seen timestamp as segment stop */
471       duration = segment->last_stop - segment->start;
472     } else {
473       /* else we don't know and throw a warning.. really, this should
474        * be fixed in the element. */
475       g_warning ("closing segment of unknown duration, assuming duration of 0");
476       duration = 0;
477     }
478   }
479   /* use previous rate to calculate duration */
480   if (segment->abs_rate != 1.0)
481     duration /= segment->abs_rate;
482
483   /* accumulate duration */
484   segment->accum += duration;
485
486   /* then update the current segment */
487   segment->rate = rate;
488   segment->abs_rate = ABS (rate);
489   segment->applied_rate = applied_rate;
490   segment->start = start;
491   segment->last_stop = start;
492   segment->stop = stop;
493   segment->time = time;
494 }
495
496 /**
497  * gst_segment_to_stream_time:
498  * @segment: a #GstSegment structure.
499  * @format: the format of the segment.
500  * @position: the position in the segment
501  *
502  * Translate @position to stream time using the currently configured 
503  * segment. The @position value must be between @segment start and
504  * stop value. 
505  *
506  * This function is typically used by elements that need to operate on
507  * the stream time of the buffers it receives, such as effect plugins.
508  * In those use cases, @position is typically the buffer timestamp or 
509  * clock time that one wants to convert to the stream time.
510  * The stream time is always between 0 and the total duration of the 
511  * media stream. 
512  *
513  * Returns: the position in stream_time or -1 when an invalid position
514  * was given.
515  */
516 gint64
517 gst_segment_to_stream_time (GstSegment * segment, GstFormat format,
518     gint64 position)
519 {
520   gint64 result, start, stop, time;
521   gdouble abs_applied_rate;
522
523   g_return_val_if_fail (segment != NULL, -1);
524
525   /* format does not matter for -1 */
526   if (G_UNLIKELY (position == -1))
527     return -1;
528
529   if (G_UNLIKELY (segment->format == GST_FORMAT_UNDEFINED))
530     segment->format = format;
531
532   /* if we have the position for the same format as the segment, we can compare
533    * the start and stop values, otherwise we assume 0 and -1 */
534   if (segment->format == format) {
535     start = segment->start;
536     stop = segment->stop;
537     time = segment->time;
538   } else {
539     start = 0;
540     stop = -1;
541     time = 0;
542   }
543
544   /* outside of the segment boundary stop */
545   if (G_UNLIKELY (stop != -1 && position > stop))
546     return -1;
547
548   /* before the segment boundary */
549   if (G_UNLIKELY (position < start))
550     return -1;
551
552   /* time must be known */
553   if (G_UNLIKELY (time == -1))
554     return -1;
555
556   /* bring to uncorrected position in segment */
557   result = position - start;
558
559   abs_applied_rate = ABS (segment->applied_rate);
560
561   /* correct for applied rate if needed */
562   if (abs_applied_rate != 1.0)
563     result *= abs_applied_rate;
564
565   /* add or subtract from segment time based on applied rate */
566   if (segment->applied_rate > 0.0) {
567     /* correct for segment time */
568     result += time;
569   } else {
570     /* correct for segment time, clamp at 0 */
571     if (time > result)
572       result = time - result;
573     else
574       result = 0;
575   }
576
577   return result;
578 }
579
580 /**
581  * gst_segment_to_running_time:
582  * @segment: a #GstSegment structure.
583  * @format: the format of the segment.
584  * @position: the position in the segment
585  *
586  * Translate @position to the total running time using the currently configured 
587  * and previously accumulated segments. Position is a value between @segment
588  * start and stop time.
589  *
590  * This function is typically used by elements that need to synchronize to the
591  * global clock in a pipeline. The runnning time is a constantly increasing value
592  * starting from 0. When gst_segment_init() is called, this value will reset to
593  * 0.
594  *
595  * This function returns -1 if the position is outside of @segment start and stop.
596  *
597  * Returns: the position as the total running time or -1 when an invalid position
598  * was given.
599  */
600 gint64
601 gst_segment_to_running_time (GstSegment * segment, GstFormat format,
602     gint64 position)
603 {
604   gint64 result;
605   gint64 start, stop, accum;
606
607   g_return_val_if_fail (segment != NULL, -1);
608
609   if (G_UNLIKELY (position == -1))
610     return -1;
611
612   if (G_UNLIKELY (segment->format == GST_FORMAT_UNDEFINED))
613     segment->format = format;
614
615   /* if we have the position for the same format as the segment, we can compare
616    * the start and stop values, otherwise we assume 0 and -1 */
617   if (segment->format == format) {
618     start = segment->start;
619     stop = segment->stop;
620     accum = segment->accum;
621   } else {
622     start = 0;
623     stop = -1;
624     accum = 0;
625   }
626
627   /* before the segment boundary */
628   if (G_UNLIKELY (position < start))
629     return -1;
630
631   if (segment->rate > 0.0) {
632     /* outside of the segment boundary stop */
633     if (G_UNLIKELY (stop != -1 && position > stop))
634       return -1;
635
636     /* bring to uncorrected position in segment */
637     result = position - start;
638   } else {
639     /* cannot continue if no stop position set or outside of
640      * the segment. */
641     if (G_UNLIKELY (stop == -1 || position > stop))
642       return -1;
643
644     /* bring to uncorrected position in segment */
645     result = stop - position;
646   }
647
648   /* scale based on the rate, avoid division by and conversion to 
649    * float when not needed */
650   if (segment->abs_rate != 1.0)
651     result /= segment->abs_rate;
652
653   /* correct for accumulated segments */
654   result += accum;
655
656   return result;
657 }
658
659 /**
660  * gst_segment_clip:
661  * @segment: a #GstSegment structure.
662  * @format: the format of the segment.
663  * @start: the start position in the segment
664  * @stop: the stop position in the segment
665  * @clip_start: the clipped start position in the segment
666  * @clip_stop: the clipped stop position in the segment
667  *
668  * Clip the given @start and @stop values to the segment boundaries given
669  * in @segment. @start and @stop are compared and clipped to @segment 
670  * start and stop values.
671  *
672  * If the function returns FALSE, @start and @stop are known to fall
673  * outside of @segment and @clip_start and @clip_stop are not updated.
674  *
675  * When the function returns TRUE, @clip_start and @clip_stop will be
676  * updated. If @clip_start or @clip_stop are different from @start or @stop
677  * respectively, the region fell partially in the segment.
678  *
679  * Note that when @stop is -1, @clip_stop will be set to the end of the
680  * segment. Depending on the use case, this may or may not be what you want.
681  *
682  * Returns: TRUE if the given @start and @stop times fall partially or 
683  *     completely in @segment, FALSE if the values are completely outside 
684  *     of the segment.
685  */
686 gboolean
687 gst_segment_clip (GstSegment * segment, GstFormat format, gint64 start,
688     gint64 stop, gint64 * clip_start, gint64 * clip_stop)
689 {
690   g_return_val_if_fail (segment != NULL, FALSE);
691
692   if (G_UNLIKELY (segment->format == GST_FORMAT_UNDEFINED))
693     segment->format = format;
694   else
695     g_return_val_if_fail (segment->format == format, FALSE);
696
697   /* if we have a stop position and a valid start and start is bigger, 
698    * we're outside of the segment */
699   if (G_UNLIKELY (segment->stop != -1 && start != -1 && start >= segment->stop))
700     return FALSE;
701
702   /* if a stop position is given and is before the segment start,
703    * we're outside of the segment */
704   if (G_UNLIKELY (stop != -1 && stop != start && stop <= segment->start))
705     return FALSE;
706
707   if (clip_start) {
708     if (start == -1)
709       *clip_start = -1;
710     else
711       *clip_start = MAX (start, segment->start);
712   }
713
714   if (clip_stop) {
715     if (stop == -1)
716       *clip_stop = segment->stop;
717     else if (segment->stop == -1)
718       *clip_stop = MAX (-1, stop);
719     else
720       *clip_stop = MIN (stop, segment->stop);
721
722     if (segment->duration != -1)
723       *clip_stop = MIN (*clip_stop, segment->duration);
724   }
725
726   return TRUE;
727 }