tivx.h

Go to the documentation of this file.

/*
*
* Copyright (c) 2017-2025 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 VX_EXT_TI_H_
#define VX_EXT_TI_H_

#include <VX/vx.h>
#include <VX/vx_khr_pipelining.h>
#include <VX/vx_khr_user_data_object.h>
#include <VX/vx_khr_bidirectional_parameters.h>
#include <TI/tivx_debug.h>
#include <TI/tivx_log_rt.h>
#include <TI/tivx_kernels.h>
#include <TI/tivx_nodes.h>
#include <TI/tivx_mem.h>
#include <TI/tivx_tensor.h>
#include <TI/tivx_ext_raw_image.h>
#include <TI/tivx_ext_super_node.h>
#include <TI/tivx_soc.h>
#include <TI/tivx_log_stats.h>
#include <TI/tivx_ext_obj_array_from_list.h>

#ifdef __cplusplus
extern "C" {
#endif

#define TIVX_TARGET_MAX_NAME            (64u)

#define TIVX_TARGET_HOST        "HOST"

#define TIVX_CONFIG_PATH_LENGTH   (512u)

#define TIVX_CONTROL_CMD_SEND_TO_ALL_REPLICATED_NODES ((uint32_t)-1)

/*
 * Super node configuration resources
 */
#define TIVX_GRAPH_MAX_SUPER_NODES         (8u)

#define TIVX_MAX_DSP_BAM_USER_PLUGINS      (8u)

#define TIVX_SUPER_NODE_MAX_NODES          (16u)

#define TIVX_SUPER_NODE_MAX_EDGES          (16u)

#define TIVX_SUPER_NODE_MAX_OBJECTS        (16u)

/*
 * The following parameters are publicly included to retain functionality
 * within the boundary test cases.
 */
#define TIVX_PYRAMID_MAX_LEVELS_ORB        (17u)

#define TIVX_MAX_KERNEL_ID                 (VX_KERNEL_MASK)

#define TIVX_MAX_LIBRARY_ID                (VX_LIBRARY(VX_LIBRARY_MASK))

#if 0
/* The below enums are provided here in a commented out location in order
 * to track the value of the enums and ensure that there are no conflicting
 * values.  The location of the actual definition of these values are also
 * provided.
 */
/* This enum can be found in include/TI/tivx_ext_raw_image.h */
#define TIVX_ENUM_RAW_IMAGE_BUFFER_ACCESS      (vx_enum)0x0

/* This enum can be found in include/TI/tivx_ext_raw_image.h */
#define TIVX_ENUM_RAW_IMAGE_PIXEL_CONTAINER    (vx_enum)0x1

/* This enum can be found in source/include/tivx_event_queue.h */
#define TIVX_ENUM_EVENT_QUEUE                  (vx_enum)0x2
#endif

typedef enum _tivx_graph_attribute_extensions_e {

    TIVX_GRAPH_STREAM_EXECUTIONS = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_GRAPH) + 0x0,

} tivx_graph_attribute_extensions_e;

typedef enum _tivx_node_attribute_extensions_e {

    TIVX_NODE_TARGET_STRING = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_NODE) + 0x0,

    TIVX_NODE_TIMEOUT = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_NODE) + 0x1,

    TIVX_NODE_IS_TIMED_OUT = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_NODE) + 0x2

} tivx_node_attribute_extensions_e;

typedef enum _tivx_reference_attribute_extensions_e {

    TIVX_REFERENCE_TIMESTAMP = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_REFERENCE) + 0x0,

    TIVX_REFERENCE_INVALID = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_REFERENCE) + 0x1,

    TIVX_REFERENCE_BUFFER_IS_ALLOCATED = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_REFERENCE) + 0x2,
} tivx_reference_attribute_extensions_e;

typedef enum _tivx_kernel_attribute_extensions_e {

    TIVX_KERNEL_TIMEOUT = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_KERNEL) + 0x0

} tivx_kernel_attribute_extensions_e;

typedef enum _tivx_context_attribute_extensions_e {

    TIVX_CONTEXT_NUM_USER_KERNEL_ID = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_CONTEXT) + 0x0,

    TIVX_CONTEXT_NUM_USER_LIBRARY_ID = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_CONTEXT) + 0x1

} tivx_context_attribute_extensions_e;

typedef enum _tivx_image_attribute_extensions_e {

    TIVX_IMAGE_IMAGEPATCH_ADDRESSING = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_IMAGE) + 0x0,

    TIVX_IMAGE_STRIDE_Y_ALIGNMENT = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_IMAGE) + 0x1

} tivx_image_attribute_extensions_e;

