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

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

6 min read time

Applies to Linux

rocJPEG: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocjpeg/checkouts/develop/projects/rocjpeg/api/rocjpeg/rocjpeg.h Source File

Go to the documentation of this file.

 /* Copyright (c) 2024 - 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.
 */
  
 #ifndef ROC_JPEG_H
 #define ROC_JPEG_H
  
 #define ROCJPEGAPI
  
 #pragma once
 #include "hip/hip_runtime.h"
  
 #if defined(__cplusplus)
 extern "C" {
 #endif // __cplusplus
 #define ROCJPEG_MAX_COMPONENT 4
  
 typedef enum {
     ROCJPEG_STATUS_SUCCESS = 0, 
     ROCJPEG_STATUS_NOT_INITIALIZED = -1, 
     ROCJPEG_STATUS_INVALID_PARAMETER = -2, 
     ROCJPEG_STATUS_BAD_JPEG = -3, 
     ROCJPEG_STATUS_JPEG_NOT_SUPPORTED = -4, 
     ROCJPEG_STATUS_OUTOF_MEMORY = -5, 
     ROCJPEG_STATUS_EXECUTION_FAILED = -6, 
     ROCJPEG_STATUS_ARCH_MISMATCH = -7, 
     ROCJPEG_STATUS_INTERNAL_ERROR = -8, 
     ROCJPEG_STATUS_IMPLEMENTATION_NOT_SUPPORTED = -9, 
     ROCJPEG_STATUS_HW_JPEG_DECODER_NOT_SUPPORTED = -10, 
     ROCJPEG_STATUS_RUNTIME_ERROR = -11, 
     ROCJPEG_STATUS_NOT_IMPLEMENTED = -12, 
     ROCJPEG_STATUS_MAX_VALUE = -13, 
 } RocJpegStatus;
  
 typedef enum {
     ROCJPEG_CSS_444 = 0,
     ROCJPEG_CSS_440 = 1,
     ROCJPEG_CSS_422 = 2,
     ROCJPEG_CSS_420 = 3,
     ROCJPEG_CSS_411 = 4,
     ROCJPEG_CSS_400 = 5,
     ROCJPEG_CSS_UNKNOWN = -1
 } RocJpegChromaSubsampling;
  
 typedef struct {
     uint8_t* channel[ROCJPEG_MAX_COMPONENT]; 
     uint32_t pitch[ROCJPEG_MAX_COMPONENT]; 
 } RocJpegImage;
  
 typedef enum {
     ROCJPEG_OUTPUT_NATIVE = 0,
     ROCJPEG_OUTPUT_YUV_PLANAR = 1,
     ROCJPEG_OUTPUT_Y = 2,
     ROCJPEG_OUTPUT_RGB = 3,
     ROCJPEG_OUTPUT_RGB_PLANAR = 4,
     ROCJPEG_OUTPUT_FORMAT_MAX = 5 
 } RocJpegOutputFormat;
  
 typedef struct {
     RocJpegOutputFormat output_format; 
     struct {
         int16_t left; 
         int16_t top; 
         int16_t right; 
         int16_t bottom; 
     } crop_rectangle; 
     struct {
         uint32_t width; 
         uint32_t height; 
     } target_dimension; 
 } RocJpegDecodeParams;
  
 typedef enum {
     ROCJPEG_BACKEND_HARDWARE = 0, 
     ROCJPEG_BACKEND_HYBRID = 1    
 } RocJpegBackend;
  
 typedef void* RocJpegStreamHandle;
  
 RocJpegStatus ROCJPEGAPI rocJpegStreamCreate(RocJpegStreamHandle *jpeg_stream_handle);
  
 RocJpegStatus ROCJPEGAPI rocJpegStreamParse(const unsigned char *data, size_t length, RocJpegStreamHandle jpeg_stream_handle);
  
 RocJpegStatus ROCJPEGAPI rocJpegStreamDestroy(RocJpegStreamHandle jpeg_stream_handle);
  
 typedef void *RocJpegHandle;
  
 RocJpegStatus ROCJPEGAPI rocJpegCreate(RocJpegBackend backend, int device_id, RocJpegHandle *handle);
  
 RocJpegStatus ROCJPEGAPI rocJpegDestroy(RocJpegHandle handle);
  
 RocJpegStatus ROCJPEGAPI rocJpegGetImageInfo(RocJpegHandle handle, RocJpegStreamHandle jpeg_stream_handle, uint8_t *num_components, RocJpegChromaSubsampling *subsampling, uint32_t *widths, uint32_t *heights);
  
 RocJpegStatus ROCJPEGAPI rocJpegDecode(RocJpegHandle handle, RocJpegStreamHandle jpeg_stream_handle, const RocJpegDecodeParams *decode_params, RocJpegImage *destination);
  
 RocJpegStatus ROCJPEGAPI rocJpegDecodeBatched(RocJpegHandle handle, RocJpegStreamHandle *jpeg_stream_handles, int batch_size, const RocJpegDecodeParams *decode_params, RocJpegImage *destinations);
  
 extern const char* ROCJPEGAPI rocJpegGetErrorName(RocJpegStatus rocjpeg_status);
  
 RocJpegStatus ROCJPEGAPI rocJpegDecodeAsync(RocJpegHandle handle, RocJpegStreamHandle jpeg_stream_handle, const RocJpegDecodeParams *decode_params, RocJpegImage *destination);
  
 RocJpegStatus ROCJPEGAPI rocJpegDecodeSync(RocJpegHandle handle, RocJpegImage *destination);
  
 RocJpegStatus ROCJPEGAPI rocJpegDecodeBatchedAsync(RocJpegHandle handle, RocJpegStreamHandle *jpeg_stream_handles, int batch_size, const RocJpegDecodeParams *decode_params, RocJpegImage *destinations);
  
 RocJpegStatus ROCJPEGAPI rocJpegDecodeBatchedSync(RocJpegHandle handle, RocJpegImage *destinations, int batch_size);
  
 #if defined(__cplusplus)
   }
 #endif
  
 #endif // ROC_JPEG_H