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

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

rocAL: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocal/checkouts/docs-6.2.1/rocAL/include/api/rocal_api_types.h File Reference
rocal_api_types.h File Reference

The AMD rocAL Library - Types. More...

#include <cstdlib>
#include <half/half.hpp>

Go to the source code of this file.

Data Structures

struct  TimingInfo
 Timing Info struct. More...
 
struct  RocalJointsData
 rocAL Joints Data struct - HRNet training expects meta data (joints_data) in below format, so added here as a type for exposing to user More...
 
struct  ROIxywh
 

Macros

#define ROCAL_API_CALL
 
#define ROCAL_MEMCPY_TO_HOST   1
 AMD rocAL external memcpy flags - force copy to user provided host memory.
 
#define ROCAL_MEMCPY_TO_DEVICE   2
 AMD rocAL external memcpy flags - force copy to user provided device memory (gpu)
 
#define ROCAL_MEMCPY_IS_PINNED   4
 AMD rocAL external memcpy flags - for future use.
 

Typedefs

typedef void * RocalFloatParam
 typedef void* Float Param
 
typedef void * RocalIntParam
 typedef void* rocAL Int Param
 
typedef void * RocalContext
 typedef void* rocAL Context
 
typedef std::vector< int > ImageIDBatch
 typedef std::vectors
 
typedef std::vector< int > AnnotationIDBatch
 typedef std::vectors
 
typedef std::vector< std::string > ImagePathBatch
 typedef std::vectors
 
typedef std::vector< float > ScoreBatch
 typedef std::vectors
 
typedef std::vector< float > RotationBatch
 typedef std::vectors
 
typedef std::vector< std::vector< float > > CenterBatch
 typedef std::vectors
 
typedef std::vector< std::vector< float > > ScaleBatch
 typedef std::vectors
 
typedef std::vector< std::vector< std::vector< float > > > JointsBatch
 typedef std::vectors
 
typedef std::vector< std::vector< std::vector< float > > > JointsVisibilityBatch
 typedef std::vectors
 

Enumerations

enum  RocalStatus {
  ROCAL_OK = 0 , ROCAL_CONTEXT_INVALID , ROCAL_RUNTIME_ERROR , ROCAL_UPDATE_PARAMETER_FAILED ,
  ROCAL_INVALID_PARAMETER_TYPE
}
 rocAL Status enum More...
 
enum  RocalImageColor { ROCAL_COLOR_RGB24 = 0 , ROCAL_COLOR_BGR24 = 1 , ROCAL_COLOR_U8 = 2 , ROCAL_COLOR_RGB_PLANAR = 3 }
 rocAL Image Color enum More...
 
enum  RocalProcessMode { ROCAL_PROCESS_GPU = 0 , ROCAL_PROCESS_CPU = 1 }
 rocAL Process Mode enum More...
 
enum  RocalFlipAxis { ROCAL_FLIP_HORIZONTAL = 0 , ROCAL_FLIP_VERTICAL = 1 }
 rocAL Flip Axis enum More...
 
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 ,
  ROCAL_USE_MAX_SIZE_RESTRICTED = 4
}
 rocAL Image Size Evaluation Policy enum More...
 
enum  RocalDecodeDevice { ROCAL_HW_DECODE = 0 , ROCAL_SW_DECODE = 1 }
 rocAL Decode Device enum More...
 
enum  RocalTensorLayout {
  ROCAL_NHWC = 0 , ROCAL_NCHW = 1 , ROCAL_NFHWC = 2 , ROCAL_NFCHW = 3 ,
  ROCAL_NHW = 4 , ROCAL_NFT = 5 , ROCAL_NTF = 6 , ROCAL_NONE = 7
}
 rocAL Tensor Layout enum More...
 
enum  RocalTensorOutputType {
  ROCAL_FP32 = 0 , ROCAL_FP16 = 1 , ROCAL_UINT8 = 2 , ROCAL_INT8 = 3 ,
  ROCAL_UINT32 = 4 , ROCAL_INT32 = 5
}
 rocAL Tensor Output Type enum More...
 
enum  RocalDecoderType {
  ROCAL_DECODER_TJPEG = 0 , ROCAL_DECODER_OPENCV = 1 , ROCAL_DECODER_HW_JPEG = 2 , ROCAL_DECODER_VIDEO_FFMPEG_SW = 3 ,
  ROCAL_DECODER_VIDEO_FFMPEG_HW = 4 , ROCAL_DECODER_AUDIO_GENERIC = 5
}
 rocAL Decoder Type enum More...
 
enum  RocalOutputMemType { ROCAL_MEMCPY_HOST = 0 , ROCAL_MEMCPY_GPU = 1 , ROCAL_MEMCPY_PINNED = 2 }
 
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
}
 rocAL Resize Scaling Mode enum More...
 
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
}
 rocAL Resize Interpolation Type enum More...
 
enum  RocalTensorBackend { ROCAL_CPU = 0 , ROCAL_GPU = 1 }
 Tensor Backend. More...
 
enum class  RocalROICordsType { ROCAL_LTRB = 0 , ROCAL_XYWH = 1 }
 Tensor ROI type. More...
 
enum  RocalExternalSourceMode { ROCAL_EXTSOURCE_FNAME = 0 , ROCAL_EXTSOURCE_RAW_COMPRESSED = 1 , ROCAL_EXTSOURCE_RAW_UNCOMPRESSED = 2 }
 RocalExternalSourceMode struct. More...
 
enum  RocalAudioBorderType { ROCAL_ZERO = 0 , ROCAL_CLAMP = 1 , ROCAL_REFLECT = 2 }
 rocAL Audio Border Type enum More...
 
enum  RocalOutOfBoundsPolicy { ROCAL_PAD = 0 , ROCAL_TRIMTOSHAPE , ROCAL_ERROR }
 rocAL Out Of Bounds Policy Type enum More...
 
enum  RocalMelScaleFormula { ROCAL_MELSCALE_SLANEY = 0 , ROCAL_MELSCALE_HTK }
 rocAL MelScale formula enum More...
 
enum  RocalLastBatchPolicy { ROCAL_LAST_BATCH_FILL = 0 , ROCAL_LAST_BATCH_DROP = 1 , ROCAL_LAST_BATCH_PARTIAL = 2 }
 Tensor Last Batch Policies. More...
 

Detailed Description

The AMD rocAL Library - Types.

Macro Definition Documentation

◆ ROCAL_API_CALL

#define ROCAL_API_CALL

rocAL API Call macro.

Enumeration Type Documentation

◆ RocalOutputMemType

Enumerator
ROCAL_MEMCPY_HOST 

AMD ROCAL_MEMCPY_HOST.

ROCAL_MEMCPY_GPU 

AMD ROCAL_MEMCPY_GPU.

ROCAL_MEMCPY_PINNED 

AMD ROCAL_MEMCPY_PINNED.