Contents

• 1. Introduction
  • 1.1. nvJPEG Decoder
  • 1.2. nvJPEG Encoder
  • 1.3. Thread Safety
  • 1.4. Multi-GPU support
  • 1.5. Hardware Acceleration
• 2. JPEG Decoding
  • 2.1. Using JPEG Decoding
    • 2.1.1. Single Image Decoding
    • 2.1.2. Decode using Decoupled Phases
    • 2.1.3. Batched Image Decoding
      • 2.1.3.1. Single Phase
  • 2.2. nvJPEG Type Declarations
    • 2.2.1. nvJPEG Backend
    • 2.2.2. nvJPEG Bitstream Handle
    • 2.2.3. nvJPEG Decode Device Buffer Handle
    • 2.2.4. nvJPEG Decode Parameter Handle
    • 2.2.5. nvJPEG Decode Pinned Buffer Handle
    • 2.2.6. nvJPEG Decoder Handle
    • 2.2.7. nvJPEG Host Pinned Memory Allocator Interface
    • 2.2.8. nvJPEG Extended Host Pinned Memory Allocator Interface
    • 2.2.9. nvJPEG Image
    • 2.2.10. nvJPEG Device Memory Allocator Interface
    • 2.2.11. nvJPEG Extended Device Memory Allocator Interface
    • 2.2.12. nvJPEG Opaque JPEG Decoding State Handle
    • 2.2.13. nvJPEG Opaque Library Handle Struct
    • 2.2.14. nvJPEG Output Pointer Struct
    • 2.2.15. nvJPEG Jpeg Encoding
    • 2.2.16. nvJPEG Scale Factor
    • 2.2.17. nvJPEG Flags
    • 2.2.18. nvJPEG Exif Orientation
  • 2.3. nvJPEG API Reference
    • 2.3.1. nvJPEG Helper API Reference
      • 2.3.1.1. nvjpegGetProperty()
      • 2.3.1.2. nvjpegGetCudartProperty()
      • 2.3.1.3. nvjpegCreate() [DEPRECATED]
      • 2.3.1.4. nvjpegCreateSimple()
      • 2.3.1.5. nvjpegCreateEx()
      • 2.3.1.6. nvjpegCreateExV2()
      • 2.3.1.7. nvjpegDestroy()
      • 2.3.1.8. nvjpegSetDeviceMemoryPadding()
      • 2.3.1.9. nvjpegGetDeviceMemoryPadding()
      • 2.3.1.10. nvjpegSetPinnedMemoryPadding()
      • 2.3.1.11. nvjpegGetPinnedMemoryPadding()
      • 2.3.1.12. nvjpegGetHardwareDecoderInfo()
      • 2.3.1.13. nvjpegJpegStateCreate()
      • 2.3.1.14. nvjpegJpegStateDestroy()
      • 2.3.1.15. nvjpegDecoderCreate()
      • 2.3.1.16. nvjpegDecoderDestroy()
      • 2.3.1.17. nvjpegDecoderJpegSupported()
      • 2.3.1.18. nvjpegDecoderStateCreate()
      • 2.3.1.19. nvjpegJpegStreamCreate()
      • 2.3.1.20. nvjpegJpegStreamDestroy()
      • 2.3.1.21. nvjpegBufferPinnedCreate()
      • 2.3.1.22. nvjpegBufferPinnedCreateV2()
      • 2.3.1.23. nvjpegBufferPinnedDestroy()
      • 2.3.1.24. nvjpegStateAttachPinnedBuffer()
      • 2.3.1.25. nvjpegBufferPinnedRetrieve()
      • 2.3.1.26. nvjpegBufferPinnedResize()
      • 2.3.1.27. nvjpegBufferDeviceCreate()
      • 2.3.1.28. nvjpegBufferDeviceCreateV2()
      • 2.3.1.29. nvjpegBufferDeviceDestroy()
      • 2.3.1.30. nvjpegStateAttachDeviceBuffer()
      • 2.3.1.31. nvjpegBufferDeviceRetrieve()
      • 2.3.1.32. nvjpegBufferDeviceResize()
      • 2.3.1.33. nvjpegDecodeParamsCreate()
      • 2.3.1.34. nvjpegDecodeParamsDestroy()
    • 2.3.2. Retrieve Encoded Image Information API
      • 2.3.2.1. nvjpegGetImageInfo()
      • 2.3.2.2. nvJPEG Stream API
        • 2.3.2.2.1. nvjpegJpegStreamParse()
        • 2.3.2.2.2. nvjpegJpegStreamParseHeader()
        • 2.3.2.2.3. nvjpegJpegStreamParseTables()
        • 2.3.2.2.4. nvjpegJpegStreamGetFrameDimensions()
        • 2.3.2.2.5. nvjpegJpegStreamGetComponentsNum()
        • 2.3.2.2.6. nvjpegJpegStreamGetComponentDimensions()
        • 2.3.2.2.7. nvjpegJpegStreamGetChromaSubsampling()
        • 2.3.2.2.8. nvjpegJpegStreamGetJpegEncoding()
        • 2.3.2.2.9. nvjpegJpegStreamGetExifOrientation()
        • 2.3.2.2.10. nvjpegJpegStreamGetSamplePrecision()
    • 2.3.3. Decode API—Single Phase
      • 2.3.3.1. ​nvjpegDecode()
      • 2.3.3.2. ​nvjpegDecodeBatchedInitialize()
      • 2.3.3.3. ​nvjpegDecodeBatched()
      • 2.3.3.4. nvjpegDecodeBatchedEx()
      • 2.3.3.5. nvjpegDecodeBatchedSupported()
      • 2.3.3.6. nvjpegDecodeBatchedSupportedEx()
      • 2.3.3.7. nvjpegDecodeBatchedPreAllocate()
      • 2.3.3.8. nvjpegDecodeBatchedParseJpegTables()
    • 2.3.4. Decode API—Decoupled Decoding
      • 2.3.4.1. nvjpegDecodeJpegHost()
      • 2.3.4.2. nvjpegDecodeJpegTransferToDevice()
      • 2.3.4.3. nvjpegDecodeJpegDevice()
      • 2.3.4.4. nvjpegDecodeJpeg()
    • 2.3.5. nvJPEG Decode Parameters
      • 2.3.5.1. nvjpegDecodeParamsSetOutputFormat()
      • 2.3.5.2. nvjpegDecodeParamsSetROI()
      • 2.3.5.3. nvjpegDecodeParamsSetAllowCMYK()
      • 2.3.5.4. nvjpegDecodeParamsSetScaleFactor()
      • 2.3.5.5. nvjpegDecodeParamsSetExifOrientation()
    • 2.3.6. nvJPEG API Return Codes
    • 2.3.7. nvJPEG Chroma Subsampling
    • 2.3.8. Reference Documents
  • 2.4. Examples of nvJPEG
