/*
 * #%L
 * Image processing operations for SciJava Ops.
 * %%
 * Copyright (C) 2014 - 2024 SciJava developers.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

package org.scijava.ops.image.filter.pad;

import java.util.function.BiFunction;
import java.util.function.Function;

import net.imglib2.Dimensions;
import net.imglib2.FinalDimensions;
import net.imglib2.Interval;
import net.imglib2.RandomAccessibleInterval;
import net.imglib2.outofbounds.OutOfBoundsConstantValueFactory;
import net.imglib2.outofbounds.OutOfBoundsFactory;
import net.imglib2.type.numeric.ComplexType;
import net.imglib2.util.Util;
import net.imglib2.view.Views;

import org.scijava.function.Functions;
import org.scijava.ops.spi.Nullable;
import org.scijava.ops.spi.OpDependency;

/**
 * Abstract Op used to pad the image by extending the borders optionally using
 * an "fftSize" op to make the final image size compatible with an FFT library.
 *
 * @author Brian Northan
 * @param <T>
 * @param <I>
 * @param <O>
 */
public abstract class PadInputFFT<T extends ComplexType<T>, I extends RandomAccessibleInterval<T>, O extends RandomAccessibleInterval<T>>
	implements
	Functions.Arity4<I, Dimensions, Boolean, OutOfBoundsFactory<T, RandomAccessibleInterval<T>>, O>
{

	@OpDependency(name = "filter.padIntervalCentered")
	private BiFunction<I, Dimensions, O> paddingIntervalCentered;

	private Function<Dimensions, long[][]> fftSizeOp;

	/**
	 * TODO
	 *
	 * @param input function argument 1
	 * @param paddedDimensions function argument 2
	 * @param fast function argument 3
	 * @param obf function argument 4
	 * @return
	 */
	@Override
	@SuppressWarnings("unchecked")
	public O apply( //
		final I input, //
		final Dimensions paddedDimensions, //
		@Nullable Boolean fast, //
		@Nullable OutOfBoundsFactory<T, RandomAccessibleInterval<T>> obf //
	) {

		if (fast == null) {
			fast = true;
		}

		Dimensions paddedFFTInputDimensions;

		// if an fftsize op has been set recompute padded size
        var sizes = getFFTSizeOp(fast).apply(paddedDimensions);

		paddedFFTInputDimensions = new FinalDimensions(sizes[0]);

		if (obf == null) {
			obf = new OutOfBoundsConstantValueFactory<>(Util.getTypeFromInterval(
				input).createVariable());
		}

		Interval inputInterval = paddingIntervalCentered.apply(input,
			paddedFFTInputDimensions);

		return (O) Views.interval(Views.extend(input, obf), inputInterval);
	}

	protected Function<Dimensions, long[][]> getFFTSizeOp(boolean fast) {
		return fftSizeOp;
	}
}
