libs/gst/base/gstflowcombiner.h

   1 /* GStreamer
   2  *
   3  * Copyright (C) 2014 Samsung Electronics. All rights reserved.
   4  *   Author: Thiago Santos <ts.santos@sisa.samsung.com>
   5  *
   6  * gstflowcombiner.h: utility to combine multiple flow returns into a single one
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  */
  23
  24
  25 #ifndef __GST_FLOW_COMBINER_H__
  26 #define __GST_FLOW_COMBINER_H__
  27
  28 #include <glib.h>
  29 #include <gst/gst.h>
  30 #include <gst/base/base-prelude.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define GST_TYPE_FLOW_COMBINER gst_flow_combiner_get_type()
  35
  36 /**
  37  * GstFlowCombiner:
  38  *
  39  * Opaque helper structure to aggregate flow returns.
  40  *
  41  * Since: 1.4
  42  */
  43 typedef struct _GstFlowCombiner GstFlowCombiner;
  44
  45 GST_BASE_API
  46 GstFlowCombiner * gst_flow_combiner_new (void);
  47
  48 GST_BASE_API
  49 GstFlowCombiner * gst_flow_combiner_ref (GstFlowCombiner * combiner);
  50
  51 GST_BASE_API
  52 void              gst_flow_combiner_unref (GstFlowCombiner * combiner);
  53
  54 GST_BASE_API
  55 void              gst_flow_combiner_free (GstFlowCombiner * combiner);
  56
  57 GST_BASE_API
  58 GstFlowReturn     gst_flow_combiner_update_flow (GstFlowCombiner * combiner, GstFlowReturn fret);
  59
  60 GST_BASE_API
  61 GstFlowReturn     gst_flow_combiner_update_pad_flow (GstFlowCombiner * combiner, GstPad * pad,
  62                                                      GstFlowReturn fret);
  63 GST_BASE_API
  64 void              gst_flow_combiner_add_pad    (GstFlowCombiner * combiner, GstPad * pad);
  65
  66 GST_BASE_API
  67 void              gst_flow_combiner_remove_pad (GstFlowCombiner * combiner, GstPad * pad);
  68
  69 GST_BASE_API
  70 void              gst_flow_combiner_clear (GstFlowCombiner * combiner);
  71
  72 GST_BASE_API
  73 void              gst_flow_combiner_reset (GstFlowCombiner * combiner);
  74
  75 GST_BASE_API
  76 GType             gst_flow_combiner_get_type (void);
  77
  78 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
  79 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstFlowCombiner, gst_flow_combiner_free)
  80 #endif
  81
  82 G_END_DECLS
  83
  84 #endif /* __GST_FLOW_COMBINER_H__ */