vx_reference.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2016 The Khronos Group Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */



#ifndef VX_REFERENCE_H_
#define VX_REFERENCE_H_



#ifdef __cplusplus
extern "C" {
#endif

typedef enum _tivx_reftype_e {
    VX_INTERNAL = 1,
    VX_EXTERNAL = 2,
    VX_BOTH = 3,
} tivx_reftype_e;

typedef vx_status (*tivx_reference_callback_f)(vx_reference ref);

typedef vx_status (* VX_API_CALL tivx_reference_release_callback_f)(vx_reference *ref);

typedef vx_status (*vx_kernel_callback_f)(vx_enum kernel_enum, vx_bool validate_only, const vx_reference input, const vx_reference output);

typedef struct _vx_reference {

    uint32_t magic;

    vx_enum type;

    vx_context context;

    vx_reference scope;

    char name[VX_MAX_REFERENCE_NAME];

    vx_uint32 external_count;

    vx_uint32 internal_count;

    tivx_reference_callback_f mem_alloc_callback;

    tivx_reference_callback_f destructor_callback;

    tivx_reference_release_callback_f release_callback;

    /* \brief Object specific function that is called for generic kernel operations
     * such as Copy and Select
    */
    vx_kernel_callback_f kernel_callback;

    tivx_mutex lock;

    /* \brief This indicates if the object belongs to a delay */
    vx_delay delay;
    /* \brief This indicates the original delay slot index when the object belongs to a delay */
    vx_int32 delay_slot_index;

    vx_bool is_virtual;

    vx_bool is_accessible;

    vx_bool is_array_element;

    vx_bool is_allocated;

    tivx_obj_desc_t *obj_desc;

    vx_user_data_object supplementary_data;

} tivx_reference_t;

vx_reference ownCreateReference(vx_context context, vx_enum ref_type, vx_enum reftype, vx_reference scope);

vx_status ownReleaseReferenceInt(vx_reference *ref,
                        vx_enum ref_type,
                        vx_enum reftype,
                        tivx_reference_callback_f destructor);

vx_bool ownIsValidSpecificReference(vx_reference ref, vx_enum ref_type);

vx_status ownReferenceLock(vx_reference ref);

vx_status ownReferenceUnlock(vx_reference ref);

vx_uint32 ownIncrementReference(vx_reference ref, vx_enum reftype);

vx_uint32 ownDecrementReference(vx_reference ref, vx_enum reftype);

vx_bool ownIsValidType(vx_enum ref_type);

vx_status ownInitReference(vx_reference ref, vx_context context, vx_enum ref_type, vx_reference scope);

vx_status ownCreateReferenceLock(vx_reference ref);

vx_status ownDeleteReferenceLock(vx_reference ref);


vx_bool ownIsValidReference(vx_reference ref);

void ownInitReferenceForDelay(vx_reference ref, vx_delay d, vx_int32 idx);

vx_status ownReferenceAllocMem(vx_reference ref);

vx_size ownSizeOfEnumType(vx_enum item_type);


void ownReferenceSetScope(vx_reference ref, vx_reference scope);


vx_reference ownReferenceGetHandleFromObjDescId(uint16_t obj_desc_id);

uint16_t ownReferenceGetObjDescId(vx_reference ref);

vx_status ownAllocReferenceBufferGeneric(vx_reference ref);

vx_status ownDestructReferenceGeneric(vx_reference ref);

vx_status ownCopyReferenceGeneric(vx_reference input, vx_reference output);

vx_status ownSwapReferenceGeneric(vx_reference input, vx_reference output);

vx_status VX_CALLBACK ownKernelCallbackGeneric(vx_enum kernel_enum, vx_bool validate_only, const vx_reference input, const vx_reference output);

#ifdef __cplusplus
}
#endif

#endif