expand tabs
[platform/upstream/gstreamer.git] / gst / adder / gstadder.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gstadder.h: Header for GstAdder element
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 #ifndef __GST_ADDER_H__
24 #define __GST_ADDER_H__
25
26 #include <gst/gst.h>
27 #include <gst/base/gstcollectpads.h>
28
29 G_BEGIN_DECLS
30
31 extern GstElementDetails gst_adder_details;
32
33 #define GST_TYPE_ADDER \
34   (gst_adder_get_type())
35 #define GST_ADDER(obj) \
36   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ADDER,GstAdder))
37 #define GST_ADDER_CLASS(klass) \
38   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ADDER,GstAdderClass))
39 #define GST_IS_ADDER(obj) \
40   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ADDER))
41 #define GST_IS_ADDER_CLASS(obj) \
42   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ADDER))
43
44 typedef struct _GstAdder             GstAdder;
45 typedef struct _GstAdderClass        GstAdderClass;
46 typedef struct _GstAdderInputChannel GstAdderInputChannel;
47
48 typedef enum {
49   GST_ADDER_FORMAT_UNSET,
50   GST_ADDER_FORMAT_INT,
51   GST_ADDER_FORMAT_FLOAT
52 } GstAdderFormat;
53
54 typedef void (*GstAdderFunction) (gpointer out, gpointer in, guint size);
55
56 struct _GstAdder {
57   GstElement      element;
58
59   GstPad         *srcpad;
60   GstCollectPads *collect;
61   gint            numpads;
62
63   /* the next are valid for both int and float */
64   GstAdderFormat  format;
65   gint            rate;
66   gint            channels;
67   gint            width;
68   gint            endianness;
69
70   /* the next are valid only for format == GST_ADDER_FORMAT_INT */
71   gint            depth;
72   gboolean        is_signed;
73
74   /* function to add samples */
75   GstAdderFunction func;
76
77   /* counters to keep track of timestamps */
78   gint64          timestamp;
79   gint64          offset;
80 };
81
82 struct _GstAdderClass {
83   GstElementClass parent_class;
84 };
85
86 GType    gst_adder_get_type (void);
87 gboolean gst_adder_factory_init (GstElementFactory *factory);
88
89 G_END_DECLS
90
91
92 #endif /* __GST_ADDER_H__ */