RPP common definitions

RPP common definitions#

RPP: RPP common definitions

RPP definitions for all common HOST/GPU typedefs, enums and structures. More...

Data Structures
struct	RppLayoutParams
	RPP layout params. More...

struct	Rpp32f6
	RPP 6 float vector. More...

struct	Rpp32f9
	RPP 9 float vector. More...

struct	Rpp32s24
	RPP 24 signed int vector. More...

struct	Rpp32f24
	RPP 24 float vector. More...

struct	RpptPoint2D
	RPPT Image 2D cartesian point type struct. More...

struct	RpptPoint3D
	RPPT Image 3D point type struct. More...

struct	RpptRoiLtrb
	RPPT Tensor 2D ROI LTRB struct. More...

struct	RpptChannelOffsets
	RPPT Tensor Channel Offsets struct. More...

struct	RpptRoiLtfrbb
	RPPT Tensor 3D ROI LTFRBB struct. More...

struct	RpptRoiXywh
	RPPT Tensor 2D ROI XYWH struct. More...

struct	RpptRoiXyzwhd
	RPPT Tensor 3D ROI XYZWHD struct. More...

union	RpptROI
	RPPT Tensor 2D ROI union. More...

union	RpptROI3D
	RPPT Tensor 3D ROI union. More...

struct	RpptStrides
	RPPT Tensor strides type struct. More...

struct	RpptDesc
	RPPT Tensor descriptor type struct. More...

struct	RpptGenericDesc
	RPPT Tensor Generic descriptor type struct. More...

struct	RpptRGB
	RPPT Tensor 8-bit uchar RGB type struct. More...

struct	RpptFloatRGB
	RPPT Tensor 32-bit float RGB type struct. More...

struct	RpptUintVector2D
	RPPT Tensor 2D 32-bit uint vector type struct. More...

struct	RpptFloatVector2D
	RPPT Tensor 2D 32-bit float vector type struct. More...

struct	RpptImagePatch
	RPPT Tensor 2D image patch dimensions type struct. More...

struct	RpptXorwowState
	RPPT Tensor random number generator state (xorwow state) type struct. More...

struct	RpptXorwowStateBoxMuller
	RPPT Tensor random number generator state (xorwow box muller state) type struct. More...

struct	RpptBilinearNbhoodLocsVecLen8
	RPPT Tensor 2D bilinear neighborhood 32-bit signed int 8-length-vectors type struct. More...

struct	RpptBilinearNbhoodValsVecLen8
	RPPT Tensor 2D bilinear neighborhood 32-bit float 8-length-vectors type struct. More...

struct	GenericFilter
	RPPT Tensor GenericFilter type struct. More...

struct	RpptResamplingWindow
	RPPT Tensor RpptResamplingWindow type struct. More...

struct	BaseMelScale
	Base class for Mel scale conversions. More...

struct	HtkMelScale
	Derived class for HTK Mel scale conversions. More...

struct	SlaneyMelScale
	Derived class for Slaney Mel scale conversions. More...

struct	memCPU
	RPP HOST memory type struct. More...

struct	hipMemRpp32f
	RPP HIP 32-bit float memory. More...

struct	memGPU
	RPP HIP memory management type struct. More...

struct	memMgmt
	RPP HIP-HOST memory management. More...

struct	InitHandle
	RPP initialize handle. More...

Macros
#define	RPP_MIN_8U ( 0 )
	8 bit unsigned char minimum \

#define	RPP_MAX_8U ( 255 )
	8 bit unsigned char maximum \

#define	RPPT_MAX_DIMS ( 5 )
	RPP maximum dimensions in tensor .

#define	RPPT_MAX_DIMS_SAMPLE ( 4 )
	RPP maximum dimensions in tensor for a sample (except batch size) .

#define	RPPT_MAX_AUDIO_CHANNELS ( 16 )
	RPP maximum channels in audio tensor .

