subprojects/gstreamer/gst/gsttoc.c

   1 /* GStreamer
   2  * (c) 2010, 2012 Alexander Saprykin <xelfium@gmail.com>
   3  *
   4  * gsttoc.c: GstToc initialization and parsing/creation
   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 /**
  23  * SECTION:gsttoc
  24  * @title: GstToc
  25  * @short_description: Generic table of contents support
  26  * @see_also: #GstStructure, #GstEvent, #GstMessage, #GstQuery
  27  *
  28  * #GstToc functions are used to create/free #GstToc and #GstTocEntry structures.
  29  * Also they are used to convert #GstToc into #GstStructure and vice versa.
  30  *
  31  * #GstToc lets you to inform other elements in pipeline or application that playing
  32  * source has some kind of table of contents (TOC). These may be chapters, editions,
  33  * angles or other types. For example: DVD chapters, Matroska chapters or cue sheet
  34  * TOC. Such TOC will be useful for applications to display instead of just a
  35  * playlist.
  36  *
  37  * Using TOC is very easy. Firstly, create #GstToc structure which represents root
  38  * contents of the source. You can also attach TOC-specific tags to it. Then fill
  39  * it with #GstTocEntry entries by appending them to the #GstToc using
  40  * gst_toc_append_entry(), and appending subentries to a #GstTocEntry using
  41  * gst_toc_entry_append_sub_entry().
  42  *
  43  * Note that root level of the TOC can contain only either editions or chapters. You
  44  * should not mix them together at the same level. Otherwise you will get serialization
  45  * /deserialization errors. Make sure that no one of the entries has negative start and
  46  *  stop values.
  47  *
  48  * Use gst_event_new_toc() to create a new TOC #GstEvent, and gst_event_parse_toc() to
  49  * parse received TOC event. Use gst_event_new_toc_select() to create a new TOC select #GstEvent,
  50  * and gst_event_parse_toc_select() to parse received TOC select event. The same rule for
  51  * the #GstMessage: gst_message_new_toc() to create new TOC #GstMessage, and
  52  * gst_message_parse_toc() to parse received TOC message.
  53  *
  54  * TOCs can have global scope or current scope. Global scope TOCs contain
  55  * all entries that can possibly be selected using a toc select event, and
  56  * are what an application is usually interested in. TOCs with current scope
  57  * only contain the parts of the TOC relevant to the currently selected/playing
  58  * stream; the current scope TOC is used by downstream elements such as muxers
  59  * to write correct TOC entries when transcoding files, for example. When
  60  * playing a DVD, the global TOC would contain a hierarchy of all titles,
  61  * chapters and angles, for example, while the current TOC would only contain
  62  * the chapters for the currently playing title if playback of a specific
  63  * title was requested.
  64  *
  65  * Applications and plugins should not rely on TOCs having a certain kind of
  66  * structure, but should allow for different alternatives. For example, a
  67  * simple CUE sheet embedded in a file may be presented as a flat list of
  68  * track entries, or could have a top-level edition node (or some other
  69  * alternative type entry) with track entries underneath that node; or even
  70  * multiple top-level edition nodes (or some other alternative type entries)
  71  * each with track entries underneath, in case the source file has extracted
  72  * a track listing from different sources).
  73  */
  74
  75 #ifdef HAVE_CONFIG_H
  76 #  include "config.h"
  77 #endif
  78
  79 #include "gst_private.h"
  80 #include "gstenumtypes.h"
  81 #include "gsttaglist.h"
  82 #include "gststructure.h"
  83 #include "gstvalue.h"
  84 #include "gsttoc.h"
  85 #include "gstpad.h"
  86 #include "gstquark.h"
  87
  88 struct _GstTocEntry
  89 {
  90   GstMiniObject mini_object;
  91
  92   GstToc *toc;
  93   GstTocEntry *parent;
  94
  95   gchar *uid;
  96   GstTocEntryType type;
  97   GstClockTime start, stop;
  98   GList *subentries;
  99   GstTagList *tags;
 100   GstTocLoopType loop_type;
 101   gint repeat_count;
 102 };
 103
 104 struct _GstToc
 105 {
 106   GstMiniObject mini_object;
 107
 108   GstTocScope scope;
 109   GList *entries;
 110   GstTagList *tags;
 111 };
 112
 113 #undef gst_toc_copy
 114 static GstToc *gst_toc_copy (const GstToc * toc);
 115 static void gst_toc_free (GstToc * toc);
 116 #undef gst_toc_entry_copy
 117 static GstTocEntry *gst_toc_entry_copy (const GstTocEntry * toc);
 118 static void gst_toc_entry_free (GstTocEntry * toc);
 119
 120 GType _gst_toc_type = 0;
 121 GType _gst_toc_entry_type = 0;
 122
 123 GST_DEFINE_MINI_OBJECT_TYPE (GstToc, gst_toc);
 124 GST_DEFINE_MINI_OBJECT_TYPE (GstTocEntry, gst_toc_entry);
 125
 126 /**
 127  * gst_toc_new:
 128  * @scope: scope of this TOC
 129  *
 130  * Create a new #GstToc structure.
 131  *
 132  * Returns: (transfer full): newly allocated #GstToc structure, free it
 133  *     with gst_toc_unref().
 134  */
 135 GstToc *
 136 gst_toc_new (GstTocScope scope)
 137 {
 138   GstToc *toc;
 139
 140   g_return_val_if_fail (scope == GST_TOC_SCOPE_GLOBAL ||
 141       scope == GST_TOC_SCOPE_CURRENT, NULL);
 142
 143   toc = g_slice_new0 (GstToc);
 144
 145   gst_mini_object_init (GST_MINI_OBJECT_CAST (toc), 0, GST_TYPE_TOC,
 146       (GstMiniObjectCopyFunction) gst_toc_copy, NULL,
 147       (GstMiniObjectFreeFunction) gst_toc_free);
 148
 149   toc->scope = scope;
 150   toc->tags = gst_tag_list_new_empty ();
 151
 152   return toc;
 153 }
 154
 155 /**
 156  * gst_toc_get_scope:
 157  * @toc: a #GstToc instance
 158  *
 159  * Returns: scope of @toc
 160  */
 161 GstTocScope
 162 gst_toc_get_scope (const GstToc * toc)
 163 {
 164   g_return_val_if_fail (toc != NULL, GST_TOC_SCOPE_GLOBAL);
 165
 166   return toc->scope;
 167 }
 168
 169 /**
 170  * gst_toc_set_tags:
 171  * @toc: A #GstToc instance
 172  * @tags: (nullable) (transfer full): A #GstTagList or %NULL
 173  *
 174  * Set a #GstTagList with tags for the complete @toc.
 175  */
 176 void
 177 gst_toc_set_tags (GstToc * toc, GstTagList * tags)
 178 {
 179   g_return_if_fail (toc != NULL);
 180   g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (toc)));
 181
 182   if (toc->tags)
 183     gst_tag_list_unref (toc->tags);
 184   toc->tags = tags;
 185 }
 186
 187 /**
 188  * gst_toc_merge_tags:
 189  * @toc: A #GstToc instance
 190  * @tags: (nullable): A #GstTagList or %NULL
 191  * @mode: A #GstTagMergeMode
 192  *
 193  * Merge @tags into the existing tags of @toc using @mode.
 194  */
 195 void
 196 gst_toc_merge_tags (GstToc * toc, GstTagList * tags, GstTagMergeMode mode)
 197 {
 198   g_return_if_fail (toc != NULL);
 199   g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (toc)));
 200
 201   if (!toc->tags) {
 202     toc->tags = gst_tag_list_ref (tags);
 203   } else {
 204     GstTagList *tmp = gst_tag_list_merge (toc->tags, tags, mode);
 205     gst_tag_list_unref (toc->tags);
 206     toc->tags = tmp;
 207   }
 208 }
 209
 210 /**
 211  * gst_toc_get_tags:
 212  * @toc: A #GstToc instance
 213  *
 214  * Gets the tags for @toc.
 215  *
 216  * Returns: (transfer none) (nullable): A #GstTagList for @entry
 217  */
 218 GstTagList *
 219 gst_toc_get_tags (const GstToc * toc)
 220 {
 221   g_return_val_if_fail (toc != NULL, NULL);
 222
 223   return toc->tags;
 224 }
 225
 226 /**
 227  * gst_toc_append_entry:
 228  * @toc: A #GstToc instance
 229  * @entry: (transfer full): A #GstTocEntry
 230  *
 231  * Appends the #GstTocEntry @entry to @toc.
 232  */
 233 void
 234 gst_toc_append_entry (GstToc * toc, GstTocEntry * entry)
 235 {
 236   g_return_if_fail (toc != NULL);
 237   g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (toc)));
 238   g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (entry)));
 239   g_return_if_fail (entry->toc == NULL);
 240   g_return_if_fail (entry->parent == NULL);
 241
 242   toc->entries = g_list_append (toc->entries, entry);
 243   entry->toc = toc;
 244
 245   GST_LOG ("appended %s entry with uid %s to toc %p",
 246       gst_toc_entry_type_get_nick (entry->type), entry->uid, toc);
 247
 248   gst_toc_dump (toc);
 249 }
 250
 251 /**
 252  * gst_toc_get_entries:
 253  * @toc: A #GstToc instance
 254  *
 255  * Gets the list of #GstTocEntry of @toc.
 256  *
 257  * Returns: (transfer none) (element-type Gst.TocEntry): A #GList of #GstTocEntry for @entry
 258  */
 259 GList *
 260 gst_toc_get_entries (const GstToc * toc)
 261 {
 262   g_return_val_if_fail (toc != NULL, NULL);
 263
 264   return toc->entries;
 265 }
 266
 267 static GstTocEntry *
 268 gst_toc_entry_new_internal (GstTocEntryType type, const gchar * uid)
 269 {
 270   GstTocEntry *entry;
 271
 272   entry = g_slice_new0 (GstTocEntry);
 273
 274   gst_mini_object_init (GST_MINI_OBJECT_CAST (entry), 0, GST_TYPE_TOC_ENTRY,
 275       (GstMiniObjectCopyFunction) gst_toc_entry_copy, NULL,
 276       (GstMiniObjectFreeFunction) gst_toc_entry_free);
 277
 278   entry->uid = g_strdup (uid);
 279   entry->type = type;
 280   entry->tags = NULL;
 281   entry->start = entry->stop = GST_CLOCK_TIME_NONE;
 282
 283   return entry;
 284 }
 285
 286 /**
 287  * gst_toc_entry_new:
 288  * @type: entry type.
 289  * @uid: unique ID (UID) in the whole TOC.
 290  *
 291  * Create new #GstTocEntry structure.
 292  *
 293  * Returns: (transfer full): newly allocated #GstTocEntry structure, free it with gst_toc_entry_unref().
 294  */
 295 GstTocEntry *
 296 gst_toc_entry_new (GstTocEntryType type, const gchar * uid)
 297 {
 298   g_return_val_if_fail (uid != NULL, NULL);
 299
 300   return gst_toc_entry_new_internal (type, uid);
 301 }
 302
 303 static void
 304 gst_toc_free (GstToc * toc)
 305 {
 306   g_list_foreach (toc->entries, (GFunc) gst_mini_object_unref, NULL);
 307   g_list_free (toc->entries);
 308
 309   if (toc->tags != NULL)
 310     gst_tag_list_unref (toc->tags);
 311
 312 #ifdef USE_POISONING
 313   memset (toc, 0xff, sizeof (GstToc));
 314 #endif
 315
 316   g_slice_free (GstToc, toc);
 317 }
 318
 319 static void
 320 gst_toc_entry_free (GstTocEntry * entry)
 321 {
 322   g_return_if_fail (entry != NULL);
 323
 324   g_list_foreach (entry->subentries, (GFunc) gst_mini_object_unref, NULL);
 325   g_list_free (entry->subentries);
 326
 327   g_free (entry->uid);
 328
 329   if (entry->tags != NULL)
 330     gst_tag_list_unref (entry->tags);
 331
 332 #ifdef USE_POISONING
 333   memset (entry, 0xff, sizeof (GstTocEntry));
 334 #endif
 335
 336   g_slice_free (GstTocEntry, entry);
 337 }
 338
 339 static GstTocEntry *
 340 gst_toc_entry_find_sub_entry (const GstTocEntry * entry, const gchar * uid)
 341 {
 342   GList *cur;
 343   GstTocEntry *subentry, *subsubentry;
 344
 345   g_return_val_if_fail (entry != NULL, NULL);
 346   g_return_val_if_fail (uid != NULL, NULL);
 347
 348   cur = entry->subentries;
 349   while (cur != NULL) {
 350     subentry = cur->data;
 351
 352     if (g_strcmp0 (subentry->uid, uid) == 0)
 353       return subentry;
 354
 355     subsubentry = gst_toc_entry_find_sub_entry (subentry, uid);
 356     if (subsubentry != NULL)
 357       return subsubentry;
 358
 359     cur = cur->next;
 360   }
 361
 362   return NULL;
 363 }
 364
 365 /**
 366  * gst_toc_find_entry:
 367  * @toc: #GstToc to search in.
 368  * @uid: UID to find #GstTocEntry with.
 369  *
 370  * Find #GstTocEntry with given @uid in the @toc.
 371  *
 372  * Returns: (transfer none) (nullable): #GstTocEntry with specified
 373  * @uid from the @toc, or %NULL if not found.
 374  */
 375 GstTocEntry *
 376 gst_toc_find_entry (const GstToc * toc, const gchar * uid)
 377 {
 378   GList *cur;
 379   GstTocEntry *entry, *subentry;
 380
 381   g_return_val_if_fail (toc != NULL, NULL);
 382   g_return_val_if_fail (uid != NULL, NULL);
 383
 384   cur = toc->entries;
 385   while (cur != NULL) {
 386     entry = cur->data;
 387
 388     if (g_strcmp0 (entry->uid, uid) == 0)
 389       return entry;
 390
 391     subentry = gst_toc_entry_find_sub_entry (entry, uid);
 392     if (subentry != NULL)
 393       return subentry;
 394     cur = cur->next;
 395   }
 396
 397   return NULL;
 398 }
 399
 400 static GList *
 401 gst_toc_deep_copy_toc_entries (GList * entry_list)
 402 {
 403   GQueue new_entries = G_QUEUE_INIT;
 404   GList *l;
 405
 406   for (l = entry_list; l != NULL; l = l->next)
 407     g_queue_push_tail (&new_entries, gst_toc_entry_copy (l->data));
 408
 409   return new_entries.head;
 410 }
 411
 412 /**
 413  * gst_toc_entry_copy:
 414  * @entry: #GstTocEntry to copy.
 415  *
 416  * Copy #GstTocEntry with all subentries (deep copy).
 417  *
 418  * Returns: (transfer full): newly allocated #GstTocEntry; free it when done with
 419  * gst_toc_entry_unref().
 420  */
 421 static GstTocEntry *
 422 gst_toc_entry_copy (const GstTocEntry * entry)
 423 {
 424   GstTocEntry *ret;
 425   GstTagList *list;
 426
 427   g_return_val_if_fail (entry != NULL, NULL);
 428
 429   ret = gst_toc_entry_new (entry->type, entry->uid);
 430
 431   ret->start = entry->start;
 432   ret->stop = entry->stop;
 433
 434   if (GST_IS_TAG_LIST (entry->tags)) {
 435     list = gst_tag_list_copy (entry->tags);
 436     if (ret->tags)
 437       gst_tag_list_unref (ret->tags);
 438     ret->tags = list;
 439   }
 440
 441   ret->subentries = gst_toc_deep_copy_toc_entries (entry->subentries);
 442
 443   return ret;
 444 }
 445
 446 /**
 447  * gst_toc_copy:
 448  * @toc: #GstToc to copy.
 449  *
 450  * Copy #GstToc with all subentries (deep copy).
 451  *
 452  * Returns: (transfer full): newly allocated #GstToc; free it when done with gst_toc_unref().
 453  */
 454 static GstToc *
 455 gst_toc_copy (const GstToc * toc)
 456 {
 457   GstToc *ret;
 458   GstTagList *list;
 459
 460   g_return_val_if_fail (toc != NULL, NULL);
 461
 462   ret = gst_toc_new (toc->scope);
 463
 464   if (GST_IS_TAG_LIST (toc->tags)) {
 465     list = gst_tag_list_copy (toc->tags);
 466     gst_tag_list_unref (ret->tags);
 467     ret->tags = list;
 468   }
 469
 470   ret->entries = gst_toc_deep_copy_toc_entries (toc->entries);
 471
 472   return ret;
 473 }
 474
 475 /**
 476  * gst_toc_entry_set_start_stop_times:
 477  * @entry: #GstTocEntry to set values.
 478  * @start: start value to set.
 479  * @stop: stop value to set.
 480  *
 481  * Set @start and @stop values for the @entry.
 482  */
 483 void
 484 gst_toc_entry_set_start_stop_times (GstTocEntry * entry, gint64 start,
 485     gint64 stop)
 486 {
 487   g_return_if_fail (entry != NULL);
 488
 489   entry->start = start;
 490   entry->stop = stop;
 491 }
 492
 493 /**
 494  * gst_toc_entry_get_start_stop_times:
 495  * @entry: #GstTocEntry to get values from.
 496  * @start: (out) (optional): the storage for the start value, leave
 497  *   %NULL if not need.
 498  * @stop: (out) (optional): the storage for the stop value, leave
 499  *   %NULL if not need.
 500  *
 501  * Get @start and @stop values from the @entry and write them into appropriate
 502  * storages.
 503  *
 504  * Returns: %TRUE if all non-%NULL storage pointers were filled with appropriate
 505  * values, %FALSE otherwise.
 506  */
 507 gboolean
 508 gst_toc_entry_get_start_stop_times (const GstTocEntry * entry, gint64 * start,
 509     gint64 * stop)
 510 {
 511   g_return_val_if_fail (entry != NULL, FALSE);
 512
 513   if (start != NULL)
 514     *start = entry->start;
 515   if (stop != NULL)
 516     *stop = entry->stop;
 517
 518   return TRUE;
 519 }
 520
 521 /**
 522  * gst_toc_entry_set_loop:
 523  * @entry: #GstTocEntry to set values.
 524  * @loop_type: loop_type value to set.
 525  * @repeat_count: repeat_count value to set.
 526  *
 527  * Set @loop_type and @repeat_count values for the @entry.
 528  *
 529  * Since: 1.4
 530  */
 531 void
 532 gst_toc_entry_set_loop (GstTocEntry * entry, GstTocLoopType loop_type,
 533     gint repeat_count)
 534 {
 535   g_return_if_fail (entry != NULL);
 536
 537   entry->loop_type = loop_type;
 538   entry->repeat_count = repeat_count;
 539 }
 540
 541 /**
 542  * gst_toc_entry_get_loop:
 543  * @entry: #GstTocEntry to get values from.
 544  * @loop_type: (out) (optional): the storage for the loop_type
 545  *             value, leave %NULL if not need.
 546  * @repeat_count: (out) (optional): the storage for the repeat_count
 547  *                value, leave %NULL if not need.
 548  *
 549  * Get @loop_type and @repeat_count values from the @entry and write them into
 550  * appropriate storages. Loops are e.g. used by sampled instruments. GStreamer
 551  * is not automatically applying the loop. The application can process this
 552  * meta data and use it e.g. to send a seek-event to loop a section.
 553  *
 554  * Returns: %TRUE if all non-%NULL storage pointers were filled with appropriate
 555  * values, %FALSE otherwise.
 556  *
 557  * Since: 1.4
 558  */
 559 gboolean
 560 gst_toc_entry_get_loop (const GstTocEntry * entry, GstTocLoopType * loop_type,
 561     gint * repeat_count)
 562 {
 563   g_return_val_if_fail (entry != NULL, FALSE);
 564
 565   if (loop_type != NULL)
 566     *loop_type = entry->loop_type;
 567   if (repeat_count != NULL)
 568     *repeat_count = entry->repeat_count;
 569
 570   return TRUE;
 571 }
 572
 573
 574 /**
 575  * gst_toc_entry_type_get_nick:
 576  * @type: a #GstTocEntryType.
 577  *
 578  * Converts @type to a string representation.
 579  *
 580  * Returns: Returns a human-readable string for @type. This string is
 581  *    only for debugging purpose and should not be displayed in a user
 582  *    interface.
 583  */
 584 const gchar *
 585 gst_toc_entry_type_get_nick (GstTocEntryType type)
 586 {
 587   switch (type) {
 588     case GST_TOC_ENTRY_TYPE_ANGLE:
 589       return "angle";
 590     case GST_TOC_ENTRY_TYPE_VERSION:
 591       return "version";
 592     case GST_TOC_ENTRY_TYPE_EDITION:
 593       return "edition";
 594     case GST_TOC_ENTRY_TYPE_TITLE:
 595       return "title";
 596     case GST_TOC_ENTRY_TYPE_TRACK:
 597       return "track";
 598     case GST_TOC_ENTRY_TYPE_CHAPTER:
 599       return "chapter";
 600     default:
 601       break;
 602   }
 603   return "invalid";
 604 }
 605
 606 /**
 607  * gst_toc_entry_get_entry_type:
 608  * @entry: a #GstTocEntry
 609  *
 610  * Returns: @entry's entry type
 611  */
 612 GstTocEntryType
 613 gst_toc_entry_get_entry_type (const GstTocEntry * entry)
 614 {
 615   g_return_val_if_fail (entry != NULL, GST_TOC_ENTRY_TYPE_INVALID);
 616
 617   return entry->type;
 618 }
 619
 620 /**
 621  * gst_toc_entry_is_alternative:
 622  * @entry: a #GstTocEntry
 623  *
 624  * Returns: %TRUE if @entry's type is an alternative type, otherwise %FALSE
 625  */
 626 gboolean
 627 gst_toc_entry_is_alternative (const GstTocEntry * entry)
 628 {
 629   g_return_val_if_fail (entry != NULL, FALSE);
 630
 631   return GST_TOC_ENTRY_TYPE_IS_ALTERNATIVE (entry->type);
 632 }
 633
 634 /**
 635  * gst_toc_entry_is_sequence:
 636  * @entry: a #GstTocEntry
 637  *
 638  * Returns: %TRUE if @entry's type is a sequence type, otherwise %FALSE
 639  */
 640 gboolean
 641 gst_toc_entry_is_sequence (const GstTocEntry * entry)
 642 {
 643   g_return_val_if_fail (entry != NULL, FALSE);
 644
 645   return GST_TOC_ENTRY_TYPE_IS_SEQUENCE (entry->type);
 646 }
 647
 648 /**
 649  * gst_toc_entry_get_uid:
 650  * @entry: A #GstTocEntry instance
 651  *
 652  * Gets the UID of @entry.
 653  *
 654  * Returns: (transfer none): The UID of @entry
 655  */
 656 const gchar *
 657 gst_toc_entry_get_uid (const GstTocEntry * entry)
 658 {
 659   g_return_val_if_fail (entry != NULL, NULL);
 660
 661   return entry->uid;
 662 }
 663
 664 /**
 665  * gst_toc_entry_append_sub_entry:
 666  * @entry: A #GstTocEntry instance
 667  * @subentry: (transfer full): A #GstTocEntry
 668  *
 669  * Appends the #GstTocEntry @subentry to @entry.
 670  */
 671 void
 672 gst_toc_entry_append_sub_entry (GstTocEntry * entry, GstTocEntry * subentry)
 673 {
 674   g_return_if_fail (entry != NULL);
 675   g_return_if_fail (subentry != NULL);
 676   g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (entry)));
 677   g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST
 678           (subentry)));
 679   g_return_if_fail (subentry->toc == NULL);
 680   g_return_if_fail (subentry->parent == NULL);
 681
 682   entry->subentries = g_list_append (entry->subentries, subentry);
 683   subentry->toc = entry->toc;
 684   subentry->parent = entry;
 685
 686   GST_LOG ("appended %s subentry with uid %s to entry %s",
 687       gst_toc_entry_type_get_nick (subentry->type), subentry->uid, entry->uid);
 688 }
 689
 690 /**
 691  * gst_toc_entry_get_sub_entries:
 692  * @entry: A #GstTocEntry instance
 693  *
 694  * Gets the sub-entries of @entry.
 695  *
 696  * Returns: (transfer none) (element-type Gst.TocEntry): A #GList of #GstTocEntry of @entry
 697  */
 698 GList *
 699 gst_toc_entry_get_sub_entries (const GstTocEntry * entry)
 700 {
 701   g_return_val_if_fail (entry != NULL, NULL);
 702
 703   return entry->subentries;
 704 }
 705
 706 /**
 707  * gst_toc_entry_set_tags:
 708  * @entry: A #GstTocEntry instance
 709  * @tags: (nullable) (transfer full): A #GstTagList or %NULL
 710  *
 711  * Set a #GstTagList with tags for the complete @entry.
 712  */
 713 void
 714 gst_toc_entry_set_tags (GstTocEntry * entry, GstTagList * tags)
 715 {
 716   g_return_if_fail (entry != NULL);
 717   g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (entry)));
 718
 719   if (entry->tags)
 720     gst_tag_list_unref (entry->tags);
 721   entry->tags = tags;
 722 }
 723
 724 /**
 725  * gst_toc_entry_merge_tags:
 726  * @entry: A #GstTocEntry instance
 727  * @tags: (nullable): A #GstTagList or %NULL
 728  * @mode: A #GstTagMergeMode
 729  *
 730  * Merge @tags into the existing tags of @entry using @mode.
 731  */
 732 void
 733 gst_toc_entry_merge_tags (GstTocEntry * entry, GstTagList * tags,
 734     GstTagMergeMode mode)
 735 {
 736   g_return_if_fail (entry != NULL);
 737   g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (entry)));
 738
 739   if (!entry->tags) {
 740     entry->tags = gst_tag_list_ref (tags);
 741   } else {
 742     GstTagList *tmp = gst_tag_list_merge (entry->tags, tags, mode);
 743     gst_tag_list_unref (entry->tags);
 744     entry->tags = tmp;
 745   }
 746 }
 747
 748 /**
 749  * gst_toc_entry_get_tags:
 750  * @entry: A #GstTocEntry instance
 751  *
 752  * Gets the tags for @entry.
 753  *
 754  * Returns: (nullable) (transfer none): A #GstTagList for @entry
 755  */
 756 GstTagList *
 757 gst_toc_entry_get_tags (const GstTocEntry * entry)
 758 {
 759   g_return_val_if_fail (entry != NULL, NULL);
 760
 761   return entry->tags;
 762 }
 763
 764 /**
 765  * gst_toc_entry_get_toc:
 766  * @entry: A #GstTocEntry instance
 767  *
 768  * Gets the parent #GstToc of @entry.
 769  *
 770  * Returns: (transfer none) (nullable): The parent #GstToc of @entry
 771  */
 772 GstToc *
 773 gst_toc_entry_get_toc (GstTocEntry * entry)
 774 {
 775   g_return_val_if_fail (entry != NULL, NULL);
 776
 777   return entry->toc;
 778 }
 779
 780 /**
 781  * gst_toc_entry_get_parent:
 782  * @entry: A #GstTocEntry instance
 783  *
 784  * Gets the parent #GstTocEntry of @entry.
 785  *
 786  * Returns: (transfer none) (nullable): The parent #GstTocEntry of @entry
 787  */
 788 GstTocEntry *
 789 gst_toc_entry_get_parent (GstTocEntry * entry)
 790 {
 791   g_return_val_if_fail (entry != NULL, NULL);
 792
 793   return entry->parent;
 794 }
 795
 796 #ifndef GST_DISABLE_GST_DEBUG
 797 static void
 798 gst_toc_dump_entries (GList * entries, guint depth)
 799 {
 800   GList *e;
 801   gchar *indent;
 802
 803   indent = g_malloc0 (depth + 1);
 804   memset (indent, ' ', depth);
 805   for (e = entries; e != NULL; e = e->next) {
 806     GstTocEntry *entry = e->data;
 807
 808     GST_TRACE ("%s+ %s (%s), %" GST_TIME_FORMAT " - %" GST_TIME_FORMAT ", "
 809         "tags: %" GST_PTR_FORMAT, indent, entry->uid,
 810         gst_toc_entry_type_get_nick (entry->type),
 811         GST_TIME_ARGS (entry->start), GST_TIME_ARGS (entry->stop), entry->tags);
 812
 813     if (entry->subentries != NULL)
 814       gst_toc_dump_entries (entry->subentries, depth + 2);
 815   }
 816   g_free (indent);
 817 }
 818 #endif
 819
 820 void
 821 gst_toc_dump (GstToc * toc)
 822 {
 823 #ifndef GST_DISABLE_GST_DEBUG
 824   GST_TRACE ("        Toc %p, scope: %s, tags: %" GST_PTR_FORMAT, toc,
 825       (toc->scope == GST_TOC_SCOPE_GLOBAL) ? "global" : "current", toc->tags);
 826   gst_toc_dump_entries (toc->entries, 2);
 827 #endif
 828 }
 829
 830 void
 831 _priv_gst_toc_initialize (void)
 832 {
 833   _gst_toc_type = gst_toc_get_type ();
 834   _gst_toc_entry_type = gst_toc_entry_get_type ();
 835 }