/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocal/checkouts/develop/rocAL/include/api/rocal_api_types.h Source File

/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocal/checkouts/develop/rocAL/include/api/rocal_api_types.h Source File#

rocAL: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocal/checkouts/develop/rocAL/include/api/rocal_api_types.h Source File
Go to the documentation of this file.
 /*
 Copyright (c) 2019 - 2025 Advanced Micro Devices, Inc. All rights reserved.
  
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
  
 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.
  
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 */
  
 #ifndef MIVISIONX_ROCAL_API_TYPES_H
 #define MIVISIONX_ROCAL_API_TYPES_H
  
 #include <cstdlib>
 #include <optional>
  
 #ifndef ROCAL_API_CALL
 #if defined(_WIN32)
 #define ROCAL_API_CALL __stdcall
 #else
 #define ROCAL_API_CALL
 #endif
 #endif
  
 #include <half/half.hpp>
 using half_float::half;
  
 typedef void* RocalFloatParam;
  
 typedef void* RocalIntParam;
  
 typedef void* RocalContext;
  
 typedef std::vector<int> ImageIDBatch, AnnotationIDBatch;
 typedef std::vector<std::string> ImagePathBatch;
 typedef std::vector<float> ScoreBatch, RotationBatch;
 typedef std::vector<std::vector<float>> CenterBatch, ScaleBatch;
 typedef std::vector<std::vector<std::vector<float>>> JointsBatch, JointsVisibilityBatch;
  
 struct TimingInfo {
     long long unsigned load_time;
     long long unsigned decode_time;
     long long unsigned process_time;
     long long unsigned transfer_time;
 };
  
 // HRNet training expects meta data (joints_data) in below format, so added here as a type for exposing to user
 struct RocalJointsData {
     ImageIDBatch image_id_batch;
     AnnotationIDBatch annotation_id_batch;
     ImagePathBatch image_path_batch;
     CenterBatch center_batch;
     ScaleBatch scale_batch;
     JointsBatch joints_batch;
     JointsVisibilityBatch joints_visibility_batch;
     ScoreBatch score_batch;
     RotationBatch rotation_batch;
 };
  
 struct ROIxywh {
     unsigned x;
     unsigned y;
     unsigned w;
     unsigned h;
 };
  
 enum RocalStatus {
     ROCAL_OK = 0,
     ROCAL_CONTEXT_INVALID,
     ROCAL_RUNTIME_ERROR,
     ROCAL_UPDATE_PARAMETER_FAILED,
     ROCAL_INVALID_PARAMETER_TYPE
 };
  
 enum RocalImageColor {
     ROCAL_COLOR_RGB24 = 0,
     ROCAL_COLOR_BGR24 = 1,
     ROCAL_COLOR_U8 = 2,
     ROCAL_COLOR_RGB_PLANAR = 3,
 };
  
 enum RocalProcessMode {
     ROCAL_PROCESS_GPU = 0,
     ROCAL_PROCESS_CPU = 1
 };
  
 enum RocalFlipAxis {
     ROCAL_FLIP_HORIZONTAL = 0,
     ROCAL_FLIP_VERTICAL = 1
 };
  
 enum RocalImageSizeEvaluationPolicy {
     ROCAL_USE_MAX_SIZE = 0,
     ROCAL_USE_USER_GIVEN_SIZE = 1,
     ROCAL_USE_MOST_FREQUENT_SIZE = 2,
     ROCAL_USE_USER_GIVEN_SIZE_RESTRICTED = 3,  // use the given size only if the actual decoded size is greater than the given size
     ROCAL_USE_MAX_SIZE_RESTRICTED = 4,         // use max size if the actual decoded size is greater than max
 };
  
 enum RocalDecodeDevice {
     ROCAL_HW_DECODE = 0,
     ROCAL_SW_DECODE = 1
 };
  
 enum RocalTensorLayout {
     ROCAL_NHWC = 0,
     ROCAL_NCHW = 1,
     ROCAL_NFHWC = 2,
     ROCAL_NFCHW = 3,
     ROCAL_NHW = 4,
     ROCAL_NFT = 5,
     ROCAL_NTF = 6,
     ROCAL_NDHWC = 7,
     ROCAL_NCDHW = 8,
     ROCAL_NONE = 9  // Layout for generic tensors (Non-Image or Non-Video)
 };
  
 enum RocalTensorOutputType {
     ROCAL_FP32 = 0,
     ROCAL_FP16 = 1,
     ROCAL_UINT8 = 2,
     ROCAL_INT8 = 3,
     ROCAL_UINT32 = 4,
     ROCAL_INT32 = 5,
     ROCAL_INT16 = 6
 };
  
 enum RocalDecoderType {
     ROCAL_DECODER_TJPEG = 0,
     ROCAL_DECODER_VIDEO_FFMPEG_SW = 1,
     ROCAL_DECODER_AUDIO_GENERIC = 2,
     ROCAL_DECODER_VIDEO_ROCDECODE = 3,
     ROCAL_DECODER_ROCJPEG = 4
 };
  
 enum RocalOutputMemType {
     ROCAL_MEMCPY_HOST = 0,
     ROCAL_MEMCPY_GPU = 1,
     ROCAL_MEMCPY_PINNED = 2
 };
  
 // rocal external memcpy flags
 #define ROCAL_MEMCPY_TO_HOST 1    // force copy to user provided host memory
 #define ROCAL_MEMCPY_TO_DEVICE 2  // force copy to user provided device memory (gpu)
 #define ROCAL_MEMCPY_IS_PINNED 4  // for future use
  
 enum RocalResizeScalingMode {
     ROCAL_SCALING_MODE_DEFAULT = 0,
     ROCAL_SCALING_MODE_STRETCH = 1,
     ROCAL_SCALING_MODE_NOT_SMALLER = 2,
     ROCAL_SCALING_MODE_NOT_LARGER = 3,
     ROCAL_SCALING_MODE_MIN_MAX = 4
 };
  
 enum RocalResizeInterpolationType
 {
     ROCAL_NEAREST_NEIGHBOR_INTERPOLATION = 0,
     ROCAL_LINEAR_INTERPOLATION = 1,
     ROCAL_CUBIC_INTERPOLATION = 2,
     ROCAL_LANCZOS_INTERPOLATION = 3,
     ROCAL_GAUSSIAN_INTERPOLATION = 4,
     ROCAL_TRIANGULAR_INTERPOLATION = 5
 };
  
 enum RocalTensorBackend {
     ROCAL_CPU = 0,
     ROCAL_GPU = 1
 };
  
 enum class RocalROICordsType {
     ROCAL_LTRB = 0,
     ROCAL_XYWH = 1
 };
  
 enum RocalExternalSourceMode {
     ROCAL_EXTSOURCE_FNAME = 0,
     ROCAL_EXTSOURCE_RAW_COMPRESSED = 1,
     ROCAL_EXTSOURCE_RAW_UNCOMPRESSED = 2,
 };
  
 enum RocalAudioBorderType {
     ROCAL_ZERO = 0,
     ROCAL_CLAMP = 1,
     ROCAL_REFLECT = 2
 };
  
 enum RocalOutOfBoundsPolicy {
     ROCAL_PAD = 0,
     ROCAL_TRIMTOSHAPE,
     ROCAL_ERROR
 };
  
 enum RocalMelScaleFormula {
     ROCAL_MELSCALE_SLANEY = 0,
     ROCAL_MELSCALE_HTK
 };
  
 enum RocalLastBatchPolicy {
     ROCAL_LAST_BATCH_FILL = 0,
     ROCAL_LAST_BATCH_DROP = 1,
     ROCAL_LAST_BATCH_PARTIAL = 2
 };
  
  
 enum RocalImageBorderType {
     ROCAL_REPLICATE = 0,
     ROCAL_CONSTANT = 1,
     ROCAL_REFLECT_NO_EDGE = 2
 };
  
 struct RocalShardingInfo {
     RocalLastBatchPolicy last_batch_policy;
     bool pad_last_batch_repeated;
     bool stick_to_shard;
     int32_t shard_size;
  
     // Constructor with default values
     RocalShardingInfo()
         : last_batch_policy(RocalLastBatchPolicy::ROCAL_LAST_BATCH_FILL),
           pad_last_batch_repeated(false),
           stick_to_shard(true),
           shard_size(-1)
     {}
  
     // Constructor that initializes all members
     RocalShardingInfo(
         RocalLastBatchPolicy last_batch_policy,
         bool pad_last_batch_repeated,
         bool stick_to_shard,
         int shard_size
     )
         : last_batch_policy(last_batch_policy),
           pad_last_batch_repeated(pad_last_batch_repeated),
           stick_to_shard(stick_to_shard),
           shard_size(shard_size) {}
 };
  
 enum RocalMissingComponentsBehaviour {
     ROCAL_MISSING_COMPONENT_ERROR = 0,
     ROCAL_MISSING_COMPONENT_SKIP = 1,
     ROCAL_MISSING_COMPONENT_EMPTY = 2
 };
  
 struct CameraMatrix {
     float fx;
     float cx;
     float fy;
     float cy;
 };
  
 struct DistortionCoeffs {
     float k1;
     float k2;
     float p1;
     float p2;
     float k3;
 };
  
 enum RocalBitwiseOp {
     ROCAL_BITWISE_AND = 0,
     ROCAL_BITWISE_OR  = 1,
     ROCAL_BITWISE_XOR = 2,
     ROCAL_BITWISE_NOT = 3
 };
  
 struct RocalPipelineParams {
     std::optional<size_t> batch_size;
     std::optional<size_t> num_threads;
     std::optional<size_t> prefetch_queue_depth;
     std::optional<int> device_id;
     std::optional<bool> rocal_cpu;
     std::optional<unsigned> seed;
 };
  
 #endif  // MIVISIONX_ROCAL_API_TYPES_H