#define	HIP_CHECK_LAUNCH_RETURN()
	Check last HIP error after kernel launch; return RPP_ERROR_HIP_LAUNCH on failure. Use after hipLaunchKernelGGL. More...

Typedefs
typedef unsigned char	Rpp8u
	8 bit unsigned char

typedef signed char	Rpp8s
	8 bit signed char

typedef unsigned short	Rpp16u
	16 bit unsigned short

typedef short	Rpp16s
	16 bit signed short

typedef unsigned int	Rpp32u
	32 bit unsigned int

typedef int	Rpp32s
	32 bit signed int

typedef unsigned long long	Rpp64u
	64 bit unsigned long long

typedef long long	Rpp64s
	64 bit long long

typedef float	Rpp32f
	32 bit float

typedef double	Rpp64f
	64 bit double

typedef void *	RppPtr_t
	void pointer

typedef size_t	RppSize_t
	size_t

typedef struct GenericFilter	GenericFilter
	RPPT Tensor GenericFilter type struct.

typedef struct RpptResamplingWindow	RpptResamplingWindow
	RPPT Tensor RpptResamplingWindow type struct.

Enumerations
enum	RppStatus { RPP_SUCCESS = 0 , RPP_ERROR = -1 , RPP_ERROR_INVALID_ARGUMENTS = -2 , RPP_ERROR_LOW_OFFSET = -3 , RPP_ERROR_ZERO_DIVISION = -4 , RPP_ERROR_HIGH_SRC_DIMENSION = -5 , RPP_ERROR_NOT_IMPLEMENTED = -6 , RPP_ERROR_INVALID_SRC_CHANNELS = -7 , RPP_ERROR_INVALID_DST_CHANNELS = -8 , RPP_ERROR_INVALID_SRC_LAYOUT = -9 , RPP_ERROR_INVALID_DST_LAYOUT = -10 , RPP_ERROR_INVALID_SRC_DATATYPE = -11 , RPP_ERROR_INVALID_DST_DATATYPE = -12 , RPP_ERROR_INVALID_SRC_OR_DST_DATATYPE = -13 , RPP_ERROR_INSUFFICIENT_DST_BUFFER_LENGTH = -14 , RPP_ERROR_INVALID_PARAMETER_DATATYPE = -15 , RPP_ERROR_NOT_ENOUGH_MEMORY = -16 , RPP_ERROR_OUT_OF_BOUND_SRC_ROI = -17 , RPP_ERROR_LAYOUT_MISMATCH = -18 , RPP_ERROR_INVALID_CHANNELS = -19 , RPP_ERROR_INVALID_OUTPUT_TILE_LENGTH = -20 , RPP_ERROR_OUT_OF_BOUND_SHARED_MEMORY_SIZE = -21 , RPP_ERROR_OUT_OF_BOUND_SCRATCH_MEMORY_SIZE = -22 , RPP_ERROR_INVALID_SRC_DIMS = -23 , RPP_ERROR_INVALID_DST_DIMS = -24 , RPP_ERROR_INVALID_DIM_LENGTHS = -25 , RPP_ERROR_INVALID_AXIS = -26 , RPP_ERROR_INCOMPATIBLE_BACKEND = -27 , RPP_ERROR_HIP_LAUNCH = -28 }
	RPP RppStatus type enums. More...

enum	RppBackend { RPP_HOST_BACKEND , RPP_HIP_BACKEND }
	RPP RppBackend type enums.

enum	rppStatus_t { rppStatusSuccess = 0 , rppStatusBadParm = -1 , rppStatusUnknownError = -2 , rppStatusNotInitialized = -3 , rppStatusInvalidValue = -4 , rppStatusAllocFailed = -5 , rppStatusInternalError = -6 , rppStatusNotImplemented = -7 , rppStatusUnsupportedOp = -8 }
	RPP rppStatus_t type enums.

enum	RpptBitwiseOp { RPP_TENSOR_OP_AND , RPP_TENSOR_OP_OR , RPP_TENSOR_OP_XOR }
	RPP Tensor Operations type enum.

