JpegImageCompressor Class Reference

Jpeg image compressor. More...

#include <fvutils/compression/jpeg_compressor.h>

Inheritance diagram for JpegImageCompressor:

Inheritance graph
[legend]

List of all members.


Public Types

enum  JpegColorspace { JPEG_CS_RGB, JPEG_CS_YUV }
 JPEG color space. More...

Public Member Functions

 JpegImageCompressor (unsigned int quality=80, JpegColorspace jcs=JPEG_CS_RGB)
 Constructor.
virtual ~JpegImageCompressor ()
 Destructor.
virtual void set_image_dimensions (unsigned int width, unsigned int height)
 Set dimensions of image to compress.
virtual void set_image_buffer (colorspace_t cspace, unsigned char *buffer)
 Set image buffer to compress.
virtual void set_destination_buffer (unsigned char *buf, unsigned int buf_size)
 Set destination buffer (if compressing to memory).
virtual size_t compressed_size ()
 Get compressed size.
virtual void set_filename (const char *filename)
 Set file name.
virtual void set_compression_destination (ImageCompressor::CompressionDestination cd)
 Set compression destination.
virtual bool supports_compression_destination (ImageCompressor::CompressionDestination cd)
 Check if compressor supports desired compression destination.
virtual void compress ()
 Compress image.
virtual size_t recommended_compressed_buffer_size ()
 Get the recommended size for the compressed buffer.

Detailed Description

Jpeg image compressor.

Definition at line 29 of file jpeg_compressor.h.

Member Enumeration Documentation

enum JpegImageCompressor::JpegColorspace

JPEG color space.

Enumerator:
JPEG_CS_RGB  RGB.
JPEG_CS_YUV  YUV444 packed.

Definition at line 33 of file jpeg_compressor.h.

Constructor & Destructor Documentation

JpegImageCompressor::JpegImageCompressor ( unsigned int  quality = 80,
JpegColorspace  jcs = JPEG_CS_RGB 
)

Constructor.

Parameters:
quality JPEG quality in percent
jcs Jpeg colorspace

Definition at line 192 of file jpeg_compressor.cpp.

JpegImageCompressor::~JpegImageCompressor (  )  [virtual]

Destructor.

Definition at line 199 of file jpeg_compressor.cpp.

Member Function Documentation

void JpegImageCompressor::compress (  )  [virtual]

Compress image.

Implements ImageCompressor.

Definition at line 205 of file jpeg_compressor.cpp.

References ImageCompressor::COMP_DEST_MEM, and JPEG_CS_RGB.

Referenced by FuseServerClientThread::process_getimage_message().

size_t JpegImageCompressor::compressed_size (  )  [virtual]

Get compressed size.

Returns:
compressed size

Implements ImageCompressor.

Definition at line 328 of file jpeg_compressor.cpp.

Referenced by FuseServerClientThread::process_getimage_message().

size_t JpegImageCompressor::recommended_compressed_buffer_size (  )  [virtual]

Get the recommended size for the compressed buffer.

It is not guaranteed that this size is really enough for compression but in most cases this should be suitable.

Returns:
recommended buffer size

Implements ImageCompressor.

Definition at line 334 of file jpeg_compressor.cpp.

Referenced by FuseServerClientThread::process_getimage_message().

void JpegImageCompressor::set_compression_destination ( ImageCompressor::CompressionDestination  cd  )  [virtual]

Set compression destination.

Parameters:
cd compression destination

Implements ImageCompressor.

Definition at line 306 of file jpeg_compressor.cpp.

Referenced by FuseServerClientThread::process_getimage_message().

void JpegImageCompressor::set_destination_buffer ( unsigned char *  buf,
unsigned int  buf_size 
) [virtual]

Set destination buffer (if compressing to memory).

Parameters:
buf buffer
buf_size buffer size

Implements ImageCompressor.

Definition at line 320 of file jpeg_compressor.cpp.

Referenced by FuseServerClientThread::process_getimage_message().

void JpegImageCompressor::set_filename ( const char *  filename  )  [virtual]

Set file name.

Parameters:
filename file name (if compressing to file)

Implements ImageCompressor.

Definition at line 341 of file jpeg_compressor.cpp.

void JpegImageCompressor::set_image_buffer ( colorspace_t  cspace,
unsigned char *  buffer 
) [virtual]

Set image buffer to compress.

Parameters:
cspace colorspace of image
buffer buffer that contains the image

Implements ImageCompressor.

Definition at line 297 of file jpeg_compressor.cpp.

Referenced by FuseServerClientThread::process_getimage_message().

void JpegImageCompressor::set_image_dimensions ( unsigned int  width,
unsigned int  height 
) [virtual]

Set dimensions of image to compress.

Parameters:
width width of image in pixels
height height of image in pixels

Implements ImageCompressor.

Definition at line 289 of file jpeg_compressor.cpp.

Referenced by FuseServerClientThread::process_getimage_message().

bool JpegImageCompressor::supports_compression_destination ( ImageCompressor::CompressionDestination  cd  )  [virtual]

Check if compressor supports desired compression destination.

Parameters:
cd compression destination

Implements ImageCompressor.

Definition at line 313 of file jpeg_compressor.cpp.

The documentation for this class was generated from the following files: