2 * (c) 2010, 2012 Alexander Saprykin <xelfium@gmail.com>
4 * gsttoc.c: GstToc initialization and parsing/creation
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.
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.
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.
25 * @short_description: Generic table of contents support
26 * @see_also: #GstStructure, #GstEvent, #GstMessage, #GstQuery
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.
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
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().
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
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.
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.
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).
79 #include "gst_private.h"
80 #include "gstenumtypes.h"
81 #include "gsttaglist.h"
82 #include "gststructure.h"
90 GstMiniObject mini_object;
97 GstClockTime start, stop;
100 GstTocLoopType loop_type;
106 GstMiniObject mini_object;
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);
120 GType _gst_toc_type = 0;
121 GType _gst_toc_entry_type = 0;
123 GST_DEFINE_MINI_OBJECT_TYPE (GstToc, gst_toc);
124 GST_DEFINE_MINI_OBJECT_TYPE (GstTocEntry, gst_toc_entry);
128 * @scope: scope of this TOC
130 * Create a new #GstToc structure.
132 * Returns: (transfer full): newly allocated #GstToc structure, free it
133 * with gst_toc_unref().
136 gst_toc_new (GstTocScope scope)
140 g_return_val_if_fail (scope == GST_TOC_SCOPE_GLOBAL ||
141 scope == GST_TOC_SCOPE_CURRENT, NULL);
143 toc = g_slice_new0 (GstToc);
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);
150 toc->tags = gst_tag_list_new_empty ();
157 * @toc: a #GstToc instance
159 * Returns: scope of @toc
162 gst_toc_get_scope (const GstToc * toc)
164 g_return_val_if_fail (toc != NULL, GST_TOC_SCOPE_GLOBAL);
171 * @toc: A #GstToc instance
172 * @tags: (allow-none) (transfer full): A #GstTagList or %NULL
174 * Set a #GstTagList with tags for the complete @toc.
177 gst_toc_set_tags (GstToc * toc, GstTagList * tags)
179 g_return_if_fail (toc != NULL);
180 g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (toc)));
183 gst_tag_list_unref (toc->tags);
188 * gst_toc_merge_tags:
189 * @toc: A #GstToc instance
190 * @tags: (allow-none): A #GstTagList or %NULL
191 * @mode: A #GstTagMergeMode
193 * Merge @tags into the existing tags of @toc using @mode.
196 gst_toc_merge_tags (GstToc * toc, GstTagList * tags, GstTagMergeMode mode)
198 g_return_if_fail (toc != NULL);
199 g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (toc)));
202 toc->tags = gst_tag_list_ref (tags);
204 GstTagList *tmp = gst_tag_list_merge (toc->tags, tags, mode);
205 gst_tag_list_unref (toc->tags);
212 * @toc: A #GstToc instance
214 * Gets the tags for @toc.
216 * Returns: (transfer none): A #GstTagList for @entry
219 gst_toc_get_tags (const GstToc * toc)
221 g_return_val_if_fail (toc != NULL, NULL);
227 * gst_toc_append_entry:
228 * @toc: A #GstToc instance
229 * @entry: (transfer full): A #GstTocEntry
231 * Appends the #GstTocEntry @entry to @toc.
234 gst_toc_append_entry (GstToc * toc, GstTocEntry * entry)
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);
242 toc->entries = g_list_append (toc->entries, entry);
245 GST_LOG ("appended %s entry with uid %s to toc %p",
246 gst_toc_entry_type_get_nick (entry->type), entry->uid, toc);
252 * gst_toc_get_entries:
253 * @toc: A #GstToc instance
255 * Gets the list of #GstTocEntry of @toc.
257 * Returns: (transfer none) (element-type Gst.TocEntry): A #GList of #GstTocEntry for @entry
260 gst_toc_get_entries (const GstToc * toc)
262 g_return_val_if_fail (toc != NULL, NULL);
268 gst_toc_entry_new_internal (GstTocEntryType type, const gchar * uid)
272 entry = g_slice_new0 (GstTocEntry);
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);
278 entry->uid = g_strdup (uid);
281 entry->start = entry->stop = GST_CLOCK_TIME_NONE;
289 * @uid: unique ID (UID) in the whole TOC.
291 * Create new #GstTocEntry structure.
293 * Returns: newly allocated #GstTocEntry structure, free it with gst_toc_entry_unref().
296 gst_toc_entry_new (GstTocEntryType type, const gchar * uid)
298 g_return_val_if_fail (uid != NULL, NULL);
300 return gst_toc_entry_new_internal (type, uid);
304 gst_toc_free (GstToc * toc)
306 g_list_foreach (toc->entries, (GFunc) gst_mini_object_unref, NULL);
307 g_list_free (toc->entries);
309 if (toc->tags != NULL)
310 gst_tag_list_unref (toc->tags);
313 memset (toc, 0xff, sizeof (GstToc));
316 g_slice_free (GstToc, toc);
320 gst_toc_entry_free (GstTocEntry * entry)
322 g_return_if_fail (entry != NULL);
324 g_list_foreach (entry->subentries, (GFunc) gst_mini_object_unref, NULL);
325 g_list_free (entry->subentries);
329 if (entry->tags != NULL)
330 gst_tag_list_unref (entry->tags);
333 memset (entry, 0xff, sizeof (GstTocEntry));
336 g_slice_free (GstTocEntry, entry);
340 gst_toc_entry_find_sub_entry (const GstTocEntry * entry, const gchar * uid)
343 GstTocEntry *subentry, *subsubentry;
345 g_return_val_if_fail (entry != NULL, NULL);
346 g_return_val_if_fail (uid != NULL, NULL);
348 cur = entry->subentries;
349 while (cur != NULL) {
350 subentry = cur->data;
352 if (g_strcmp0 (subentry->uid, uid) == 0)
355 subsubentry = gst_toc_entry_find_sub_entry (subentry, uid);
356 if (subsubentry != NULL)
366 * gst_toc_find_entry:
367 * @toc: #GstToc to search in.
368 * @uid: UID to find #GstTocEntry with.
370 * Find #GstTocEntry with given @uid in the @toc.
372 * Returns: (transfer none) (nullable): #GstTocEntry with specified
373 * @uid from the @toc, or %NULL if not found.
376 gst_toc_find_entry (const GstToc * toc, const gchar * uid)
379 GstTocEntry *entry, *subentry;
381 g_return_val_if_fail (toc != NULL, NULL);
382 g_return_val_if_fail (uid != NULL, NULL);
385 while (cur != NULL) {
388 if (g_strcmp0 (entry->uid, uid) == 0)
391 subentry = gst_toc_entry_find_sub_entry (entry, uid);
392 if (subentry != NULL)
401 gst_toc_deep_copy_toc_entries (GList * entry_list)
403 GQueue new_entries = G_QUEUE_INIT;
406 for (l = entry_list; l != NULL; l = l->next)
407 g_queue_push_tail (&new_entries, gst_toc_entry_copy (l->data));
409 return new_entries.head;
413 * gst_toc_entry_copy:
414 * @entry: #GstTocEntry to copy.
416 * Copy #GstTocEntry with all subentries (deep copy).
418 * Returns: (nullable): newly allocated #GstTocEntry in case of
419 * success, %NULL otherwise; free it when done with
420 * gst_toc_entry_unref().
423 gst_toc_entry_copy (const GstTocEntry * entry)
428 g_return_val_if_fail (entry != NULL, NULL);
430 ret = gst_toc_entry_new (entry->type, entry->uid);
432 ret->start = entry->start;
433 ret->stop = entry->stop;
435 if (GST_IS_TAG_LIST (entry->tags)) {
436 list = gst_tag_list_copy (entry->tags);
438 gst_tag_list_unref (ret->tags);
442 ret->subentries = gst_toc_deep_copy_toc_entries (entry->subentries);
449 * @toc: #GstToc to copy.
451 * Copy #GstToc with all subentries (deep copy).
453 * Returns: (nullable): newly allocated #GstToc in case of success,
454 * %NULL otherwise; free it when done with gst_toc_unref().
457 gst_toc_copy (const GstToc * toc)
462 g_return_val_if_fail (toc != NULL, NULL);
464 ret = gst_toc_new (toc->scope);
466 if (GST_IS_TAG_LIST (toc->tags)) {
467 list = gst_tag_list_copy (toc->tags);
468 gst_tag_list_unref (ret->tags);
472 ret->entries = gst_toc_deep_copy_toc_entries (toc->entries);
478 * gst_toc_entry_set_start_stop_times:
479 * @entry: #GstTocEntry to set values.
480 * @start: start value to set.
481 * @stop: stop value to set.
483 * Set @start and @stop values for the @entry.
486 gst_toc_entry_set_start_stop_times (GstTocEntry * entry, gint64 start,
489 g_return_if_fail (entry != NULL);
491 entry->start = start;
496 * gst_toc_entry_get_start_stop_times:
497 * @entry: #GstTocEntry to get values from.
498 * @start: (out) (allow-none): the storage for the start value, leave
500 * @stop: (out) (allow-none): the storage for the stop value, leave
503 * Get @start and @stop values from the @entry and write them into appropriate
506 * Returns: %TRUE if all non-%NULL storage pointers were filled with appropriate
507 * values, %FALSE otherwise.
510 gst_toc_entry_get_start_stop_times (const GstTocEntry * entry, gint64 * start,
513 g_return_val_if_fail (entry != NULL, FALSE);
516 *start = entry->start;
524 * gst_toc_entry_set_loop:
525 * @entry: #GstTocEntry to set values.
526 * @loop_type: loop_type value to set.
527 * @repeat_count: repeat_count value to set.
529 * Set @loop_type and @repeat_count values for the @entry.
534 gst_toc_entry_set_loop (GstTocEntry * entry, GstTocLoopType loop_type,
537 g_return_if_fail (entry != NULL);
539 entry->loop_type = loop_type;
540 entry->repeat_count = repeat_count;
544 * gst_toc_entry_get_loop:
545 * @entry: #GstTocEntry to get values from.
546 * @loop_type: (out) (allow-none): the storage for the loop_type
547 * value, leave %NULL if not need.
548 * @repeat_count: (out) (allow-none): the storage for the repeat_count
549 * value, leave %NULL if not need.
551 * Get @loop_type and @repeat_count values from the @entry and write them into
552 * appropriate storages. Loops are e.g. used by sampled instruments. GStreamer
553 * is not automatically applying the loop. The application can process this
554 * meta data and use it e.g. to send a seek-event to loop a section.
556 * Returns: %TRUE if all non-%NULL storage pointers were filled with appropriate
557 * values, %FALSE otherwise.
562 gst_toc_entry_get_loop (const GstTocEntry * entry, GstTocLoopType * loop_type,
565 g_return_val_if_fail (entry != NULL, FALSE);
567 if (loop_type != NULL)
568 *loop_type = entry->loop_type;
569 if (repeat_count != NULL)
570 *repeat_count = entry->repeat_count;
577 * gst_toc_entry_type_get_nick:
578 * @type: a #GstTocEntryType.
580 * Converts @type to a string representation.
582 * Returns: Returns a human-readable string for @type. This string is
583 * only for debugging purpose and should not be displayed in a user
587 gst_toc_entry_type_get_nick (GstTocEntryType type)
590 case GST_TOC_ENTRY_TYPE_ANGLE:
592 case GST_TOC_ENTRY_TYPE_VERSION:
594 case GST_TOC_ENTRY_TYPE_EDITION:
596 case GST_TOC_ENTRY_TYPE_TITLE:
598 case GST_TOC_ENTRY_TYPE_TRACK:
600 case GST_TOC_ENTRY_TYPE_CHAPTER:
609 * gst_toc_entry_get_entry_type:
610 * @entry: a #GstTocEntry
612 * Returns: @entry's entry type
615 gst_toc_entry_get_entry_type (const GstTocEntry * entry)
617 g_return_val_if_fail (entry != NULL, GST_TOC_ENTRY_TYPE_INVALID);
623 * gst_toc_entry_is_alternative:
624 * @entry: a #GstTocEntry
626 * Returns: %TRUE if @entry's type is an alternative type, otherwise %FALSE
629 gst_toc_entry_is_alternative (const GstTocEntry * entry)
631 g_return_val_if_fail (entry != NULL, FALSE);
633 return GST_TOC_ENTRY_TYPE_IS_ALTERNATIVE (entry->type);
637 * gst_toc_entry_is_sequence:
638 * @entry: a #GstTocEntry
640 * Returns: %TRUE if @entry's type is a sequence type, otherwise %FALSE
643 gst_toc_entry_is_sequence (const GstTocEntry * entry)
645 g_return_val_if_fail (entry != NULL, FALSE);
647 return GST_TOC_ENTRY_TYPE_IS_SEQUENCE (entry->type);
651 * gst_toc_entry_get_uid:
652 * @entry: A #GstTocEntry instance
654 * Gets the UID of @entry.
656 * Returns: (transfer none): The UID of @entry
659 gst_toc_entry_get_uid (const GstTocEntry * entry)
661 g_return_val_if_fail (entry != NULL, NULL);
667 * gst_toc_entry_append_sub_entry:
668 * @entry: A #GstTocEntry instance
669 * @subentry: (transfer full): A #GstTocEntry
671 * Appends the #GstTocEntry @subentry to @entry.
674 gst_toc_entry_append_sub_entry (GstTocEntry * entry, GstTocEntry * subentry)
676 g_return_if_fail (entry != NULL);
677 g_return_if_fail (subentry != NULL);
678 g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (entry)));
679 g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST
681 g_return_if_fail (subentry->toc == NULL);
682 g_return_if_fail (subentry->parent == NULL);
684 entry->subentries = g_list_append (entry->subentries, subentry);
685 subentry->toc = entry->toc;
686 subentry->parent = entry;
688 GST_LOG ("appended %s subentry with uid %s to entry %s",
689 gst_toc_entry_type_get_nick (subentry->type), subentry->uid, entry->uid);
693 * gst_toc_entry_get_sub_entries:
694 * @entry: A #GstTocEntry instance
696 * Gets the sub-entries of @entry.
698 * Returns: (transfer none) (element-type Gst.TocEntry): A #GList of #GstTocEntry of @entry
701 gst_toc_entry_get_sub_entries (const GstTocEntry * entry)
703 g_return_val_if_fail (entry != NULL, NULL);
705 return entry->subentries;
709 * gst_toc_entry_set_tags:
710 * @entry: A #GstTocEntry instance
711 * @tags: (allow-none) (transfer full): A #GstTagList or %NULL
713 * Set a #GstTagList with tags for the complete @entry.
716 gst_toc_entry_set_tags (GstTocEntry * entry, GstTagList * tags)
718 g_return_if_fail (entry != NULL);
719 g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (entry)));
722 gst_tag_list_unref (entry->tags);
727 * gst_toc_entry_merge_tags:
728 * @entry: A #GstTocEntry instance
729 * @tags: (allow-none): A #GstTagList or %NULL
730 * @mode: A #GstTagMergeMode
732 * Merge @tags into the existing tags of @entry using @mode.
735 gst_toc_entry_merge_tags (GstTocEntry * entry, GstTagList * tags,
736 GstTagMergeMode mode)
738 g_return_if_fail (entry != NULL);
739 g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (entry)));
742 entry->tags = gst_tag_list_ref (tags);
744 GstTagList *tmp = gst_tag_list_merge (entry->tags, tags, mode);
745 gst_tag_list_unref (entry->tags);
751 * gst_toc_entry_get_tags:
752 * @entry: A #GstTocEntry instance
754 * Gets the tags for @entry.
756 * Returns: (transfer none): A #GstTagList for @entry
759 gst_toc_entry_get_tags (const GstTocEntry * entry)
761 g_return_val_if_fail (entry != NULL, NULL);
767 * gst_toc_entry_get_toc:
768 * @entry: A #GstTocEntry instance
770 * Gets the parent #GstToc of @entry.
772 * Returns: (transfer none): The parent #GstToc of @entry
775 gst_toc_entry_get_toc (GstTocEntry * entry)
777 g_return_val_if_fail (entry != NULL, NULL);
783 * gst_toc_entry_get_parent:
784 * @entry: A #GstTocEntry instance
786 * Gets the parent #GstTocEntry of @entry.
788 * Returns: (transfer none) (nullable): The parent #GstTocEntry of @entry
791 gst_toc_entry_get_parent (GstTocEntry * entry)
793 g_return_val_if_fail (entry != NULL, NULL);
795 return entry->parent;
798 #ifndef GST_DISABLE_GST_DEBUG
800 gst_toc_dump_entries (GList * entries, guint depth)
805 indent = g_malloc0 (depth + 1);
806 memset (indent, ' ', depth);
807 for (e = entries; e != NULL; e = e->next) {
808 GstTocEntry *entry = e->data;
810 GST_TRACE ("%s+ %s (%s), %" GST_TIME_FORMAT " - %" GST_TIME_FORMAT ", "
811 "tags: %" GST_PTR_FORMAT, indent, entry->uid,
812 gst_toc_entry_type_get_nick (entry->type),
813 GST_TIME_ARGS (entry->start), GST_TIME_ARGS (entry->stop), entry->tags);
815 if (entry->subentries != NULL)
816 gst_toc_dump_entries (entry->subentries, depth + 2);
823 gst_toc_dump (GstToc * toc)
825 #ifndef GST_DISABLE_GST_DEBUG
826 GST_TRACE (" Toc %p, scope: %s, tags: %" GST_PTR_FORMAT, toc,
827 (toc->scope == GST_TOC_SCOPE_GLOBAL) ? "global" : "current", toc->tags);
828 gst_toc_dump_entries (toc->entries, 2);
833 _priv_gst_toc_initialize (void)
835 _gst_toc_type = gst_toc_get_type ();
836 _gst_toc_entry_type = gst_toc_entry_get_type ();