gst-libs/gst/tag/gsttagmux.h

   1 /* GStreamer tag muxer base class
   2  * Copyright (C) 2006 Christophe Fergeau  <teuf@gnome.org>
   3  * Copyright (C) 2006,2011 Tim-Philipp Müller <tim centricular net>
   4  * Copyright (C) 2009 Pioneers of the Inevitable <songbird@songbirdnest.com>
   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_TAG_MUX_H
  23 #define GST_TAG_MUX_H
  24
  25 #include <gst/gst.h>
  26
  27 G_BEGIN_DECLS
  28
  29 #define GST_TYPE_TAG_MUX \
  30   (gst_tag_mux_get_type())
  31 #define GST_TAG_MUX(obj) \
  32   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_TAG_MUX,GstTagMux))
  33 #define GST_TAG_MUX_CLASS(klass) \
  34   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_TAG_MUX,GstTagMuxClass))
  35 #define GST_IS_TAG_MUX(obj) \
  36   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_TAG_MUX))
  37 #define GST_IS_TAG_MUX_CLASS(klass) \
  38   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_TAG_MUX))
  39
  40 typedef struct _GstTagMux GstTagMux;
  41 typedef struct _GstTagMuxClass GstTagMuxClass;
  42 typedef struct _GstTagMuxPrivate GstTagMuxPrivate;
  43
  44 /**
  45  * GstTagMux:
  46  * @element: parent element
  47  *
  48  * Opaque #GstTagMux structure.
  49  *
  50  * Since: 0.10.36
  51  */
  52 struct _GstTagMux {
  53   GstElement    element;
  54
  55   /*< private >*/
  56   GstTagMuxPrivate *priv;
  57
  58   gpointer _gst_reserved[GST_PADDING];
  59 };
  60
  61 /**
  62  * GstTagMuxClass:
  63  * @parent_class: the parent class.
  64  * @render_start_tag: create a tag buffer to add to the beginning of the
  65  *     input stream given a tag list, or NULL
  66  * @render_end_tag: create a tag buffer to add to the end of the
  67  *     input stream given a tag list, or NULL
  68  *
  69  * The #GstTagMuxClass structure. Subclasses need to override at least one
  70  * of the two render vfuncs.
  71  *
  72  * Since: 0.10.36
  73  */
  74 struct _GstTagMuxClass {
  75   GstElementClass parent_class;
  76
  77   /* vfuncs */
  78   GstBuffer  * (*render_start_tag) (GstTagMux * mux, const GstTagList * tag_list);
  79   GstBuffer  * (*render_end_tag)   (GstTagMux * mux, const GstTagList * tag_list);
  80
  81   /*< private >*/
  82   gpointer _gst_reserved[GST_PADDING];
  83 };
  84
  85 GType gst_tag_mux_get_type (void);
  86
  87 G_END_DECLS
  88
  89 #endif