draw2d.h

Go to the documentation of this file.

/******************************************************************************
Copyright (c) [2012 - 2017] Texas Instruments Incorporated

All rights reserved not granted herein.

Limited License.

 Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
 license under copyrights and patents it now or hereafter owns or controls to
 make,  have made, use, import, offer to sell and sell ("Utilize") this software
 subject to the terms herein.  With respect to the foregoing patent license,
 such license is granted  solely to the extent that any such patent is necessary
 to Utilize the software alone.  The patent license shall not apply to any
 combinations which include this software, other than combinations with devices
 manufactured by or for TI ("TI Devices").  No hardware patent is licensed
 hereunder.

 Redistributions must preserve existing copyright notices and reproduce this
 license (including the above copyright notice and the disclaimer and
 (if applicable) source code license limitations below) in the documentation
 and/or other materials provided with the distribution

 Redistribution and use in binary form, without modification, are permitted
 provided that the following conditions are met:

 * No reverse engineering, decompilation, or disassembly of this software
   is permitted with respect to any software provided in binary form.

 * Any redistribution and use are licensed by TI for use only with TI Devices.

 * Nothing shall obligate TI to provide you with source code for the software
   licensed and provided to you in object code.

 If software source code is provided to you, modification and redistribution of
 the source code are permitted provided that the following conditions are met:

 * Any redistribution and use of the source code, including any resulting
   derivative works, are licensed by TI for use only with TI Devices.

 * Any redistribution and use of any object code compiled from the source code
   and any resulting derivative works, are licensed by TI for use only with TI
   Devices.

 Neither the name of Texas Instruments Incorporated nor the names of its
 suppliers may be used to endorse or promote products derived from this software
 without specific prior written permission.

 DISCLAIMER.

 THIS SOFTWARE IS PROVIDED BY TI AND TI�S LICENSORS "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 TI AND TI�S LICENSORS 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 _DRAW_2D_H_
#define _DRAW_2D_H_

#ifdef __cplusplus
extern "C" {
#endif

/*******************************************************************************
 *  INCLUDE FILES
 *******************************************************************************
 */
#include <TI/tivx.h>

#include <stdlib.h>
#include <stdint.h>
#include <string.h>
#include <assert.h>
#include <math.h>
/*******************************************************************************
 *  Defines
 *******************************************************************************
 */

 #define DRAW2D_MAX_PLANES   (3)

 typedef enum
 {
     DRAW2D_DF_YUV422I_UYVY = 0x0000,
     DRAW2D_DF_YUV422I_YUYV,
     DRAW2D_DF_YUV422I_YVYU,
     DRAW2D_DF_YUV422I_VYUY,
     DRAW2D_DF_YUV422SP_UV,
     DRAW2D_DF_YUV422SP_VU,
     DRAW2D_DF_YUV422P,
     DRAW2D_DF_YUV420SP_UV,
     DRAW2D_DF_YUV420SP_VU,
     DRAW2D_DF_YUV420P,
     DRAW2D_DF_YUV444P,
     DRAW2D_DF_YUV444I,
     DRAW2D_DF_RGB16_565,
     DRAW2D_DF_BGRA16_4444,
     DRAW2D_DF_RGB24_888,
     DRAW2D_DF_ARGB32_8888,
     DRAW2D_DF_RGBA32_8888,
     DRAW2D_DF_BGR16_565,
     DRAW2D_DF_BGR24_888,
     DRAW2D_DF_ABGR32_8888,
     DRAW2D_DF_BGRA32_8888,
     DRAW2D_DF_MISC,
     DRAW2D_DF_INVALID,
     DRAW2D_DF_FORCE32BITS = 0xFFFFFFFF
 }Draw2D_DataFormat;

#define RGB888_TO_RGB565(r,g,b)     ((((uint32_t)(r>>3) & 0x1F) << 11) | (((uint32_t)(g>>2) & 0x3F) << 5) | (((uint32_t)(b>>3) & 0x1F)))
#define RGB888_TO_BGRA444(r,g,b,a)  ((((uint32_t)(r>>4) & 0xF) << 0) | (((uint32_t)(g>>4) & 0xF) << 4) | (((uint32_t)(b>>4) & 0xF)<<8)| (((uint32_t)(a>>4) & 0xF)<<12))

#define DRAW2D_TRANSPARENT_COLOR            (RGB888_TO_RGB565(0, 0, 0))
#define DRAW2D_TRANSPARENT_COLOR_FORMAT     (DRAW2D_DF_BGR16_565)

/* white logo with transperency */
#define DRAW2D_BMP_IDX_TI_LOGO_0            (0)
/* red+white logo with black background */
#define DRAW2D_BMP_IDX_TI_LOGO_1            (1)
/* white logo with black background */
#define DRAW2D_BMP_IDX_TI_LOGO_2            (2)
/* white logo with black background */
#define DRAW2D_BMP_IDX_TI_LOGO_3            (3)
/* red+white logo (small) with black background */
#define DRAW2D_BMP_IDX_TI_LOGO_4            (4)
/* white logo (small) with black background */
#define DRAW2D_BMP_IDX_TI_LOGO_5            (5)
/* DOF Colour Map */
#define DRAW2D_BMP_IDX_DOF_COLOUR_MAP       (6)
/* Stereo Vision Colour Map */
#define DRAW2D_BMP_IDX_SDE_COLOUR_MAP       (7)


