/* Copyright (c) V-Nova International Limited 2022-2026. All rights reserved.
 * This software is licensed under the BSD-3-Clause-Clear License by V-Nova Limited.
 * No patent licenses are granted under this license. For enquiries about patent licenses,
 * please contact legal@v-nova.com.
 * The LCEVCdec software is a stand-alone project and is NOT A CONTRIBUTION to any other project.
 * If the software is incorporated into another project, THE TERMS OF THE BSD-3-CLAUSE-CLEAR LICENSE
 * AND THE ADDITIONAL LICENSING INFORMATION CONTAINED IN THIS FILE MUST BE MAINTAINED, AND THE
 * SOFTWARE DOES NOT AND MUST NOT ADOPT THE LICENSE OF THE INCORPORATING PROJECT. However, the
 * software may be incorporated into a project under a compatible license provided the requirements
 * of the BSD-3-Clause-Clear license are respected, and V-Nova Limited remains
 * licensor of the software ONLY UNDER the BSD-3-Clause-Clear license (not the compatible license).
 * ANY ONWARD DISTRIBUTION, WHETHER STAND-ALONE OR AS PART OF ANY OTHER PROJECT, REMAINS SUBJECT TO
 * THE EXCLUSION OF PATENT LICENSES PROVISION OF THE BSD-3-CLAUSE-CLEAR LICENSE. */

#ifndef VN_LCEVC_PIXEL_PROCESSING_ADD_H
#define VN_LCEVC_PIXEL_PROCESSING_ADD_H

#include <LCEVC/common/task_pool.h>
#include <LCEVC/pipeline/picture_layout.h>

#ifdef __cplusplus
extern "C"
{
#endif

/*! \brief Adds two signed 16bit source planes to a destination plane. Primarily used to add the
 *         temporal buffer to the upscaled base and save the result to the output buffer.
 *
 * \param taskPool       The task pool to create a sliced blit task from
 * \param parent         If not NULL, task that deferred tasks inherit dependencies from
 * \param planeIndex     The plane index in src/dst layout
 * \param srcLayout      The source plane picture layout
 * \param dstLayout      The destination picture layout
 * \param srcPlane1      The first source plane to blit from.
 * \param srcPlane2      The second source plane to blit from.
 * \param dstPlane       The destination plane to blit to.
 * \param diagInfo       Any diagnostic information for tracing.
 *
 * \return True if the add operation was successful. */
bool ldppPlaneAdd(LdcTaskPool* taskPool, LdcTask* parent, uint32_t planeIndex,
                  const LdpPictureLayout* srcLayout, const LdpPictureLayout* dstLayout,
                  LdpPicturePlaneDesc* srcPlane1, LdpPicturePlaneDesc* srcPlane2,
                  LdpPicturePlaneDesc* dstPlane, const LdpPipelineDiagInfo* diagInfo);

/*------------------------------------------------------------------------------*/

#ifdef __cplusplus
}
#endif

#endif // VN_LCEVC_PIXEL_PROCESSING_ADD_H
