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  * 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 cur_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  * Last reviewed on 2012-03-29 (0.11.3)
  84  */
  85
  86 /**
  87  * gst_segment_copy:
  88  * @segment: (transfer none): a #GstSegment
  89  *
  90  * Create a copy of given @segment.
  91  *
  92  * Free-function: gst_segment_free
  93  *
  94  * Returns: (transfer full): a new #GstSegment, free with gst_segment_free().
  95  */
  96 GstSegment *
  97 gst_segment_copy (const GstSegment * segment)
  98 {
  99   GstSegment *result = NULL;
 100
 101   if (segment) {
 102     result = (GstSegment *) g_slice_copy (sizeof (GstSegment), segment);
 103   }
 104   return result;
 105 }
 106
 107 /**
 108  * gst_segment_copy_into:
 109  * @src: (transfer none): a #GstSegment
 110  * @dest: (transfer none): a #GstSegment
 111  *
 112  * Copy the contents of @src into @dest.
 113  */
 114 void
 115 gst_segment_copy_into (const GstSegment * src, GstSegment * dest)
 116 {
 117   memcpy (dest, src, sizeof (GstSegment));
 118 }
 119
 120 G_DEFINE_BOXED_TYPE (GstSegment, gst_segment,
 121     (GBoxedCopyFunc) gst_segment_copy, (GBoxedFreeFunc) gst_segment_free);
 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->flags = GST_SEGMENT_FLAG_NONE;
 173   segment->rate = 1.0;
 174   segment->applied_rate = 1.0;
 175   segment->format = format;
 176   segment->base = 0;
 177   segment->start = 0;
 178   segment->stop = -1;
 179   segment->time = 0;
 180   segment->position = 0;
 181   segment->duration = -1;
 182 }
 183
 184 /**
 185  * gst_segment_do_seek:
 186  * @segment: a #GstSegment structure.
 187  * @rate: the rate of the segment.
 188  * @format: the format of the segment.
 189  * @flags: the segment flags for the segment
 190  * @start_type: the seek method
 191  * @start: the seek start value
 192  * @stop_type: the seek method
 193  * @stop: the seek stop value
 194  * @update: boolean holding whether position was updated.
 195  *
 196  * Update the segment structure with the field values of a seek event (see
 197  * gst_event_new_seek()).
 198  *
 199  * After calling this method, the segment field position and time will
 200  * contain the requested new position in the segment. The new requested
 201  * position in the segment depends on @rate and @start_type and @stop_type.
 202  *
 203  * For positive @rate, the new position in the segment is the new @segment
 204  * start field when it was updated with a @start_type different from
 205  * #GST_SEEK_TYPE_NONE. If no update was performed on @segment start position
 206  * (#GST_SEEK_TYPE_NONE), @start is ignored and @segment position is
 207  * unmodified.
 208  *
 209  * For negative @rate, the new position in the segment is the new @segment
 210  * stop field when it was updated with a @stop_type different from
 211  * #GST_SEEK_TYPE_NONE. If no stop was previously configured in the segment, the
 212  * duration of the segment will be used to update the stop position.
 213  * If no update was performed on @segment stop position (#GST_SEEK_TYPE_NONE),
 214  * @stop is ignored and @segment position is unmodified.
 215  *
 216  * The applied rate of the segment will be set to 1.0 by default.
 217  * If the caller can apply a rate change, it should update @segment
 218  * rate and applied_rate after calling this function.
 219  *
 220  * @update will be set to TRUE if a seek should be performed to the segment
 221  * position field. This field can be FALSE if, for example, only the @rate
 222  * has been changed but not the playback position.
 223  *
 224  * Returns: %TRUE if the seek could be performed.
 225  */
 226 gboolean
 227 gst_segment_do_seek (GstSegment * segment, gdouble rate,
 228     GstFormat format, GstSeekFlags flags,
 229     GstSeekType start_type, guint64 start,
 230     GstSeekType stop_type, guint64 stop, gboolean * update)
 231 {
 232   gboolean update_stop, update_start;
 233   guint64 position, base;
 234
 235   g_return_val_if_fail (rate != 0.0, FALSE);
 236   g_return_val_if_fail (segment != NULL, FALSE);
 237   g_return_val_if_fail (segment->format == format, FALSE);
 238
 239   update_start = update_stop = TRUE;
 240
 241   position = segment->position;
 242
 243   if (flags & GST_SEEK_FLAG_FLUSH) {
 244     /* flush resets the running_time */
 245     base = 0;
 246   } else {
 247     base = gst_segment_to_running_time (segment, format, position);
 248   }
 249
 250   /* segment->start is never invalid */
 251   switch (start_type) {
 252     case GST_SEEK_TYPE_NONE:
 253       /* no update to segment, take previous start */
 254       start = segment->start;
 255       update_start = FALSE;
 256       break;
 257     case GST_SEEK_TYPE_SET:
 258       /* start holds desired position, map -1 to the start */
 259       if (start == -1)
 260         start = 0;
 261       break;
 262     case GST_SEEK_TYPE_END:
 263       if (segment->duration != -1) {
 264         /* add start to total length */
 265         start = segment->duration + start;
 266       } else {
 267         /* no update if duration unknown */
 268         start = segment->start;
 269         update_start = FALSE;
 270       }
 271       break;
 272   }
 273   /* bring in sane range */
 274   if (segment->duration != -1)
 275     start = MIN (start, segment->duration);
 276   else
 277     start = MAX (start, 0);
 278
 279   /* stop can be -1 if we have not configured a stop. */
 280   switch (stop_type) {
 281     case GST_SEEK_TYPE_NONE:
 282       stop = segment->stop;
 283       update_stop = FALSE;
 284       break;
 285     case GST_SEEK_TYPE_SET:
 286       /* stop holds required value */
 287       break;
 288     case GST_SEEK_TYPE_END:
 289       if (segment->duration != -1) {
 290         stop = segment->duration + stop;
 291       } else {
 292         stop = segment->stop;
 293         update_stop = FALSE;
 294       }
 295       break;
 296   }
 297
 298   /* if we have a valid stop time, make sure it is clipped */
 299   if (stop != -1) {
 300     if (segment->duration != -1)
 301       stop = CLAMP (stop, 0, segment->duration);
 302     else
 303       stop = MAX (stop, 0);
 304   }
 305
 306   /* we can't have stop before start */
 307   if (stop != -1) {
 308     if (start > stop) {
 309       g_return_val_if_fail (start <= stop, FALSE);
 310       return FALSE;
 311     }
 312   }
 313
 314   segment->rate = rate;
 315   segment->applied_rate = 1.0;
 316   segment->base = base;
 317   /* be explicit about our GstSeekFlag -> GstSegmentFlag conversion */
 318   segment->flags = GST_SEGMENT_FLAG_NONE;
 319   if ((flags & GST_SEEK_FLAG_FLUSH) != 0)
 320     segment->flags |= GST_SEGMENT_FLAG_RESET;
 321   if ((flags & GST_SEEK_FLAG_SKIP) != 0)
 322     segment->flags |= GST_SEGMENT_FLAG_SKIP;
 323   if ((flags & GST_SEEK_FLAG_SEGMENT) != 0)
 324     segment->flags |= GST_SEGMENT_FLAG_SEGMENT;
 325   segment->start = start;
 326   segment->stop = stop;
 327   segment->time = start;
 328
 329   if (update_start && rate > 0.0) {
 330     position = start;
 331   }
 332   if (update_stop && rate < 0.0) {
 333     if (stop != -1)
 334       position = stop;
 335     else {
 336       if (segment->duration != -1)
 337         position = segment->duration;
 338       else
 339         position = 0;
 340     }
 341   }
 342   /* set update arg to reflect update of position */
 343   if (update)
 344     *update = position != segment->position;
 345
 346   /* update new position */
 347   segment->position = position;
 348
 349   return TRUE;
 350 }
 351
 352 /**
 353  * gst_segment_to_stream_time:
 354  * @segment: a #GstSegment structure.
 355  * @format: the format of the segment.
 356  * @position: the position in the segment
 357  *
 358  * Translate @position to stream time using the currently configured
 359  * segment. The @position value must be between @segment start and
 360  * stop value.
 361  *
 362  * This function is typically used by elements that need to operate on
 363  * the stream time of the buffers it receives, such as effect plugins.
 364  * In those use cases, @position is typically the buffer timestamp or
 365  * clock time that one wants to convert to the stream time.
 366  * The stream time is always between 0 and the total duration of the
 367  * media stream.
 368  *
 369  * Returns: the position in stream_time or -1 when an invalid position
 370  * was given.
 371  */
 372 guint64
 373 gst_segment_to_stream_time (const GstSegment * segment, GstFormat format,
 374     guint64 position)
 375 {
 376   guint64 result, start, stop, time;
 377   gdouble abs_applied_rate;
 378
 379   /* format does not matter for -1 */
 380   if (G_UNLIKELY (position == -1))
 381     return -1;
 382
 383   g_return_val_if_fail (segment != NULL, -1);
 384   g_return_val_if_fail (segment->format == format, -1);
 385
 386   /* if we have the position for the same format as the segment, we can compare
 387    * the start and stop values, otherwise we assume 0 and -1 */
 388   if (G_LIKELY (segment->format == format)) {
 389     start = segment->start;
 390     stop = segment->stop;
 391     time = segment->time;
 392   } else {
 393     start = 0;
 394     stop = -1;
 395     time = 0;
 396   }
 397
 398   /* outside of the segment boundary stop */
 399   if (G_UNLIKELY (stop != -1 && position > stop))
 400     return -1;
 401
 402   /* before the segment boundary */
 403   if (G_UNLIKELY (position < start))
 404     return -1;
 405
 406   /* time must be known */
 407   if (G_UNLIKELY (time == -1))
 408     return -1;
 409
 410   /* bring to uncorrected position in segment */
 411   result = position - start;
 412
 413   abs_applied_rate = ABS (segment->applied_rate);
 414
 415   /* correct for applied rate if needed */
 416   if (G_UNLIKELY (abs_applied_rate != 1.0))
 417     result *= abs_applied_rate;
 418
 419   /* add or subtract from segment time based on applied rate */
 420   if (G_LIKELY (segment->applied_rate > 0.0)) {
 421     /* correct for segment time */
 422     result += time;
 423   } else {
 424     /* correct for segment time, clamp at 0. Streams with a negative
 425      * applied_rate have timestamps between start and stop, as usual, but have
 426      * the time member starting high and going backwards.  */
 427     if (G_LIKELY (time > result))
 428       result = time - result;
 429     else
 430       result = 0;
 431   }
 432
 433   return result;
 434 }
 435
 436 /**
 437  * gst_segment_to_running_time:
 438  * @segment: a #GstSegment structure.
 439  * @format: the format of the segment.
 440  * @position: the position in the segment
 441  *
 442  * Translate @position to the total running time using the currently configured
 443  * and previously accumulated segments. Position is a value between @segment
 444  * start and stop time.
 445  *
 446  * This function is typically used by elements that need to synchronize to the
 447  * global clock in a pipeline. The runnning time is a constantly increasing value
 448  * starting from 0. When gst_segment_init() is called, this value will reset to
 449  * 0.
 450  *
 451  * This function returns -1 if the position is outside of @segment start and stop.
 452  *
 453  * Returns: the position as the total running time or -1 when an invalid position
 454  * was given.
 455  */
 456 guint64
 457 gst_segment_to_running_time (const GstSegment * segment, GstFormat format,
 458     guint64 position)
 459 {
 460   guint64 result;
 461   guint64 start, stop, base;
 462   gdouble abs_rate;
 463
 464   if (G_UNLIKELY (position == -1))
 465     return -1;
 466
 467   g_return_val_if_fail (segment != NULL, -1);
 468   g_return_val_if_fail (segment->format == format, -1);
 469
 470   /* if we have the position for the same format as the segment, we can compare
 471    * the start and stop values, otherwise we assume 0 and -1 */
 472   if (G_LIKELY (segment->format == format)) {
 473     start = segment->start;
 474     stop = segment->stop;
 475     base = segment->base;
 476   } else {
 477     start = 0;
 478     stop = -1;
 479     base = 0;
 480   }
 481
 482   /* before the segment boundary */
 483   if (G_UNLIKELY (position < start))
 484     return -1;
 485
 486   if (G_LIKELY (segment->rate > 0.0)) {
 487     /* outside of the segment boundary stop */
 488     if (G_UNLIKELY (stop != -1 && position > stop))
 489       return -1;
 490
 491     /* bring to uncorrected position in segment */
 492     result = position - start;
 493   } else {
 494     /* cannot continue if no stop position set or outside of
 495      * the segment. */
 496     if (G_UNLIKELY (stop == -1 || position > stop))
 497       return -1;
 498
 499     /* bring to uncorrected position in segment */
 500     result = stop - position;
 501   }
 502
 503   /* scale based on the rate, avoid division by and conversion to
 504    * float when not needed */
 505   abs_rate = ABS (segment->rate);
 506   if (G_UNLIKELY (abs_rate != 1.0))
 507     result /= abs_rate;
 508
 509   /* correct for base of the segment */
 510   result += base;
 511
 512   return result;
 513 }
 514
 515 /**
 516  * gst_segment_clip:
 517  * @segment: a #GstSegment structure.
 518  * @format: the format of the segment.
 519  * @start: the start position in the segment
 520  * @stop: the stop position in the segment
 521  * @clip_start: (out) (allow-none): the clipped start position in the segment
 522  * @clip_stop: (out) (allow-none): the clipped stop position in the segment
 523  *
 524  * Clip the given @start and @stop values to the segment boundaries given
 525  * in @segment. @start and @stop are compared and clipped to @segment
 526  * start and stop values.
 527  *
 528  * If the function returns FALSE, @start and @stop are known to fall
 529  * outside of @segment and @clip_start and @clip_stop are not updated.
 530  *
 531  * When the function returns TRUE, @clip_start and @clip_stop will be
 532  * updated. If @clip_start or @clip_stop are different from @start or @stop
 533  * respectively, the region fell partially in the segment.
 534  *
 535  * Note that when @stop is -1, @clip_stop will be set to the end of the
 536  * segment. Depending on the use case, this may or may not be what you want.
 537  *
 538  * Returns: TRUE if the given @start and @stop times fall partially or
 539  *     completely in @segment, FALSE if the values are completely outside
 540  *     of the segment.
 541  */
 542 gboolean
 543 gst_segment_clip (const GstSegment * segment, GstFormat format, guint64 start,
 544     guint64 stop, guint64 * clip_start, guint64 * clip_stop)
 545 {
 546   g_return_val_if_fail (segment != NULL, FALSE);
 547   g_return_val_if_fail (segment->format == format, FALSE);
 548
 549   /* if we have a stop position and a valid start and start is bigger,
 550    * we're outside of the segment */
 551   if (G_UNLIKELY (segment->stop != -1 && start != -1 && start >= segment->stop))
 552     return FALSE;
 553
 554   /* if a stop position is given and is before the segment start,
 555    * we're outside of the segment. Special case is were start
 556    * and stop are equal to the segment start. In that case we
 557    * are inside the segment. */
 558   if (G_UNLIKELY (stop != -1 && (stop < segment->start || (start != stop
 559                   && stop == segment->start))))
 560     return FALSE;
 561
 562   if (clip_start) {
 563     if (start == -1)
 564       *clip_start = -1;
 565     else
 566       *clip_start = MAX (start, segment->start);
 567   }
 568
 569   if (clip_stop) {
 570     if (stop == -1)
 571       *clip_stop = segment->stop;
 572     else if (segment->stop == -1)
 573       *clip_stop = stop;
 574     else
 575       *clip_stop = MIN (stop, segment->stop);
 576   }
 577
 578   return TRUE;
 579 }
 580
 581 /**
 582  * gst_segment_to_position:
 583  * @segment: a #GstSegment structure.
 584  * @format: the format of the segment.
 585  * @running_time: the running_time in the segment
 586  *
 587  * Convert @running_time into a position in the segment so that
 588  * gst_segment_to_running_time() with that position returns @running_time.
 589  *
 590  * Returns: the position in the segment for @running_time. This function returns
 591  * -1 when @running_time is -1 or when it is not inside @segment.
 592  */
 593 guint64
 594 gst_segment_to_position (const GstSegment * segment, GstFormat format,
 595     guint64 running_time)
 596 {
 597   guint64 result;
 598   guint64 start, stop, base;
 599   gdouble abs_rate;
 600
 601   if (G_UNLIKELY (running_time == -1))
 602     return -1;
 603
 604   g_return_val_if_fail (segment != NULL, -1);
 605   g_return_val_if_fail (segment->format == format, FALSE);
 606
 607   /* if we have the position for the same format as the segment, we can compare
 608    * the start and stop values, otherwise we assume 0 and -1 */
 609   if (G_LIKELY (segment->format == format)) {
 610     start = segment->start;
 611     stop = segment->stop;
 612     base = segment->base;
 613   } else {
 614     start = 0;
 615     stop = -1;
 616     base = 0;
 617   }
 618
 619   /* this running_time was for a previous segment */
 620   if (running_time < base)
 621     return -1;
 622
 623   /* start by subtracting the base time */
 624   result = running_time - base;
 625
 626   /* move into the segment at the right rate */
 627   abs_rate = ABS (segment->rate);
 628   if (G_UNLIKELY (abs_rate != 1.0))
 629     result = ceil (result * abs_rate);
 630
 631   if (G_LIKELY (segment->rate > 0.0)) {
 632     /* bring to corrected position in segment */
 633     result += start;
 634
 635     /* outside of the segment boundary stop */
 636     if (G_UNLIKELY (stop != -1 && result > stop))
 637       return -1;
 638   } else {
 639     /* cannot continue if no stop position set or outside of
 640      * the segment. */
 641     if (G_UNLIKELY (stop == -1 || result + start > stop))
 642       return -1;
 643
 644     /* bring to corrected position in segment */
 645     result = stop - result;
 646   }
 647   return result;
 648 }
 649
 650
 651 /**
 652  * gst_segment_set_running_time:
 653  * @segment: a #GstSegment structure.
 654  * @format: the format of the segment.
 655  * @running_time: the running_time in the segment
 656  *
 657  * Adjust the start/stop and base values of @segment such that the next valid
 658  * buffer will be one with @running_time.
 659  *
 660  * Returns: %TRUE if the segment could be updated successfully. If %FALSE is
 661  * returned, @running_time is -1 or not in @segment.
 662  */
 663 gboolean
 664 gst_segment_set_running_time (GstSegment * segment, GstFormat format,
 665     guint64 running_time)
 666 {
 667   guint64 position;
 668   guint64 start, stop;
 669
 670   /* start by bringing the running_time into the segment position */
 671   position = gst_segment_to_position (segment, format, running_time);
 672
 673   /* we must have a valid position now */
 674   if (G_UNLIKELY (position == -1))
 675     return FALSE;
 676
 677   start = segment->start;
 678   stop = segment->stop;
 679
 680   if (G_LIKELY (segment->rate > 0.0)) {
 681     /* update the start and time values */
 682     start = position;
 683   } else {
 684     /* reverse, update stop */
 685     stop = position;
 686   }
 687   /* and base time is exactly the running time */
 688   segment->time = gst_segment_to_stream_time (segment, format, start);
 689   segment->start = start;
 690   segment->stop = stop;
 691   segment->base = running_time;
 692
 693   return TRUE;
 694 }