/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocdecode/checkouts/docs-6.2.1/api/rocparser.h File Reference

• api

Data Structures | Typedefs | Enumerations | Functions

rocparser.h File Reference

The AMD rocParser Library. More...

#include "rocdecode.h"

Go to the source code of this file.

Data Structures
struct	RocdecVideoFormat
	ROCDEC_VIDEO_FORMAT structUsed in Parser callback API. More...
struct	RocdecVideoFormatEx
struct	_RocdecSourceDataPacket
struct	_RocdecParserDispInfo
struct	_RocdecOperatingPointInfo
	RocdecOperatingPointInfo structOperating point information of scalable bitstream. More...
struct	_RocdecSeiMessage
struct	_RocdecSeiMessageInfo
struct	_RocdecParserParams
	The AMD rocDecode library.\Used in rocDecCreateVideoParser API. More...

Typedefs
typedef void *	RocdecVideoParser
typedef uint64_t	RocdecTimeStamp
typedef struct _RocdecSourceDataPacket	RocdecSourceDataPacket
typedef struct _RocdecParserDispInfo	RocdecParserDispInfo
typedef struct _RocdecOperatingPointInfo	RocdecOperatingPointInfo
	RocdecOperatingPointInfo structOperating point information of scalable bitstream.
typedef struct _RocdecSeiMessage	RocdecSeiMessage
typedef struct _RocdecSeiMessageInfo	RocdecSeiMessageInfo
typedef int(ROCDECAPI *	PFNVIDSEQUENCECALLBACK) (void *, RocdecVideoFormat *)
	Parser callbacks \ The parser will call these synchronously from within rocDecParseVideoData(), whenever there is sequence change or a picture \ is ready to be decoded and/or displayed. \ Return values from these callbacks are interpreted as below. If the callbacks return failure, it will be propagated by \ rocDecParseVideoData() to the application. \ Parser picks default operating point as 0 and outputAllLayers flag as 0 if PFNVIDOPPOINTCALLBACK is not set or return value is \ -1 or invalid operating point. \ PFNVIDSEQUENCECALLBACK : 0: fail, 1: succeeded, > 1: override dpb size of parser (set by RocdecParserParams::max_num_decode_surfaces \ while creating parser) \ PFNVIDDECODECALLBACK : 0: fail, >=1: succeeded \ PFNVIDDISPLAYCALLBACK : 0: fail, >=1: succeeded \ PFNVIDOPPOINTCALLBACK : <0: fail, >=0: succeeded (bit 0-9: OperatingPoint, bit 10-10: outputAllLayers, bit 11-30: reserved) \ PFNVIDSEIMSGCALLBACK : 0: fail, >=1: succeeded.
typedef int(ROCDECAPI *	PFNVIDDECODECALLBACK) (void *, RocdecPicParams *)
typedef int(ROCDECAPI *	PFNVIDDISPLAYCALLBACK) (void *, RocdecParserDispInfo *)
typedef int(ROCDECAPI *	PFNVIDSEIMSGCALLBACK) (void *, RocdecSeiMessageInfo *)
typedef struct _RocdecParserParams	RocdecParserParams
	The AMD rocDecode library.\Used in rocDecCreateVideoParser API.

Enumerations
enum	RocdecVideoPacketFlags {   ROCDEC_PKT_ENDOFSTREAM = 0x01 , ROCDEC_PKT_TIMESTAMP = 0x02 , ROCDEC_PKT_DISCONTINUITY = 0x04 , ROCDEC_PKT_ENDOFPICTURE = 0x08 ,   ROCDEC_PKT_NOTIFY_EOS = 0x10 }

Functions
rocDecStatus ROCDECAPI	rocDecCreateVideoParser (RocdecVideoParser *parser_handle, RocdecParserParams *params)
rocDecStatus ROCDECAPI	rocDecParseVideoData (RocdecVideoParser parser_handle, RocdecSourceDataPacket *packet)
rocDecStatus ROCDECAPI	rocDecDestroyVideoParser (RocdecVideoParser parser_handle)

Detailed Description

The AMD rocParser Library.

Typedef Documentation

◆ RocdecVideoParser

typedef void* RocdecVideoParser

HANDLE pf rocDecDecoder Used in subsequent API calls after rocDecCreateDecoder

Enumeration Type Documentation

◆ RocdecVideoPacketFlags

enum RocdecVideoPacketFlags

Data packet flags Used in RocdecSourceDataPacket structure

Enumerator
ROCDEC_PKT_ENDOFSTREAM	Set when this is the last packet for this stream
ROCDEC_PKT_TIMESTAMP	Timestamp is valid
ROCDEC_PKT_DISCONTINUITY	Set when a discontinuity has to be signalled
ROCDEC_PKT_ENDOFPICTURE	Set when the packet contains exactly one frame or one field
ROCDEC_PKT_NOTIFY_EOS	If this flag is set along with ROCDEC_PKT_ENDOFSTREAM, an additional (dummy) display callback will be invoked with null value of ROCDECPARSERDISPINFO which should be interpreted as end of the stream.