gstreamer/gst/adder/gstadder.h
Thomas Vander Stichele 29569738a6 first stab at documenting elements
Original commit message from CVS:
first stab at documenting elements
2005-08-05 17:13:10 +00:00

92 lines
2.6 KiB
C

/* GStreamer
* Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
* 2000 Wim Taymans <wtay@chello.be>
*
* gstadder.h: Header for GstAdder element
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifndef __GST_ADDER_H__
#define __GST_ADDER_H__
#include <gst/gst.h>
#include <gst/base/gstcollectpads.h>
G_BEGIN_DECLS
extern GstElementDetails gst_adder_details;
#define GST_TYPE_ADDER \
(gst_adder_get_type())
#define GST_ADDER(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ADDER,GstAdder))
#define GST_ADDER_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ADDER,GstAdderClass))
#define GST_IS_ADDER(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ADDER))
#define GST_IS_ADDER_CLASS(obj) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ADDER))
typedef struct _GstAdder GstAdder;
typedef struct _GstAdderClass GstAdderClass;
typedef struct _GstAdderInputChannel GstAdderInputChannel;
typedef enum {
GST_ADDER_FORMAT_UNSET,
GST_ADDER_FORMAT_INT,
GST_ADDER_FORMAT_FLOAT
} GstAdderFormat;
typedef void (*GstAdderFunction) (gpointer out, gpointer in, guint size);
struct _GstAdder {
GstElement element;
GstPad *srcpad;
GstCollectPads *collect;
gint numpads;
/* the next are valid for both int and float */
GstAdderFormat format;
gint rate;
gint channels;
gint width;
gint endianness;
/* the next are valid only for format == GST_ADDER_FORMAT_INT */
gint depth;
gboolean is_signed;
/* function to add samples */
GstAdderFunction func;
/* counters to keep track of timestamps */
gint64 timestamp;
gint64 offset;
};
struct _GstAdderClass {
GstElementClass parent_class;
};
GType gst_adder_get_type (void);
gboolean gst_adder_factory_init (GstElementFactory *factory);
G_END_DECLS
#endif /* __GST_ADDER_H__ */