nuttx/boards/arm/cxd56xx/spresense/include/cxd56_imageproc.h

152 lines
5.0 KiB
C

/***************************************************************************
* boards/arm/cxd56xx/spresense/include/cxd56_imageproc.h
*
* Copyright 2018 Sony Semiconductor Solutions Corporation
*
* 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.
* 3. Neither the name of Sony Corporation nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* 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 OWNER 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.
*
****************************************************************************/
#ifndef __BOARDS_ARM_CXD56XX_SPRESENSE_INCLUDE_CXD56_IMAGEPROC_H
#define __BOARDS_ARM_CXD56XX_SPRESENSE_INCLUDE_CXD56_IMAGEPROC_H
#include <stdint.h>
#ifdef __cplusplus
extern "C"
{
#endif
/* Structure of rectangle coordinates from left top point to
* right buttom point.
*/
struct imageproc_rect_s
{
uint16_t x1; /* X coordinate of left top point */
uint16_t y1; /* Y coordinate of left top point */
uint16_t x2; /* X coordinate of rignt bottom point */
uint16_t y2; /* Y coordinate of rignt bottom point */
};
typedef struct imageproc_rect_s imageproc_rect_t;
/* Initialize imageproc library
*/
void imageproc_initialize(void);
/* Finalize imageproc library
*/
void imageproc_finalize(void);
/* Convert color format (YUV to RGB)
*
* TODO: need more description here
*
* [in,out] ibuf: image
* [in] hsize: Horizontal size
* [in] vsize: Vertical size
*/
void imageproc_convert_yuv2rgb(uint8_t * ibuf, uint32_t hsize,
uint32_t vsize);
/* Convert color format (YUV to grayscale)
*
* TODO: need more description here
*
* [in] ibuf: Input image
* [out] obuf: Output buffer
* [in] hsize: Horizontal size
* [in] vsize: Vertical size
*/
void imageproc_convert_yuv2gray(uint8_t * ibuf, uint8_t * obuf,
size_t hsize, size_t vsize);
/* Resize image
*
* Resize image specified by ibuf to ohsize, ovsize. Processed
* image will be stored to obuf.
*
* For ohsize and ovsize, specify output size calculated by multiply
* in range 1/2^n to 2^n (n=0..5) against ihsize and ivsize.
*
* This function can be processing for YUV422 color format.
* So all of specified sizes must be multiple of 2.
*
* And there is limitation about output size below.
*
* * Shrink
* + Horizontal size least 12 pixels
* + Vertical size least 12 pixels
* * Enlarge
* + Horizontal size up to 768 pixels
* + Vertical size up to 1024 pixels
*
* [in] ibuf: Input image
* [in] ihsize: Input horizontal size
* [in] ivsize: Input vertical size
* [out] obuf: Output buffer
* [in] ohsize: Output horizontal size
* [in] ovsize: Output vertical size
* [in] bpp: Bits per pixel (16 or 8)
*
* return 0 on success, otherwise error code.
*/
int imageproc_resize(uint8_t * ibuf, uint16_t ihsize, uint16_t ivsize,
uint8_t * obuf, uint16_t ohsize, uint16_t ovsize,
int bpp);
/* Clip and Resize image
*
* [in] ibuf: Input image
* [in] ihsize: Input horizontal size
* [in] ivsize: Input vertical size
* [out] obuf: Output buffer
* [in] ohsize: Output horizontal size
* [in] ovsize: Output vertical size
* [in] bpp: Bits per pixel (16 or 8)
* [in] clip_rect: Clipping rectangle on input image.
*
* return 0 on success, otherwise error code.
*/
int imageproc_clip_and_resize(uint8_t * ibuf, uint16_t ihsize,
uint16_t ivsize, uint8_t * obuf,
uint16_t ohsize, uint16_t ovsize, int bpp,
imageproc_rect_t * clip_rect);
#ifdef __cplusplus
}
#endif
#endif /* __BOARDS_ARM_CXD56XX_SPRESENSE_INCLUDE_CXD56_IMAGEPROC_H */