typedef enum _tivx_tensor_attribute_extensions_e {

    TIVX_TENSOR_STRIDES = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_TENSOR) + 0x0

} tivx_tensor_attribute_extensions_e;


typedef enum _tivx_df_image_e {

    TIVX_DF_IMAGE_P12 = VX_DF_IMAGE('P','0','1','2'),

    TIVX_DF_IMAGE_NV12_P12 = VX_DF_IMAGE('N','1','2','P'),

    TIVX_DF_IMAGE_RGB565 = VX_DF_IMAGE('R','5','6','5'),

    TIVX_DF_IMAGE_BGRX = VX_DF_IMAGE('B','G','R','A'),
} tivx_df_image_e;

typedef enum _tivx_status_e {
    TIVX_STATUS_BASE         = -(vx_int32)100

    /* add new codes here */

} tivx_status_e;

void tivxInit(void);

void tivxDeInit(void);

void tivxHostInit(void);

void tivxHostDeInit(void);

VX_API_ENTRY vx_status VX_API_CALL tivxAddKernelTarget(vx_kernel kernel, const char *target_name);

VX_API_ENTRY vx_status VX_API_CALL tivxSetKernelSinkDepth(vx_kernel kernel, uint32_t num_sink_bufs);

VX_API_ENTRY vx_status VX_API_CALL tivxRegisterModule(const char *name, vx_publish_kernels_f publish, vx_unpublish_kernels_f unpublish);

VX_API_ENTRY vx_status VX_API_CALL tivxUnRegisterModule(const char *name);

vx_enum tivxGetSelfCpuId(void);


#ifndef dimof
#define dimof(x) (sizeof(x)/sizeof(x[0]))
#endif

vx_node tivxCreateNodeByKernelEnum(vx_graph graph,
                                vx_enum kernelenum,
                                vx_reference params[],
                                vx_uint32 num);

vx_node tivxCreateNodeByKernelRef(vx_graph graph,
                                vx_kernel kernel,
                                vx_reference params[],
                                vx_uint32 num);

vx_node tivxCreateNodeByKernelName(vx_graph graph,
                                const char *kernel_name,
                                vx_reference params[],
                                vx_uint32 num);

vx_bool tivxIsReferenceVirtual(vx_reference ref);

vx_reference tivxGetReferenceParent(vx_reference child_ref);

vx_bool tivxIsTargetEnabled(const char target_name[]);

uint64_t tivxPlatformGetTimeInUsecs(void);

vx_status VX_API_CALL tivxSetNodeParameterNumBufByIndex(vx_node node, vx_uint32 idx, vx_uint32 num_buf);

vx_status VX_API_CALL tivxGetNodeParameterNumBufByIndex(vx_node node, vx_uint32 idx, vx_uint32 *num_buf);

vx_status VX_API_CALL tivxSetGraphPipelineDepth(vx_graph graph, vx_uint32 pipeline_depth);

vx_status VX_API_CALL tivxNodeSendCommand(vx_node node,
    uint32_t replicate_nodex_idx, uint32_t node_cmd_id,
    vx_reference ref[], uint32_t num_refs);

vx_status VX_API_CALL tivxNodeSendCommandTimed(vx_node node,
    uint32_t replicate_nodex_idx, uint32_t node_cmd_id,
    vx_reference ref[], uint32_t num_refs, uint32_t timeout);

vx_node tivxGraphGetNode(vx_graph graph, uint32_t idx);

VX_API_ENTRY vx_status VX_API_CALL tivxSetNodeTileSize(vx_node node, vx_uint32 block_width, vx_uint32 block_height);

VX_API_ENTRY vx_status VX_API_CALL tivxSetReferenceAttribute(vx_reference ref, vx_enum attribute, const void *ptr, vx_size size);

VX_API_ENTRY vx_bool VX_API_CALL tivxIsReferenceMetaFormatEqual(vx_reference ref1, vx_reference ref2);

VX_API_ENTRY vx_status VX_API_CALL tivxReferenceImportHandle(vx_reference ref, const void *addr[], const uint32_t size[], uint32_t num_entries);

VX_API_ENTRY vx_status VX_API_CALL tivxReferenceExportHandle(const vx_reference ref, void *addr[], uint32_t size[], uint32_t max_num_entries, uint32_t *num_entries);


VX_API_ENTRY vx_reference VX_API_CALL tivxCreateReferenceFromExemplar(vx_context context, vx_reference exemplar);


#ifdef __cplusplus
}
#endif

#endif