tetrees/Plugins/Wwise/Source/AkAudio/Classes/GTE/Mathematics/FastGaussianBlur3.h

// David Eberly, Geometric Tools, Redmond WA 98052
// Copyright (c) 1998-2020
// Distributed under the Boost Software License, Version 1.0.
// https://www.boost.org/LICENSE_1_0.txt
// https://www.geometrictools.com/License/Boost/LICENSE_1_0.txt
// Version: 4.0.2019.08.13

#pragma once

#include <Mathematics/Math.h>

// The algorithms here are based on solving the linear heat equation using
// finite differences in scale, not in time.  The following document has
// a brief summary of the concept,
//   https://www.geometrictools.com/Documentation/FastGaussianBlur.pdf
// The idea is to represent the blurred image as f(x,s) in terms of position
// x and scale s.  Gaussian blurring is accomplished by using the input image
// I(x,s0) as the initial image (of scale s0 > 0) for the partial differential
// equation
//   s*df/ds = s^2*Laplacian(f)
// where the Laplacian operator is
//   Laplacian = (d/dx)^2, dimension 1
//   Laplacian = (d/dx)^2+(d/dy)^2, dimension 2
//   Laplacian = (d/dx)^2+(d/dy)^2+(d/dz)^2, dimension 3
//
// The term s*df/ds is approximated by
//   s*df(x,s)/ds = (f(x,b*s)-f(x,s))/ln(b)
// for b > 1, but close to 1, where ln(b) is the natural logarithm of b.  If
// you take the limit of the right-hand side as b approaches 1, you get the
// left-hand side.
//
// The term s^2*((d/dx)^2)f is approximated by
//   s^2*((d/dx)^2)f = (f(x+h*s,s)-2*f(x,s)+f(x-h*s,s))/h^2
// for h > 0, but close to zero.
//
// Equating the approximations for the left-hand side and the right-hand side
// of the partial differential equation leads to the numerical method used in
// this code.
//
// For iterative application of these functions, the caller is responsible
// for constructing a geometric sequence of scales,
//   s0, s1 = s0*b, s2 = s1*b = s0*b^2, ...
// where the base b satisfies 1 < b < exp(0.5*d) where d is the dimension of
// the image.  The upper bound on b guarantees stability of the finite
// difference method used to approximate the partial differential equation.
// The method assumes a pixel size of h = 1.

namespace WwiseGTE
{
    template <typename T>
    class FastGaussianBlur3
    {
    public:
        void Execute(int xBound, int yBound, int zBound, T const* input, T* output,
            double scale, double logBase)
        {
            mXBound = xBound;
            mYBound = yBound;
            mZBound = zBound;
            mInput = input;
            mOutput = output;

            int xBoundM1 = xBound - 1, yBoundM1 = yBound - 1, zBoundM1 = zBound - 1;
            for (int z = 0; z < zBound; ++z)
            {
                double rzps = static_cast<double>(z) + scale;
                double rzms = static_cast<double>(z) - scale;
                int zp1 = static_cast<int>(std::floor(rzps));
                int zm1 = static_cast<int>(std::ceil(rzms));

                for (int y = 0; y < yBound; ++y)
                {
                    double ryps = static_cast<double>(y) + scale;
                    double ryms = static_cast<double>(y) - scale;
                    int yp1 = static_cast<int>(std::floor(ryps));
                    int ym1 = static_cast<int>(std::ceil(ryms));

                    for (int x = 0; x < xBound; ++x)
                    {
                        double rxps = static_cast<double>(x) + scale;
                        double rxms = static_cast<double>(x) - scale;
                        int xp1 = static_cast<int>(std::floor(rxps));
                        int xm1 = static_cast<int>(std::ceil(rxms));

                        double center = Input(x, y, z);
                        double xsum = -2.0 * center, ysum = xsum, zsum = xsum;

                        // x portion of second central difference
                        if (xp1 >= xBoundM1)  // use boundary value
                        {
                            xsum += Input(xBoundM1, y, z);
                        }
                        else  // linearly interpolate
                        {
                            double imgXp1 = Input(xp1, y, z);
                            double imgXp2 = Input(xp1 + 1, y, z);
                            double delta = rxps - static_cast<double>(xp1);
                            xsum += imgXp1 + delta * (imgXp2 - imgXp1);
                        }

                        if (xm1 <= 0)  // use boundary value
                        {
                            xsum += Input(0, y, z);
                        }
                        else  // linearly interpolate
                        {
                            double imgXm1 = Input(xm1, y, z);
                            double imgXm2 = Input(xm1 - 1, y, z);
                            double delta = rxms - static_cast<double>(xm1);
                            xsum += imgXm1 + delta * (imgXm1 - imgXm2);
                        }

                        // y portion of second central difference
                        if (yp1 >= yBoundM1)  // use boundary value
                        {
                            ysum += Input(x, yBoundM1, z);
                        }
                        else  // linearly interpolate
                        {
                            double imgYp1 = Input(x, yp1, z);
                            double imgYp2 = Input(x, yp1 + 1, z);
                            double delta = ryps - static_cast<double>(yp1);
                            ysum += imgYp1 + delta * (imgYp2 - imgYp1);
                        }

                        if (ym1 <= 0)  // use boundary value
                        {
                            ysum += Input(x, 0, z);
                        }
                        else  // linearly interpolate
                        {
                            double imgYm1 = Input(x, ym1, z);
                            double imgYm2 = Input(x, ym1 - 1, z);
                            double delta = ryms - static_cast<double>(ym1);
                            ysum += imgYm1 + delta * (imgYm1 - imgYm2);
                        }

                        // z portion of second central difference
                        if (zp1 >= zBoundM1)  // use boundary value
                        {
                            zsum += Input(x, y, zBoundM1);
                        }
                        else  // linearly interpolate
                        {
                            double imgZp1 = Input(x, y, zp1);
                            double imgZp2 = Input(x, y, zp1 + 1);
                            double delta = rzps - static_cast<double>(zp1);
                            zsum += imgZp1 + delta * (imgZp2 - imgZp1);
                        }

                        if (zm1 <= 0)  // use boundary value
                        {
                            zsum += Input(x, y, 0);
                        }
                        else  // linearly interpolate
                        {
                            double imgZm1 = Input(x, y, zm1);
                            double imgZm2 = Input(x, y, zm1 - 1);
                            double delta = rzms - static_cast<double>(zm1);
                            zsum += imgZm1 + delta * (imgZm1 - imgZm2);
                        }

                        Output(x, y, z) = static_cast<T>(center + logBase * (xsum + ysum + zsum));
                    }
                }
            }
        }

    private:
        inline double Input(int x, int y, int z) const
        {
            return static_cast<double>(mInput[x + mXBound * (y + mYBound * z)]);
        }

        inline T& Output(int x, int y, int z)
        {
            return mOutput[x + mXBound * (y + mYBound * z)];
        }

        int mXBound, mYBound, mZBound;
        T const* mInput;
        T* mOutput;
    };
}