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): #GstTocEntry with specified @uid from the @toc, or %NULL if not found.
 364  */
 365 GstTocEntry *
 366 gst_toc_find_entry (const GstToc * toc, const gchar * uid)
 367 {
 368   GList *cur;
 369   GstTocEntry *entry, *subentry;
 370
 371   g_return_val_if_fail (toc != NULL, NULL);
 372   g_return_val_if_fail (uid != NULL, NULL);
 373
 374   cur = toc->entries;
 375   while (cur != NULL) {
 376     entry = cur->data;
 377
 378     if (g_strcmp0 (entry->uid, uid) == 0)
 379       return entry;
 380
 381     subentry = gst_toc_entry_find_sub_entry (entry, uid);
 382     if (subentry != NULL)
 383       return subentry;
 384     cur = cur->next;
 385   }
 386
 387   return NULL;
 388 }
 389
 390 /**
 391  * gst_toc_entry_copy:
 392  * @entry: #GstTocEntry to copy.
 393  *
 394  * Copy #GstTocEntry with all subentries (deep copy).
 395  *
 396  * Returns: newly allocated #GstTocEntry in case of success, %NULL otherwise;
 397  * free it when done with gst_toc_entry_unref().
 398  */
 399 static GstTocEntry *
 400 gst_toc_entry_copy (const GstTocEntry * entry)
 401 {
 402   GstTocEntry *ret, *sub;
 403   GstTagList *list;
 404   GList *cur;
 405
 406   g_return_val_if_fail (entry != NULL, NULL);
 407
 408   ret = gst_toc_entry_new (entry->type, entry->uid);
 409
 410   ret->start = entry->start;
 411   ret->stop = entry->stop;
 412
 413   if (GST_IS_TAG_LIST (entry->tags)) {
 414     list = gst_tag_list_copy (entry->tags);
 415     if (ret->tags)
 416       gst_tag_list_unref (ret->tags);
 417     ret->tags = list;
 418   }
 419
 420   cur = entry->subentries;
 421   while (cur != NULL) {
 422     sub = gst_toc_entry_copy (cur->data);
 423
 424     if (sub != NULL)
 425       ret->subentries = g_list_prepend (ret->subentries, sub);
 426
 427     cur = cur->next;
 428   }
 429   ret->subentries = g_list_reverse (ret->subentries);
 430
 431   return ret;
 432 }
 433
 434 /**
 435  * gst_toc_copy:
 436  * @toc: #GstToc to copy.
 437  *
 438  * Copy #GstToc with all subentries (deep copy).
 439  *
 440  * Returns: newly allocated #GstToc in case of success, %NULL otherwise;
 441  * free it when done with gst_toc_unref().
 442  */
 443 static GstToc *
 444 gst_toc_copy (const GstToc * toc)
 445 {
 446   GstToc *ret;
 447   GstTocEntry *entry;
 448   GList *cur;
 449   GstTagList *list;
 450
 451   g_return_val_if_fail (toc != NULL, NULL);
 452
 453   ret = gst_toc_new (toc->scope);
 454
 455   if (GST_IS_TAG_LIST (toc->tags)) {
 456     list = gst_tag_list_copy (toc->tags);
 457     gst_tag_list_unref (ret->tags);
 458     ret->tags = list;
 459   }
 460
 461   cur = toc->entries;
 462   while (cur != NULL) {
 463     entry = gst_toc_entry_copy (cur->data);
 464
 465     if (entry != NULL)
 466       ret->entries = g_list_prepend (ret->entries, entry);
 467
 468     cur = cur->next;
 469   }
 470   ret->entries = g_list_reverse (ret->entries);
 471   return ret;
 472 }
 473
 474 /**
 475  * gst_toc_entry_set_start_stop_times:
 476  * @entry: #GstTocEntry to set values.
 477  * @start: start value to set.
 478  * @stop: stop value to set.
 479  *
 480  * Set @start and @stop values for the @entry.
 481  */
 482 void
 483 gst_toc_entry_set_start_stop_times (GstTocEntry * entry, gint64 start,
 484     gint64 stop)
 485 {
 486   g_return_if_fail (entry != NULL);
 487
 488   entry->start = start;
 489   entry->stop = stop;
 490 }
 491
 492 /**
 493  * gst_toc_entry_get_start_stop_times:
 494  * @entry: #GstTocEntry to get values from.
 495  * @start: (out): the storage for the start value, leave %NULL if not need.
 496  * @stop: (out): the storage for the stop value, leave %NULL if not need.
 497  *
 498  * Get @start and @stop values from the @entry and write them into appropriate
 499  * storages.
 500  *
 501  * Returns: %TRUE if all non-%NULL storage pointers were filled with appropriate
 502  * values, %FALSE otherwise.
 503  */
 504 gboolean
 505 gst_toc_entry_get_start_stop_times (const GstTocEntry * entry, gint64 * start,
 506     gint64 * stop)
 507 {
 508   g_return_val_if_fail (entry != NULL, FALSE);
 509
 510   if (start != NULL)
 511     *start = entry->start;
 512   if (stop != NULL)
 513     *stop = entry->stop;
 514
 515   return TRUE;
 516 }
 517
 518 /**
 519  * gst_toc_entry_set_loop:
 520  * @entry: #GstTocEntry to set values.
 521  * @loop_type: loop_type value to set.
 522  * @repeat_count: repeat_count value to set.
 523  *
 524  * Set @loop_type and @repeat_count values for the @entry.
 525  *
 526  * Since: 1.4
 527  */
 528 void
 529 gst_toc_entry_set_loop (GstTocEntry * entry, GstTocLoopType loop_type,
 530     gint repeat_count)
 531 {
 532   g_return_if_fail (entry != NULL);
 533
 534   entry->loop_type = loop_type;
 535   entry->repeat_count = repeat_count;
 536 }
 537
 538 /**
 539  * gst_toc_entry_get_loop:
 540  * @entry: #GstTocEntry to get values from.
 541  * @loop_type: (out): the storage for the loop_type value, leave %NULL if not
 542  *                    need.
 543  * @repeat_count: (out): the storage for the repeat_count value, leave %NULL if
 544  *                       not need.
 545  *
 546  * Get @loop_type and @repeat_count values from the @entry and write them into
 547  * appropriate storages. Loops are e.g. used by sampled instruments. GStreamer
 548  * is not automatically applying the loop. The application can process this
 549  * meta data and use it e.g. to send a seek-event to loop a section.
 550  *
 551  * Returns: %TRUE if all non-%NULL storage pointers were filled with appropriate
 552  * values, %FALSE otherwise.
 553  *
 554  * Since: 1.4
 555  */
 556 gboolean
 557 gst_toc_entry_get_loop (const GstTocEntry * entry, GstTocLoopType * loop_type,
 558     gint * repeat_count)
 559 {
 560   g_return_val_if_fail (entry != NULL, FALSE);
 561
 562   if (loop_type != NULL)
 563     *loop_type = entry->loop_type;
 564   if (repeat_count != NULL)
 565     *repeat_count = entry->repeat_count;
 566
 567   return TRUE;
 568 }
 569
 570
 571 /**
 572  * gst_toc_entry_type_get_nick:
 573  * @type: a #GstTocEntryType.
 574  *
 575  * Converts @type to a string representation.
 576  *
 577  * Returns: Returns a human-readable string for @type. This string is
 578  *    only for debugging purpose and should not be displayed in a user
 579  *    interface.
 580  */
 581 const gchar *
 582 gst_toc_entry_type_get_nick (GstTocEntryType type)
 583 {
 584   switch (type) {
 585     case GST_TOC_ENTRY_TYPE_ANGLE:
 586       return "angle";
 587     case GST_TOC_ENTRY_TYPE_VERSION:
 588       return "version";
 589     case GST_TOC_ENTRY_TYPE_EDITION:
 590       return "edition";
 591     case GST_TOC_ENTRY_TYPE_TITLE:
 592       return "title";
 593     case GST_TOC_ENTRY_TYPE_TRACK:
 594       return "track";
 595     case GST_TOC_ENTRY_TYPE_CHAPTER:
 596       return "chapter";
 597     default:
 598       break;
 599   }
 600   return "invalid";
 601 }
 602
 603 /**
 604  * gst_toc_entry_get_entry_type:
 605  * @entry: a #GstTocEntry
 606  *
 607  * Returns: @entry's entry type
 608  */
 609 GstTocEntryType
 610 gst_toc_entry_get_entry_type (const GstTocEntry * entry)
 611 {
 612   g_return_val_if_fail (entry != NULL, GST_TOC_ENTRY_TYPE_INVALID);
 613
 614   return entry->type;
 615 }
 616
 617 /**
 618  * gst_toc_entry_is_alternative:
 619  * @entry: a #GstTocEntry
 620  *
 621  * Returns: %TRUE if @entry's type is an alternative type, otherwise %FALSE
 622  */
 623 gboolean
 624 gst_toc_entry_is_alternative (const GstTocEntry * entry)
 625 {
 626   g_return_val_if_fail (entry != NULL, FALSE);
 627
 628   return GST_TOC_ENTRY_TYPE_IS_ALTERNATIVE (entry->type);
 629 }
 630
 631 /**
 632  * gst_toc_entry_is_sequence:
 633  * @entry: a #GstTocEntry
 634  *
 635  * Returns: %TRUE if @entry's type is a sequence type, otherwise %FALSE
 636  */
 637 gboolean
 638 gst_toc_entry_is_sequence (const GstTocEntry * entry)
 639 {
 640   g_return_val_if_fail (entry != NULL, FALSE);
 641
 642   return GST_TOC_ENTRY_TYPE_IS_SEQUENCE (entry->type);
 643 }
 644
 645 /**
 646  * gst_toc_entry_get_uid:
 647  * @entry: A #GstTocEntry instance
 648  *
 649  * Gets the UID of @entry.
 650  *
 651  * Returns: (transfer none): The UID of @entry
 652  */
 653 const gchar *
 654 gst_toc_entry_get_uid (const GstTocEntry * entry)
 655 {
 656   g_return_val_if_fail (entry != NULL, NULL);
 657
 658   return entry->uid;
 659 }
 660
 661 /**
 662  * gst_toc_entry_append_sub_entry:
 663  * @entry: A #GstTocEntry instance
 664  * @subentry: (transfer full): A #GstTocEntry
 665  *
 666  * Appends the #GstTocEntry @subentry to @entry.
 667  */
 668 void
 669 gst_toc_entry_append_sub_entry (GstTocEntry * entry, GstTocEntry * subentry)
 670 {
 671   g_return_if_fail (entry != NULL);
 672   g_return_if_fail (subentry != NULL);
 673   g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (entry)));
 674   g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST
 675           (subentry)));
 676   g_return_if_fail (subentry->toc == NULL);
 677   g_return_if_fail (subentry->parent == NULL);
 678
 679   entry->subentries = g_list_append (entry->subentries, subentry);
 680   subentry->toc = entry->toc;
 681   subentry->parent = entry;
 682
 683   GST_LOG ("appended %s subentry with uid %s to entry %s",
 684       gst_toc_entry_type_get_nick (subentry->type), subentry->uid, entry->uid);
 685 }
 686
 687 /**
 688  * gst_toc_entry_get_sub_entries:
 689  * @entry: A #GstTocEntry instance
 690  *
 691  * Gets the sub-entries of @entry.
 692  *
 693  * Returns: (transfer none) (element-type Gst.TocEntry): A #GList of #GstTocEntry of @entry
 694  */
 695 GList *
 696 gst_toc_entry_get_sub_entries (const GstTocEntry * entry)
 697 {
 698   g_return_val_if_fail (entry != NULL, NULL);
 699
 700   return entry->subentries;
 701 }
 702
 703 /**
 704  * gst_toc_entry_set_tags:
 705  * @entry: A #GstTocEntry instance
 706  * @tags: (allow-none) (transfer full): A #GstTagList or %NULL
 707  *
 708  * Set a #GstTagList with tags for the complete @entry.
 709  */
 710 void
 711 gst_toc_entry_set_tags (GstTocEntry * entry, GstTagList * tags)
 712 {
 713   g_return_if_fail (entry != NULL);
 714   g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (entry)));
 715
 716   if (entry->tags)
 717     gst_tag_list_unref (entry->tags);
 718   entry->tags = tags;
 719 }
 720
 721 /**
 722  * gst_toc_entry_merge_tags:
 723  * @entry: A #GstTocEntry instance
 724  * @tags: (allow-none): A #GstTagList or %NULL
 725  * @mode: A #GstTagMergeMode
 726  *
 727  * Merge @tags into the existing tags of @entry using @mode.
 728  */
 729 void
 730 gst_toc_entry_merge_tags (GstTocEntry * entry, GstTagList * tags,
 731     GstTagMergeMode mode)
 732 {
 733   g_return_if_fail (entry != NULL);
 734   g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (entry)));
 735
 736   if (!entry->tags) {
 737     entry->tags = gst_tag_list_ref (tags);
 738   } else {
 739     GstTagList *tmp = gst_tag_list_merge (entry->tags, tags, mode);
 740     gst_tag_list_unref (entry->tags);
 741     entry->tags = tmp;
 742   }
 743 }
 744
 745 /**
 746  * gst_toc_entry_get_tags:
 747  * @entry: A #GstTocEntry instance
 748  *
 749  * Gets the tags for @entry.
 750  *
 751  * Returns: (transfer none): A #GstTagList for @entry
 752  */
 753 GstTagList *
 754 gst_toc_entry_get_tags (const GstTocEntry * entry)
 755 {
 756   g_return_val_if_fail (entry != NULL, NULL);
 757
 758   return entry->tags;
 759 }
 760
 761 /**
 762  * gst_toc_entry_get_toc:
 763  * @entry: A #GstTocEntry instance
 764  *
 765  * Gets the parent #GstToc of @entry.
 766  *
 767  * Returns: (transfer none): The parent #GstToc of @entry
 768  */
 769 GstToc *
 770 gst_toc_entry_get_toc (GstTocEntry * entry)
 771 {
 772   g_return_val_if_fail (entry != NULL, NULL);
 773
 774   return entry->toc;
 775 }
 776
 777 /**
 778  * gst_toc_entry_get_parent:
 779  * @entry: A #GstTocEntry instance
 780  *
 781  * Gets the parent #GstTocEntry of @entry.
 782  *
 783  * Returns: (transfer none): The parent #GstTocEntry of @entry
 784  */
 785 GstTocEntry *
 786 gst_toc_entry_get_parent (GstTocEntry * entry)
 787 {
 788   g_return_val_if_fail (entry != NULL, NULL);
 789
 790   return entry->parent;
 791 }
 792
 793 #ifndef GST_DISABLE_GST_DEBUG
 794 static void
 795 gst_toc_dump_entries (GList * entries, guint depth)
 796 {
 797   GList *e;
 798   gchar *indent;
 799
 800   indent = g_malloc0 (depth + 1);
 801   memset (indent, ' ', depth);
 802   for (e = entries; e != NULL; e = e->next) {
 803     GstTocEntry *entry = e->data;
 804
 805     GST_TRACE ("%s+ %s (%s), %" GST_TIME_FORMAT " - %" GST_TIME_FORMAT ", "
 806         "tags: %" GST_PTR_FORMAT, indent, entry->uid,
 807         gst_toc_entry_type_get_nick (entry->type),
 808         GST_TIME_ARGS (entry->start), GST_TIME_ARGS (entry->stop), entry->tags);
 809
 810     if (entry->subentries != NULL)
 811       gst_toc_dump_entries (entry->subentries, depth + 2);
 812   }
 813   g_free (indent);
 814 }
 815 #endif
 816
 817 void
 818 gst_toc_dump (GstToc * toc)
 819 {
 820 #ifndef GST_DISABLE_GST_DEBUG
 821   GST_TRACE ("        Toc %p, scope: %s, tags: %" GST_PTR_FORMAT, toc,
 822       (toc->scope == GST_TOC_SCOPE_GLOBAL) ? "global" : "current", toc->tags);
 823   gst_toc_dump_entries (toc->entries, 2);
 824 #endif
 825 }
 826
 827 void
 828 _priv_gst_toc_initialize (void)
 829 {
 830   _gst_toc_type = gst_toc_get_type ();
 831   _gst_toc_entry_type = gst_toc_entry_get_type ();
 832 }