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   abs_applied_rate = ABS (segment->applied_rate);
 430
 431   /* add or subtract from segment time based on applied rate */
 432   if (G_LIKELY (segment->applied_rate > 0.0)) {
 433     if (G_UNLIKELY (position < start))
 434       return -1;
 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   } 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_UNLIKELY (position > stop))
 447       return -1;
 448     stream_time = stop - position;
 449     if (G_UNLIKELY (abs_applied_rate != 1.0))
 450       stream_time *= abs_applied_rate;
 451     stream_time += time;
 452   }
 453
 454   return stream_time;
 455 }
 456
 457 /**
 458  * gst_segment_position_from_stream_time:
 459  * @segment: a #GstSegment structure.
 460  * @format: the format of the segment.
 461  * @stream_time: the stream_time in the segment
 462  *
 463  * Convert @stream_time into a position in the segment so that
 464  * gst_segment_to_stream_time() with that position returns @stream_time.
 465  *
 466  * Returns: the position in the segment for @stream_time. This function returns
 467  * -1 when @stream_time is -1 or when it is not inside @segment.
 468  *
 469  * Since: 1.8
 470  */
 471 guint64
 472 gst_segment_position_from_stream_time (const GstSegment * segment,
 473     GstFormat format, guint64 stream_time)
 474 {
 475   guint64 position, start, stop, time;
 476   gdouble abs_applied_rate;
 477
 478   /* format does not matter for -1 */
 479   if (G_UNLIKELY (stream_time == -1))
 480     return -1;
 481
 482   g_return_val_if_fail (segment != NULL, -1);
 483   g_return_val_if_fail (segment->format == format, -1);
 484
 485   start = segment->start;
 486   time = segment->time;
 487   /* this stream time was for a previous segment */
 488   if (G_UNLIKELY (stream_time < segment->time))
 489     return -1;
 490
 491   /* time must be known */
 492   if (G_UNLIKELY (time == -1))
 493     return -1;
 494
 495   position = stream_time - time;
 496
 497   abs_applied_rate = ABS (segment->applied_rate);
 498   stop = segment->stop;
 499
 500   /* correct for applied rate if needed */
 501   if (G_UNLIKELY (abs_applied_rate != 1.0))
 502     position /= abs_applied_rate;
 503
 504   if (G_LIKELY (segment->applied_rate > 0.0)) {
 505     position += start;
 506     /* outside of the segment boundary stop */
 507     if (G_UNLIKELY (stop != -1 && position > stop))
 508       return -1;
 509   } else {
 510     /* cannot calculate without known boundary stop */
 511     if (G_UNLIKELY (stop == -1))
 512       return -1;
 513     /* outside segment boundary */
 514     if (G_UNLIKELY (position > stop))
 515       return -1;
 516
 517     position = stop - position;
 518
 519     /* position before segment start */
 520     if (G_UNLIKELY (position < start))
 521       return -1;
 522   }
 523
 524   return position;
 525 }
 526
 527 /**
 528  * gst_segment_to_running_time_full:
 529  * @segment: a #GstSegment structure.
 530  * @format: the format of the segment.
 531  * @position: the position in the segment
 532  * @running_time: result running-time
 533  *
 534  * Translate @position to the total running time using the currently configured
 535  * segment. Compared to gst_segment_to_running_time() this function can return
 536  * negative running-time.
 537  *
 538  * This function is typically used by elements that need to synchronize buffers
 539  * against the clock or eachother.
 540  *
 541  * @position can be any value and the result of this function for values outside
 542  * of the segment is extrapolated.
 543  *
 544  * When 1 is returned, @position resulted in a positive running-time returned
 545  * in @running_time.
 546  *
 547  * When this function returns -1, the returned @running_time should be negated
 548  * to get the real negative running time.
 549  *
 550  * Returns: a 1 or -1 on success, 0 on failure.
 551  *
 552  * Since: 1.6
 553  */
 554 gint
 555 gst_segment_to_running_time_full (const GstSegment * segment, GstFormat format,
 556     guint64 position, guint64 * running_time)
 557 {
 558   gint res = 0;
 559   guint64 result;
 560   guint64 start, stop, offset;
 561   gdouble abs_rate;
 562
 563   if (G_UNLIKELY (position == -1)) {
 564     GST_DEBUG ("invalid position (-1)");
 565     goto done;
 566   }
 567
 568   g_return_val_if_fail (segment != NULL, 0);
 569   g_return_val_if_fail (segment->format == format, 0);
 570
 571   offset = segment->offset;
 572
 573   if (G_LIKELY (segment->rate > 0.0)) {
 574     start = segment->start + offset;
 575
 576     /* bring to uncorrected position in segment */
 577     if (position < start) {
 578       /* negative value */
 579       result = start - position;
 580       res = -1;
 581     } else {
 582       result = position - start;
 583       res = 1;
 584     }
 585   } else {
 586     stop = segment->stop;
 587
 588     /* cannot continue if no stop position set or invalid offset */
 589     g_return_val_if_fail (stop != -1, 0);
 590     g_return_val_if_fail (stop >= offset, 0);
 591
 592     stop -= offset;
 593
 594     /* bring to uncorrected position in segment */
 595     if (position > stop) {
 596       /* negative value */
 597       result = position - stop;
 598       res = -1;
 599     } else {
 600       result = stop - position;
 601       res = 1;
 602     }
 603   }
 604
 605   if (running_time) {
 606     /* scale based on the rate, avoid division by and conversion to
 607      * float when not needed */
 608     abs_rate = ABS (segment->rate);
 609     if (G_UNLIKELY (abs_rate != 1.0))
 610       result /= abs_rate;
 611
 612     /* correct for base of the segment */
 613     if (res == 1)
 614       /* positive, add base */
 615       *running_time = result + segment->base;
 616     else if (segment->base >= result) {
 617       /* negative and base is bigger, subtract from base and we have a
 618        * positive value again */
 619       *running_time = segment->base - result;
 620       res = 1;
 621     } else {
 622       /* negative and base is smaller, subtract base and remainder is
 623        * negative */
 624       *running_time = result - segment->base;
 625     }
 626   }
 627   return res;
 628
 629 done:
 630   {
 631     if (running_time)
 632       *running_time = -1;
 633     return 0;
 634   }
 635 }
 636
 637 /**
 638  * gst_segment_to_running_time:
 639  * @segment: a #GstSegment structure.
 640  * @format: the format of the segment.
 641  * @position: the position in the segment
 642  *
 643  * Translate @position to the total running time using the currently configured
 644  * segment. Position is a value between @segment start and stop time.
 645  *
 646  * This function is typically used by elements that need to synchronize to the
 647  * global clock in a pipeline. The running time is a constantly increasing value
 648  * starting from 0. When gst_segment_init() is called, this value will reset to
 649  * 0.
 650  *
 651  * This function returns -1 if the position is outside of @segment start and stop.
 652  *
 653  * Returns: the position as the total running time or -1 when an invalid position
 654  * was given.
 655  */
 656 guint64
 657 gst_segment_to_running_time (const GstSegment * segment, GstFormat format,
 658     guint64 position)
 659 {
 660   guint64 result;
 661
 662   g_return_val_if_fail (segment != NULL, -1);
 663   g_return_val_if_fail (segment->format == format, -1);
 664
 665   /* before the segment boundary */
 666   if (G_UNLIKELY (position < segment->start)) {
 667     GST_DEBUG ("position(%" G_GUINT64_FORMAT ") < start(%" G_GUINT64_FORMAT
 668         ")", position, segment->start);
 669     return -1;
 670   }
 671   /* after the segment boundary */
 672   if (G_UNLIKELY (segment->stop != -1 && position > segment->stop)) {
 673     GST_DEBUG ("position(%" G_GUINT64_FORMAT ") > stop(%" G_GUINT64_FORMAT
 674         ")", position, segment->stop);
 675     return -1;
 676   }
 677
 678   if (gst_segment_to_running_time_full (segment, format, position,
 679           &result) == 1)
 680     return result;
 681
 682   return -1;
 683 }
 684
 685 /**
 686  * gst_segment_clip:
 687  * @segment: a #GstSegment structure.
 688  * @format: the format of the segment.
 689  * @start: the start position in the segment
 690  * @stop: the stop position in the segment
 691  * @clip_start: (out) (allow-none): the clipped start position in the segment
 692  * @clip_stop: (out) (allow-none): the clipped stop position in the segment
 693  *
 694  * Clip the given @start and @stop values to the segment boundaries given
 695  * in @segment. @start and @stop are compared and clipped to @segment
 696  * start and stop values.
 697  *
 698  * If the function returns %FALSE, @start and @stop are known to fall
 699  * outside of @segment and @clip_start and @clip_stop are not updated.
 700  *
 701  * When the function returns %TRUE, @clip_start and @clip_stop will be
 702  * updated. If @clip_start or @clip_stop are different from @start or @stop
 703  * respectively, the region fell partially in the segment.
 704  *
 705  * Note that when @stop is -1, @clip_stop will be set to the end of the
 706  * segment. Depending on the use case, this may or may not be what you want.
 707  *
 708  * Returns: %TRUE if the given @start and @stop times fall partially or
 709  *     completely in @segment, %FALSE if the values are completely outside
 710  *     of the segment.
 711  */
 712 gboolean
 713 gst_segment_clip (const GstSegment * segment, GstFormat format, guint64 start,
 714     guint64 stop, guint64 * clip_start, guint64 * clip_stop)
 715 {
 716   g_return_val_if_fail (segment != NULL, FALSE);
 717   g_return_val_if_fail (segment->format == format, FALSE);
 718
 719   /* if we have a stop position and a valid start and start is bigger,
 720    * we're outside of the segment */
 721   if (G_UNLIKELY (segment->stop != -1 && start != -1 && start >= segment->stop))
 722     return FALSE;
 723
 724   /* if a stop position is given and is before the segment start,
 725    * we're outside of the segment. Special case is were start
 726    * and stop are equal to the segment start. In that case we
 727    * are inside the segment. */
 728   if (G_UNLIKELY (stop != -1 && (stop < segment->start || (start != stop
 729                   && stop == segment->start))))
 730     return FALSE;
 731
 732   if (clip_start) {
 733     if (start == -1)
 734       *clip_start = -1;
 735     else
 736       *clip_start = MAX (start, segment->start);
 737   }
 738
 739   if (clip_stop) {
 740     if (stop == -1)
 741       *clip_stop = segment->stop;
 742     else if (segment->stop == -1)
 743       *clip_stop = stop;
 744     else
 745       *clip_stop = MIN (stop, segment->stop);
 746   }
 747
 748   return TRUE;
 749 }
 750
 751 /**
 752  * gst_segment_position_from_running_time:
 753  * @segment: a #GstSegment structure.
 754  * @format: the format of the segment.
 755  * @running_time: the running_time in the segment
 756  *
 757  * Convert @running_time into a position in the segment so that
 758  * gst_segment_to_running_time() with that position returns @running_time.
 759  *
 760  * Returns: the position in the segment for @running_time. This function returns
 761  * -1 when @running_time is -1 or when it is not inside @segment.
 762  *
 763  * Since: 1.8
 764  */
 765 guint64
 766 gst_segment_position_from_running_time (const GstSegment * segment,
 767     GstFormat format, guint64 running_time)
 768 {
 769   guint64 result;
 770   guint64 start, stop, base;
 771   gdouble abs_rate;
 772
 773   if (G_UNLIKELY (running_time == -1))
 774     return -1;
 775
 776   g_return_val_if_fail (segment != NULL, -1);
 777   g_return_val_if_fail (segment->format == format, FALSE);
 778
 779   base = segment->base;
 780
 781   /* this running_time was for a previous segment */
 782   if (running_time < base)
 783     return -1;
 784
 785   /* start by subtracting the base time */
 786   result = running_time - base;
 787
 788   /* move into the segment at the right rate */
 789   abs_rate = ABS (segment->rate);
 790   if (G_UNLIKELY (abs_rate != 1.0))
 791     result = ceil (result * abs_rate);
 792
 793   start = segment->start;
 794   stop = segment->stop;
 795
 796   if (G_LIKELY (segment->rate > 0.0)) {
 797     /* bring to corrected position in segment */
 798     result += start + segment->offset;
 799
 800     /* outside of the segment boundary stop */
 801     if (G_UNLIKELY (stop != -1 && result > stop))
 802       return -1;
 803   } else {
 804     /* cannot continue if no stop position set or outside of
 805      * the segment. */
 806     if (G_UNLIKELY (stop == -1 || result + start > stop))
 807       return -1;
 808
 809     /* bring to corrected position in segment */
 810     result = stop - result - segment->offset;
 811   }
 812   return result;
 813 }
 814
 815 /**
 816  * gst_segment_to_position:
 817  * @segment: a #GstSegment structure.
 818  * @format: the format of the segment.
 819  * @running_time: the running_time in the segment
 820  *
 821  * Convert @running_time into a position in the segment so that
 822  * gst_segment_to_running_time() with that position returns @running_time.
 823  *
 824  * Returns: the position in the segment for @running_time. This function returns
 825  * -1 when @running_time is -1 or when it is not inside @segment.
 826  *
 827  * Deprecated. Use gst_segment_position_from_running_time() instead.
 828  */
 829 #ifndef GST_REMOVE_DEPRECATED
 830 #ifdef GST_DISABLE_DEPRECATED
 831 guint64 gst_segment_to_position (const GstSegment * segment, GstFormat format,
 832     guint64 running_time);
 833 #endif
 834 guint64
 835 gst_segment_to_position (const GstSegment * segment, GstFormat format,
 836     guint64 running_time)
 837 {
 838   return gst_segment_position_from_running_time (segment, format, running_time);
 839 }
 840 #endif
 841
 842 /**
 843  * gst_segment_set_running_time:
 844  * @segment: a #GstSegment structure.
 845  * @format: the format of the segment.
 846  * @running_time: the running_time in the segment
 847  *
 848  * Adjust the start/stop and base values of @segment such that the next valid
 849  * buffer will be one with @running_time.
 850  *
 851  * Returns: %TRUE if the segment could be updated successfully. If %FALSE is
 852  * returned, @running_time is -1 or not in @segment.
 853  */
 854 gboolean
 855 gst_segment_set_running_time (GstSegment * segment, GstFormat format,
 856     guint64 running_time)
 857 {
 858   guint64 position;
 859   guint64 start, stop;
 860
 861   /* start by bringing the running_time into the segment position */
 862   position =
 863       gst_segment_position_from_running_time (segment, format, running_time);
 864
 865   /* we must have a valid position now */
 866   if (G_UNLIKELY (position == -1))
 867     return FALSE;
 868
 869   start = segment->start;
 870   stop = segment->stop;
 871
 872   if (G_LIKELY (segment->rate > 0.0)) {
 873     /* update the start and time values */
 874     start = position;
 875   } else {
 876     /* reverse, update stop */
 877     stop = position;
 878   }
 879   /* and base time is exactly the running time */
 880   segment->time = gst_segment_to_stream_time (segment, format, start);
 881   segment->start = start;
 882   segment->stop = stop;
 883   segment->base = running_time;
 884
 885   return TRUE;
 886 }
 887
 888 /**
 889  * gst_segment_offset_running_time:
 890  * @segment: a #GstSegment structure.
 891  * @format: the format of the segment.
 892  * @offset: the offset to apply in the segment
 893  *
 894  * Adjust the values in @segment so that @offset is applied to all
 895  * future running-time calculations.
 896  *
 897  * Since: 1.2.3
 898  *
 899  * Returns: %TRUE if the segment could be updated successfully. If %FALSE is
 900  * returned, @offset is not in @segment.
 901  */
 902 gboolean
 903 gst_segment_offset_running_time (GstSegment * segment, GstFormat format,
 904     gint64 offset)
 905 {
 906   g_return_val_if_fail (segment != NULL, FALSE);
 907   g_return_val_if_fail (segment->format == format, FALSE);
 908
 909   if (offset == 0)
 910     return TRUE;
 911
 912   if (offset > 0) {
 913     /* positive offset, we can simply apply to the base time */
 914     segment->base += offset;
 915   } else {
 916     offset = -offset;
 917     /* negative offset, first try to subtract from base */
 918     if (segment->base > offset) {
 919       segment->base -= offset;
 920     } else {
 921       guint64 position;
 922
 923       /* subtract all from segment.base, remainder in offset */
 924       offset -= segment->base;
 925       segment->base = 0;
 926       position =
 927           gst_segment_position_from_running_time (segment, format, offset);
 928       if (position == -1)
 929         return FALSE;
 930
 931       segment->offset = position - segment->start;
 932     }
 933   }
 934   return TRUE;
 935 }
 936
 937 /**
 938  * gst_segment_is_equal:
 939  * @s0: a #GstSegment structure.
 940  * @s1: a #GstSegment structure.
 941  *
 942  * Checks for two segments being equal. Equality here is defined
 943  * as perfect equality, including floating point values.
 944  *
 945  * Since: 1.6
 946  *
 947  * Returns: %TRUE if the segments are equal, %FALSE otherwise.
 948  */
 949 gboolean
 950 gst_segment_is_equal (const GstSegment * s0, const GstSegment * s1)
 951 {
 952   if (s0->flags != s1->flags)
 953     return FALSE;
 954   if (s0->rate != s1->rate)
 955     return FALSE;
 956   if (s0->applied_rate != s1->applied_rate)
 957     return FALSE;
 958   if (s0->format != s1->format)
 959     return FALSE;
 960   if (s0->base != s1->base)
 961     return FALSE;
 962   if (s0->offset != s1->offset)
 963     return FALSE;
 964   if (s0->start != s1->start)
 965     return FALSE;
 966   if (s0->stop != s1->stop)
 967     return FALSE;
 968   if (s0->time != s1->time)
 969     return FALSE;
 970   if (s0->position != s1->position)
 971     return FALSE;
 972   if (s0->duration != s1->duration)
 973     return FALSE;
 974   return TRUE;
 975 }