libs/gst/base/gstbasetransform.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2005 Wim Taymans <wim@fluendo.com>
   4  *
   5  * gstbasetransform.h:
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23
  24 #ifndef __GST_BASE_TRANSFORM_H__
  25 #define __GST_BASE_TRANSFORM_H__
  26
  27 #include <gst/gst.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define GST_TYPE_BASE_TRANSFORM         (gst_base_transform_get_type())
  32 #define GST_BASE_TRANSFORM(obj)         (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BASE_TRANSFORM,GstBaseTransform))
  33 #define GST_BASE_TRANSFORM_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_BASE_TRANSFORM,GstBaseTransformClass))
  34 #define GST_BASE_TRANSFORM_GET_CLASS(obj) \
  35         (G_TYPE_INSTANCE_GET_CLASS ((obj),GST_TYPE_BASE_TRANSFORM,GstBaseTransformClass))
  36 #define GST_IS_BASE_TRANSFORM(obj)      (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASE_TRANSFORM))
  37 #define GST_IS_BASE_TRANSFORM_CLASS(obj)(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASE_TRANSFORM))
  38
  39 /* the names of the templates for the sink and source pads */
  40 #define GST_BASE_TRANSFORM_SINK_NAME    "sink"
  41 #define GST_BASE_TRANSFORM_SRC_NAME     "src"
  42
  43 typedef struct _GstBaseTransform GstBaseTransform;
  44 typedef struct _GstBaseTransformClass GstBaseTransformClass;
  45
  46 struct _GstBaseTransform {
  47   GstElement     element;
  48
  49   /* source and sink pads */
  50   GstPad        *sinkpad;
  51   GstPad        *srcpad;
  52
  53   gboolean       passthrough;
  54
  55   gboolean       in_place;
  56   guint          out_size;
  57 };
  58
  59 struct _GstBaseTransformClass {
  60   GstElementClass parent_class;
  61
  62   /*< public >*/
  63   /* virtual methods for subclasses */
  64
  65   /* given caps on one pad, what can I do on the other pad */
  66   GstCaps*      (*transform_caps) (GstBaseTransform *trans, GstPad *pad,
  67                                    GstCaps *caps);
  68
  69   /* notify the subclass of new caps */
  70   gboolean      (*set_caps)     (GstBaseTransform *trans, GstCaps *incaps,
  71                                  GstCaps *outcaps);
  72
  73   /* get the size of the output buffer, -1 on error */
  74   guint         (*get_size)     (GstBaseTransform *trans);
  75
  76   /* start and stop processing, ideal for opening/closing the resource */
  77   gboolean      (*start)        (GstBaseTransform *trans);
  78   gboolean      (*stop)         (GstBaseTransform *trans);
  79
  80   gboolean      (*event)        (GstBaseTransform *trans, GstEvent *event);
  81
  82   /* transform one incoming buffer to one outgoing buffer */
  83   GstFlowReturn (*transform)    (GstBaseTransform *trans, GstBuffer *inbuf,
  84                                  GstBuffer *outbuf);
  85
  86   /* transform a buffer inplace */
  87   GstFlowReturn (*transform_ip) (GstBaseTransform *trans, GstBuffer *buf);
  88 };
  89
  90 void            gst_base_transform_set_passthrough (GstBaseTransform *trans, gboolean passthrough);
  91 gboolean        gst_base_transform_is_passthrough (GstBaseTransform *trans);
  92
  93 GType gst_base_transform_get_type (void);
  94
  95 G_END_DECLS
  96
  97 #endif /* __GST_BASE_TRANSFORM_H__ */