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  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef __GST_BASE_TRANSFORM_H__
  22 #define __GST_BASE_TRANSFORM_H__
  23
  24 #include <gst/gst.h>
  25
  26 G_BEGIN_DECLS
  27
  28 #define GST_TYPE_BASE_TRANSFORM            (gst_base_transform_get_type())
  29 #define GST_BASE_TRANSFORM(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BASE_TRANSFORM,GstBaseTransform))
  30 #define GST_BASE_TRANSFORM_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_BASE_TRANSFORM,GstBaseTransformClass))
  31 #define GST_BASE_TRANSFORM_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),GST_TYPE_BASE_TRANSFORM,GstBaseTransformClass))
  32 #define GST_IS_BASE_TRANSFORM(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASE_TRANSFORM))
  33 #define GST_IS_BASE_TRANSFORM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASE_TRANSFORM))
  34 /* since 0.10.4 */
  35 #define GST_BASE_TRANSFORM_CAST(obj)    ((GstBaseTransform *)(obj))
  36
  37 /**
  38  * GST_BASE_TRANSFORM_SINK_NAME:
  39  *
  40  * The name of the templates for the sink pad.
  41  */
  42 #define GST_BASE_TRANSFORM_SINK_NAME    "sink"
  43 /**
  44  * GST_BASE_TRANSFORM_SRC_NAME:
  45  *
  46  * The name of the templates for the source pad.
  47  */
  48 #define GST_BASE_TRANSFORM_SRC_NAME     "src"
  49
  50 /**
  51  * GST_BASE_TRANSFORM_SRC_PAD:
  52  * @obj: base transform instance
  53  *
  54  * Gives the pointer to the source #GstPad object of the element.
  55  *
  56  * Since: 0.10.4
  57  */
  58 #define GST_BASE_TRANSFORM_SRC_PAD(obj)         (GST_BASE_TRANSFORM_CAST (obj)->srcpad)
  59
  60 /**
  61  * GST_BASE_TRANSFORM_SINK_PAD:
  62  * @obj: base transform instance
  63  *
  64  * Gives the pointer to the sink #GstPad object of the element.
  65  *
  66  * Since: 0.10.4
  67  */
  68 #define GST_BASE_TRANSFORM_SINK_PAD(obj)        (GST_BASE_TRANSFORM_CAST (obj)->sinkpad)
  69
  70 /**
  71  * GST_BASE_TRANSFORM_FLOW_DROPPED:
  72  *
  73  * A #GstFlowReturn that can be returned from transform and transform_ip to
  74  * indicate that no output buffer was generated.
  75  *
  76  * Since: 0.10.13
  77  */
  78 #define GST_BASE_TRANSFORM_FLOW_DROPPED   GST_FLOW_CUSTOM_SUCCESS
  79
  80 /**
  81  * GST_BASE_TRANSFORM_LOCK:
  82  * @obj: base transform instance
  83  *
  84  * Obtain a lock to protect the transform function from concurrent access.
  85  *
  86  * Since: 0.10.13
  87  */
  88 #define GST_BASE_TRANSFORM_LOCK(obj)   g_mutex_lock (GST_BASE_TRANSFORM_CAST (obj)->transform_lock)
  89
  90 /**
  91  * GST_BASE_TRANSFORM_UNLOCK:
  92  * @obj: base transform instance
  93  *
  94  * Release the lock that protects the transform function from concurrent access.
  95  *
  96  * Since: 0.10.13
  97  */
  98 #define GST_BASE_TRANSFORM_UNLOCK(obj) g_mutex_unlock (GST_BASE_TRANSFORM_CAST (obj)->transform_lock)
  99
 100 typedef struct _GstBaseTransform GstBaseTransform;
 101 typedef struct _GstBaseTransformClass GstBaseTransformClass;
 102 typedef struct _GstBaseTransformPrivate GstBaseTransformPrivate;
 103
 104 /**
 105  * GstBaseTransform:
 106  *
 107  * The opaque #GstBaseTransform data structure.
 108  */
 109 struct _GstBaseTransform {
 110   GstElement     element;
 111
 112   /*< protected >*/
 113   /* source and sink pads */
 114   GstPad        *sinkpad;
 115   GstPad        *srcpad;
 116
 117   /* Set by sub-class */
 118   gboolean       passthrough;
 119   gboolean       always_in_place;
 120
 121   GstCaps       *cache_caps1;
 122   gsize          cache_caps1_size;
 123   GstCaps       *cache_caps2;
 124   gsize          cache_caps2_size;
 125   gboolean       have_same_caps;
 126
 127   gboolean       delay_configure;
 128   gboolean       pending_configure;
 129   gboolean       negotiated;
 130
 131   gboolean       have_segment;
 132
 133   /* MT-protected (with STREAM_LOCK) */
 134   GstSegment     segment;
 135
 136   GMutex        *transform_lock;
 137
 138   /*< private >*/
 139   GstBaseTransformPrivate *priv;
 140
 141   gpointer       _gst_reserved[GST_PADDING_LARGE];
 142 };
 143
 144 /**
 145  * GstBaseTransformClass:
 146  * @parent_class:   Element parent class
 147  * @transform_caps: Optional.  Given the pad in this direction and the given
 148  *                  caps, what caps are allowed on the other pad in this
 149  *                  element ?
 150  * @fixate_caps:    Optional. Given the pad in this direction and the given
 151  *                  caps, fixate the caps on the other pad.
 152  * @transform_size: Optional. Given the size of a buffer in the given direction
 153  *                  with the given caps, calculate the size in bytes of a buffer
 154  *                  on the other pad with the given other caps.
 155  *                  The default implementation uses get_unit_size and keeps
 156  *                  the number of units the same.
 157  * @get_unit_size:  Required if the transform is not in-place.
 158  *                  get the size in bytes of one unit for the given caps.
 159  * @set_caps:       allows the subclass to be notified of the actual caps set.
 160  * @start:          Optional.
 161  *                  Called when the element starts processing.
 162  *                  Allows opening external resources.
 163  * @stop:           Optional.
 164  *                  Called when the element stops processing.
 165  *                  Allows closing external resources.
 166  * @transform:      Required if the element does not operate in-place.
 167  *                  Transforms one incoming buffer to one outgoing buffer.
 168  *                  The function is allowed to change size/timestamp/duration
 169  *                  of the outgoing buffer.
 170  * @transform_ip:   Required if the element operates in-place.
 171  *                  Transform the incoming buffer in-place.
 172  * @event:          Optional.
 173  *                  Event handler on the sink pad. This function should return
 174  *                  TRUE if the base class should forward the event.
 175  * @src_event:      Optional.
 176  *                  Event handler on the source pad.
 177  * @passthrough_on_same_caps: If set to TRUE, passthrough mode will be
 178  *                            automatically enabled if the caps are the same.
 179  * @prepare_output_buffer: Optional.
 180  *                         Subclasses can override this to do their own
 181  *                         allocation of output buffers.  Elements that only do
 182  *                         analysis can return a subbuffer or even just
 183  *                         return a reference to the input buffer (if in
 184  *                         passthrough mode). The default implementation will
 185  *                         use the negotiated allocator or bufferpool and
 186  *                         transform_size to allocate an output buffer or it
 187  *                         will return the input buffer in passthrough mode.
 188  * @copy_metadata: Optional.
 189  *                 Copy the metadata from the input buffer to the output buffer.
 190  *                 The default implementation will copy the flags, timestamps and
 191  *                 offsets of the buffer.
 192  * @before_transform: Optional. Since 0.10.22
 193  *                    This method is called right before the base class will
 194  *                    start processing. Dynamic properties or other delayed
 195  *                    configuration could be performed in this method.
 196  * @accept_caps: Optional. Since 0.10.30
 197  *               Subclasses can override this method to check if @caps can be
 198  *               handled by the element. The default implementation might not be
 199  *               the most optimal way to check this in all cases.
 200  *
 201  * Subclasses can override any of the available virtual methods or not, as
 202  * needed. At minimum either @transform or @transform_ip need to be overridden.
 203  * If the element can overwrite the input data with the results (data is of the
 204  * same type and quantity) it should provide @transform_ip.
 205  */
 206 struct _GstBaseTransformClass {
 207   GstElementClass parent_class;
 208
 209   /*< public >*/
 210   gboolean       passthrough_on_same_caps;
 211
 212   /* virtual methods for subclasses */
 213   GstCaps*      (*transform_caps) (GstBaseTransform *trans,
 214                                    GstPadDirection direction,
 215                                    GstCaps *caps, GstCaps *filter);
 216   void          (*fixate_caps)    (GstBaseTransform *trans,
 217                                    GstPadDirection direction, GstCaps *caps,
 218                                    GstCaps *othercaps);
 219   gboolean      (*accept_caps)    (GstBaseTransform *trans, GstPadDirection direction,
 220                                    GstCaps *caps);
 221   gboolean      (*set_caps)       (GstBaseTransform *trans, GstCaps *incaps,
 222                                    GstCaps *outcaps);
 223
 224   /* setup allocation query */
 225   gboolean      (*setup_allocation) (GstBaseTransform *trans, GstQuery *query);
 226
 227   /* transform size */
 228   gboolean      (*transform_size) (GstBaseTransform *trans,
 229                                    GstPadDirection direction,
 230                                    GstCaps *caps, gsize size,
 231                                    GstCaps *othercaps, gsize *othersize);
 232
 233   gboolean      (*get_unit_size)  (GstBaseTransform *trans, GstCaps *caps,
 234                                    gsize *size);
 235
 236   /* states */
 237   gboolean      (*start)        (GstBaseTransform *trans);
 238   gboolean      (*stop)         (GstBaseTransform *trans);
 239
 240   gboolean      (*event)        (GstBaseTransform *trans, GstEvent *event);
 241   /* src event */
 242   gboolean      (*src_event)    (GstBaseTransform *trans, GstEvent *event);
 243
 244   GstFlowReturn (*prepare_output_buffer) (GstBaseTransform * trans,
 245      GstBuffer *input, GstBuffer **outbuf);
 246
 247   gboolean      (*copy_metadata) (GstBaseTransform * trans, GstBuffer *input, GstBuffer *outbuf);
 248
 249   void          (*before_transform)  (GstBaseTransform *trans, GstBuffer *buffer);
 250
 251   /* transform */
 252   GstFlowReturn (*transform)    (GstBaseTransform *trans, GstBuffer *inbuf,
 253                                  GstBuffer *outbuf);
 254   GstFlowReturn (*transform_ip) (GstBaseTransform *trans, GstBuffer *buf);
 255
 256   /*< private >*/
 257   gpointer       _gst_reserved[GST_PADDING_LARGE];
 258 };
 259
 260 GType           gst_base_transform_get_type         (void);
 261
 262 void            gst_base_transform_set_passthrough  (GstBaseTransform *trans,
 263                                                      gboolean passthrough);
 264 gboolean        gst_base_transform_is_passthrough   (GstBaseTransform *trans);
 265
 266 void            gst_base_transform_set_in_place     (GstBaseTransform *trans,
 267                                                      gboolean in_place);
 268 gboolean        gst_base_transform_is_in_place      (GstBaseTransform *trans);
 269
 270 void            gst_base_transform_update_qos       (GstBaseTransform *trans,
 271                                                      gdouble proportion,
 272                                                      GstClockTimeDiff diff,
 273                                                      GstClockTime timestamp);
 274 void            gst_base_transform_set_qos_enabled  (GstBaseTransform *trans,
 275                                                      gboolean enabled);
 276 gboolean        gst_base_transform_is_qos_enabled   (GstBaseTransform *trans);
 277
 278 void            gst_base_transform_set_gap_aware    (GstBaseTransform *trans,
 279                                                      gboolean gap_aware);
 280
 281 void            gst_base_transform_suggest          (GstBaseTransform *trans,
 282                                                      GstCaps *caps, gsize size);
 283 void            gst_base_transform_reconfigure      (GstBaseTransform *trans);
 284 G_END_DECLS
 285
 286 #endif /* __GST_BASE_TRANSFORM_H__ */