about summary refs log tree commit diff
path: root/src/engine/external/portaudio/pa_dither.h
diff options
context:
space:
mode:
authorMagnus Auvinen <magnus.auvinen@gmail.com>2007-08-22 07:52:33 +0000
committerMagnus Auvinen <magnus.auvinen@gmail.com>2007-08-22 07:52:33 +0000
commit8b3c16e6152a527f9aec1a88a9eed74119de7000 (patch)
treef0bde5cea15e696e42cade06a3b12ff6b13acc57 /src/engine/external/portaudio/pa_dither.h
parent9899666a7ce6679a3b9667ab09f615f4d0769c16 (diff)
downloadzcatch-8b3c16e6152a527f9aec1a88a9eed74119de7000.tar.gz
zcatch-8b3c16e6152a527f9aec1a88a9eed74119de7000.zip
major engine cleanup. dependency on baselib removed. engine is now C code (not ansi tho). some other cruft removed aswell
Diffstat (limited to 'src/engine/external/portaudio/pa_dither.h')
-rw-r--r--src/engine/external/portaudio/pa_dither.h100
1 files changed, 100 insertions, 0 deletions
diff --git a/src/engine/external/portaudio/pa_dither.h b/src/engine/external/portaudio/pa_dither.h
new file mode 100644
index 00000000..c76af3ae
--- /dev/null
+++ b/src/engine/external/portaudio/pa_dither.h
@@ -0,0 +1,100 @@
+#ifndef PA_DITHER_H

+#define PA_DITHER_H

+/*

+ * $Id: pa_dither.h 1097 2006-08-26 08:27:53Z rossb $

+ * Portable Audio I/O Library triangular dither generator

+ *

+ * Based on the Open Source API proposed by Ross Bencina

+ * Copyright (c) 1999-2002 Phil Burk, Ross Bencina

+ *

+ * Permission is hereby granted, free of charge, to any person obtaining

+ * a copy of this software and associated documentation files

+ * (the "Software"), to deal in the Software without restriction,

+ * including without limitation the rights to use, copy, modify, merge,

+ * publish, distribute, sublicense, and/or sell copies of the Software,

+ * and to permit persons to whom the Software is furnished to do so,

+ * subject to the following conditions:

+ *

+ * The above copyright notice and this permission notice shall be

+ * included in all copies or substantial portions of the Software.

+ *

+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR

+ * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF

+ * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+ */

+

+/*

+ * The text above constitutes the entire PortAudio license; however, 

+ * the PortAudio community also makes the following non-binding requests:

+ *

+ * Any person wishing to distribute modifications to the Software is

+ * requested to send the modifications to the original developer so that

+ * they can be incorporated into the canonical version. It is also 

+ * requested that these non-binding requests be included along with the 

+ * license above.

+ */

+

+/** @file

+ @ingroup common_src

+

+ @brief Functions for generating dither noise

+*/

+

+

+#ifdef __cplusplus

+extern "C"

+{

+#endif /* __cplusplus */

+

+

+/** @brief State needed to generate a dither signal */

+typedef struct PaUtilTriangularDitherGenerator{

+    unsigned long previous;

+    unsigned long randSeed1;

+    unsigned long randSeed2;

+} PaUtilTriangularDitherGenerator;

+

+

+/** @brief Initialize dither state */

+void PaUtil_InitializeTriangularDitherState( PaUtilTriangularDitherGenerator *ditherState );

+

+

+/**

+ @brief Calculate 2 LSB dither signal with a triangular distribution.

+ Ranged for adding to a 1 bit right-shifted 32 bit integer

+ prior to >>15. eg:

+<pre>

+    signed long in = *

+    signed long dither = PaUtil_Generate16BitTriangularDither( ditherState );

+    signed short out = (signed short)(((in>>1) + dither) >> 15);

+</pre>

+ @return

+ A signed long with a range of +32767 to -32768

+*/

+signed long PaUtil_Generate16BitTriangularDither( PaUtilTriangularDitherGenerator *ditherState );

+

+

+/**

+ @brief Calculate 2 LSB dither signal with a triangular distribution.

+ Ranged for adding to a pre-scaled float.

+<pre>

+    float in = *

+    float dither = PaUtil_GenerateFloatTriangularDither( ditherState );

+    // use smaller scaler to prevent overflow when we add the dither

+    signed short out = (signed short)(in*(32766.0f) + dither );

+</pre>

+ @return

+ A float with a range of -2.0 to +1.99999.

+*/

+float PaUtil_GenerateFloatTriangularDither( PaUtilTriangularDitherGenerator *ditherState );

+

+

+

+#ifdef __cplusplus

+}

+#endif /* __cplusplus */

+#endif /* PA_DITHER_H */