2 * (c) 2010, 2012 Alexander Saprykin <xelfium@gmail.com>
4 * gsttoc.h: generic TOC API declaration
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.
25 #include <gst/gstconfig.h>
26 #include <gst/gstminiobject.h>
27 #include <gst/gststructure.h>
28 #include <gst/gsttaglist.h>
29 #include <gst/gstformat.h>
33 #define GST_TYPE_TOC (gst_toc_get_type ())
34 #define GST_TYPE_TOC_ENTRY (gst_toc_entry_get_type ())
36 typedef struct _GstTocEntry GstTocEntry;
37 typedef struct _GstToc GstToc;
41 * @GST_TOC_ENTRY_TYPE_ANGLE: entry is an angle (i.e. an alternative)
42 * @GST_TOC_ENTRY_TYPE_VERSION: entry is a version (i.e. alternative)
43 * @GST_TOC_ENTRY_TYPE_EDITION: entry is an edition (i.e. alternative)
44 * @GST_TOC_ENTRY_TYPE_INVALID: invalid entry type value
45 * @GST_TOC_ENTRY_TYPE_TITLE: entry is a title (i.e. a part of a sequence)
46 * @GST_TOC_ENTRY_TYPE_TRACK: entry is a track (i.e. a part of a sequence)
47 * @GST_TOC_ENTRY_TYPE_CHAPTER: entry is a chapter (i.e. a part of a sequence)
49 * The different types of TOC entries (see #GstTocEntry).
51 * There are two types of TOC entries: alternatives or parts in a sequence.
54 GST_TOC_ENTRY_TYPE_ANGLE = -3,
55 GST_TOC_ENTRY_TYPE_VERSION = -2,
56 GST_TOC_ENTRY_TYPE_EDITION = -1,
57 GST_TOC_ENTRY_TYPE_INVALID = 0,
58 GST_TOC_ENTRY_TYPE_TITLE = 1,
59 GST_TOC_ENTRY_TYPE_TRACK = 2,
60 GST_TOC_ENTRY_TYPE_CHAPTER = 3,
63 #define GST_TOC_ENTRY_TYPE_IS_ALTERNATIVE(entry_type) (entry_type < 0)
64 #define GST_TOC_ENTRY_TYPE_IS_SEQUENCE(entry_type) (entry_type > 0)
68 * @uid: unique (for a whole TOC) id of the entry. This value should be persistent and
69 * should not be changed while updating TOC. @uid should be handled as "opaque" value
70 * without meaning (e.g. applications should not assume the /editionX/chapterY/chapter/Z structure,
71 * other demuxers could do something else), it should help to track updates of certain entries.
72 * @type: #GstTocEntryType of this entry.
73 * @subentries: (element-type GstTocEntry): list of #GstTocEntry
75 * @pads: (element-type GstPad): list of #GstPad objects, related to
77 * @tags: tags related to this entry.
78 * @info: extra information related to this entry.
80 * Definition of TOC entry structure.
83 GstMiniObject mini_object;
93 gpointer _gst_reserved[GST_PADDING];
96 /* FIXME: pad member should be GstPad type, but that's
97 * impossible due to recursive includes */
101 * @entries: (element-type GstTocEntry): list of #GstTocEntry entries
103 * @tags: tags related to the whole TOC.
104 * @info: extra information related to the TOC.
106 * Definition of TOC structure.
109 GstMiniObject mini_object;
116 gpointer _gst_reserved[GST_PADDING];
119 /* functions to return type structures */
120 GType gst_toc_get_type (void);
121 GType gst_toc_entry_get_type (void);
123 /* functions to create, ref and unref/free TOCs */
124 GstToc * gst_toc_new (void);
126 #define gst_toc_ref(toc) (GstToc*)gst_mini_object_ref(GST_MINI_OBJECT_CAST(toc))
127 #define gst_toc_unref(toc) gst_mini_object_unref(GST_MINI_OBJECT_CAST(toc))
128 #define gst_toc_copy(toc) (GstToc*)gst_mini_object_copy(GST_MINI_OBJECT_CAST(toc))
129 #define gst_toc_make_writable(toc) (GstToc*)gst_mini_object_make_writable(GST_MINI_OBJECT_CAST(toc))
131 /* functions to create, ref and unref/free TOC entries */
132 GstTocEntry * gst_toc_entry_new (GstTocEntryType type, const gchar *uid);
133 GstTocEntry * gst_toc_entry_new_with_pad (GstTocEntryType type, const gchar *uid, GstPad * pad);
135 #define gst_toc_entry_ref(entry) (GstTocEntry*)gst_mini_object_ref(GST_MINI_OBJECT_CAST(entry))
136 #define gst_toc_entry_unref(entry) gst_mini_object_unref(GST_MINI_OBJECT_CAST(entry))
137 #define gst_toc_entry_copy(entry) (GstTocEntry*)gst_mini_object_copy(GST_MINI_OBJECT_CAST(entry))
138 #define gst_toc_entry_make_writable(entry) (GstTocEntry*)gst_mini_object_make_writable(GST_MINI_OBJECT_CAST(entry))
140 GstTocEntry * gst_toc_find_entry (const GstToc *toc, const gchar *uid);
142 GstTocEntryType gst_toc_entry_get_entry_type (GstTocEntry * entry);
144 gboolean gst_toc_entry_is_alternative (GstTocEntry * entry);
145 gboolean gst_toc_entry_is_sequence (GstTocEntry * entry);
147 void gst_toc_entry_set_start_stop (GstTocEntry *entry, gint64 start, gint64 stop);
148 gboolean gst_toc_entry_get_start_stop (const GstTocEntry *entry, gint64 *start, gint64 *stop);
149 const gchar * gst_toc_entry_type_get_nick (GstTocEntryType type);
153 #endif /* __GST_TOC_H__ */