Fawkes API
Fawkes Development Version
|
Image compressor interface. More...
#include <>>
Public Types | |
enum | CompressionDestination { COMP_DEST_FILE, COMP_DEST_MEM } |
Where to put the compressed image. More... | |
Public Member Functions | |
virtual | ~ImageCompressor () |
Virtual empty destructor. More... | |
virtual void | set_image_dimensions (unsigned int width, unsigned int height)=0 |
Set dimensions of image to compress. More... | |
virtual void | set_image_buffer (colorspace_t cspace, unsigned char *buffer)=0 |
Set image buffer to compress. More... | |
virtual void | set_destination_buffer (unsigned char *buf, unsigned int buf_size)=0 |
Set destination buffer (if compressing to memory). More... | |
virtual size_t | compressed_size ()=0 |
Get compressed size. More... | |
virtual void | set_filename (const char *filename)=0 |
Set file name. More... | |
virtual void | set_compression_destination (CompressionDestination cd)=0 |
Set compression destination. More... | |
virtual bool | supports_compression_destination (CompressionDestination cd)=0 |
Check if compressor supports desired compression destination. More... | |
virtual size_t | recommended_compressed_buffer_size ()=0 |
Get the recommended size for the compressed buffer. More... | |
virtual void | compress ()=0 |
Compress image. More... | |
virtual bool | supports_vflip ()=0 |
Check if image compressor can do vflip during compress. More... | |
virtual void | set_vflip (bool enable)=0 |
Enable or disable vflipping. More... | |
Image compressor interface.
Definition at line 35 of file imagecompressor.h.
Where to put the compressed image.
Enumerator | |
---|---|
COMP_DEST_FILE | write compressed image to file |
COMP_DEST_MEM | write compressed image to buffer in memory |
Definition at line 39 of file imagecompressor.h.
|
virtual |
Virtual empty destructor.
Definition at line 95 of file imagecompressor.cpp.
|
pure virtual |
Compress image.
Implemented in firevision::JpegImageCompressor, firevision::JpegImageCompressorMMAL, and firevision::JpegImageCompressorLibJpeg.
Referenced by firevision::JpegImageCompressor::compress(), and firevision::CompressedImageWriter::write().
|
pure virtual |
Get compressed size.
Implemented in firevision::JpegImageCompressor, firevision::JpegImageCompressorMMAL, and firevision::JpegImageCompressorLibJpeg.
Referenced by firevision::JpegImageCompressor::compressed_size(), and firevision::CompressedImageWriter::write().
|
pure 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.
Implemented in firevision::JpegImageCompressor, firevision::JpegImageCompressorMMAL, and firevision::JpegImageCompressorLibJpeg.
Referenced by firevision::JpegImageCompressor::recommended_compressed_buffer_size(), and firevision::CompressedImageWriter::write().
|
pure virtual |
Set compression destination.
cd | compression destination |
Implemented in firevision::JpegImageCompressor, firevision::JpegImageCompressorMMAL, and firevision::JpegImageCompressorLibJpeg.
Referenced by firevision::JpegImageCompressor::set_compression_destination(), and firevision::CompressedImageWriter::write().
|
pure virtual |
Set destination buffer (if compressing to memory).
buf | buffer |
buf_size | buffer size |
Implemented in firevision::JpegImageCompressor, firevision::JpegImageCompressorMMAL, and firevision::JpegImageCompressorLibJpeg.
Referenced by firevision::JpegImageCompressor::set_destination_buffer(), and firevision::CompressedImageWriter::write().
|
pure virtual |
Set file name.
filename | file name (if compressing to file) |
Implemented in firevision::JpegImageCompressor, firevision::JpegImageCompressorMMAL, and firevision::JpegImageCompressorLibJpeg.
Referenced by firevision::CompressedImageWriter::set_filename(), firevision::JpegImageCompressor::set_filename(), and firevision::CompressedImageWriter::set_image_compressor().
|
pure virtual |
Set image buffer to compress.
cspace | colorspace of image |
buffer | buffer that contains the image |
Implemented in firevision::JpegImageCompressor, firevision::JpegImageCompressorMMAL, and firevision::JpegImageCompressorLibJpeg.
Referenced by firevision::CompressedImageWriter::set_buffer(), firevision::JpegImageCompressor::set_image_buffer(), and firevision::CompressedImageWriter::set_image_compressor().
|
pure virtual |
Set dimensions of image to compress.
width | width of image in pixels |
height | height of image in pixels |
Implemented in firevision::JpegImageCompressor, firevision::JpegImageCompressorMMAL, and firevision::JpegImageCompressorLibJpeg.
Referenced by firevision::CompressedImageWriter::set_dimensions(), firevision::CompressedImageWriter::set_image_compressor(), and firevision::JpegImageCompressor::set_image_dimensions().
|
pure virtual |
Enable or disable vflipping.
This shall throw an exception if vflipping is not supported.
enable | true to enable vflipping, false to disable |
Exception | thrown if vflipping is not supported. |
Implemented in firevision::JpegImageCompressor, firevision::JpegImageCompressorMMAL, and firevision::JpegImageCompressorLibJpeg.
Referenced by firevision::JpegImageCompressor::set_vflip().
|
pure virtual |
Check if compressor supports desired compression destination.
cd | compression destination |
Implemented in firevision::JpegImageCompressor, firevision::JpegImageCompressorMMAL, and firevision::JpegImageCompressorLibJpeg.
Referenced by firevision::JpegImageCompressor::supports_compression_destination(), and firevision::CompressedImageWriter::write().
|
pure virtual |
Check if image compressor can do vflip during compress.
Vertical flipping (having the image upside down) is an operation necessary for example for cameras hanging upside down. During compression when the buffer is typically copied or converted line-wise anyway, this is a particularly cheap operation. Therfore we provide an API to implement this.
Implemented in firevision::JpegImageCompressor, firevision::JpegImageCompressorMMAL, and firevision::JpegImageCompressorLibJpeg.
Referenced by firevision::JpegImageCompressor::supports_vflip().