/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocdecode/checkouts/develop/projects/rocdecode/api/rocdecode/rocparser.h Source File

/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocdecode/checkouts/develop/projects/rocdecode/api/rocdecode/rocparser.h Source File#

7 min read time
Applies to Linux
rocDecode: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocdecode/checkouts/develop/projects/rocdecode/api/rocdecode/rocparser.h Source File
Go to the documentation of this file.
 /*
 Copyright (c) 2023 - 2026 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.
 */
  
 #pragma once
  
 #include "rocdecode/rocdecode.h"
  
 #if defined(__cplusplus)
 extern "C" {
 #endif /* __cplusplus */
  
 /*********************************************************************************/
 /*********************************************************************************/
  
 typedef void *RocdecVideoParser;
 typedef uint64_t RocdecTimeStamp;
  
 /***************************************************************/
 /***************************************************************/
 typedef enum {
     ROCDEC_RECONFIG_NEW_SURFACES  = 0,      
     ROCDEC_RECONFIG_KEEP_SURFACES = 1,      
 } RocdecReconfigOptions;
  
 typedef struct {
     rocDecVideoCodec codec; 
     struct {
         uint32_t numerator;
         uint32_t denominator;
     } frame_rate;
     uint8_t progressive_sequence;    
     uint8_t bit_depth_luma_minus8;   
     uint8_t bit_depth_chroma_minus8; 
     uint8_t min_num_decode_surfaces; 
     uint32_t coded_width;            
     uint32_t coded_height;           
     struct {
         int left;   
         int top;    
         int right;  
         int bottom; 
     } display_area;
     rocDecVideoChromaFormat chroma_format; 
     uint32_t bitrate;                      
     struct {
         int x;
         int y;
     } display_aspect_ratio;
     struct {
         uint8_t video_format : 3;          
         uint8_t video_full_range_flag : 1; 
         uint8_t reserved_zero_bits : 4;    
         uint8_t color_primaries;           
         uint8_t transfer_characteristics;  
         uint8_t matrix_coefficients;       
     } video_signal_description;
     uint32_t seqhdr_data_length;           
     uint32_t reconfig_options;             
 } RocdecVideoFormat;
  
 /****************************************************************/
 /****************************************************************/
 typedef struct {
     RocdecVideoFormat format; 
     uint32_t max_width;
     uint32_t max_height;
     uint8_t raw_seqhdr_data[1024]; 
 } RocdecVideoFormatEx;
  
 /***************************************************************/
 /***************************************************************/
 typedef enum {
     ROCDEC_PKT_ENDOFSTREAM = 0x01,   
     ROCDEC_PKT_TIMESTAMP = 0x02,     
     ROCDEC_PKT_DISCONTINUITY = 0x04, 
     ROCDEC_PKT_ENDOFPICTURE = 0x08,  
     ROCDEC_PKT_NOTIFY_EOS = 0x10,    
 } RocdecVideoPacketFlags;
  
 /*****************************************************************************/
 /*****************************************************************************/
 typedef struct _RocdecSourceDataPacket {
     uint32_t flags;         
     uint32_t payload_size;  
     const uint8_t *payload; 
     RocdecTimeStamp pts;    
 } RocdecSourceDataPacket;
  
 /**********************************************************************************/
 /**********************************************************************************/
 typedef struct _RocdecParserDispInfo {
     int picture_index;      
     int progressive_frame;  
     int top_field_first;    
     int repeat_first_field; 
     RocdecTimeStamp pts;    
 } RocdecParserDispInfo;
  
 typedef struct _RocdecOperatingPointInfo {
     rocDecVideoCodec codec;
     union {
         struct
         {
             uint8_t operating_points_cnt;
             uint8_t reserved24_bits[3];
             uint16_t operating_points_idc[32];
         } av1;
         uint8_t codec_reserved[1024];
     };
 } RocdecOperatingPointInfo;
  
 /**********************************************************************************/
 /**********************************************************************************/
 typedef struct _RocdecSeiMessage {
     uint8_t sei_message_type; 
     uint8_t reserved[3];
     uint32_t sei_message_size; 
 } RocdecSeiMessage;
  
 /**********************************************************************************/
 /**********************************************************************************/
 typedef struct _RocdecSeiMessageInfo {
     void *sei_data;                
     RocdecSeiMessage *sei_message; 
     uint32_t sei_message_count;    
     uint32_t picIdx;               
 } RocdecSeiMessageInfo;
  
 typedef int(ROCDECAPI *PFNVIDSEQUENCECALLBACK)(void *, RocdecVideoFormat *);
 typedef int(ROCDECAPI *PFNVIDDECODECALLBACK)(void *, RocdecPicParams *);
 typedef int(ROCDECAPI *PFNVIDDISPLAYCALLBACK)(void *, RocdecParserDispInfo *);
 // typedef int (ROCDECAPI *PFNVIDOPPOINTCALLBACK)(void *, RocdecOperatingPointInfo*);        // reserved for future (AV1 specific)
 typedef int(ROCDECAPI *PFNVIDSEIMSGCALLBACK)(void *, RocdecSeiMessageInfo *);
  
 typedef struct _RocdecParserParams {
     rocDecVideoCodec codec_type;                  
     uint32_t max_num_decode_surfaces;             
     uint32_t clock_rate;                          
     uint32_t error_threshold;                     
     uint32_t max_display_delay;                   
     uint32_t annex_b : 1;                         
     uint32_t reserved : 31;                       
     uint32_t reserved_1[4];                       
     void *user_data;                              
     PFNVIDSEQUENCECALLBACK pfn_sequence_callback; 
     PFNVIDDECODECALLBACK pfn_decode_picture;      
     PFNVIDDISPLAYCALLBACK pfn_display_picture;    
     PFNVIDSEIMSGCALLBACK pfn_get_sei_msg;         
     void *reserved_2[5];                          
     RocdecVideoFormatEx *ext_video_info;          
 } RocdecParserParams;
  
 extern rocDecStatus ROCDECAPI rocDecCreateVideoParser(RocdecVideoParser *parser_handle, RocdecParserParams *params);
  
 extern rocDecStatus ROCDECAPI rocDecParseVideoData(RocdecVideoParser parser_handle, RocdecSourceDataPacket *packet);
  
 extern rocDecStatus ROCDECAPI rocDecDestroyVideoParser(RocdecVideoParser parser_handle);
  
 #if defined(__cplusplus)
 }
 #endif /* __cplusplus */