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 typedef struct _GstBaseTransform GstBaseTransform;
  81 typedef struct _GstBaseTransformClass GstBaseTransformClass;
  82 typedef struct _GstBaseTransformPrivate GstBaseTransformPrivate;
  83
  84 /**
  85  * GstBaseTransform:
  86  *
  87  * The opaque #GstBaseTransform data structure.
  88  */
  89 struct _GstBaseTransform {
  90   GstElement     element;
  91
  92   /*< protected >*/
  93   /* source and sink pads */
  94   GstPad        *sinkpad;
  95   GstPad        *srcpad;
  96
  97   /* MT-protected (with STREAM_LOCK) */
  98   gboolean       have_segment;
  99   GstSegment     segment;
 100
 101   /*< private >*/
 102   GstBaseTransformPrivate *priv;
 103
 104   gpointer       _gst_reserved[GST_PADDING_LARGE];
 105 };
 106
 107 /**
 108  * GstBaseTransformClass:
 109  * @parent_class:   Element parent class
 110  * @passthrough_on_same_caps: If set to TRUE, passthrough mode will be
 111  *                            automatically enabled if the caps are the same.
 112  * @transform_caps: Optional.  Given the pad in this direction and the given
 113  *                  caps, what caps are allowed on the other pad in this
 114  *                  element ?
 115  * @fixate_caps:    Optional. Given the pad in this direction and the given
 116  *                  caps, fixate the caps on the other pad. The function takes
 117  *                  ownership of @othercaps and returns a fixated version of
 118  *                  @othercaps. @othercaps is not guaranteed to be writable.
 119  * @accept_caps:    Optional. Since 0.10.30
 120  *                  Subclasses can override this method to check if @caps can be
 121  *                  handled by the element. The default implementation might not be
 122  *                  the most optimal way to check this in all cases.
 123  * @set_caps:       allows the subclass to be notified of the actual caps set.
 124  * @query:          Optional Since 0.10.36
 125  *                  Handle a requested query. Subclasses that implement this
 126  *                  should must chain up to the parent if they didn't handle the
 127  *                  query
 128  * @decide_allocation: Setup the allocation parameters for allocating output
 129  *                    buffers. The passed in query contains the result of the
 130  *                    downstream allocation query. This function is only called
 131  *                    when not operating in passthrough mode. The default
 132  *                    implementation will remove all memory dependent metadata.
 133  *                    If there is ia @filter_meta method implementation, it will
 134  *                    be called for all metadata API in the downstream query,
 135  *                    otherwise the metadata API is removed.
 136  * @filter_meta: Return TRUE if the metadata API should be proposed in the
 137  *               upstream allocation query. The default implementation is NULL
 138  *               and will cause all metadata to be removed.
 139  * @propose_allocation: Propose buffer allocation parameters for upstream elements.
 140  *                      This function must be implemented if the element reads or
 141  *                      writes the buffer content. The query that was passed to
 142  *                      the decide_allocation is passed in this method (or NULL
 143  *                      when the element is in passthrough mode). The default
 144  *                      implementation will pass the query downstream when in
 145  *                      passthrough mode and will copy all the filtered metadata
 146  *                      API in non-passthrough mode.
 147  * @transform_size: Optional. Given the size of a buffer in the given direction
 148  *                  with the given caps, calculate the size in bytes of a buffer
 149  *                  on the other pad with the given other caps.
 150  *                  The default implementation uses get_unit_size and keeps
 151  *                  the number of units the same.
 152  * @get_unit_size:  Required if the transform is not in-place.
 153  *                  get the size in bytes of one unit for the given caps.
 154  * @start:          Optional.
 155  *                  Called when the element starts processing.
 156  *                  Allows opening external resources.
 157  * @stop:           Optional.
 158  *                  Called when the element stops processing.
 159  *                  Allows closing external resources.
 160  * @sink_event:     Optional.
 161  *                  Event handler on the sink pad. The default implementation
 162  *                  handles the event and forwards it downstream.
 163  * @src_event:      Optional.
 164  *                  Event handler on the source pad. The default implementation
 165  *                  handles the event and forwards it upstream.
 166  * @prepare_output_buffer: Optional.
 167  *                         Subclasses can override this to do their own
 168  *                         allocation of output buffers.  Elements that only do
 169  *                         analysis can return a subbuffer or even just
 170  *                         return a reference to the input buffer (if in
 171  *                         passthrough mode). The default implementation will
 172  *                         use the negotiated allocator or bufferpool and
 173  *                         transform_size to allocate an output buffer or it
 174  *                         will return the input buffer in passthrough mode.
 175  * @copy_metadata: Optional.
 176  *                 Copy the metadata from the input buffer to the output buffer.
 177  *                 The default implementation will copy the flags, timestamps and
 178  *                 offsets of the buffer.
 179  * @transform_meta: Optional. Transform the metadata on the input buffer to the
 180  *                  output buffer. By default this method is NULL and no
 181  *                  metadata is copied. subclasses can implement this method and
 182  *                  return TRUE if the metadata is to be copied.
 183  * @before_transform: Optional. Since 0.10.22
 184  *                    This method is called right before the base class will
 185  *                    start processing. Dynamic properties or other delayed
 186  *                    configuration could be performed in this method.
 187  * @transform:      Required if the element does not operate in-place.
 188  *                  Transforms one incoming buffer to one outgoing buffer.
 189  *                  The function is allowed to change size/timestamp/duration
 190  *                  of the outgoing buffer.
 191  * @transform_ip:   Required if the element operates in-place.
 192  *                  Transform the incoming buffer in-place.
 193  *
 194  * Subclasses can override any of the available virtual methods or not, as
 195  * needed. At minimum either @transform or @transform_ip need to be overridden.
 196  * If the element can overwrite the input data with the results (data is of the
 197  * same type and quantity) it should provide @transform_ip.
 198  */
 199 struct _GstBaseTransformClass {
 200   GstElementClass parent_class;
 201
 202   /*< public >*/
 203   gboolean       passthrough_on_same_caps;
 204
 205   /* virtual methods for subclasses */
 206   GstCaps*      (*transform_caps) (GstBaseTransform *trans,
 207                                    GstPadDirection direction,
 208                                    GstCaps *caps, GstCaps *filter);
 209   GstCaps*      (*fixate_caps)    (GstBaseTransform *trans,
 210                                    GstPadDirection direction, GstCaps *caps,
 211                                    GstCaps *othercaps);
 212   gboolean      (*accept_caps)    (GstBaseTransform *trans, GstPadDirection direction,
 213                                    GstCaps *caps);
 214   gboolean      (*set_caps)       (GstBaseTransform *trans, GstCaps *incaps,
 215                                    GstCaps *outcaps);
 216   gboolean      (*query)          (GstBaseTransform *trans, GstPadDirection direction,
 217                                    GstQuery *query);
 218
 219   /* decide allocation query for output buffers */
 220   gboolean      (*decide_allocation)  (GstBaseTransform *trans, GstQuery *query);
 221   gboolean      (*filter_meta)        (GstBaseTransform *trans, GstQuery *query, GType api);
 222
 223   /* propose allocation query parameters for input buffers */
 224   gboolean      (*propose_allocation) (GstBaseTransform *trans, GstQuery *decide_query,
 225                                        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   /* sink and src pad event handlers */
 241   gboolean      (*sink_event)   (GstBaseTransform *trans, GstEvent *event);
 242   gboolean      (*src_event)    (GstBaseTransform *trans, GstEvent *event);
 243
 244   GstFlowReturn (*prepare_output_buffer) (GstBaseTransform * trans,
 245                                           GstBuffer *input, GstBuffer **outbuf);
 246
 247   /* metadata */
 248   gboolean      (*copy_metadata)     (GstBaseTransform *trans, GstBuffer *input,
 249                                       GstBuffer *outbuf);
 250   gboolean      (*transform_meta)    (GstBaseTransform *trans, GstBuffer *outbuf,
 251                                       GstMeta *meta, GstBuffer *inbuf);
 252
 253   void          (*before_transform)  (GstBaseTransform *trans, GstBuffer *buffer);
 254
 255   /* transform */
 256   GstFlowReturn (*transform)    (GstBaseTransform *trans, GstBuffer *inbuf,
 257                                  GstBuffer *outbuf);
 258   GstFlowReturn (*transform_ip) (GstBaseTransform *trans, GstBuffer *buf);
 259
 260   /*< private >*/
 261   gpointer       _gst_reserved[GST_PADDING_LARGE];
 262 };
 263
 264 GType           gst_base_transform_get_type         (void);
 265
 266 void            gst_base_transform_set_passthrough  (GstBaseTransform *trans,
 267                                                      gboolean passthrough);
 268 gboolean        gst_base_transform_is_passthrough   (GstBaseTransform *trans);
 269
 270 void            gst_base_transform_set_in_place     (GstBaseTransform *trans,
 271                                                      gboolean in_place);
 272 gboolean        gst_base_transform_is_in_place      (GstBaseTransform *trans);
 273
 274 void            gst_base_transform_update_qos       (GstBaseTransform *trans,
 275                                                      gdouble proportion,
 276                                                      GstClockTimeDiff diff,
 277                                                      GstClockTime timestamp);
 278 void            gst_base_transform_set_qos_enabled  (GstBaseTransform *trans,
 279                                                      gboolean enabled);
 280 gboolean        gst_base_transform_is_qos_enabled   (GstBaseTransform *trans);
 281
 282 void            gst_base_transform_set_gap_aware    (GstBaseTransform *trans,
 283                                                      gboolean gap_aware);
 284
 285 void            gst_base_transform_reconfigure_sink (GstBaseTransform *trans);
 286 void            gst_base_transform_reconfigure_src  (GstBaseTransform *trans);
 287 G_END_DECLS
 288
 289 #endif /* __GST_BASE_TRANSFORM_H__ */