nvmedia_ijpe.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2017, NVIDIA CORPORATION.  All rights reserved.  All
 * information contained herein is proprietary and confidential to NVIDIA
 * Corporation.  Any use, reproduction, or disclosure without the written
 * permission of NVIDIA Corporation is prohibited.
 */

#ifndef _NVMEDIA_IJPE_H
#define _NVMEDIA_IJPE_H

#ifdef __cplusplus
extern "C" {
#endif

#include "nvmedia_common.h"

#define NVMEDIA_IJPE_VERSION_MAJOR   1

#define NVMEDIA_IJPE_VERSION_MINOR   3

#define NVMEDIA_JPEG_ENC_FLAG_NONE                      (0 << 0)

#define NVMEDIA_JPEG_ENC_FLAG_SKIP_SOI                  (1 << 0)

#define NVMEDIA_IMAGE_JPEG_ATTRIBUTE_QUALITY            (1 << 0)

#define NVMEDIA_IMAGE_JPEG_ATTRIBUTE_RESTARTINTERVAL    (1 << 1)

#define NVMEDIA_IMAGE_JPEG_ATTRIBUTE_TARGETSIZE         (1 << 2)

#define NVMEDIA_IMAGE_JPEG_ATTRIBUTE_QUANTTABLE         (1 << 3)

#define NVMEDIA_IMAGE_JPEG_ATTRIBUTE_HUFFTABLE          (1 << 4)

typedef struct {
   uint8_t length[16];
   uint8_t *values;
} NvMediaJPHuffmanTableSpecfication;

typedef struct {
   uint8_t quality;
   uint32_t restartInterval;
   uint32_t targetImageSize;
   uint8_t lumaQuant[64];
   uint8_t chromaQuant[64];
   NvMediaJPHuffmanTableSpecfication *lumaDC;
   NvMediaJPHuffmanTableSpecfication *lumaAC;
   NvMediaJPHuffmanTableSpecfication *chromaDC;
   NvMediaJPHuffmanTableSpecfication *chromaAC;
} NvMediaJPEncAttributes;

typedef struct {
    NvMediaSurfaceType inputFormat;
} NvMediaIJPE;

NvMediaStatus
NvMediaIJPEGetVersion(
    NvMediaVersion *version
);

NvMediaIJPE *
NvMediaIJPECreate(
    NvMediaDevice *device,
    NvMediaSurfaceType inputFormat,
    uint8_t maxOutputBuffering,
    uint32_t  maxBitstreamBytes
);

void NvMediaIJPEDestroy(NvMediaIJPE *encoder);

NvMediaStatus
NvMediaIJPEFeedFrame(
    NvMediaIJPE *encoder,
    NvMediaImage *frame,
    uint8_t quality
);

NvMediaStatus
NvMediaIJPEFeedFrameQuant(
    NvMediaIJPE *encoder,
    NvMediaImage *frame,
    uint8_t *lumaQuant,
    uint8_t *chromaQuant
);

NvMediaStatus
NvMediaIJPEFeedFrameRateControl(
    NvMediaIJPE *encoder,
    NvMediaImage *frame,
    uint8_t *lumaQuant,
    uint8_t *chromaQuant,
    uint32_t targetImageSize
);

NvMediaStatus
NvMediaIJPESetAttributes(
    NvMediaIJPE *encoder,
    uint32_t attributeMask,
    void *attributes
);

NvMediaStatus
NvMediaIJPEGetBits(
    NvMediaIJPE *encoder,
    uint32_t *numBytes,
    void *buffer,
    uint32_t flags
);

NvMediaStatus
NvMediaIJPEGetBitsEx(
    NvMediaIJPE *encoder,
    uint32_t *numBytes,
    uint32_t numBitstreamBuffers,
    const NvMediaBitstreamBuffer *bitstreams,
    uint32_t flags
);

NvMediaStatus
NvMediaIJPEBitsAvailable(
    NvMediaIJPE *encoder,
    uint32_t *numBytesAvailable,
    NvMediaBlockingType blockingType,
    uint32_t millisecondTimeout
);

/*
 * \defgroup history_nvmedia_ijpe History
 * Provides change history for the NvMedia Image Jpeg Encode API.
 *
 * \section history_nvmedia_ijpe Version History
 *
 * <b> Version 1.0 </b> November 9, 2015
 * - Initial release
 *
 * <b> Version 1.1 </b> May 11, 2016
 * - Added \ref NvMediaIJPECheckVersion API
 *
 * <b> Version 1.2 </b> Sep 19, 2016
 * - Added \ref NvMediaIJPEGetBitsEx API
 *
 * <b> Version 1.3 </b> May 15, 2017
 * - Added \ref NvMediaIJPEGetVersion API to get the version of NvMedia IJPE library
 * - NvMediaIJPECheckVersion is deprecated. Use NvMediaIJPEGetVersion() instead
 * - All NvMedia data types are moved to standard data types
 */

#ifdef __cplusplus
};     /* extern "C" */
#endif

#endif /* _NVMEDIA_IJPE_H */