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_entry_find_sub_entry (const GstTocEntry * entry, const gchar * uid)
290 GstTocEntry *subentry, *subsubentry;
292 g_return_val_if_fail (entry != NULL, NULL);
293 g_return_val_if_fail (uid != NULL, NULL);
295 cur = entry->subentries;
296 while (cur != NULL) {
297 subentry = cur->data;
299 if (g_strcmp0 (subentry->uid, uid) == 0)
302 subsubentry = gst_toc_entry_find_sub_entry (subentry, uid);
303 if (subsubentry != NULL)
313 * gst_toc_find_entry:
314 * @toc: #GstToc to search in.
315 * @uid: UID to find #GstTocEntry with.
317 * Find #GstTocEntry with given @uid in the @toc.
319 * Returns: (transfer none): #GstTocEntry with specified @uid from the @toc, or NULL if not found.
322 gst_toc_find_entry (const GstToc * toc, const gchar * uid)
325 GstTocEntry *entry, *subentry;
327 g_return_val_if_fail (toc != NULL, NULL);
328 g_return_val_if_fail (uid != NULL, NULL);
331 while (cur != NULL) {
334 if (g_strcmp0 (entry->uid, uid) == 0)
337 subentry = gst_toc_entry_find_sub_entry (entry, uid);
338 if (subentry != NULL)
347 * gst_toc_entry_copy:
348 * @entry: #GstTocEntry to copy.
350 * Copy #GstTocEntry with all subentries (deep copy).
352 * Returns: newly allocated #GstTocEntry in case of success, NULL otherwise;
353 * free it when done with gst_toc_entry_unref().
356 gst_toc_entry_copy (const GstTocEntry * entry)
358 GstTocEntry *ret, *sub;
362 g_return_val_if_fail (entry != NULL, NULL);
364 ret = gst_toc_entry_new (entry->type, entry->uid);
366 ret->start = entry->start;
367 ret->stop = entry->stop;
369 if (GST_IS_TAG_LIST (entry->tags)) {
370 list = gst_tag_list_copy (entry->tags);
372 gst_tag_list_unref (ret->tags);
376 cur = entry->subentries;
377 while (cur != NULL) {
378 sub = gst_toc_entry_copy (cur->data);
381 ret->subentries = g_list_prepend (ret->subentries, sub);
385 ret->subentries = g_list_reverse (ret->subentries);
392 * @toc: #GstToc to copy.
394 * Copy #GstToc with all subentries (deep copy).
396 * Returns: newly allocated #GstToc in case of success, NULL otherwise;
397 * free it when done with gst_toc_free().
400 gst_toc_copy (const GstToc * toc)
407 g_return_val_if_fail (toc != NULL, NULL);
409 ret = gst_toc_new ();
411 if (GST_IS_TAG_LIST (toc->tags)) {
412 list = gst_tag_list_copy (toc->tags);
413 gst_tag_list_unref (ret->tags);
418 while (cur != NULL) {
419 entry = gst_toc_entry_copy (cur->data);
422 ret->entries = g_list_prepend (ret->entries, entry);
426 ret->entries = g_list_reverse (ret->entries);
432 * gst_toc_entry_set_start_stop_times:
433 * @entry: #GstTocEntry to set values.
434 * @start: start value to set.
435 * @stop: stop value to set.
437 * Set @start and @stop values for the @entry.
440 gst_toc_entry_set_start_stop_times (GstTocEntry * entry, gint64 start,
443 g_return_if_fail (entry != NULL);
445 entry->start = start;
450 * gst_toc_entry_get_start_stop_times:
451 * @entry: #GstTocEntry to get values from.
452 * @start: (out): the storage for the start value, leave #NULL if not need.
453 * @stop: (out): the storage for the stop value, leave #NULL if not need.
455 * Get start and stop values from the @entry and write them into appropriate storages.
457 * Returns: TRUE if all non-NULL storage pointers were filled with appropriate values,
461 gst_toc_entry_get_start_stop_times (const GstTocEntry * entry, gint64 * start,
466 g_return_val_if_fail (entry != NULL, FALSE);
469 *start = entry->start;
477 * gst_toc_entry_type_get_nick:
478 * @type: a #GstTocEntryType.
480 * Converts @type to a string representation.
482 * Returns: Returns a human-readable string for @type. This string is
483 * only for debugging purpose and should not be displayed in a user
487 gst_toc_entry_type_get_nick (GstTocEntryType type)
490 case GST_TOC_ENTRY_TYPE_ANGLE:
492 case GST_TOC_ENTRY_TYPE_VERSION:
494 case GST_TOC_ENTRY_TYPE_EDITION:
496 case GST_TOC_ENTRY_TYPE_TITLE:
498 case GST_TOC_ENTRY_TYPE_TRACK:
500 case GST_TOC_ENTRY_TYPE_CHAPTER:
509 * gst_toc_entry_get_entry_type:
510 * @entry: a #GstTocEntry
512 * Returns: @entry's entry type
515 gst_toc_entry_get_entry_type (const GstTocEntry * entry)
517 g_return_val_if_fail (entry != NULL, GST_TOC_ENTRY_TYPE_INVALID);
523 * gst_toc_entry_is_alternative:
524 * @entry: a #GstTocEntry
526 * Returns: %TRUE if @entry's type is an alternative type, otherwise %FALSE
529 gst_toc_entry_is_alternative (const GstTocEntry * entry)
531 g_return_val_if_fail (entry != NULL, FALSE);
533 return GST_TOC_ENTRY_TYPE_IS_ALTERNATIVE (entry->type);
537 * gst_toc_entry_is_sequence:
538 * @entry: a #GstTocEntry
540 * Returns: %TRUE if @entry's type is a sequence type, otherwise %FALSE
543 gst_toc_entry_is_sequence (const GstTocEntry * entry)
545 g_return_val_if_fail (entry != NULL, FALSE);
547 return GST_TOC_ENTRY_TYPE_IS_SEQUENCE (entry->type);
551 * gst_toc_entry_get_uid:
552 * @entry: A #GstTocEntry instance
554 * Gets the UID of @entry.
556 * Returns: (transfer none): The UID of @entry
559 gst_toc_entry_get_uid (const GstTocEntry * entry)
561 g_return_val_if_fail (entry != NULL, NULL);
567 * gst_toc_entry_append_sub_entry:
568 * @entry: A #GstTocEntry instance
569 * @subentry: (transfer full): A #GstTocEntry
571 * Appends the #GstTocEntry @subentry to @entry.
574 gst_toc_entry_append_sub_entry (GstTocEntry * entry, GstTocEntry * subentry)
576 g_return_if_fail (entry != NULL);
577 g_return_if_fail (subentry != NULL);
578 g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (entry)));
580 entry->subentries = g_list_append (entry->subentries, subentry);
582 GST_LOG ("appended %s subentry with uid %s to entry %s",
583 gst_toc_entry_type_get_nick (subentry->type), subentry->uid, entry->uid);
587 * gst_toc_entry_get_uid:
588 * @entry: A #GstTocEntry instance
590 * Gets the sub-entries of @entry.
592 * Returns: (transfer none) (element-type Gst.TocEntry): A #GList of #GstTocEntry of @entry
595 gst_toc_entry_get_sub_entries (const GstTocEntry * entry)
597 g_return_val_if_fail (entry != NULL, NULL);
599 return entry->subentries;
603 * gst_toc_entry_set_tags:
604 * @entry: A #GstTocEntry instance
605 * @tags: (allow-none) (transfer full): A #GstTagList or %NULL
607 * Set a #GstTagList with tags for the complete @entry.
610 gst_toc_entry_set_tags (GstTocEntry * entry, GstTagList * tags)
612 g_return_if_fail (entry != NULL);
613 g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (entry)));
616 gst_tag_list_unref (entry->tags);
621 * gst_toc_entry_merge_tags:
622 * @entry: A #GstTocEntry instance
623 * @tags: (allow-none): A #GstTagList or %NULL
624 * @mode: A #GstTagMergeMode
626 * Merge @tags into the existing tags of @entry using @mode.
629 gst_toc_entry_merge_tags (GstTocEntry * entry, GstTagList * tags,
630 GstTagMergeMode mode)
632 g_return_if_fail (entry != NULL);
633 g_return_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (entry)));
636 entry->tags = gst_tag_list_ref (tags);
638 GstTagList *tmp = gst_tag_list_merge (entry->tags, tags, mode);
639 gst_tag_list_unref (entry->tags);
645 * gst_toc_entry_get_tags:
646 * @entry: A #GstTocEntry instance
648 * Gets the tags for @entry.
650 * Returns: (transfer none): A #GstTagList for @entry
653 gst_toc_entry_get_tags (const GstTocEntry * entry)
655 g_return_val_if_fail (entry != NULL, NULL);
660 #ifndef GST_DISABLE_GST_DEBUG
662 gst_toc_dump_entries (GList * entries, guint depth)
667 indent = g_malloc0 (depth + 1);
668 memset (indent, ' ', depth);
669 for (e = entries; e != NULL; e = e->next) {
670 GstTocEntry *entry = e->data;
672 GST_TRACE ("%s+ %s (%s), %" GST_TIME_FORMAT " - %" GST_TIME_FORMAT ", "
673 "tags: %" GST_PTR_FORMAT, indent, entry->uid,
674 gst_toc_entry_type_get_nick (entry->type),
675 GST_TIME_ARGS (entry->start), GST_TIME_ARGS (entry->stop), entry->tags);
677 if (entry->subentries != NULL)
678 gst_toc_dump_entries (entry->subentries, depth + 2);
685 gst_toc_dump (GstToc * toc)
687 #ifndef GST_DISABLE_GST_DEBUG
688 GST_TRACE (" Toc %p, tags: %" GST_PTR_FORMAT, toc, toc->tags);
689 gst_toc_dump_entries (toc->entries, 2);