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