/*
 *  \brief  Font property
 */
typedef struct {

    uint8_t *addr;
    uint32_t width;
    uint32_t height;
    uint32_t bpp;
    uint32_t lineOffset;
    uint32_t num;
    uint32_t colorFormat;
} Draw2D_FontProperty;

/*
 *  \brief  Font property
 */
typedef struct {

    uint8_t *addr;
    uint32_t width;
    uint32_t height;
    uint32_t bpp;
    uint32_t lineOffset;
    uint32_t colorFormat;
} Draw2D_BmpProperty;

typedef struct
{
    uint8_t *bufAddr[DRAW2D_MAX_PLANES];
    uint32_t bufWidth;
    uint32_t bufHeight;
    uint32_t bufPitch[DRAW2D_MAX_PLANES];
    uint32_t dataFormat;
    uint32_t transperentColor;
    uint32_t transperentColorFormat;
} Draw2D_BufInfo;

typedef struct
{
    uint32_t fontIdx;
} Draw2D_FontPrm;

typedef struct
{
    uint32_t bmpIdx;
} Draw2D_BmpPrm;

typedef struct
{
    uint32_t lineColor;
    uint32_t lineSize;
    uint32_t lineColorFormat;
} Draw2D_LinePrm;

typedef struct
{
    uint32_t startX;
    uint32_t startY;
    uint32_t height;
    uint32_t width;
    uint32_t color;
    uint32_t colorFormat;
}Draw2D_RegionPrm;

typedef void *Draw2D_Handle;


/*
 *  Functions
 */

int32_t Draw2D_create(Draw2D_Handle *pCtx);

int32_t Draw2D_delete(Draw2D_Handle pCtx);


int32_t Draw2D_setBufInfo(Draw2D_Handle pCtx, Draw2D_BufInfo *pBufInfo);

void Draw2D_updateBufAddr(Draw2D_Handle pCtx, uint8_t **bufAddr);

int32_t Draw2D_clearBuf(Draw2D_Handle pCtx);

int32_t Draw2D_drawString(Draw2D_Handle pCtx,
                        uint32_t startX,
                        uint32_t startY,
                        char *str,
                        Draw2D_FontPrm *pPrm);

int32_t Draw2D_drawString_rot(Draw2D_Handle pCtx,
                        uint32_t startX,
                        uint32_t startY,
                        char *str,
                        Draw2D_FontPrm *pPrm,
                        uint32_t rotate);

int32_t Draw2D_clearString(Draw2D_Handle pCtx,
                            uint32_t startX,
                            uint32_t startY,
                            uint32_t stringLength,
                            Draw2D_FontPrm *pPrm);


int32_t Draw2D_getFontProperty(Draw2D_FontPrm *pPrm, Draw2D_FontProperty *pProp);

int32_t Draw2D_getBmpProperty(Draw2D_BmpPrm *pPrm, Draw2D_BmpProperty *pProp);

int32_t Draw2D_drawLine(Draw2D_Handle pCtx,
                        uint32_t startX,
                        uint32_t startY,
                        uint32_t endX,
                        uint32_t endY,
                        Draw2D_LinePrm *pPrm);

int32_t Draw2D_drawRect(Draw2D_Handle pCtx,
                        uint32_t startX,
                        uint32_t startY,
                        uint32_t width,
                        uint32_t height,
                        Draw2D_LinePrm *pPrm);

int32_t Draw2D_clearRegion(Draw2D_Handle pCtx,
                            uint32_t startX,
                            uint32_t startY,
                            uint32_t width,
                            uint32_t height);


int32_t Draw2D_fillRegion(Draw2D_Handle pCtx, Draw2D_RegionPrm *prm);


void Draw2D_drawPixel(Draw2D_Handle pCtx, uint32_t px, uint32_t py, uint32_t color, uint32_t colorFormat);


int32_t Draw2D_drawBmp(Draw2D_Handle pCtx,
                        uint32_t startX,
                        uint32_t startY,
                        Draw2D_BmpPrm *pPrm);

int32_t Draw2D_drawBmp_rot(Draw2D_Handle pCtx,
                        uint32_t startX,
                        uint32_t startY,
                        Draw2D_BmpPrm *pPrm,
                        uint32_t rotate);

int32_t Draw2D_insertBmp(Draw2D_Handle pCtx,
                         char *input_file,
                         int32_t startX,
                         int32_t startY);

int32_t Draw2D_insertBmpFromMemory(Draw2D_Handle pCtx,
                         void *buf,
                         uint32_t buf_size,
                         int32_t startX,
                         int32_t startY);

void Draw2D_setFontColor(uint16_t colorText, uint16_t colorBorder, uint16_t colorBg );

void Draw2D_resetFontColor();

static inline uint32_t Draw2D_floor(uint32_t val, uint32_t align)
{
    return (((val) / (align)) * (align));
}

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif  /* _DRAW_2D_H_ */

/* @} */

/* Nothing beyond this point */