gst/audioconvert/: Implement dithering and noise shaping in audioconvert. By default now
[platform/upstream/gstreamer.git] / gst / audioconvert / audioconvert.h
1 /* GStreamer
2  * Copyright (C) 2004 Ronald Bultje <rbultje@ronald.bitfreak.net>
3  *
4  * audioconvert.h: audio format conversion library
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 __AUDIO_CONVERT_H__
23 #define __AUDIO_CONVERT_H__
24
25 #include <gst/gst.h>
26 #include <gst/audio/multichannel.h>
27
28 typedef enum
29 {
30   DITHER_NONE = 0,
31   DITHER_RPDF,
32   DITHER_TPDF,
33   DITHER_TPDF_HF
34 } DitherType;
35
36 typedef enum
37 {
38   NOISE_SHAPING_NONE = 0,
39   NOISE_SHAPING_ERROR_FEEDBACK,
40   NOISE_SHAPING_SIMPLE,
41   NOISE_SHAPING_MEDIUM,
42   NOISE_SHAPING_HIGH
43 } NoiseShapingType;
44
45 typedef struct _AudioConvertCtx AudioConvertCtx;
46 typedef struct _AudioConvertFmt AudioConvertFmt;
47
48 struct _AudioConvertFmt
49 {
50   /* general caps */
51   gboolean is_int;
52   gint endianness;
53   gint width;
54   gint rate;
55   gint channels;
56   GstAudioChannelPosition *pos;
57
58   /* int audio caps */
59   gboolean sign;
60   gint depth;
61
62   gint unit_size;
63 };
64
65 typedef void (*AudioConvertUnpack) (gpointer src, gpointer dst, gint scale,
66     gint count);
67 typedef void (*AudioConvertPack) (gpointer src, gpointer dst, gint scale,
68     gint count);
69
70 typedef void (*AudioConvertMix) (AudioConvertCtx *, gpointer, gpointer, gint);
71 typedef void (*AudioConvertQuantize) (AudioConvertCtx * ctx, gpointer src,
72     gpointer dst, gint count);
73
74 struct _AudioConvertCtx
75 {
76   AudioConvertFmt in;
77   AudioConvertFmt out;
78
79   AudioConvertUnpack unpack;
80   AudioConvertPack pack;
81
82   /* channel conversion matrix, m[in_channels][out_channels].
83    * If identity matrix, passthrough applies. */
84   gfloat **matrix;
85   /* temp storage for channelmix */
86   gpointer tmp;
87
88   gboolean in_default;
89   gboolean mix_passthrough;
90   gboolean out_default;
91
92   gpointer tmpbuf;
93   gint tmpbufsize;
94
95   gint in_scale;
96   gint out_scale;
97
98   AudioConvertMix channel_mix;
99
100   AudioConvertQuantize quantize;
101   DitherType dither;
102   NoiseShapingType ns;
103   /* random number generate for dither noise */
104   GRand *dither_random;
105   /* last random number generated per channel for hifreq TPDF dither */
106   gpointer last_random;
107   /* contains the past quantization errors, error[out_channels][count] */
108   gdouble *error_buf;
109 };
110
111 gboolean audio_convert_clean_fmt (AudioConvertFmt * fmt);
112
113 gboolean audio_convert_prepare_context (AudioConvertCtx * ctx,
114     AudioConvertFmt * in, AudioConvertFmt * out, DitherType dither,
115     NoiseShapingType ns);
116 gboolean audio_convert_get_sizes (AudioConvertCtx * ctx, gint samples,
117     gint * srcsize, gint * dstsize);
118
119 gboolean audio_convert_clean_context (AudioConvertCtx * ctx);
120
121 gboolean audio_convert_convert (AudioConvertCtx * ctx, gpointer src,
122     gpointer dst, gint samples, gboolean src_writable);
123
124 #endif /* __AUDIO_CONVERT_H__ */