DUNE::Media::JPEGCompressor Class Reference

Public Types
enum	ColorSpace { CS_GRAYSCALE, CS_RGB, CS_CMYK, CS_YUV }

Public Member Functions
	JPEGCompressor (void)
	~JPEGCompressor (void)
JPEGCompressor &	setOptimize (bool optimize)
JPEGCompressor &	setInputDimensions (uint32_t width, uint32_t height)
JPEGCompressor &	setInputColorSpace (ColorSpace cspace)
JPEGCompressor &	setOutputColorSpace (ColorSpace cspace)
bool	compress (uint8_t *raw, uint8_t quality=90)
const uint8_t *	imageData (void) const
uint32_t	imageSize (void) const

Member Enumeration Documentation

ColorSpace

enum DUNE::Media::JPEGCompressor::ColorSpace

Image color space.

Enumerator
CS_GRAYSCALE	Grayscale.
CS_RGB	Red, Green and Blue.
CS_CMYK	Cyan, Magenta, Yellow and Black.
CS_YUV	YCbCr.

Constructor & Destructor Documentation

JPEGCompressor()

DUNE::Media::JPEGCompressor::JPEGCompressor

(

void

)

Construct a JPEGCompressor object.

~JPEGCompressor()

DUNE::Media::JPEGCompressor::~JPEGCompressor

(

void

)

Destroy a JPEGCompressor object.

Member Function Documentation

compress()

bool DUNE::Media::JPEGCompressor::compress	(	uint8_t *	raw,
		uint8_t	quality = 90
	)

Compress a raw image in JPEG.

Parameters

raw	raw image.
quality	JPEG image quality.

Returns

true on success, false otherwise.

imageData()

const uint8_t * DUNE::Media::JPEGCompressor::imageData

(

void

)

const

Retrieve the compressed image.

Returns

compressed image.

imageSize()

uint32_t DUNE::Media::JPEGCompressor::imageSize

(

void

)

const

Retrieve the size of the compressed image.

Returns

size in bytes of the compressed image.

setInputColorSpace()

JPEGCompressor & DUNE::Media::JPEGCompressor::setInputColorSpace

(

ColorSpace

cspace

)

Set input color space.

Parameters

cspace

color space.

Returns

JPEGCompressor object.

setInputDimensions()

JPEGCompressor & DUNE::Media::JPEGCompressor::setInputDimensions	(	uint32_t	width,
		uint32_t	height
	)

Set dimensions of input image.

Parameters

width	width of input image.
height	height of input image.

Returns

JPEGCompressor object.

setOptimize()

JPEGCompressor & DUNE::Media::JPEGCompressor::setOptimize

(

bool

optimize

)

Set entropy encoding optimization.

Parameters

optimize

true enables optimization.

Returns

JPEGCompressor object.

setOutputColorSpace()

JPEGCompressor & DUNE::Media::JPEGCompressor::setOutputColorSpace

(

ColorSpace

cspace

)

Set output image color space.

Parameters

cspace

color space.

Returns

JPEGCompressor object.

Collaboration diagram for DUNE::Media::JPEGCompressor: