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 #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  * If the segment is used for managing seeks, the segment duration should be set with
  56  * gst_segment_set_duration(). The public duration field contains the duration of the
  57  * segment. When using the segment for seeking, the start and time members should
  58  * normally be left to their default 0 value. The stop position is left to -1 unless
  59  * explicitly configured to a different value after a seek event.
  60  *
  61  * The current position in the segment should be set with the gst_segment_set_last_stop().
  62  * The public last_stop field contains the last set stop position in the segment.
  63  *
  64  * For elements that perform seeks, the current segment should be updated with the
  65  * gst_segment_set_seek() and the values from the seek event. This method will update
  66  * all the segment fields. The last_stop field will contain the new playback position.
  67  * If the cur_type was different from GST_SEEK_TYPE_NONE, playback continues from
  68  * the last_stop position, possibly with updated flags or rate.
  69  *
  70  * For elements that want to use #GstSegment to track the playback region, use
  71  * gst_segment_set_newsegment() to update the segment fields with the information from
  72  * the newsegment event. The gst_segment_clip() method can be used to check and clip
  73  * the media data to the segment boundaries.
  74  *
  75  * For elements that want to synchronize to the pipeline clock, gst_segment_to_running_time()
  76  * can be used to convert a timestamp to a value that can be used to synchronize
  77  * to the clock. This function takes into account all accumulated segments as well as
  78  * any rate or applied_rate conversions.
  79  *
  80  * For elements that need to perform operations on media data in stream_time,
  81  * gst_segment_to_stream_time() can be used to convert a timestamp and the segment
  82  * info to stream time (which is always between 0 and the duration of the stream).
  83  *
  84  * Last reviewed on 2007-05-17 (0.10.13)
  85  */
  86
  87 /**
  88  * gst_segment_copy:
  89  * @segment: (transfer none): a #GstSegment
  90  *
  91  * Create a copy of given @segment.
  92  *
  93  * Free-function: gst_segment_free
  94  *
  95  * Returns: (transfer full): a new #GstSegment, free with gst_segment_free().
  96  *
  97  * Since: 0.10.20
  98  */
  99 GstSegment *
 100 gst_segment_copy (GstSegment * segment)
 101 {
 102   GstSegment *result = NULL;
 103
 104   if (segment) {
 105     result = (GstSegment *) g_slice_copy (sizeof (GstSegment), segment);
 106   }
 107   return result;
 108 }
 109
 110 GType
 111 gst_segment_get_type (void)
 112 {
 113   static GType gst_segment_type = 0;
 114
 115   if (G_UNLIKELY (gst_segment_type == 0)) {
 116     gst_segment_type = g_boxed_type_register_static ("GstSegment",
 117         (GBoxedCopyFunc) gst_segment_copy, (GBoxedFreeFunc) gst_segment_free);
 118   }
 119
 120   return gst_segment_type;
 121 }
 122
 123 /**
 124  * gst_segment_new:
 125  *
 126  * Allocate a new #GstSegment structure and initialize it using
 127  * gst_segment_init().
 128  *
 129  * Free-function: gst_segment_free
 130  *
 131  * Returns: (transfer full): a new #GstSegment, free with gst_segment_free().
 132  */
 133 GstSegment *
 134 gst_segment_new (void)
 135 {
 136   GstSegment *result;
 137
 138   result = g_slice_new0 (GstSegment);
 139   gst_segment_init (result, GST_FORMAT_UNDEFINED);
 140
 141   return result;
 142 }
 143
 144 /**
 145  * gst_segment_free:
 146  * @segment: (in) (transfer full): a #GstSegment
 147  *
 148  * Free the allocated segment @segment.
 149  */
 150 void
 151 gst_segment_free (GstSegment * segment)
 152 {
 153   g_slice_free (GstSegment, segment);
 154 }
 155
 156 /**
 157  * gst_segment_init:
 158  * @segment: a #GstSegment structure.
 159  * @format: the format of the segment.
 160  *
 161  * The start/last_stop positions are set to 0 and the stop/duration
 162  * fields are set to -1 (unknown). The default rate of 1.0 and no
 163  * flags are set.
 164  *
 165  * Initialize @segment to its default values.
 166  */
 167 void
 168 gst_segment_init (GstSegment * segment, GstFormat format)
 169 {
 170   g_return_if_fail (segment != NULL);
 171
 172   segment->rate = 1.0;
 173   segment->applied_rate = 1.0;
 174   segment->format = format;
 175   segment->flags = 0;
 176   segment->start = 0;
 177   segment->stop = -1;
 178   segment->time = 0;
 179   segment->accum = 0;
 180   segment->last_stop = 0;
 181   segment->duration = -1;
 182 }
 183
 184 /**
 185  * gst_segment_set_duration:
 186  * @segment: a #GstSegment structure.
 187  * @format: the format of the segment.
 188  * @duration: the duration of the segment info or -1 if unknown.
 189  *
 190  * Set the duration of the segment to @duration. This function is mainly
 191  * used by elements that perform seeking and know the total duration of the
 192  * segment.
 193  *
 194  * This field should be set to allow seeking requests relative to the
 195  * duration.
 196  */
 197 void
 198 gst_segment_set_duration (GstSegment * segment, GstFormat format,
 199     gint64 duration)
 200 {
 201   g_return_if_fail (segment != NULL);
 202
 203   if (G_UNLIKELY (segment->format == GST_FORMAT_UNDEFINED))
 204     segment->format = format;
 205   else
 206     g_return_if_fail (segment->format == format);
 207
 208   segment->duration = duration;
 209 }
 210
 211 /**
 212  * gst_segment_set_last_stop:
 213  * @segment: a #GstSegment structure.
 214  * @format: the format of the segment.
 215  * @position: the position
 216  *
 217  * Set the last observed stop position in the segment to @position.
 218  *
 219  * This field should be set to allow seeking requests relative to the
 220  * current playing position.
 221  */
 222 void
 223 gst_segment_set_last_stop (GstSegment * segment, GstFormat format,
 224     gint64 position)
 225 {
 226   g_return_if_fail (segment != NULL);
 227
 228   if (G_UNLIKELY (segment->format == GST_FORMAT_UNDEFINED))
 229     segment->format = format;
 230   else
 231     g_return_if_fail (segment->format == format);
 232
 233   segment->last_stop = MAX (segment->start, position);
 234 }
 235
 236 /**
 237  * gst_segment_set_seek:
 238  * @segment: a #GstSegment structure.
 239  * @rate: the rate of the segment.
 240  * @format: the format of the segment.
 241  * @flags: the seek flags for the segment
 242  * @start_type: the seek method
 243  * @start: the seek start value
 244  * @stop_type: the seek method
 245  * @stop: the seek stop value
 246  * @update: boolean holding whether last_stop was updated.
 247  *
 248  * Update the segment structure with the field values of a seek event (see
 249  * gst_event_new_seek()).
 250  *
 251  * After calling this method, the segment field last_stop and time will
 252  * contain the requested new position in the segment. The new requested
 253  * position in the segment depends on @rate and @start_type and @stop_type.
 254  *
 255  * For positive @rate, the new position in the segment is the new @segment
 256  * start field when it was updated with a @start_type different from
 257  * #GST_SEEK_TYPE_NONE. If no update was performed on @segment start position
 258  * (#GST_SEEK_TYPE_NONE), @start is ignored and @segment last_stop is
 259  * unmodified.
 260  *
 261  * For negative @rate, the new position in the segment is the new @segment
 262  * stop field when it was updated with a @stop_type different from
 263  * #GST_SEEK_TYPE_NONE. If no stop was previously configured in the segment, the
 264  * duration of the segment will be used to update the stop position.
 265  * If no update was performed on @segment stop position (#GST_SEEK_TYPE_NONE),
 266  * @stop is ignored and @segment last_stop is unmodified.
 267  *
 268  * The applied rate of the segment will be set to 1.0 by default.
 269  * If the caller can apply a rate change, it should update @segment
 270  * rate and applied_rate after calling this function.
 271  *
 272  * @update will be set to TRUE if a seek should be performed to the segment
 273  * last_stop field. This field can be FALSE if, for example, only the @rate
 274  * has been changed but not the playback position.
 275  */
 276 void
 277 gst_segment_set_seek (GstSegment * segment, gdouble rate,
 278     GstFormat format, GstSeekFlags flags,
 279     GstSeekType start_type, gint64 start,
 280     GstSeekType stop_type, gint64 stop, gboolean * update)
 281 {
 282   gboolean update_stop, update_start;
 283   gint64 last_stop;
 284
 285   g_return_if_fail (rate != 0.0);
 286   g_return_if_fail (segment != NULL);
 287
 288   if (G_UNLIKELY (segment->format == GST_FORMAT_UNDEFINED))
 289     segment->format = format;
 290
 291   update_start = update_stop = TRUE;
 292
 293   /* segment->start is never invalid */
 294   switch (start_type) {
 295     case GST_SEEK_TYPE_NONE:
 296       /* no update to segment, take previous start */
 297       start = segment->start;
 298       update_start = FALSE;
 299       break;
 300     case GST_SEEK_TYPE_SET:
 301       /* start holds desired position, map -1 to the start */
 302       if (start == -1)
 303         start = 0;
 304       /* start must be 0 or the formats must match */
 305       g_return_if_fail (start == 0 || segment->format == format);
 306       break;
 307     case GST_SEEK_TYPE_CUR:
 308       g_return_if_fail (start == 0 || segment->format == format);
 309       /* add start to currently configured segment */
 310       start = segment->start + start;
 311       break;
 312     case GST_SEEK_TYPE_END:
 313       if (segment->duration != -1) {
 314         g_return_if_fail (start == 0 || segment->format == format);
 315         /* add start to total length */
 316         start = segment->duration + start;
 317       } else {
 318         /* no update if duration unknown */
 319         start = segment->start;
 320         update_start = FALSE;
 321       }
 322       break;
 323   }
 324   /* bring in sane range */
 325   if (segment->duration != -1)
 326     start = CLAMP (start, 0, segment->duration);
 327   else
 328     start = MAX (start, 0);
 329
 330   /* stop can be -1 if we have not configured a stop. */
 331   switch (stop_type) {
 332     case GST_SEEK_TYPE_NONE:
 333       stop = segment->stop;
 334       update_stop = FALSE;
 335       break;
 336     case GST_SEEK_TYPE_SET:
 337       /* stop holds required value, if it's not -1, it must be of the same
 338        * format as the segment. */
 339       g_return_if_fail (stop == -1 || segment->format == format);
 340       break;
 341     case GST_SEEK_TYPE_CUR:
 342       if (segment->stop != -1) {
 343         /* only add compatible formats or 0 */
 344         g_return_if_fail (stop == 0 || segment->format == format);
 345         stop = segment->stop + stop;
 346       } else
 347         stop = -1;
 348       break;
 349     case GST_SEEK_TYPE_END:
 350       if (segment->duration != -1) {
 351         /* only add compatible formats or 0 */
 352         g_return_if_fail (stop == 0 || segment->format == format);
 353         stop = segment->duration + stop;
 354       } else {
 355         stop = segment->stop;
 356         update_stop = FALSE;
 357       }
 358       break;
 359   }
 360
 361   /* if we have a valid stop time, make sure it is clipped */
 362   if (stop != -1) {
 363     if (segment->duration != -1)
 364       stop = CLAMP (stop, 0, segment->duration);
 365     else
 366       stop = MAX (stop, 0);
 367   }
 368
 369   /* we can't have stop before start */
 370   if (stop != -1)
 371     g_return_if_fail (start <= stop);
 372
 373   segment->rate = rate;
 374   segment->applied_rate = 1.0;
 375   segment->flags = flags;
 376   segment->start = start;
 377   segment->stop = stop;
 378   segment->time = start;
 379
 380   last_stop = segment->last_stop;
 381   if (update_start && rate > 0.0) {
 382     last_stop = start;
 383   }
 384   if (update_stop && rate < 0.0) {
 385     if (stop != -1)
 386       last_stop = stop;
 387     else {
 388       if (segment->duration != -1)
 389         last_stop = segment->duration;
 390       else
 391         last_stop = 0;
 392     }
 393   }
 394   /* set update arg to reflect update of last_stop */
 395   if (update)
 396     *update = last_stop != segment->last_stop;
 397
 398   /* update new position */
 399   segment->last_stop = last_stop;
 400 }
 401
 402 /**
 403  * gst_segment_set_newsegment:
 404  * @segment: a #GstSegment structure.
 405  * @update: flag indicating a new segment is started or updated
 406  * @rate: the rate of the segment.
 407  * @format: the format of the segment.
 408  * @start: the new start value
 409  * @stop: the new stop value
 410  * @time: the new stream time
 411  *
 412  * Update the segment structure with the field values of a new segment event and
 413  * with a default applied_rate of 1.0.
 414  *
 415  * Since: 0.10.6
 416  */
 417 void
 418 gst_segment_set_newsegment (GstSegment * segment, gboolean update, gdouble rate,
 419     GstFormat format, gint64 start, gint64 stop, gint64 time)
 420 {
 421   gst_segment_set_newsegment_full (segment, update, rate, 1.0, format, start,
 422       stop, time);
 423 }
 424
 425 /**
 426  * gst_segment_set_newsegment_full:
 427  * @segment: a #GstSegment structure.
 428  * @update: flag indicating a new segment is started or updated
 429  * @rate: the rate of the segment.
 430  * @applied_rate: the applied rate of the segment.
 431  * @format: the format of the segment.
 432  * @start: the new start value
 433  * @stop: the new stop value
 434  * @time: the new stream time
 435  *
 436  * Update the segment structure with the field values of a new segment event.
 437  */
 438 void
 439 gst_segment_set_newsegment_full (GstSegment * segment, gboolean update,
 440     gdouble rate, gdouble applied_rate, GstFormat format, gint64 start,
 441     gint64 stop, gint64 time)
 442 {
 443   gint64 duration, last_stop;
 444   gdouble abs_rate;
 445
 446   g_return_if_fail (rate != 0.0);
 447   g_return_if_fail (applied_rate != 0.0);
 448   g_return_if_fail (segment != NULL);
 449
 450   GST_DEBUG ("configuring segment update %d, rate %lf, format %s, "
 451       "start %" G_GINT64_FORMAT ", stop %" G_GINT64_FORMAT ", position %"
 452       G_GINT64_FORMAT, update, rate, gst_format_get_name (format), start,
 453       stop, time);
 454   GST_DEBUG ("old segment was: %" GST_SEGMENT_FORMAT, segment);
 455
 456   if (G_UNLIKELY (segment->format == GST_FORMAT_UNDEFINED))
 457     segment->format = format;
 458
 459   /* any other format with 0 also gives time 0, the other values are
 460    * invalid in the format though. */
 461   if (format != segment->format && start == 0) {
 462     format = segment->format;
 463     if (stop != 0)
 464       stop = -1;
 465     if (time != 0)
 466       time = -1;
 467   }
 468
 469   g_return_if_fail (segment->format == format);
 470
 471   if (update) {
 472     if (G_LIKELY (segment->rate > 0.0)) {
 473       /* an update to the current segment is done, elapsed time is
 474        * difference between the old start and new start. */
 475       if (start > segment->start)
 476         duration = start - segment->start;
 477       else
 478         duration = 0;
 479     } else {
 480       /* for negative rates, the elapsed duration is the diff between the stop
 481        * positions */
 482       if (stop != -1 && stop < segment->stop)
 483         duration = segment->stop - stop;
 484       else
 485         duration = 0;
 486     }
 487     /* update last_stop to be a valid value in the updated segment */
 488     if (start > segment->last_stop)
 489       last_stop = start;
 490     else if (stop != -1 && stop < segment->last_stop)
 491       last_stop = stop;
 492     else
 493       last_stop = segment->last_stop;
 494   } else {
 495     /* the new segment has to be aligned with the old segment.
 496      * We first update the accumulated time of the previous
 497      * segment. the accumulated time is used when syncing to the
 498      * clock. */
 499     if (segment->stop != -1) {
 500       duration = segment->stop - segment->start;
 501     } else if (segment->last_stop != -1) {
 502       /* else use last seen timestamp as segment stop */
 503       duration = segment->last_stop - segment->start;
 504     } else {
 505       /* else we don't know and throw a warning.. really, this should
 506        * be fixed in the element. */
 507       g_warning ("closing segment of unknown duration, assuming duration of 0");
 508       duration = 0;
 509     }
 510     /* position the last_stop to the next expected position in the new segment,
 511      * which is the start or the stop of the segment */
 512     if (rate > 0.0)
 513       last_stop = start;
 514     else
 515       last_stop = stop;
 516   }
 517   /* use previous rate to calculate duration */
 518   abs_rate = ABS (segment->rate);
 519   if (G_LIKELY (abs_rate != 1.0))
 520     duration /= abs_rate;
 521
 522   /* accumulate duration */
 523   segment->accum += duration;
 524
 525   /* then update the current segment */
 526   segment->rate = rate;
 527   segment->applied_rate = applied_rate;
 528   segment->start = start;
 529   segment->last_stop = last_stop;
 530   segment->stop = stop;
 531   segment->time = time;
 532 }
 533
 534 /**
 535  * gst_segment_to_stream_time:
 536  * @segment: a #GstSegment structure.
 537  * @format: the format of the segment.
 538  * @position: the position in the segment
 539  *
 540  * Translate @position to stream time using the currently configured
 541  * segment. The @position value must be between @segment start and
 542  * stop value.
 543  *
 544  * This function is typically used by elements that need to operate on
 545  * the stream time of the buffers it receives, such as effect plugins.
 546  * In those use cases, @position is typically the buffer timestamp or
 547  * clock time that one wants to convert to the stream time.
 548  * The stream time is always between 0 and the total duration of the
 549  * media stream.
 550  *
 551  * Returns: the position in stream_time or -1 when an invalid position
 552  * was given.
 553  */
 554 gint64
 555 gst_segment_to_stream_time (GstSegment * segment, GstFormat format,
 556     gint64 position)
 557 {
 558   gint64 result, start, stop, time;
 559   gdouble abs_applied_rate;
 560
 561   /* format does not matter for -1 */
 562   if (G_UNLIKELY (position == -1))
 563     return -1;
 564
 565   g_return_val_if_fail (segment != NULL, -1);
 566
 567   if (G_UNLIKELY (segment->format == GST_FORMAT_UNDEFINED))
 568     segment->format = format;
 569
 570   /* if we have the position for the same format as the segment, we can compare
 571    * the start and stop values, otherwise we assume 0 and -1 */
 572   if (G_LIKELY (segment->format == format)) {
 573     start = segment->start;
 574     stop = segment->stop;
 575     time = segment->time;
 576   } else {
 577     start = 0;
 578     stop = -1;
 579     time = 0;
 580   }
 581
 582   /* outside of the segment boundary stop */
 583   if (G_UNLIKELY (stop != -1 && position > stop))
 584     return -1;
 585
 586   /* before the segment boundary */
 587   if (G_UNLIKELY (position < start))
 588     return -1;
 589
 590   /* time must be known */
 591   if (G_UNLIKELY (time == -1))
 592     return -1;
 593
 594   /* bring to uncorrected position in segment */
 595   result = position - start;
 596
 597   abs_applied_rate = ABS (segment->applied_rate);
 598
 599   /* correct for applied rate if needed */
 600   if (G_UNLIKELY (abs_applied_rate != 1.0))
 601     result *= abs_applied_rate;
 602
 603   /* add or subtract from segment time based on applied rate */
 604   if (G_LIKELY (segment->applied_rate > 0.0)) {
 605     /* correct for segment time */
 606     result += time;
 607   } else {
 608     /* correct for segment time, clamp at 0. Streams with a negative
 609      * applied_rate have timestamps between start and stop, as usual, but have
 610      * the time member starting high and going backwards.  */
 611     if (G_LIKELY (time > result))
 612       result = time - result;
 613     else
 614       result = 0;
 615   }
 616
 617   return result;
 618 }
 619
 620 /**
 621  * gst_segment_to_running_time:
 622  * @segment: a #GstSegment structure.
 623  * @format: the format of the segment.
 624  * @position: the position in the segment
 625  *
 626  * Translate @position to the total running time using the currently configured
 627  * and previously accumulated segments. Position is a value between @segment
 628  * start and stop time.
 629  *
 630  * This function is typically used by elements that need to synchronize to the
 631  * global clock in a pipeline. The runnning time is a constantly increasing value
 632  * starting from 0. When gst_segment_init() is called, this value will reset to
 633  * 0.
 634  *
 635  * This function returns -1 if the position is outside of @segment start and stop.
 636  *
 637  * Returns: the position as the total running time or -1 when an invalid position
 638  * was given.
 639  */
 640 gint64
 641 gst_segment_to_running_time (GstSegment * segment, GstFormat format,
 642     gint64 position)
 643 {
 644   gint64 result;
 645   gint64 start, stop, accum;
 646   gdouble abs_rate;
 647
 648   if (G_UNLIKELY (position == -1))
 649     return -1;
 650
 651   g_return_val_if_fail (segment != NULL, -1);
 652
 653   if (G_UNLIKELY (segment->format == GST_FORMAT_UNDEFINED))
 654     segment->format = format;
 655
 656   /* if we have the position for the same format as the segment, we can compare
 657    * the start and stop values, otherwise we assume 0 and -1 */
 658   if (G_LIKELY (segment->format == format)) {
 659     start = segment->start;
 660     stop = segment->stop;
 661     accum = segment->accum;
 662   } else {
 663     start = 0;
 664     stop = -1;
 665     accum = 0;
 666   }
 667
 668   /* before the segment boundary */
 669   if (G_UNLIKELY (position < start))
 670     return -1;
 671
 672   if (G_LIKELY (segment->rate > 0.0)) {
 673     /* outside of the segment boundary stop */
 674     if (G_UNLIKELY (stop != -1 && position > stop))
 675       return -1;
 676
 677     /* bring to uncorrected position in segment */
 678     result = position - start;
 679   } else {
 680     /* cannot continue if no stop position set or outside of
 681      * the segment. */
 682     if (G_UNLIKELY (stop == -1 || position > stop))
 683       return -1;
 684
 685     /* bring to uncorrected position in segment */
 686     result = stop - position;
 687   }
 688
 689   /* scale based on the rate, avoid division by and conversion to
 690    * float when not needed */
 691   abs_rate = ABS (segment->rate);
 692   if (G_UNLIKELY (abs_rate != 1.0))
 693     result /= abs_rate;
 694
 695   /* correct for accumulated segments */
 696   result += accum;
 697
 698   return result;
 699 }
 700
 701 /**
 702  * gst_segment_clip:
 703  * @segment: a #GstSegment structure.
 704  * @format: the format of the segment.
 705  * @start: the start position in the segment
 706  * @stop: the stop position in the segment
 707  * @clip_start: (out) (allow-none): the clipped start position in the segment
 708  * @clip_stop: (out) (allow-none): the clipped stop position in the segment
 709  *
 710  * Clip the given @start and @stop values to the segment boundaries given
 711  * in @segment. @start and @stop are compared and clipped to @segment
 712  * start and stop values.
 713  *
 714  * If the function returns FALSE, @start and @stop are known to fall
 715  * outside of @segment and @clip_start and @clip_stop are not updated.
 716  *
 717  * When the function returns TRUE, @clip_start and @clip_stop will be
 718  * updated. If @clip_start or @clip_stop are different from @start or @stop
 719  * respectively, the region fell partially in the segment.
 720  *
 721  * Note that when @stop is -1, @clip_stop will be set to the end of the
 722  * segment. Depending on the use case, this may or may not be what you want.
 723  *
 724  * Returns: TRUE if the given @start and @stop times fall partially or
 725  *     completely in @segment, FALSE if the values are completely outside
 726  *     of the segment.
 727  */
 728 gboolean
 729 gst_segment_clip (GstSegment * segment, GstFormat format, gint64 start,
 730     gint64 stop, gint64 * clip_start, gint64 * clip_stop)
 731 {
 732   g_return_val_if_fail (segment != NULL, FALSE);
 733
 734   if (G_UNLIKELY (segment->format == GST_FORMAT_UNDEFINED))
 735     segment->format = format;
 736   else
 737     g_return_val_if_fail (segment->format == format, FALSE);
 738
 739   /* if we have a stop position and a valid start and start is bigger,
 740    * we're outside of the segment */
 741   if (G_UNLIKELY (segment->stop != -1 && start != -1 && start >= segment->stop))
 742     return FALSE;
 743
 744   /* if a stop position is given and is before the segment start,
 745    * we're outside of the segment. Special case is were start
 746    * and stop are equal to the segment start. In that case we
 747    * are inside the segment. */
 748   if (G_UNLIKELY (stop != -1 && (stop < segment->start || (start != stop
 749                   && stop == segment->start))))
 750     return FALSE;
 751
 752   if (clip_start) {
 753     if (start == -1)
 754       *clip_start = -1;
 755     else
 756       *clip_start = MAX (start, segment->start);
 757   }
 758
 759   if (clip_stop) {
 760     if (stop == -1)
 761       *clip_stop = segment->stop;
 762     else if (segment->stop == -1)
 763       *clip_stop = MAX (-1, stop);
 764     else
 765       *clip_stop = MIN (stop, segment->stop);
 766
 767     if (segment->duration != -1)
 768       *clip_stop = MIN (*clip_stop, segment->duration);
 769   }
 770
 771   return TRUE;
 772 }
 773
 774 /**
 775  * gst_segment_to_position:
 776  * @segment: a #GstSegment structure.
 777  * @format: the format of the segment.
 778  * @running_time: the running_time in the segment
 779  *
 780  * Convert @running_time into a position in the segment so that
 781  * gst_segment_to_running_time() with that position returns @running_time.
 782  *
 783  * Returns: the position in the segment for @running_time. This function returns
 784  * -1 when @running_time is -1 or when it is not inside @segment.
 785  *
 786  * Since: 0.10.24
 787  */
 788 gint64
 789 gst_segment_to_position (GstSegment * segment, GstFormat format,
 790     gint64 running_time)
 791 {
 792   gint64 result;
 793   gint64 start, stop, accum;
 794   gdouble abs_rate;
 795
 796   g_return_val_if_fail (segment != NULL, -1);
 797
 798   if (G_UNLIKELY (running_time == -1))
 799     return -1;
 800
 801   if (G_UNLIKELY (segment->format == GST_FORMAT_UNDEFINED))
 802     segment->format = format;
 803
 804   /* if we have the position for the same format as the segment, we can compare
 805    * the start and stop values, otherwise we assume 0 and -1 */
 806   if (G_LIKELY (segment->format == format)) {
 807     start = segment->start;
 808     stop = segment->stop;
 809     accum = segment->accum;
 810   } else {
 811     start = 0;
 812     stop = -1;
 813     accum = 0;
 814   }
 815
 816   /* this running_time was for a previous segment */
 817   if (running_time < accum)
 818     return -1;
 819
 820   /* start by subtracting the accumulated time */
 821   result = running_time - accum;
 822
 823   /* move into the segment at the right rate */
 824   abs_rate = ABS (segment->rate);
 825   if (G_UNLIKELY (abs_rate != 1.0))
 826     result = ceil (result * abs_rate);
 827
 828   if (G_LIKELY (segment->rate > 0.0)) {
 829     /* bring to corrected position in segment */
 830     result += start;
 831
 832     /* outside of the segment boundary stop */
 833     if (G_UNLIKELY (stop != -1 && result > stop))
 834       return -1;
 835   } else {
 836     /* cannot continue if no stop position set or outside of
 837      * the segment. */
 838     if (G_UNLIKELY (stop == -1 || result + start > stop))
 839       return -1;
 840
 841     /* bring to corrected position in segment */
 842     result = stop - result;
 843   }
 844   return result;
 845 }
 846
 847
 848 /**
 849  * gst_segment_set_running_time:
 850  * @segment: a #GstSegment structure.
 851  * @format: the format of the segment.
 852  * @running_time: the running_time in the segment
 853  *
 854  * Adjust the start/stop and accum values of @segment such that the next valid
 855  * buffer will be one with @running_time.
 856  *
 857  * Returns: %TRUE if the segment could be updated successfully. If %FALSE is
 858  * returned, @running_time is -1 or not in @segment.
 859  *
 860  * Since: 0.10.24
 861  */
 862 gboolean
 863 gst_segment_set_running_time (GstSegment * segment, GstFormat format,
 864     gint64 running_time)
 865 {
 866   gint64 position;
 867   gint64 start, stop, last_stop;
 868
 869   /* start by bringing the running_time into the segment position */
 870   position = gst_segment_to_position (segment, format, running_time);
 871
 872   /* we must have a valid position now */
 873   if (G_UNLIKELY (position == -1))
 874     return FALSE;
 875
 876   start = segment->start;
 877   stop = segment->stop;
 878   last_stop = segment->last_stop;
 879
 880   if (G_LIKELY (segment->rate > 0.0)) {
 881     /* update the start/last_stop and time values */
 882     start = position;
 883     if (last_stop < start)
 884       last_stop = start;
 885   } else {
 886     /* reverse, update stop */
 887     stop = position;
 888     /* if we were past the position, go back */
 889     if (last_stop > stop)
 890       last_stop = stop;
 891   }
 892   /* and accumulated time is exactly the running time */
 893   segment->time = gst_segment_to_stream_time (segment, format, start);
 894   segment->start = start;
 895   segment->stop = stop;
 896   segment->last_stop = last_stop;
 897   segment->accum = running_time;
 898
 899   return TRUE;
 900 }