hal_g2d.h

/* Copyright Statement:
 *
 * (C) 2005-2016  MediaTek Inc. All rights reserved.
 *
 * This software/firmware and related documentation ("MediaTek Software") are
 * protected under relevant copyright laws. The information contained herein
 * is confidential and proprietary to MediaTek Inc. ("MediaTek") and/or its licensors.
 * Without the prior written permission of MediaTek and/or its licensors,
 * any reproduction, modification, use or disclosure of MediaTek Software,
 * and information contained herein, in whole or in part, shall be strictly prohibited.
 * You may only use, reproduce, modify, or distribute (as applicable) MediaTek Software
 * if you have agreed to and been bound by the applicable license agreement with
 * MediaTek ("License Agreement") and been granted explicit permission to do so within
 * the License Agreement ("Permitted User").  If you are not a Permitted User,
 * please cease any access or use of MediaTek Software immediately.
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES
 * ARE PROVIDED TO RECEIVER ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL
 * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
 * NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
 * SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
 * SUPPLIED WITH MEDIATEK SOFTWARE, AND RECEIVER AGREES TO LOOK ONLY TO SUCH
 * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. RECEIVER EXPRESSLY ACKNOWLEDGES
 * THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES
 * CONTAINED IN MEDIATEK SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK
 * SOFTWARE RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND
 * CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
 * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE MEDIATEK SOFTWARE AT ISSUE,
 * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO
 * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
 */

#ifndef __HAL_G2D_H__
#define __HAL_G2D_H__

#include "hal_platform.h"

#ifdef HAL_G2D_MODULE_ENABLED