enum	RpptDataType { U8 , F32 , F16 , I8 , I16 , U16 , I32 , U32 }
	RPPT Tensor datatype enum.

enum	RpptLayout { NCHW , NHWC , NCDHW , NDHWC , NHW , NFT , NTF }
	RPPT Tensor layout type enum.

enum	RpptColorStandard { RpptColorStandard_BT709 = 0 , RpptColorStandard_FCC = 4 , RpptColorStandard_BT470BG = 5 , RpptColorStandard_BT601 = 6 , RpptColorStandard_SMPTE240M = 7 , RpptColorStandard_BT2020_NCL = 9 , RpptColorStandard_BT2020_CL = 10 }
	Color space standard for NV12 to RGB (YUV/YCbCr to RGB matrix). More...

enum	RpptColorRange { RpptColorRange_STUDIO = 0 , RpptColorRange_FULL = 2 }
	Color range (luma/chroma legal levels) for NV12 to RGB. More...

enum	RpptRoiType { LTRB , XYWH }
	RPPT Tensor 2D ROI type enum.

enum	RpptRoi3DType { LTFRBB , XYZWHD }
	RPPT Tensor 3D ROI type enum.

enum	RpptSubpixelLayout { RGBtype , BGRtype }
	RPPT Tensor subpixel layout type enum.

enum	RpptInterpolationType { NEAREST_NEIGHBOR = 0 , BILINEAR , BICUBIC , LANCZOS , GAUSSIAN , TRIANGULAR }
	RPPT Tensor interpolation type enum.

enum	RpptAudioBorderType { ZERO = 0 , CLAMP , REFLECT }
	RPPT Audio Border Type.

enum	RpptImageBorderEdge { TOP_EDGE = 0 , BOTTOM_EDGE , LEFT_EDGE , RIGHT_EDGE }
	RPPT Image Border Edge type enum.

enum	RpptImageBorderType { REPLICATE = 0 , CONSTANT , REFLECT_NO_EDGE }
	RPPT Image Border Type.

enum	RpptMelScaleFormula { SLANEY = 0 , HTK }
	RPPT Mel Scale Formula.

Detailed Description

RPP definitions for all common HOST/GPU typedefs, enums and structures.

Macro Definition Documentation

◆ HIP_CHECK_LAUNCH_RETURN

#define HIP_CHECK_LAUNCH_RETURN ( )

Value:

  do {                                                                         \
    hipError_t status = hipGetLastError();                                     \
    if (status != hipSuccess) {                                                \
      std::cerr << "AMD RPP: HIP Error Reported -- "                           \
                << hipGetErrorString(status) << std::endl;                     \
      return RPP_ERROR_HIP_LAUNCH;                                             \
    }                                                                          \
  } while (0)

Check last HIP error after kernel launch; return RPP_ERROR_HIP_LAUNCH on failure. Use after hipLaunchKernelGGL.

Enumeration Type Documentation

◆ RppStatus

enum RppStatus

RPP RppStatus type enums.

