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  * @title: GstSegment
  32  * @short_description: Structure describing the configured region of interest
  33  *                     in a media file.
  34  * @see_also: #GstEvent
  35  *
  36  * This helper structure holds the relevant values for tracking the region of
  37  * interest in a media file, called a segment.
  38  *
  39  * The structure can be used for two purposes:
  40  *
  41  *   * performing seeks (handling seek events)
  42  *   * tracking playback regions (handling newsegment events)
  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_full:
 379  * @segment: a #GstSegment structure.
 380  * @format: the format of the segment.
 381  * @position: the position in the segment
 382  * @stream_time: result stream-time
 383  *
 384  * Translate @position to the total stream time using the currently configured
 385  * segment. Compared to gst_segment_to_stream_time() this function can return
 386  * negative stream-time.
 387  *
 388  * This function is typically used by elements that need to synchronize buffers
 389  * against the clock or eachother.
 390  *
 391  * @position can be any value and the result of this function for values outside
 392  * of the segment is extrapolated.
 393  *
 394  * When 1 is returned, @position resulted in a positive stream-time returned
 395  * in @stream_time.
 396  *
 397  * When this function returns -1, the returned @stream_time should be negated
 398  * to get the real negative stream time.
 399  *
 400  * Returns: a 1 or -1 on success, 0 on failure.
 401  *
 402  * Since: 1.8
 403  */
 404 gint
 405 gst_segment_to_stream_time_full (const GstSegment * segment, GstFormat format,
 406     guint64 position, guint64 * stream_time)
 407 {
 408   guint64 start, stop, time;
 409   gdouble abs_applied_rate;
 410   gint res;
 411
 412   /* format does not matter for -1 */
 413   if (G_UNLIKELY (position == -1)) {
 414     *stream_time = -1;
 415     return 0;
 416   }
 417
 418   g_return_val_if_fail (segment != NULL, 0);
 419   g_return_val_if_fail (segment->format == format, 0);
 420
 421   stop = segment->stop;
 422
 423   start = segment->start;
 424   time = segment->time;
 425
 426   /* time must be known */
 427   if (G_UNLIKELY (time == -1))
 428     return 0;
 429
 430   abs_applied_rate = ABS (segment->applied_rate);
 431
 432   /* add or subtract from segment time based on applied rate */
 433   if (G_LIKELY (segment->applied_rate > 0.0)) {
 434     if (G_LIKELY (position > start)) {
 435       /* bring to uncorrected position in segment */
 436       *stream_time = position - start;
 437       /* correct for applied rate if needed */
 438       if (G_UNLIKELY (abs_applied_rate != 1.0))
 439         *stream_time *= abs_applied_rate;
 440       /* correct for segment time */
 441       *stream_time += time;
 442       res = 1;
 443     } else {
 444       *stream_time = start - position;
 445       if (G_UNLIKELY (abs_applied_rate != 1.0))
 446         *stream_time *= abs_applied_rate;
 447       if (*stream_time > time) {
 448         *stream_time -= time;
 449         res = -1;
 450       } else {
 451         *stream_time = time - *stream_time;
 452         res = 1;
 453       }
 454     }
 455   } else {
 456     /* correct for segment time. Streams with a negative applied_rate
 457      * have timestamps between start and stop, as usual, but have the
 458      * time member starting high and going backwards.  */
 459     /* cannot continue without a known segment stop */
 460     if (G_UNLIKELY (stop == -1))
 461       return 0;
 462     if (G_UNLIKELY (position > stop)) {
 463       *stream_time = position - stop;
 464       if (G_UNLIKELY (abs_applied_rate != 1.0))
 465         *stream_time *= abs_applied_rate;
 466       if (*stream_time > time) {
 467         *stream_time -= time;
 468         res = -1;
 469       } else {
 470         *stream_time = time - *stream_time;
 471         res = 1;
 472       }
 473     } else {
 474       *stream_time = stop - position;
 475       if (G_UNLIKELY (abs_applied_rate != 1.0))
 476         *stream_time *= abs_applied_rate;
 477       *stream_time += time;
 478       res = 1;
 479     }
 480   }
 481
 482   return res;
 483 }
 484
 485 /**
 486  * gst_segment_to_stream_time:
 487  * @segment: a #GstSegment structure.
 488  * @format: the format of the segment.
 489  * @position: the position in the segment
 490  *
 491  * Translate @position to stream time using the currently configured
 492  * segment. The @position value must be between @segment start and
 493  * stop value.
 494  *
 495  * This function is typically used by elements that need to operate on
 496  * the stream time of the buffers it receives, such as effect plugins.
 497  * In those use cases, @position is typically the buffer timestamp or
 498  * clock time that one wants to convert to the stream time.
 499  * The stream time is always between 0 and the total duration of the
 500  * media stream.
 501  *
 502  * Returns: the position in stream_time or -1 when an invalid position
 503  * was given.
 504  *
 505  * Since: 1.8
 506  */
 507 guint64
 508 gst_segment_to_stream_time (const GstSegment * segment, GstFormat format,
 509     guint64 position)
 510 {
 511   guint64 result;
 512
 513   g_return_val_if_fail (segment != NULL, -1);
 514   g_return_val_if_fail (segment->format == format, -1);
 515
 516   /* before the segment boundary */
 517   if (G_UNLIKELY (position < segment->start)) {
 518     GST_DEBUG ("position(%" G_GUINT64_FORMAT ") < start(%" G_GUINT64_FORMAT
 519         ")", position, segment->start);
 520     return -1;
 521   }
 522   /* after the segment boundary */
 523   if (G_UNLIKELY (segment->stop != -1 && position > segment->stop)) {
 524     GST_DEBUG ("position(%" G_GUINT64_FORMAT ") > stop(%" G_GUINT64_FORMAT
 525         ")", position, segment->stop);
 526     return -1;
 527   }
 528
 529   if (gst_segment_to_stream_time_full (segment, format, position, &result) == 1)
 530     return result;
 531
 532   return -1;
 533 }
 534
 535 /**
 536  * gst_segment_position_from_stream_time_full:
 537  * @segment: a #GstSegment structure.
 538  * @format: the format of the segment.
 539  * @stream_time: the stream-time
 540  * @position: the resulting position in the segment
 541  *
 542  * Translate @stream_time to the segment position using the currently configured
 543  * segment. Compared to gst_segment_position_from_stream_time() this function can
 544  * return negative segment position.
 545  *
 546  * This function is typically used by elements that need to synchronize buffers
 547  * against the clock or each other.
 548  *
 549  * @stream_time can be any value and the result of this function for values outside
 550  * of the segment is extrapolated.
 551  *
 552  * When 1 is returned, @stream_time resulted in a positive position returned
 553  * in @position.
 554  *
 555  * When this function returns -1, the returned @position should be negated
 556  * to get the real negative segment position.
 557  *
 558  * Returns: a 1 or -1 on success, 0 on failure.
 559  *
 560  * Since: 1.8
 561  */
 562 gint
 563 gst_segment_position_from_stream_time_full (const GstSegment * segment,
 564     GstFormat format, guint64 stream_time, guint64 * position)
 565 {
 566   guint64 start, time;
 567   gdouble abs_applied_rate;
 568   gint res;
 569
 570   /* format does not matter for -1 */
 571   if (G_UNLIKELY (stream_time == -1)) {
 572     *position = -1;
 573     return 0;
 574   }
 575
 576   g_return_val_if_fail (segment != NULL, -1);
 577   g_return_val_if_fail (segment->format == format, -1);
 578
 579   start = segment->start;
 580   time = segment->time;
 581
 582   /* time must be known */
 583   if (G_UNLIKELY (time == -1))
 584     return 0;
 585
 586   abs_applied_rate = ABS (segment->applied_rate);
 587
 588   if (G_LIKELY (segment->applied_rate > 0.0)) {
 589     if (G_LIKELY (stream_time > time)) {
 590       res = 1;
 591       *position = stream_time - time;
 592     } else {
 593       res = -1;
 594       *position = time - stream_time;
 595     }
 596     /* correct for applied rate if needed */
 597     if (G_UNLIKELY (abs_applied_rate != 1.0))
 598       *position /= abs_applied_rate;
 599
 600     if (G_UNLIKELY (res == -1)) {
 601       if (*position > start) {
 602         *position -= start;
 603       } else {
 604         *position = start - *position;
 605         res = 1;
 606       }
 607     } else {
 608       *position += start;
 609     }
 610   } else {
 611     GstClockTime stop = segment->stop;
 612     /* cannot continue without a known segment stop */
 613     if (G_UNLIKELY (stop == -1))
 614       return 0;
 615     if (G_UNLIKELY (time > stream_time)) {
 616       res = -1;
 617       *position = time - stream_time;
 618     } else {
 619       res = 1;
 620       *position = stream_time - time;
 621     }
 622     if (G_UNLIKELY (abs_applied_rate != 1.0))
 623       *position /= abs_applied_rate;
 624     if (G_UNLIKELY (stop < *position)) {
 625       if (G_LIKELY (res == 1)) {
 626         *position -= stop;
 627         res = -1;
 628       } else {
 629         *position += stop;
 630         res = 1;
 631       }
 632     } else {
 633       if (G_LIKELY (res == 1)) {
 634         *position = stop - *position;
 635         res = 1;
 636       } else {
 637         *position += stop;
 638         res = 1;
 639       }
 640     }
 641   }
 642
 643   return res;
 644 }
 645
 646 /**
 647  * gst_segment_position_from_stream_time:
 648  * @segment: a #GstSegment structure.
 649  * @format: the format of the segment.
 650  * @stream_time: the stream_time in the segment
 651  *
 652  * Convert @stream_time into a position in the segment so that
 653  * gst_segment_to_stream_time() with that position returns @stream_time.
 654  *
 655  * Returns: the position in the segment for @stream_time. This function returns
 656  * -1 when @stream_time is -1 or when it is not inside @segment.
 657  *
 658  * Since: 1.8
 659  */
 660 guint64
 661 gst_segment_position_from_stream_time (const GstSegment * segment,
 662     GstFormat format, guint64 stream_time)
 663 {
 664   guint64 position;
 665   gint res;
 666
 667   g_return_val_if_fail (segment != NULL, -1);
 668   g_return_val_if_fail (segment->format == format, -1);
 669
 670   res =
 671       gst_segment_position_from_stream_time_full (segment, format, stream_time,
 672       &position);
 673
 674   /* before the segment boundary */
 675   if (G_UNLIKELY (position < segment->start)) {
 676     GST_DEBUG ("position(%" G_GUINT64_FORMAT ") < start(%" G_GUINT64_FORMAT
 677         ")", position, segment->start);
 678     return -1;
 679   }
 680
 681   /* after the segment boundary */
 682   if (G_UNLIKELY (segment->stop != -1 && position > segment->stop)) {
 683     GST_DEBUG ("position(%" G_GUINT64_FORMAT ") > stop(%" G_GUINT64_FORMAT
 684         ")", position, segment->stop);
 685     return -1;
 686   }
 687
 688   if (res == 1)
 689     return position;
 690
 691   return -1;
 692 }
 693
 694 /**
 695  * gst_segment_to_running_time_full:
 696  * @segment: a #GstSegment structure.
 697  * @format: the format of the segment.
 698  * @position: the position in the segment
 699  * @running_time: result running-time
 700  *
 701  * Translate @position to the total running time using the currently configured
 702  * segment. Compared to gst_segment_to_running_time() this function can return
 703  * negative running-time.
 704  *
 705  * This function is typically used by elements that need to synchronize buffers
 706  * against the clock or eachother.
 707  *
 708  * @position can be any value and the result of this function for values outside
 709  * of the segment is extrapolated.
 710  *
 711  * When 1 is returned, @position resulted in a positive running-time returned
 712  * in @running_time.
 713  *
 714  * When this function returns -1, the returned @running_time should be negated
 715  * to get the real negative running time.
 716  *
 717  * Returns: a 1 or -1 on success, 0 on failure.
 718  *
 719  * Since: 1.6
 720  */
 721 gint
 722 gst_segment_to_running_time_full (const GstSegment * segment, GstFormat format,
 723     guint64 position, guint64 * running_time)
 724 {
 725   gint res = 0;
 726   guint64 result;
 727   guint64 start, stop, offset;
 728   gdouble abs_rate;
 729
 730   if (G_UNLIKELY (position == -1)) {
 731     GST_DEBUG ("invalid position (-1)");
 732     goto done;
 733   }
 734
 735   g_return_val_if_fail (segment != NULL, 0);
 736   g_return_val_if_fail (segment->format == format, 0);
 737
 738   offset = segment->offset;
 739
 740   if (G_LIKELY (segment->rate > 0.0)) {
 741     start = segment->start + offset;
 742
 743     /* bring to uncorrected position in segment */
 744     if (position < start) {
 745       /* negative value */
 746       result = start - position;
 747       res = -1;
 748     } else {
 749       result = position - start;
 750       res = 1;
 751     }
 752   } else {
 753     stop = segment->stop;
 754
 755     /* cannot continue if no stop position set or invalid offset */
 756     g_return_val_if_fail (stop != -1, 0);
 757     g_return_val_if_fail (stop >= offset, 0);
 758
 759     stop -= offset;
 760
 761     /* bring to uncorrected position in segment */
 762     if (position > stop) {
 763       /* negative value */
 764       result = position - stop;
 765       res = -1;
 766     } else {
 767       result = stop - position;
 768       res = 1;
 769     }
 770   }
 771
 772   if (running_time) {
 773     /* scale based on the rate, avoid division by and conversion to
 774      * float when not needed */
 775     abs_rate = ABS (segment->rate);
 776     if (G_UNLIKELY (abs_rate != 1.0))
 777       result /= abs_rate;
 778
 779     /* correct for base of the segment */
 780     if (res == 1)
 781       /* positive, add base */
 782       *running_time = result + segment->base;
 783     else if (segment->base >= result) {
 784       /* negative and base is bigger, subtract from base and we have a
 785        * positive value again */
 786       *running_time = segment->base - result;
 787       res = 1;
 788     } else {
 789       /* negative and base is smaller, subtract base and remainder is
 790        * negative */
 791       *running_time = result - segment->base;
 792     }
 793   }
 794   return res;
 795
 796 done:
 797   {
 798     if (running_time)
 799       *running_time = -1;
 800     return 0;
 801   }
 802 }
 803
 804 /**
 805  * gst_segment_to_running_time:
 806  * @segment: a #GstSegment structure.
 807  * @format: the format of the segment.
 808  * @position: the position in the segment
 809  *
 810  * Translate @position to the total running time using the currently configured
 811  * segment. Position is a value between @segment start and stop time.
 812  *
 813  * This function is typically used by elements that need to synchronize to the
 814  * global clock in a pipeline. The running time is a constantly increasing value
 815  * starting from 0. When gst_segment_init() is called, this value will reset to
 816  * 0.
 817  *
 818  * This function returns -1 if the position is outside of @segment start and stop.
 819  *
 820  * Returns: the position as the total running time or -1 when an invalid position
 821  * was given.
 822  */
 823 guint64
 824 gst_segment_to_running_time (const GstSegment * segment, GstFormat format,
 825     guint64 position)
 826 {
 827   guint64 result;
 828
 829   g_return_val_if_fail (segment != NULL, -1);
 830   g_return_val_if_fail (segment->format == format, -1);
 831
 832   /* before the segment boundary */
 833   if (G_UNLIKELY (position < segment->start)) {
 834     GST_DEBUG ("position(%" G_GUINT64_FORMAT ") < start(%" G_GUINT64_FORMAT
 835         ")", position, segment->start);
 836     return -1;
 837   }
 838   /* after the segment boundary */
 839   if (G_UNLIKELY (segment->stop != -1 && position > segment->stop)) {
 840     GST_DEBUG ("position(%" G_GUINT64_FORMAT ") > stop(%" G_GUINT64_FORMAT
 841         ")", position, segment->stop);
 842     return -1;
 843   }
 844
 845   if (gst_segment_to_running_time_full (segment, format, position,
 846           &result) == 1)
 847     return result;
 848
 849   return -1;
 850 }
 851
 852 /**
 853  * gst_segment_clip:
 854  * @segment: a #GstSegment structure.
 855  * @format: the format of the segment.
 856  * @start: the start position in the segment
 857  * @stop: the stop position in the segment
 858  * @clip_start: (out) (allow-none): the clipped start position in the segment
 859  * @clip_stop: (out) (allow-none): the clipped stop position in the segment
 860  *
 861  * Clip the given @start and @stop values to the segment boundaries given
 862  * in @segment. @start and @stop are compared and clipped to @segment
 863  * start and stop values.
 864  *
 865  * If the function returns %FALSE, @start and @stop are known to fall
 866  * outside of @segment and @clip_start and @clip_stop are not updated.
 867  *
 868  * When the function returns %TRUE, @clip_start and @clip_stop will be
 869  * updated. If @clip_start or @clip_stop are different from @start or @stop
 870  * respectively, the region fell partially in the segment.
 871  *
 872  * Note that when @stop is -1, @clip_stop will be set to the end of the
 873  * segment. Depending on the use case, this may or may not be what you want.
 874  *
 875  * Returns: %TRUE if the given @start and @stop times fall partially or
 876  *     completely in @segment, %FALSE if the values are completely outside
 877  *     of the segment.
 878  */
 879 gboolean
 880 gst_segment_clip (const GstSegment * segment, GstFormat format, guint64 start,
 881     guint64 stop, guint64 * clip_start, guint64 * clip_stop)
 882 {
 883   g_return_val_if_fail (segment != NULL, FALSE);
 884   g_return_val_if_fail (segment->format == format, FALSE);
 885
 886   /* if we have a stop position and a valid start and start is bigger,
 887    * we're outside of the segment. (Special case) segment start and
 888    * segment stop can be identical. In this case, if start is also identical,
 889    * it's inside of segment */
 890   if (G_UNLIKELY (segment->stop != -1 && start != -1 && (start > segment->stop
 891               || (segment->start != segment->stop && start == segment->stop))))
 892     return FALSE;
 893
 894   /* if a stop position is given and is before the segment start,
 895    * we're outside of the segment. Special case is were start
 896    * and stop are equal to the segment start. In that case we
 897    * are inside the segment. */
 898   if (G_UNLIKELY (stop != -1 && (stop < segment->start || (start != stop
 899                   && stop == segment->start))))
 900     return FALSE;
 901
 902   if (clip_start) {
 903     if (start == -1)
 904       *clip_start = -1;
 905     else
 906       *clip_start = MAX (start, segment->start);
 907   }
 908
 909   if (clip_stop) {
 910     if (stop == -1)
 911       *clip_stop = segment->stop;
 912     else if (segment->stop == -1)
 913       *clip_stop = stop;
 914     else
 915       *clip_stop = MIN (stop, segment->stop);
 916   }
 917
 918   return TRUE;
 919 }
 920
 921 /**
 922  * gst_segment_position_from_running_time:
 923  * @segment: a #GstSegment structure.
 924  * @format: the format of the segment.
 925  * @running_time: the running_time in the segment
 926  *
 927  * Convert @running_time into a position in the segment so that
 928  * gst_segment_to_running_time() with that position returns @running_time.
 929  *
 930  * Returns: the position in the segment for @running_time. This function returns
 931  * -1 when @running_time is -1 or when it is not inside @segment.
 932  *
 933  * Since: 1.8
 934  */
 935 guint64
 936 gst_segment_position_from_running_time (const GstSegment * segment,
 937     GstFormat format, guint64 running_time)
 938 {
 939   guint64 position;
 940   gint res;
 941
 942   g_return_val_if_fail (segment != NULL, -1);
 943   g_return_val_if_fail (segment->format == format, -1);
 944
 945   res =
 946       gst_segment_position_from_running_time_full (segment, format,
 947       running_time, &position);
 948
 949   if (res != 1)
 950     return -1;
 951
 952   /* before the segment boundary */
 953   if (G_UNLIKELY (position < segment->start)) {
 954     GST_DEBUG ("position(%" G_GUINT64_FORMAT ") < start(%" G_GUINT64_FORMAT
 955         ")", position, segment->start);
 956     return -1;
 957   }
 958
 959   /* after the segment boundary */
 960   if (G_UNLIKELY (segment->stop != -1 && position > segment->stop)) {
 961     GST_DEBUG ("position(%" G_GUINT64_FORMAT ") > stop(%" G_GUINT64_FORMAT
 962         ")", position, segment->stop);
 963     return -1;
 964   }
 965
 966   return position;
 967 }
 968
 969 /**
 970  * gst_segment_position_from_running_time_full:
 971  * @segment: a #GstSegment structure.
 972  * @format: the format of the segment.
 973  * @running_time: the running-time
 974  * @position: the resulting position in the segment
 975  *
 976  * Translate @running_time to the segment position using the currently configured
 977  * segment. Compared to gst_segment_position_from_running_time() this function can
 978  * return negative segment position.
 979  *
 980  * This function is typically used by elements that need to synchronize buffers
 981  * against the clock or each other.
 982  *
 983  * @running_time can be any value and the result of this function for values
 984  * outside of the segment is extrapolated.
 985  *
 986  * When 1 is returned, @running_time resulted in a positive position returned
 987  * in @position.
 988  *
 989  * When this function returns -1, the returned @position should be negated
 990  * to get the real negative segment position.
 991  *
 992  * Returns: a 1 or -1 on success, 0 on failure.
 993  *
 994  * Since: 1.8
 995  */
 996 gint
 997 gst_segment_position_from_running_time_full (const GstSegment * segment,
 998     GstFormat format, guint64 running_time, guint64 * position)
 999 {
1000   gint res;
1001   guint64 start, stop, base;
1002   gdouble abs_rate;
1003
1004   if (G_UNLIKELY (running_time == -1)) {
1005     *position = -1;
1006     return 0;
1007   }
1008
1009   g_return_val_if_fail (segment != NULL, 0);
1010   g_return_val_if_fail (segment->format == format, 0);
1011
1012   base = segment->base;
1013
1014   abs_rate = ABS (segment->rate);
1015
1016   start = segment->start;
1017   stop = segment->stop;
1018
1019   if (G_LIKELY (segment->rate > 0.0)) {
1020     /* start by subtracting the base time */
1021     if (G_LIKELY (running_time >= base)) {
1022       *position = running_time - base;
1023       /* move into the segment at the right rate */
1024       if (G_UNLIKELY (abs_rate != 1.0))
1025         *position = ceil (*position * abs_rate);
1026       /* bring to corrected position in segment */
1027       *position += start + segment->offset;
1028       res = 1;
1029     } else {
1030       *position = base - running_time;
1031       if (G_UNLIKELY (abs_rate != 1.0))
1032         *position = ceil (*position * abs_rate);
1033       if (start + segment->offset > *position) {
1034         *position -= start + segment->offset;
1035         res = -1;
1036       } else {
1037         *position = start + segment->offset - *position;
1038         res = 1;
1039       }
1040     }
1041   } else {
1042     if (G_LIKELY (running_time >= base)) {
1043       *position = running_time - base;
1044       if (G_UNLIKELY (abs_rate != 1.0))
1045         *position = ceil (*position * abs_rate);
1046       if (G_UNLIKELY (stop < *position + segment->offset)) {
1047         *position += segment->offset - stop;
1048         res = -1;
1049       } else {
1050         *position = stop - *position - segment->offset;
1051         res = 1;
1052       }
1053     } else {
1054       *position = base - running_time;
1055       if (G_UNLIKELY (abs_rate != 1.0))
1056         *position = ceil (*position * abs_rate);
1057       if (G_UNLIKELY (stop < segment->offset - *position)) {
1058         *position -= segment->offset - stop;
1059         res = -1;
1060       } else {
1061         *position = stop + *position - segment->offset;
1062         res = 1;
1063       }
1064     }
1065   }
1066   return res;
1067 }
1068
1069 /**
1070  * gst_segment_to_position:
1071  * @segment: a #GstSegment structure.
1072  * @format: the format of the segment.
1073  * @running_time: the running_time in the segment
1074  *
1075  * Convert @running_time into a position in the segment so that
1076  * gst_segment_to_running_time() with that position returns @running_time.
1077  *
1078  * Returns: the position in the segment for @running_time. This function returns
1079  * -1 when @running_time is -1 or when it is not inside @segment.
1080  *
1081  * Deprecated. Use gst_segment_position_from_running_time() instead.
1082  */
1083 #ifndef GST_REMOVE_DEPRECATED
1084 #ifdef GST_DISABLE_DEPRECATED
1085 guint64 gst_segment_to_position (const GstSegment * segment, GstFormat format,
1086     guint64 running_time);
1087 #endif
1088 guint64
1089 gst_segment_to_position (const GstSegment * segment, GstFormat format,
1090     guint64 running_time)
1091 {
1092   return gst_segment_position_from_running_time (segment, format, running_time);
1093 }
1094 #endif
1095
1096 /**
1097  * gst_segment_set_running_time:
1098  * @segment: a #GstSegment structure.
1099  * @format: the format of the segment.
1100  * @running_time: the running_time in the segment
1101  *
1102  * Adjust the start/stop and base values of @segment such that the next valid
1103  * buffer will be one with @running_time.
1104  *
1105  * Returns: %TRUE if the segment could be updated successfully. If %FALSE is
1106  * returned, @running_time is -1 or not in @segment.
1107  */
1108 gboolean
1109 gst_segment_set_running_time (GstSegment * segment, GstFormat format,
1110     guint64 running_time)
1111 {
1112   guint64 position;
1113   guint64 start, stop;
1114
1115   /* start by bringing the running_time into the segment position */
1116   position =
1117       gst_segment_position_from_running_time (segment, format, running_time);
1118
1119   /* we must have a valid position now */
1120   if (G_UNLIKELY (position == -1))
1121     return FALSE;
1122
1123   start = segment->start;
1124   stop = segment->stop;
1125
1126   if (G_LIKELY (segment->rate > 0.0)) {
1127     /* update the start and time values */
1128     start = position;
1129   } else {
1130     /* reverse, update stop */
1131     stop = position;
1132   }
1133   /* and base time is exactly the running time */
1134   segment->time = gst_segment_to_stream_time (segment, format, start);
1135   segment->start = start;
1136   segment->stop = stop;
1137   segment->base = running_time;
1138
1139   return TRUE;
1140 }
1141
1142 /**
1143  * gst_segment_offset_running_time:
1144  * @segment: a #GstSegment structure.
1145  * @format: the format of the segment.
1146  * @offset: the offset to apply in the segment
1147  *
1148  * Adjust the values in @segment so that @offset is applied to all
1149  * future running-time calculations.
1150  *
1151  * Since: 1.2.3
1152  *
1153  * Returns: %TRUE if the segment could be updated successfully. If %FALSE is
1154  * returned, @offset is not in @segment.
1155  */
1156 gboolean
1157 gst_segment_offset_running_time (GstSegment * segment, GstFormat format,
1158     gint64 offset)
1159 {
1160   g_return_val_if_fail (segment != NULL, FALSE);
1161   g_return_val_if_fail (segment->format == format, FALSE);
1162
1163   if (offset == 0)
1164     return TRUE;
1165
1166   if (offset > 0) {
1167     /* positive offset, we can simply apply to the base time */
1168     segment->base += offset;
1169   } else {
1170     offset = -offset;
1171     /* negative offset, first try to subtract from base */
1172     if (segment->base > offset) {
1173       segment->base -= offset;
1174     } else {
1175       guint64 position;
1176
1177       /* subtract all from segment.base, remainder in offset */
1178       offset -= segment->base;
1179       segment->base = 0;
1180       position =
1181           gst_segment_position_from_running_time (segment, format, offset);
1182       if (position == -1)
1183         return FALSE;
1184
1185       segment->offset = position - segment->start;
1186     }
1187   }
1188   return TRUE;
1189 }
1190
1191 /**
1192  * gst_segment_is_equal:
1193  * @s0: a #GstSegment structure.
1194  * @s1: a #GstSegment structure.
1195  *
1196  * Checks for two segments being equal. Equality here is defined
1197  * as perfect equality, including floating point values.
1198  *
1199  * Since: 1.6
1200  *
1201  * Returns: %TRUE if the segments are equal, %FALSE otherwise.
1202  */
1203 gboolean
1204 gst_segment_is_equal (const GstSegment * s0, const GstSegment * s1)
1205 {
1206   if (s0->flags != s1->flags)
1207     return FALSE;
1208   if (s0->rate != s1->rate)
1209     return FALSE;
1210   if (s0->applied_rate != s1->applied_rate)
1211     return FALSE;
1212   if (s0->format != s1->format)
1213     return FALSE;
1214   if (s0->base != s1->base)
1215     return FALSE;
1216   if (s0->offset != s1->offset)
1217     return FALSE;
1218   if (s0->start != s1->start)
1219     return FALSE;
1220   if (s0->stop != s1->stop)
1221     return FALSE;
1222   if (s0->time != s1->time)
1223     return FALSE;
1224   if (s0->position != s1->position)
1225     return FALSE;
1226   if (s0->duration != s1->duration)
1227     return FALSE;
1228   return TRUE;
1229 }