#ifdef __cplusplus
extern "C" {
#endif

/*****************************************************************************
 * Enums
 *****************************************************************************/

typedef enum {
    HAL_G2D_STATUS_HW_ERROR = -6,                     
    HAL_G2D_STATUS_NOT_SUPPORTEDED_COLOR_FORMAT = -5, 
    HAL_G2D_STATUS_INVALID_PARAMETER = -4,            
    HAL_G2D_STATUS_NOT_SUPPORTED = -3,                
    HAL_G2D_STATUS_BUSY = 0,                          
    HAL_G2D_STATUS_OK = 1                             
} hal_g2d_status_t;

typedef enum {
    HAL_G2D_CODEC_TYPE_HW = 0 
} hal_g2d_codec_type_t;

typedef enum {
    HAL_G2D_GET_HANDLE_MODE_BLOCKING = 0, 
    HAL_G2D_GET_HANDLE_MODE_NON_BLOCKING  
} hal_g2d_get_handle_mode_t;

typedef enum {
    HAL_G2D_COLOR_FORMAT_RGB565 = 0, 
    HAL_G2D_COLOR_FORMAT_RGB888,     
    HAL_G2D_COLOR_FORMAT_BGR888,     
    HAL_G2D_COLOR_FORMAT_ARGB8565,   
    HAL_G2D_COLOR_FORMAT_ARGB6666,   
    HAL_G2D_COLOR_FORMAT_ARGB8888,   
    HAL_G2D_COLOR_FORMAT_PARGB8565,  
    HAL_G2D_COLOR_FORMAT_PARGB6666,  
    HAL_G2D_COLOR_FORMAT_PARGB8888,  
    HAL_G2D_COLOR_FORMAT_UYVY        
} hal_g2d_color_format_t;

typedef enum {
    HAL_G2D_SUPPORTED_FUNCTION_BITBLT = 0, 
    HAL_G2D_SUPPORTED_FUNCTION_RECTFILL,   
    HAL_G2D_SUPPORTED_FUNCTION_FONT,       
    HAL_G2D_SUPPORTED_FUNCTION_OVERLAY,    
    HAL_G2D_SUPPORTED_FUNCTION_DITHERING   
} hal_g2d_supported_function_t;

typedef enum {
    HAL_G2D_OVERLAY_LAYER0 = 0, 
    HAL_G2D_OVERLAY_LAYER1 = 1, 
    HAL_G2D_OVERLAY_LAYER2 = 2, 
    HAL_G2D_OVERLAY_LAYER3 = 3  
} hal_g2d_overlay_layer_t;

typedef enum {
    HAL_G2D_OVERLAY_LAYER_FUNCTION_FONT = 0, 
    HAL_G2D_OVERLAY_LAYER_FUNCTION_RECTFILL, 
    HAL_G2D_OVERLAY_LAYER_FUNCTION_BUFFER    
} hal_g2d_overlay_layer_function_t;

typedef enum {
    HAL_G2D_ROTATE_ANGLE_0 = 0,      
    HAL_G2D_ROTATE_ANGLE_90,         
    HAL_G2D_ROTATE_ANGLE_180,        
    HAL_G2D_ROTATE_ANGLE_270,        
    HAL_G2D_ROTATE_ANGLE_MIRROR_0,   
    HAL_G2D_ROTATE_ANGLE_MIRROR_90,  
    HAL_G2D_ROTATE_ANGLE_MIRROR_180, 
    HAL_G2D_ROTATE_ANGLE_MIRROR_270  
} hal_g2d_rotate_angle_t;

typedef enum {
    HAL_G2D_FONT_FORMAT_1_BIT = 0, 
    HAL_G2D_FONT_FORMAT_2_BIT,     
    HAL_G2D_FONT_FORMAT_4_BIT,     
    HAL_G2D_FONT_FORMAT_8_BIT      
} hal_g2d_font_format_t;

typedef enum {
    HAL_G2D_DITHERING_MODE_DISABLE = 0,  
    HAL_G2D_DITHERING_MODE_RANDOM,       
    HAL_G2D_DITHERING_MODE_FIXED_PATTERN 
} hal_g2d_dithering_mode_t;

/*****************************************************************************
 * Structures
 *****************************************************************************/

typedef struct hal_g2d_hanele_struct_t hal_g2d_handle_t;

typedef bool (*hal_g2d_callback_t)(void *);

/*****************************************************************************
 * Functions
 *****************************************************************************/

hal_g2d_status_t hal_g2d_init(void);

hal_g2d_status_t hal_g2d_get_handle(hal_g2d_handle_t **handle_ptr, hal_g2d_codec_type_t codec_type, hal_g2d_get_handle_mode_t handle_mode);

hal_g2d_status_t hal_g2d_release_handle(hal_g2d_handle_t *handle);

hal_g2d_status_t hal_g2d_query_rgb_buffer_range(hal_g2d_handle_t *handle,
        uint32_t *min_width, uint32_t *max_width, uint32_t *min_height, uint32_t *max_height);

hal_g2d_status_t hal_g2d_register_callback(hal_g2d_handle_t *handle, hal_g2d_callback_t callback);

hal_g2d_status_t hal_g2d_set_clipping_window(hal_g2d_handle_t *handle, int32_t x, int32_t y, int32_t width, int32_t height);

hal_g2d_status_t hal_g2d_replace_color(hal_g2d_handle_t *handle,
        uint8_t alpha0, uint8_t red0, uint8_t green0, uint8_t blue0, uint8_t alpha1, uint8_t red1, uint8_t green1, uint8_t blue1);

hal_g2d_status_t hal_g2d_set_source_key(hal_g2d_handle_t *handle, uint8_t alpha, uint8_t red, uint8_t green, uint8_t blue);

hal_g2d_status_t hal_set_rgb_buffer(hal_g2d_handle_t *handle,
        uint8_t *buffer, uint32_t size, uint32_t width, uint32_t height, hal_g2d_color_format_t color_format);

hal_g2d_status_t hal_g2d_set_rgb_buffer(hal_g2d_handle_t *handle,
        uint8_t *buffer, uint32_t size, uint32_t width, uint32_t height, hal_g2d_color_format_t color_format);

hal_g2d_status_t hal_g2d_get_status(hal_g2d_handle_t *handle);

hal_g2d_status_t hal_g2d_query_support(hal_g2d_codec_type_t codec_type, hal_g2d_supported_function_t function_type);

hal_g2d_status_t hal_g2d_overlay_enable_layer(hal_g2d_handle_t *handle, hal_g2d_overlay_layer_t layer, bool show_layer);

hal_g2d_status_t hal_g2d_overlay_set_layer_function(hal_g2d_handle_t *handle,
        hal_g2d_overlay_layer_t layer, hal_g2d_overlay_layer_function_t function);

hal_g2d_status_t hal_g2d_overlay_set_layer_rectfill_color(hal_g2d_handle_t *handle,
        hal_g2d_overlay_layer_t layer, uint32_t rectfill_color);

hal_g2d_status_t hal_g2d_overlay_set_layer_buffer(hal_g2d_handle_t *handle,
        hal_g2d_overlay_layer_t layer, uint8_t *buffer, uint32_t size);

hal_g2d_status_t hal_g2d_overlay_set_layer_rgb_buffer(hal_g2d_handle_t *handle,
        hal_g2d_overlay_layer_t layer, uint8_t *buffer, uint32_t size,
        uint32_t width, uint32_t height, hal_g2d_color_format_t color_format);

hal_g2d_status_t hal_g2d_overlay_set_layer_yuv_buffer(hal_g2d_handle_t *handle,
        hal_g2d_overlay_layer_t layer, uint8_t *buffer[3], uint32_t size[3],
        uint32_t width, uint32_t height, hal_g2d_color_format_t color_format);

hal_g2d_status_t hal_g2d_overlay_set_layer_window(hal_g2d_handle_t *handle,
        hal_g2d_overlay_layer_t layer, int32_t x, int32_t y, uint32_t width, uint32_t height);

hal_g2d_status_t hal_g2d_overlay_set_layer_source_key(hal_g2d_handle_t *handle,
        hal_g2d_overlay_layer_t layer, uint32_t src_key_value);

hal_g2d_status_t hal_g2d_overlay_set_layer_rotation(hal_g2d_handle_t *handle,
        hal_g2d_overlay_layer_t layer, hal_g2d_rotate_angle_t rotation);

hal_g2d_status_t hal_g2d_overlay_set_layer_alpha(hal_g2d_handle_t *handle,
        hal_g2d_overlay_layer_t layer, uint32_t alpha_value);

hal_g2d_status_t hal_g2d_overlay_set_background_color(hal_g2d_handle_t *handle, uint32_t bg_color);

hal_g2d_status_t hal_g2d_overlay_set_alpha(hal_g2d_handle_t *handle, uint32_t alpha_value);

hal_g2d_status_t hal_g2d_overlay_set_window(hal_g2d_handle_t *handle, int32_t x, int32_t y);

hal_g2d_status_t hal_g2d_overlay_set_roi_window(hal_g2d_handle_t *handle, int32_t x, int32_t y, uint32_t width, uint32_t height);

hal_g2d_status_t hal_g2d_overlay_start(hal_g2d_handle_t *handle);

hal_g2d_status_t hal_g2d_set_dithering(hal_g2d_handle_t *handle, hal_g2d_dithering_mode_t mode, uint8_t red_bit, uint8_t green_bit, uint8_t blue_bit);

hal_g2d_status_t hal_g2d_overlay_set_layer_font_format(hal_g2d_handle_t *handle, hal_g2d_overlay_layer_t layer, hal_g2d_font_format_t format);

hal_g2d_status_t hal_g2d_overlay_set_layer_font_color(hal_g2d_handle_t *handle, hal_g2d_overlay_layer_t layer, uint32_t color);

hal_g2d_status_t hal_g2d_rectfill_set_destination_window(hal_g2d_handle_t *handle, int32_t x, int32_t y, int32_t width, int32_t height);

hal_g2d_status_t hal_g2d_rectfill_set_color(hal_g2d_handle_t *handle, uint32_t color);

hal_g2d_status_t hal_g2d_rectangle_fill_query_window_range(hal_g2d_handle_t *handle,
        int32_t *min_x, int32_t *max_x, int32_t *min_y, int32_t *max_y,
        uint32_t *min_width, uint32_t *max_width, uint32_t *min_height, uint32_t *max_height);

hal_g2d_status_t hal_g2d_rectfill_start(hal_g2d_handle_t *handle);

#ifdef __cplusplus
}
#endif

#endif /* HAL_G2D_MODULE_ENABLED */
#endif /* __HAL_G2D_H__ */