Add docs for wavpack elements (#352476).
[platform/upstream/gst-plugins-good.git] / ext / wavpack / gstwavpackenc.h
1 /* GStreamer Wavpack encoder plugin
2  * Copyright (c) 2006 Sebastian Dröge <slomo@circular-chaos.org>
3  *
4  * gstwavpackenc.h: Wavpack audio encoder
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public
17  * License along with this library; if not, write to the
18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19  * Boston, MA 02111-1307, USA.
20  */
21
22 #ifndef __GST_WAVPACK_ENC_H__
23 #define __GST_WAVPACK_ENC_H__
24
25 #include <gst/gst.h>
26
27 #include <wavpack/wavpack.h>
28 #include <wavpack/md5.h>
29
30 G_BEGIN_DECLS
31
32 #define GST_TYPE_WAVPACK_ENC \
33   (gst_wavpack_enc_get_type())
34 #define GST_WAVPACK_ENC(obj) \
35   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_WAVPACK_ENC,GstWavpackEnc))
36 #define GST_WAVPACK_ENC_CLASS(klass) \
37   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_WAVPACK_ENC,GstWavpackEnc))
38 #define GST_IS_WAVPACK_ENC(obj) \
39   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_WAVPACK_ENC))
40 #define GST_IS_WAVPACK_ENC_CLASS(obj) \
41   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_WAVPACK_ENC))
42
43 typedef struct _GstWavpackEnc GstWavpackEnc;
44 typedef struct _GstWavpackEncClass GstWavpackEncClass;
45
46 typedef struct
47 {
48   gboolean correction;
49   GstWavpackEnc *wavpack_enc;
50 } GstWavpackEncWriteID;
51
52
53 struct _GstWavpackEnc
54 {
55   GstElement element;
56
57   /*< private >*/
58   GstPad *sinkpad, *srcpad;
59   GstPad *wvcsrcpad;
60
61   GstFlowReturn srcpad_last_return;
62   GstFlowReturn wvcsrcpad_last_return;
63
64   WavpackConfig *wp_config;
65   WavpackContext *wp_context;
66
67   gint samplerate;
68   gint channels;
69   gint width;
70
71   GstWavpackEncWriteID *wv_id;
72   GstWavpackEncWriteID *wvc_id;
73
74   guint mode;
75   gdouble bitrate;
76   guint correction_mode;
77   gboolean md5;
78   MD5_CTX *md5_context;
79   gboolean extra_processing;
80   guint joint_stereo_mode;
81
82   void *first_block;
83   int32_t first_block_size;
84 };
85
86 struct _GstWavpackEncClass
87 {
88   GstElementClass parent;
89 };
90
91 GType gst_wavpack_enc_get_type (void);
92
93 gboolean gst_wavpack_enc_plugin_init (GstPlugin * plugin);
94
95 G_END_DECLS
96
97 #endif /* __GST_WAVPACK_ENC_H__ */