Enumerator
RPP_SUCCESS	No error.
RPP_ERROR	Unspecified error.
RPP_ERROR_INVALID_ARGUMENTS	One or more arguments invalid. (Needs to adhere to function specification.)
RPP_ERROR_LOW_OFFSET	Low tensor offsetInBytes provided for src/dst tensor.
RPP_ERROR_ZERO_DIVISION	Arguments provided will result in zero division error.
RPP_ERROR_HIGH_SRC_DIMENSION	Src tensor / src ROI dimension too high. (Needs to adhere to function specification.)
RPP_ERROR_NOT_IMPLEMENTED	Function variant requested is not implemented / unsupported.
RPP_ERROR_INVALID_SRC_CHANNELS	Invalid src tensor number of channels. (Needs to adhere to function specification.)
RPP_ERROR_INVALID_DST_CHANNELS	Invalid dst tensor number of channels. (Needs to adhere to function specification.)
RPP_ERROR_INVALID_SRC_LAYOUT	Invalid src tensor layout. (Needs to adhere to function specification.)
RPP_ERROR_INVALID_DST_LAYOUT	Invalid dst tensor layout. (Needs to adhere to function specification.)
RPP_ERROR_INVALID_SRC_DATATYPE	Invalid src tensor datatype. (Needs to adhere to function specification.)
RPP_ERROR_INVALID_DST_DATATYPE	Invalid dst tensor datatype. (Needs to adhere to function specification.)
RPP_ERROR_INVALID_SRC_OR_DST_DATATYPE	Invalid src/dst tensor datatype. (Needs to adhere to function specification.)
RPP_ERROR_INSUFFICIENT_DST_BUFFER_LENGTH	Insufficient dst buffer length provided. (Needs to adhere to function specification.)
RPP_ERROR_INVALID_PARAMETER_DATATYPE	Invalid datatype.
RPP_ERROR_NOT_ENOUGH_MEMORY	Not enough memory to write outputs, as per dim-lengths and strides set in descriptor.
RPP_ERROR_OUT_OF_BOUND_SRC_ROI	Out of bound source ROI.
RPP_ERROR_LAYOUT_MISMATCH	src and dst layout mismatch
RPP_ERROR_INVALID_CHANNELS	Number of channels is invalid. (Needs to adhere to function specification.)
RPP_ERROR_INVALID_OUTPUT_TILE_LENGTH	Invalid output tile length (Needs to adhere to function specification.)
RPP_ERROR_OUT_OF_BOUND_SHARED_MEMORY_SIZE	Shared memory size needed is beyond the bounds (Needs to adhere to function specification.)
RPP_ERROR_OUT_OF_BOUND_SCRATCH_MEMORY_SIZE	Scratch memory size needed is beyond the bounds (Needs to adhere to function specification.)
RPP_ERROR_INVALID_SRC_DIMS	Number of src dims is invalid. (Needs to adhere to function specification.)
RPP_ERROR_INVALID_DST_DIMS	Number of dst dims is invalid. (Needs to adhere to function specification.)
RPP_ERROR_INVALID_DIM_LENGTHS	Length in some dimensions are invalid. (Needs to adhere to function specification.)
RPP_ERROR_INVALID_AXIS	The specified axis is invalid or out of range. (Needs to adhere to function specification.)
RPP_ERROR_INCOMPATIBLE_BACKEND	The user specified backend is not compatible with the initialized handle.
RPP_ERROR_HIP_LAUNCH	HIP/GPU runtime or kernel launch error.

◆ RpptColorRange

enum RpptColorRange

Color range (luma/chroma legal levels) for NV12 to RGB.

Color range specifies how 8-bit Y (and scaling of the matrix) is interpreted: limited (studio / TV / MPEG) vs full (JPEG / PC). RpptColorRange_STUDIO: luma nominally 16–235, chroma centered with Y bias 16. RpptColorRange_FULL: luma 0–255, Y bias 0.

Enumerator
RpptColorRange_STUDIO	Limited / MPEG / TV range
RpptColorRange_FULL	Full / JPEG / PC range

◆ RpptColorStandard

enum RpptColorStandard

Color space standard for NV12 to RGB (YUV/YCbCr to RGB matrix).

Selects which industry color space standard defines the luma coefficients (wr, wb).

Enumerator
RpptColorStandard_BT709	ITU-R BT.709 (default wr=0.2126, wb=0.0722)
RpptColorStandard_FCC	FCC
RpptColorStandard_BT470BG	ITU-R BT.470 System B, G
RpptColorStandard_BT601	ITU-R BT.601 / SMPTE 170M
RpptColorStandard_SMPTE240M	SMPTE 240M
RpptColorStandard_BT2020_NCL	ITU-R BT.2020 non-constant luminance
RpptColorStandard_BT2020_CL	ITU-R BT.2020 constant luminance

RPP common definitions

RPP common definitions#

Data Structures

Macros

Typedefs

Enumerations