hwa_dmpac_dof.h

Go to the documentation of this file.

/*
 *
 * Copyright (c) 2019-2021 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 HWA_DMPAC_DOF_H_
#define HWA_DMPAC_DOF_H_

#include <VX/vx.h>
#include <VX/vx_kernels.h>

#ifdef __cplusplus
extern "C" {
#endif

#define TIVX_KERNEL_DMPAC_DOF_NAME     "com.ti.hwa.dmpac_dof"

#define TIVX_KERNEL_DOF_VISUALIZE_NAME     "com.ti.hwa.dof_visualize"

/*********************************
 *      DMPAC_DOF Control Commands
 *********************************/

#define TIVX_DMPAC_DOF_CMD_SET_HTS_BW_LIMIT_PARAMS        (0x10000000u)

#define TIVX_DMPAC_DOF_CMD_CS_PARAMS                      (0x10000001u)

#define TIVX_DMPAC_DOF_CMD_GET_ERR_STATUS                 (0x10000002u)

#define TIVX_DMPAC_DOF_CMD_GET_PSA_STATUS                 (0x10000003u)

/*********************************
 *      DMPAC_DOF PREDICTORS
 *********************************/
#define TIVX_DMPAC_DOF_PREDICTOR_NONE                  (0U)

#define TIVX_DMPAC_DOF_PREDICTOR_DELAY_LEFT            (1U)

#define TIVX_DMPAC_DOF_PREDICTOR_TEMPORAL              (2U)

#define TIVX_DMPAC_DOF_PREDICTOR_PYR_LEFT              (3U)

#define TIVX_DMPAC_DOF_PREDICTOR_PYR_COLOCATED         (4U)

#define TIVX_DMPAC_DOF_MAX_FLOW_VECTOR_DELAY           (4U)

/*********************************
 *      DMPAC_DOF Defines
 *********************************/
#define TIVX_DMPAC_DOF_RD_ERR                         (0x04U)

#define TIVX_DMPAC_DOF_WR_ERR                         (0x08U)

#define TIVX_DMPAC_DOF_MP0_RD_STATUS_ERR              (0x10U)

#define TIVX_DMPAC_DOF_FOCO0_SL2_WR_ERR               (0x400000U)

#define TIVX_DMPAC_DOF_FOCO0_VBUSM_RD_ERR             (0x200000U)

#define TIVX_DMPAC_DOF_WDTIMER_ERR                    (0x40000000U)

#define TIVX_DMPAC_DOF_FOCO0_WDTIMER_ERR              (0x80000000U)

/*********************************
 *      DMPAC_DOF STRUCTURES
 *********************************/

typedef struct {
    uint16_t  vertical_search_range[2];
    uint16_t  horizontal_search_range;
    uint16_t  median_filter_enable;
    uint16_t  motion_smoothness_factor;
    uint16_t  motion_direction;
    uint16_t  base_predictor[2];
    uint16_t  inter_predictor[2];
    uint16_t  iir_filter_alpha;
    uint16_t  flow_vector_internal_delay_num;

    uint32_t  enable_error_events;
    uint32_t  enable_psa;

} tivx_dmpac_dof_params_t;

typedef struct {
    uint16_t  sof_max_pix_in_row;
    uint16_t  sof_fv_height;
} tivx_dmpac_dof_sof_params_t;

typedef struct {
    uint32_t  cs_gain;
    uint32_t  decision_tree_index[16][3];
    uint32_t  decision_tree_threshold[16][3];
    uint32_t  decision_tree_weight[16][4];
} tivx_dmpac_dof_cs_tree_params_t;

typedef struct {
    uint32_t  enable_hts_bw_limit;
    uint32_t  cycle_cnt;
    uint32_t  token_cnt;
} tivx_dmpac_dof_hts_bw_limit_params_t;

typedef struct {
    uint32_t psa_values;
    uint64_t timestamp;
} tivx_dmpac_dof_psa_timestamp_data_t;

/*********************************
 *      Function Prototypes
 *********************************/

void tivxRegisterHwaTargetDmpacDofKernels(void);

void tivxUnRegisterHwaTargetDmpacDofKernels(void);

void tivxRegisterHwaTargetArmKernels(void);

void tivxUnRegisterHwaTargetArmKernels(void);


VX_API_ENTRY vx_node VX_API_CALL tivxDmpacDofNode(vx_graph graph,
                                      vx_user_data_object  configuration,
                                      vx_image             input_current_base,
                                      vx_image             input_reference_base,
                                      vx_pyramid           input_current,
                                      vx_pyramid           input_reference,
                                      vx_image             flow_vector_in,
                                      vx_user_data_object  sparse_of_config,
                                      vx_image             sparse_of_map,
                                      vx_image             flow_vector_out,
                                      vx_distribution      confidence_histogram);

VX_API_ENTRY vx_node VX_API_CALL tivxDofVisualizeNode(vx_graph graph,
                                      vx_image             flow_vector,
                                      vx_scalar            confidence_threshold,
                                      vx_image             flow_vector_rgb,
                                      vx_image             confidence_image);

void tivx_dmpac_dof_params_init(tivx_dmpac_dof_params_t *prms);

void tivx_dmpac_dof_sof_params_init(tivx_dmpac_dof_sof_params_t *prms);

 void tivx_dmpac_dof_cs_tree_params_init(tivx_dmpac_dof_cs_tree_params_t *prms);


void tivx_dmpac_dof_hts_bw_limit_params_init(
                                    tivx_dmpac_dof_hts_bw_limit_params_t *prms);

#ifdef __cplusplus
}
#endif

#endif /* HWA_DMPAC_DOF_H_ */