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., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
24 * @short_description: Generic table of contents support
25 * @see_also: #GstStructure, #GstEvent, #GstMessage, #GstQuery
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.
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
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 #GstToc.entries #GstTocEntry.subentries
39 * lists. You should use GST_TOC_ENTRY_TYPE_CHAPTER for generic TOC entry and
40 * GST_TOC_ENTRY_TYPE_EDITION for the entries which are considered to be alternatives
41 * (like DVD angles, Matroska editions and so on).
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 * Please, use #GstToc.info and #GstTocEntry.info fields in that way: create a #GstStructure,
49 * put all info related to your element there and put this structure into the info field under
50 * the name of your element. Some fields in the info structure can be used for internal purposes,
51 * so you should use it in the way described above to not to overwrite already existent fields.
53 * Use gst_event_new_toc() to create a new TOC #GstEvent, and gst_event_parse_toc() to
54 * parse received TOC event. Use gst_event_new_toc_select() to create a new TOC select #GstEvent,
55 * and gst_event_parse_toc_select() to parse received TOC select event. The same rule for
56 * the #GstMessage: gst_message_new_toc() to create new TOC #GstMessage, and
57 * gst_message_parse_toc() to parse received TOC message. Also you can create a new TOC query
58 * with gst_query_new_toc(), set it with gst_query_set_toc() and parse it with
59 * gst_query_parse_toc().
66 #include "gst_private.h"
67 #include "gstenumtypes.h"
68 #include "gsttaglist.h"
69 #include "gststructure.h"
77 GstMiniObject mini_object;
81 GstClockTime start, stop;
88 GstMiniObject mini_object;
95 static GstToc *gst_toc_copy (const GstToc * toc);
96 static void gst_toc_free (GstToc * toc);
97 #undef gst_toc_entry_copy
98 static GstTocEntry *gst_toc_entry_copy (const GstTocEntry * toc);
99 static void gst_toc_entry_free (GstTocEntry * toc);
101 GST_DEFINE_MINI_OBJECT_TYPE (GstToc, gst_toc);
102 GST_DEFINE_MINI_OBJECT_TYPE (GstTocEntry, gst_toc_entry);
107 * Create a new #GstToc structure.
109 * Returns: (transfer full): newly allocated #GstToc structure, free it
110 * with gst_toc_unref().
117 toc = g_slice_new0 (GstToc);
119 gst_mini_object_init (GST_MINI_OBJECT_CAST (toc), 0, GST_TYPE_TOC,
120 (GstMiniObjectCopyFunction) gst_toc_copy, NULL,
121 (GstMiniObjectFreeFunction) gst_toc_free);
123 toc->tags = gst_tag_list_new_empty ();
130 * @toc: A #GstToc instance
131 * @tags: (allow-none) (transfer full): A #GstTagList or %NULL
133 * Set a #GstTagList with tags for the complete @toc.
136 gst_toc_set_tags (GstToc * toc, GstTagList * tags)
138 g_return_if_fail (toc != NULL);
139 g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (toc)));
142 gst_tag_list_unref (toc->tags);
147 * gst_toc_merge_tags:
148 * @toc: A #GstToc instance
149 * @tags: (allow-none): A #GstTagList or %NULL
150 * @mode: A #GstTagMergeMode
152 * Merge @tags into the existing tags of @toc using @mode.
155 gst_toc_merge_tags (GstToc * toc, GstTagList * tags, GstTagMergeMode mode)
157 g_return_if_fail (toc != NULL);
158 g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (toc)));
161 toc->tags = gst_tag_list_ref (tags);
163 GstTagList *tmp = gst_tag_list_merge (toc->tags, tags, mode);
164 gst_tag_list_unref (toc->tags);
171 * @toc: A #GstToc instance
173 * Gets the tags for @toc.
175 * Returns: (transfer none): A #GstTagList for @entry
178 gst_toc_get_tags (const GstToc * toc)
180 g_return_val_if_fail (toc != NULL, NULL);
186 * gst_toc_append_entry:
187 * @toc: A #GstToc instance
188 * @entry: (transfer full): A #GstTocEntry
190 * Appends the #GstTocEntry @entry to @toc.
193 gst_toc_append_entry (GstToc * toc, GstTocEntry * entry)
195 g_return_if_fail (toc != NULL);
196 g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (toc)));
198 toc->entries = g_list_append (toc->entries, entry);
200 GST_LOG ("appended %s entry with uid %s to toc %p",
201 gst_toc_entry_type_get_nick (entry->type), entry->uid, toc);
207 * gst_toc_get_entries:
208 * @toc: A #GstToc instance
210 * Gets the list of #GstTocEntry of @toc.
212 * Returns: (transfer none) (element-type Gst.TocEntry): A #GList of #GstTocEntry for @entry
215 gst_toc_get_entries (const GstToc * toc)
217 g_return_val_if_fail (toc != NULL, NULL);
223 gst_toc_entry_new_internal (GstTocEntryType type, const gchar * uid)
227 entry = g_slice_new0 (GstTocEntry);
229 gst_mini_object_init (GST_MINI_OBJECT_CAST (entry), 0, GST_TYPE_TOC_ENTRY,
230 (GstMiniObjectCopyFunction) gst_toc_entry_copy, NULL,
231 (GstMiniObjectFreeFunction) gst_toc_entry_free);
233 entry->uid = g_strdup (uid);
236 entry->start = entry->stop = GST_CLOCK_TIME_NONE;
244 * @uid: unique ID (UID) in the whole TOC.
246 * Create new #GstTocEntry structure.
248 * Returns: newly allocated #GstTocEntry structure, free it with gst_toc_entry_unref().
251 gst_toc_entry_new (GstTocEntryType type, const gchar * uid)
253 g_return_val_if_fail (uid != NULL, NULL);
255 return gst_toc_entry_new_internal (type, uid);
259 gst_toc_free (GstToc * toc)
261 g_list_foreach (toc->entries, (GFunc) gst_mini_object_unref, NULL);
262 g_list_free (toc->entries);
264 if (toc->tags != NULL)
265 gst_tag_list_unref (toc->tags);
267 g_slice_free (GstToc, toc);
271 gst_toc_entry_free (GstTocEntry * entry)
273 g_return_if_fail (entry != NULL);
275 g_list_foreach (entry->subentries, (GFunc) gst_mini_object_unref, NULL);
276 g_list_free (entry->subentries);
280 if (entry->tags != NULL)
281 gst_tag_list_unref (entry->tags);
283 g_slice_free (GstTocEntry, entry);
287 gst_toc_check_entry_for_uid (const GstTocEntry * entry, const gchar * uid)
291 g_return_val_if_fail (entry != NULL, FALSE);
292 g_return_val_if_fail (uid != NULL, FALSE);
294 if (g_strcmp0 (entry->uid, uid) == 0)
297 cur = entry->subentries;
298 while (cur != NULL) {
299 if (gst_toc_check_entry_for_uid (cur->data, uid))
308 * gst_toc_find_entry:
309 * @toc: #GstToc to search in.
310 * @uid: UID to find #GstTocEntry with.
312 * Find #GstTocEntry with given @uid in the @toc.
314 * Returns: #GstTocEntry with specified @uid from the @toc, or NULL if not found.
317 gst_toc_find_entry (const GstToc * toc, const gchar * uid)
321 g_return_val_if_fail (toc != NULL, NULL);
322 g_return_val_if_fail (uid != NULL, NULL);
325 while (cur != NULL) {
326 if (gst_toc_check_entry_for_uid (cur->data, uid))
335 * gst_toc_entry_copy:
336 * @entry: #GstTocEntry to copy.
338 * Copy #GstTocEntry with all subentries (deep copy).
340 * Returns: newly allocated #GstTocEntry in case of success, NULL otherwise;
341 * free it when done with gst_toc_entry_unref().
344 gst_toc_entry_copy (const GstTocEntry * entry)
346 GstTocEntry *ret, *sub;
350 g_return_val_if_fail (entry != NULL, NULL);
352 ret = gst_toc_entry_new (entry->type, entry->uid);
354 ret->start = entry->start;
355 ret->stop = entry->stop;
357 if (GST_IS_TAG_LIST (entry->tags)) {
358 list = gst_tag_list_copy (entry->tags);
360 gst_tag_list_unref (ret->tags);
364 cur = entry->subentries;
365 while (cur != NULL) {
366 sub = gst_toc_entry_copy (cur->data);
369 ret->subentries = g_list_prepend (ret->subentries, sub);
373 ret->subentries = g_list_reverse (ret->subentries);
380 * @toc: #GstToc to copy.
382 * Copy #GstToc with all subentries (deep copy).
384 * Returns: newly allocated #GstToc in case of success, NULL otherwise;
385 * free it when done with gst_toc_free().
388 gst_toc_copy (const GstToc * toc)
395 g_return_val_if_fail (toc != NULL, NULL);
397 ret = gst_toc_new ();
399 if (GST_IS_TAG_LIST (toc->tags)) {
400 list = gst_tag_list_copy (toc->tags);
401 gst_tag_list_unref (ret->tags);
406 while (cur != NULL) {
407 entry = gst_toc_entry_copy (cur->data);
410 ret->entries = g_list_prepend (ret->entries, entry);
414 ret->entries = g_list_reverse (ret->entries);
420 * gst_toc_entry_set_start_stop_times:
421 * @entry: #GstTocEntry to set values.
422 * @start: start value to set.
423 * @stop: stop value to set.
425 * Set @start and @stop values for the @entry.
428 gst_toc_entry_set_start_stop_times (GstTocEntry * entry, gint64 start,
431 g_return_if_fail (entry != NULL);
433 entry->start = start;
438 * gst_toc_entry_get_start_stop_times:
439 * @entry: #GstTocEntry to get values from.
440 * @start: (out): the storage for the start value, leave #NULL if not need.
441 * @stop: (out): the storage for the stop value, leave #NULL if not need.
443 * Get start and stop values from the @entry and write them into appropriate storages.
445 * Returns: TRUE if all non-NULL storage pointers were filled with appropriate values,
449 gst_toc_entry_get_start_stop_times (const GstTocEntry * entry, gint64 * start,
454 g_return_val_if_fail (entry != NULL, FALSE);
457 *start = entry->start;
465 * gst_toc_entry_type_get_nick:
466 * @type: a #GstTocEntryType.
468 * Converts @type to a string representation.
470 * Returns: Returns a human-readable string for @type. This string is
471 * only for debugging purpose and should not be displayed in a user
475 gst_toc_entry_type_get_nick (GstTocEntryType type)
478 case GST_TOC_ENTRY_TYPE_ANGLE:
480 case GST_TOC_ENTRY_TYPE_VERSION:
482 case GST_TOC_ENTRY_TYPE_EDITION:
484 case GST_TOC_ENTRY_TYPE_TITLE:
486 case GST_TOC_ENTRY_TYPE_TRACK:
488 case GST_TOC_ENTRY_TYPE_CHAPTER:
497 * gst_toc_entry_get_entry_type:
498 * @entry: a #GstTocEntry
500 * Returns: @entry's entry type
503 gst_toc_entry_get_entry_type (const GstTocEntry * entry)
505 g_return_val_if_fail (entry != NULL, GST_TOC_ENTRY_TYPE_INVALID);
511 * gst_toc_entry_is_alternative:
512 * @entry: a #GstTocEntry
514 * Returns: %TRUE if @entry's type is an alternative type, otherwise %FALSE
517 gst_toc_entry_is_alternative (const GstTocEntry * entry)
519 g_return_val_if_fail (entry != NULL, FALSE);
521 return GST_TOC_ENTRY_TYPE_IS_ALTERNATIVE (entry->type);
525 * gst_toc_entry_is_sequence:
526 * @entry: a #GstTocEntry
528 * Returns: %TRUE if @entry's type is a sequence type, otherwise %FALSE
531 gst_toc_entry_is_sequence (const GstTocEntry * entry)
533 g_return_val_if_fail (entry != NULL, FALSE);
535 return GST_TOC_ENTRY_TYPE_IS_SEQUENCE (entry->type);
539 * gst_toc_entry_get_uid:
540 * @entry: A #GstTocEntry instance
542 * Gets the UID of @entry.
544 * Returns: (transfer none): The UID of @entry
547 gst_toc_entry_get_uid (const GstTocEntry * entry)
549 g_return_val_if_fail (entry != NULL, NULL);
555 * gst_toc_entry_append_sub_entry:
556 * @entry: A #GstTocEntry instance
557 * @subentry: (transfer full): A #GstTocEntry
559 * Appends the #GstTocEntry @subentry to @entry.
562 gst_toc_entry_append_sub_entry (GstTocEntry * entry, GstTocEntry * subentry)
564 g_return_if_fail (entry != NULL);
565 g_return_if_fail (subentry != NULL);
566 g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (entry)));
568 entry->subentries = g_list_append (entry->subentries, subentry);
570 GST_LOG ("appended %s subentry with uid %s to entry %s",
571 gst_toc_entry_type_get_nick (subentry->type), subentry->uid, entry->uid);
575 * gst_toc_entry_get_uid:
576 * @entry: A #GstTocEntry instance
578 * Gets the sub-entries of @entry.
580 * Returns: (transfer none) (element-type Gst.TocEntry): A #GList of #GstTocEntry of @entry
583 gst_toc_entry_get_sub_entries (const GstTocEntry * entry)
585 g_return_val_if_fail (entry != NULL, NULL);
587 return entry->subentries;
591 * gst_toc_entry_set_tags:
592 * @entry: A #GstTocEntry instance
593 * @tags: (allow-none) (transfer full): A #GstTagList or %NULL
595 * Set a #GstTagList with tags for the complete @entry.
598 gst_toc_entry_set_tags (GstTocEntry * entry, GstTagList * tags)
600 g_return_if_fail (entry != NULL);
601 g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (entry)));
604 gst_tag_list_unref (entry->tags);
609 * gst_toc_entry_merge_tags:
610 * @entry: A #GstTocEntry instance
611 * @tags: (allow-none): A #GstTagList or %NULL
612 * @mode: A #GstTagMergeMode
614 * Merge @tags into the existing tags of @entry using @mode.
617 gst_toc_entry_merge_tags (GstTocEntry * entry, GstTagList * tags,
618 GstTagMergeMode mode)
620 g_return_if_fail (entry != NULL);
621 g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (entry)));
624 entry->tags = gst_tag_list_ref (tags);
626 GstTagList *tmp = gst_tag_list_merge (entry->tags, tags, mode);
627 gst_tag_list_unref (entry->tags);
633 * gst_toc_entry_get_tags:
634 * @entry: A #GstTocEntry instance
636 * Gets the tags for @entry.
638 * Returns: (transfer none): A #GstTagList for @entry
641 gst_toc_entry_get_tags (const GstTocEntry * entry)
643 g_return_val_if_fail (entry != NULL, NULL);
648 #ifndef GST_DISABLE_GST_DEBUG
650 gst_toc_dump_entries (GList * entries, guint depth)
655 indent = g_malloc0 (depth + 1);
656 memset (indent, ' ', depth);
657 for (e = entries; e != NULL; e = e->next) {
658 GstTocEntry *entry = e->data;
660 GST_TRACE ("%s+ %s (%s), %" GST_TIME_FORMAT " - %" GST_TIME_FORMAT ", "
661 "tags: %" GST_PTR_FORMAT, indent, entry->uid,
662 gst_toc_entry_type_get_nick (entry->type),
663 GST_TIME_ARGS (entry->start), GST_TIME_ARGS (entry->stop), entry->tags);
665 if (entry->subentries != NULL)
666 gst_toc_dump_entries (entry->subentries, depth + 2);
673 gst_toc_dump (GstToc * toc)
675 #ifndef GST_DISABLE_GST_DEBUG
676 GST_TRACE (" Toc %p, tags: %" GST_PTR_FORMAT, toc, toc->tags);
677 gst_toc_dump_entries (toc->entries, 2);