gst/gstsegment.c

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