00001
00002 /***************************************************************************
00003  *  imagecompressor.cpp - image compressor interface
00004  *
00005  *  Generated: Thu Mar 29 01:39:05 2007
00006  *  Copyright  2005-2007  Tim Niemueller [www.niemueller.de]
00007  *
00008  ****************************************************************************/
00009
00010 /*  This program is free software; you can redistribute it and/or modify
00011  *  it under the terms of the GNU General Public License as published by
00012  *  the Free Software Foundation; either version 2 of the License, or
00013  *  (at your option) any later version. A runtime exception applies to
00014  *  this software (see LICENSE.GPL_WRE file mentioned below for details).
00015  *
00016  *  This program is distributed in the hope that it will be useful,
00017  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  *  GNU Library General Public License for more details.
00020  *
00021  *  Read the full text in the LICENSE.GPL_WRE file in the doc directory.
00022  */
00023
00024 #include <fvutils/compression/imagecompressor.h>
00025 
00026 /** @class ImageCompressor <fvutils/compression/imagecompressor.h>
00027  * Image compressor interface.
00028  *
00029  *
00030  * @fn void ImageCompressor::set_image_dimensions(unsigned int width, unsigned int height)
00031  * Set dimensions of image to compress.
00032  * @param width width of image in pixels
00033  * @param height height of image in pixels
00034  *
00035  * @fn void ImageCompressor::set_image_buffer(colorspace_t cspace, unsigned char *buffer)
00036  * Set image buffer to compress
00037  * @param cspace colorspace of image
00038  * @param buffer buffer that contains the image
00039  *
00040  * @fn void ImageCompressor::set_destination_buffer(unsigned char *buf, unsigned int buf_size)
00041  * Set destination buffer (if compressing to memory).
00042  * @param buf buffer
00043  * @param buf_size buffer size
00044  *
00045  * @fn size_t ImageCompressor::compressed_size()
00046  * Get compressed size.
00047  * @return compressed size
00048  *
00049  * @fn void ImageCompressor::set_filename(const char *filename)
00050  * Set file name.
00051  * @param filename file name (if compressing to file)
00052  *
00053  * @fn void ImageCompressor::set_compression_destination(CompressionDestination cd)
00054  * Set compression destination.
00055  * @param cd compression destination
00056  *
00057  * @fn bool ImageCompressor::supports_compression_destination(CompressionDestination cd)
00058  * Check if compressor supports desired compression destination.
00059  * @param cd compression destination
00060  *
00061  * @fn size_t ImageCompressor::recommended_compressed_buffer_size()
00062  * Get the recommended size for the compressed buffer. It is not guaranteed
00063  * that this size is really enough for compression but in most cases this should
00064  * be suitable.
00065  * @return recommended buffer size
00066  *
00067  * @fn void ImageCompressor::compress()
00068  * Compress image.
00069  */
00070 
00071 /** Virtual empty destructor. */
00072 ImageCompressor::~ImageCompressor()
00073 {
00074 }