imagecompressor.cpp

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 namespace firevision {
00027 #if 0 /* just to make Emacs auto-indent happy */
00028 }
00029 #endif
00030 
00031 /** @class ImageCompressor <fvutils/compression/imagecompressor.h>
00032  * Image compressor interface.
00033  *
00034  *
00035  * @fn void ImageCompressor::set_image_dimensions(unsigned int width, unsigned int height)
00036  * Set dimensions of image to compress.
00037  * @param width width of image in pixels
00038  * @param height height of image in pixels
00039  *
00040  * @fn void ImageCompressor::set_image_buffer(colorspace_t cspace, unsigned char *buffer)
00041  * Set image buffer to compress
00042  * @param cspace colorspace of image
00043  * @param buffer buffer that contains the image
00044  *
00045  * @fn void ImageCompressor::set_destination_buffer(unsigned char *buf, unsigned int buf_size)
00046  * Set destination buffer (if compressing to memory).
00047  * @param buf buffer
00048  * @param buf_size buffer size
00049  *
00050  * @fn size_t ImageCompressor::compressed_size()
00051  * Get compressed size.
00052  * @return compressed size
00053  *
00054  * @fn void ImageCompressor::set_filename(const char *filename)
00055  * Set file name.
00056  * @param filename file name (if compressing to file)
00057  *
00058  * @fn void ImageCompressor::set_compression_destination(CompressionDestination cd)
00059  * Set compression destination.
00060  * @param cd compression destination
00061  *
00062  * @fn bool ImageCompressor::supports_compression_destination(CompressionDestination cd)
00063  * Check if compressor supports desired compression destination.
00064  * @param cd compression destination
00065  * @return true if supported, false otherwise
00066  *
00067  * @fn size_t ImageCompressor::recommended_compressed_buffer_size()
00068  * Get the recommended size for the compressed buffer. It is not guaranteed
00069  * that this size is really enough for compression but in most cases this should
00070  * be suitable.
00071  * @return recommended buffer size
00072  *
00073  * @fn void ImageCompressor::compress()
00074  * Compress image.
00075  */
00076 
00077 /** Virtual empty destructor. */
00078 ImageCompressor::~ImageCompressor()
00079 {
00080 }
00081 
00082 } // end namespace firevision