/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
 * Copyright (C) 2023, Linaro Ltd
 * Copyright (C) 2023, Red Hat Inc.
 *
 * Authors:
 * Hans de Goede <hdegoede@redhat.com>
 *
 * debayer.cpp - debayer base class
 */

#include "debayer.h"

namespace libcamera {

/**
 * \struct DebayerParams
 * \brief Struct to hold the debayer parameters.
 */

/**
 * \var DebayerParams::kGain10
 * \brief const value for 1.0 gain
 */

/**
 * \var DebayerParams::gainR
 * \brief Red gain
 *
 * 128 = 0.5, 256 = 1.0, 512 = 2.0, etc.
 */

/**
 * \var DebayerParams::gainG
 * \brief Green gain
 *
 * 128 = 0.5, 256 = 1.0, 512 = 2.0, etc.
 */

/**
 * \var DebayerParams::gainB
 * \brief Blue gain
 *
 * 128 = 0.5, 256 = 1.0, 512 = 2.0, etc.
 */

/**
 * \var DebayerParams::gamma
 * \brief Gamma correction, 1.0 is no correction
 */

/**
 * \class Debayer
 * \brief Base debayering class
 *
 * Base class that provides functions for setting up the debayering process.
 */

LOG_DEFINE_CATEGORY(Debayer)

Debayer::~Debayer()
{
}

/**
 * \fn int Debayer::configure(const StreamConfiguration &inputCfg, const std::vector<std::reference_wrapper<StreamConfiguration>> &outputCfgs)
 * \brief Configure the debayer object according to the passed in parameters.
 * \param[in] inputCfg The input configuration.
 * \param[in] outputCfgs The output configurations.
 *
 * \return 0 on success, a negative errno on failure.
 */

/**
 * \fn Size Debayer::patternSize(PixelFormat inputFormat)
 * \brief Get the width and height at which the bayer pattern repeats.
 * \param[in] inputFormat The input format.
 *
 * Valid sizes are: 2x2, 4x2 or 4x4.
 *
 * \return Pattern size or an empty size for unsupported inputFormats.
 */

/**
 * \fn std::vector<PixelFormat> Debayer::formats(PixelFormat inputFormat)
 * \brief Get the supported output formats.
 * \param[in] inputFormat The input format.
 *
 * \return All supported output formats or an empty vector if there are none.
 */

/**
 * \fn std::tuple<unsigned int, unsigned int> Debayer::strideAndFrameSize(const PixelFormat &outputFormat, const Size &size)
 * \brief Get the stride and the frame size.
 * \param[in] outputFormat The output format.
 * \param[in] size The output size.
 *
 * \return A tuple of the stride and the frame size, or a tuple with 0,0 if
 *    there is no valid output config.
 */

/**
 * \fn void Debayer::process(FrameBuffer *input, FrameBuffer *output, DebayerParams params)
 * \brief Process the bayer data into the requested format.
 * \param[in] input The input buffer.
 * \param[in] output The output buffer.
 * \param[in] params The parameters to be used in debayering.
 *
 * \note DebayerParams is passed by value deliberately so that a copy is passed
 * when this is run in another thread by invokeMethod().
 */

/**
 * \fn virtual SizeRange Debayer::sizes(PixelFormat inputFormat, const Size &inputSize)
 * \brief Get the supported output sizes for the given input format and size.
 * \param[in] inputFormat The input format.
 * \param[in] inputSize The input size.
 *
 * \return The valid size ranges or an empty range if there are none.
 */

/**
 * \var Signal<FrameBuffer *> Debayer::inputBufferReady
 * \brief Signals when the input buffer is ready.
 */

/**
 * \var Signal<FrameBuffer *> Debayer::outputBufferReady
 * \brief Signals when the output buffer is ready.
 */

} /* namespace libcamera */