gst/gsttoc.h

   1 /* GStreamer
   2  * (c) 2010, 2012 Alexander Saprykin <xelfium@gmail.com>
   3  *
   4  * gsttoc.h: generic TOC API declaration
   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., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 #ifndef __GST_TOC_H__
  23 #define __GST_TOC_H__
  24
  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>
  30
  31 G_BEGIN_DECLS
  32
  33 #define GST_TYPE_TOC (gst_toc_get_type ())
  34 #define GST_TYPE_TOC_ENTRY (gst_toc_entry_get_type ())
  35
  36 typedef struct _GstTocEntry GstTocEntry;
  37 typedef struct _GstToc GstToc;
  38
  39 /**
  40  * GstTocEntryType:
  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)
  48  *
  49  * The different types of TOC entries (see #GstTocEntry).
  50  *
  51  * There are two types of TOC entries: alternatives or parts in a sequence.
  52  */
  53 typedef enum {
  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,
  61 } GstTocEntryType;
  62
  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)
  65
  66 /* functions to return type structures */
  67 GType           gst_toc_get_type                (void);
  68 GType           gst_toc_entry_get_type          (void);
  69
  70 /* functions to create, ref and unref/free TOCs */
  71 GstToc *           gst_toc_new                     (void);
  72
  73 void               gst_toc_set_tags                (GstToc *toc, GstTagList * tags);
  74 void               gst_toc_merge_tags              (GstToc *toc, GstTagList *tags, GstTagMergeMode mode);
  75 GstTagList *       gst_toc_get_tags                (const GstToc *toc);
  76
  77 void               gst_toc_append_entry               (GstToc *toc, GstTocEntry *entry);
  78 GList *            gst_toc_get_entries             (const GstToc *toc);
  79
  80 #define gst_toc_ref(toc)            (GstToc*)gst_mini_object_ref(GST_MINI_OBJECT_CAST(toc))
  81 #define gst_toc_unref(toc)          gst_mini_object_unref(GST_MINI_OBJECT_CAST(toc))
  82 #define gst_toc_copy(toc)           (GstToc*)gst_mini_object_copy(GST_MINI_OBJECT_CAST(toc))
  83 #define gst_toc_make_writable(toc)  (GstToc*)gst_mini_object_make_writable(GST_MINI_OBJECT_CAST(toc))
  84
  85 /* functions to create, ref and unref/free TOC entries */
  86 GstTocEntry *   gst_toc_entry_new               (GstTocEntryType type, const gchar *uid);
  87
  88 #define gst_toc_entry_ref(entry)            (GstTocEntry*)gst_mini_object_ref(GST_MINI_OBJECT_CAST(entry))
  89 #define gst_toc_entry_unref(entry)          gst_mini_object_unref(GST_MINI_OBJECT_CAST(entry))
  90 #define gst_toc_entry_copy(entry)           (GstTocEntry*)gst_mini_object_copy(GST_MINI_OBJECT_CAST(entry))
  91 #define gst_toc_entry_make_writable(entry)  (GstTocEntry*)gst_mini_object_make_writable(GST_MINI_OBJECT_CAST(entry))
  92
  93 GstTocEntry *      gst_toc_find_entry                    (const GstToc *toc, const gchar *uid);
  94
  95 GstTocEntryType    gst_toc_entry_get_entry_type          (const GstTocEntry *entry);
  96 const gchar *      gst_toc_entry_get_uid                 (const GstTocEntry *entry);
  97
  98 void               gst_toc_entry_append_sub_entry           (GstTocEntry *entry, GstTocEntry *subentry);
  99 GList *            gst_toc_entry_get_sub_entries         (const GstTocEntry *entry);
 100
 101 void               gst_toc_entry_set_tags                (GstTocEntry *entry, GstTagList *tags);
 102 void               gst_toc_entry_merge_tags              (GstTocEntry *entry, GstTagList *tags, GstTagMergeMode mode);
 103 GstTagList *       gst_toc_entry_get_tags                (const GstTocEntry *entry);
 104
 105 gboolean           gst_toc_entry_is_alternative          (const GstTocEntry *entry);
 106 gboolean           gst_toc_entry_is_sequence             (const GstTocEntry *entry);
 107
 108 void               gst_toc_entry_set_start_stop_times    (GstTocEntry *entry, gint64 start, gint64 stop);
 109 gboolean           gst_toc_entry_get_start_stop_times    (const GstTocEntry *entry, gint64 *start, gint64 *stop);
 110
 111
 112 const gchar *      gst_toc_entry_type_get_nick     (GstTocEntryType type);
 113
 114 G_END_DECLS
 115
 116 #endif /* __GST_TOC_H__ */
 117