Fawkes API Fawkes Development Version
imagecompressor.h
1
2/***************************************************************************
3 * imagecompressor.h - image compressor interface
4 *
5 * Generated: Fri Aug 11 18:53:19 2006 (on train to Cologne)
6 * Copyright 2005-2007 Tim Niemueller [www.niemueller.de]
7 *
8 ****************************************************************************/
9
10/* This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version. A runtime exception applies to
14 * this software (see LICENSE.GPL_WRE file mentioned below for details).
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU Library General Public License for more details.
20 *
21 * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
22 */
23
24#ifndef _FIREVISION_UTILS_COMPRESSION_IMAGE_COMPRESSOR_H_
25#define _FIREVISION_UTILS_COMPRESSION_IMAGE_COMPRESSOR_H_
26
27#include <fvutils/color/colorspaces.h>
28#include <sys/types.h>
29
30namespace firevision {
31
33{
34public:
35 /** Where to put the compressed image */
37 COMP_DEST_FILE, /**< write compressed image to file */
38 COMP_DEST_MEM /**< write compressed image to buffer in memory */
39 };
40
41 virtual ~ImageCompressor();
42
43 virtual void set_image_dimensions(unsigned int width, unsigned int height) = 0;
44 virtual void set_image_buffer(colorspace_t cspace, unsigned char *buffer) = 0;
45 virtual void set_destination_buffer(unsigned char *buf, unsigned int buf_size) = 0;
46 virtual size_t compressed_size() = 0;
47 virtual void set_filename(const char *filename) = 0;
51 virtual void compress() = 0;
52
53 virtual bool supports_vflip() = 0;
54 virtual void set_vflip(bool enable) = 0;
55};
56
57} // end namespace firevision
58
59#endif
Image compressor interface.
virtual void set_image_dimensions(unsigned int width, unsigned int height)=0
Set dimensions of image to compress.
virtual bool supports_compression_destination(CompressionDestination cd)=0
Check if compressor supports desired compression destination.
virtual void set_filename(const char *filename)=0
Set file name.
virtual void compress()=0
Compress image.
virtual void set_vflip(bool enable)=0
Enable or disable vflipping.
virtual size_t recommended_compressed_buffer_size()=0
Get the recommended size for the compressed buffer.
CompressionDestination
Where to put the compressed image.
@ COMP_DEST_MEM
write compressed image to buffer in memory
@ COMP_DEST_FILE
write compressed image to file
virtual void set_destination_buffer(unsigned char *buf, unsigned int buf_size)=0
Set destination buffer (if compressing to memory).
virtual bool supports_vflip()=0
Check if image compressor can do vflip during compress.
virtual void set_image_buffer(colorspace_t cspace, unsigned char *buffer)=0
Set image buffer to compress.
virtual ~ImageCompressor()
Virtual empty destructor.
virtual size_t compressed_size()=0
Get compressed size.
virtual void set_compression_destination(CompressionDestination cd)=0
Set compression destination.