• 3. JPEG Encoding
  • 3.1. Using the Encoder
    • 3.1.1. Encoding the Parameters
    • 3.1.2. Encoding the State
    • 3.1.3. Encoding the Image
      • 3.1.3.1. nvjpegEncodeYUV
      • 3.1.3.2. nvjpegEncodeImage
    • 3.1.4. Retrieving the Compressed Stream
    • 3.1.5. JPEG Encoding Example
  • 3.2. nvJPEG Encoder Type Declarations
    • 3.2.1. nvjpegInputFormat_t
    • 3.2.2. nvjpegEncoderState_t
    • 3.2.3. nvjpegEncoderParams_t
  • 3.3. nvJPEG Encoder Helper API Reference
    • 3.3.1. nvjpegEncoderStateCreate()
    • 3.3.2. nvjpegEncoderStateDestroy()
    • 3.3.3. nvjpegEncoderParamsCreate()
    • 3.3.4. nvjpegEncoderParamsDestroy()
    • 3.3.5. nvjpegEncoderParamsSetEncoding()
    • 3.3.6. nvjpegEncoderParamsSetQuality()
    • 3.3.7. nvjpegEncoderParamsSetOptimizedHuffman()
    • 3.3.8. nvjpegEncoderParamsSetSamplingFactors()
  • 3.4. nvJPEG Encoder API Reference
    • 3.4.1. nvjpegEncodeGetBufferSize()
    • 3.4.2. nvjpegEncodeYUV()
    • 3.4.3. nvjpegEncodeImage()
    • 3.4.4. nvjpegEncodeRetrieveBitstream()
    • 3.4.5. nvjpegEncodeRetrieveBitstreamDevice()
• 4. JPEG Transcoding
  • 4.1. nvJPEG Transcoder Helper API Reference
    • 4.1.1. nvjpegEncoderParamsCopyMetadata()
    • 4.1.2. nvjpegEncoderParamsCopyQuantizationTables()
    • 4.1.3. nvjpegEncoderParamsCopyHuffmanTables() [Deprecated]
  • 4.2. JPEG Transcoding Example
• 5. List of Dropped APIs
• 6. Known Issues
• 7. Notices
  • 7.1. Notice
  • 7.2. OpenCL
  • 7.3. Trademarks