Fawkes API Fawkes Development Version
imagedecompressor.cpp
1
2/***************************************************************************
3 * imagedecompressor.cpp - image de-compressor interface
4 *
5 * Created: Tue Nov 13 10:54:03 2007
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#include <fvutils/compression/imagedecompressor.h>
25
26namespace firevision {
27
28/** @class ImageDecompressor <fvutils/compression/imagedecompressor.h>
29 * Image de-compressor interface.
30 * Currently only decompressing from memory to memory is supported.
31 * @author Tim Niemueller
32 *
33 * @fn void ImageDecompressor::decompress()
34 * Decompress image.
35 */
36
37/** @var int ImageDecompressor::_width
38 * Width of image in pixels
39 */
40
41/** @var int ImageDecompressor::_height
42 * Height of image in pixels
43 */
44
45/** @var int ImageDecompressor::_compressed_buffer
46 * Buffer containing the compressed image
47 */
48
49/** @var int ImageDecompressor::_compressed_buffer_size
50 * Size in bytes of _compressed_buffer
51 */
52
53/** @var int ImageDecompressor::_decompressed_buffer
54 * Buffer containing the decompressed image after decompression
55 */
56
57/** @var int ImageDecompressor::_decompressed_buffer_size
58 * Size in bytes of _decompressed_buffer
59 */
60
61/** Virtual empty destructor. */
63{
64}
65
66/** Set image dimensions.
67 * @param width width of image in pixels
68 * @param height height of image in pixels
69 */
70void
71ImageDecompressor::set_image_dimensions(unsigned int width, unsigned int height)
72{
73 _width = width;
74 _height = height;
75}
76
77/** Set compressed buffer.
78 * @param buf buffer
79 * @param buf_size size of buffer in bytes
80 */
81void
82ImageDecompressor::set_compressed_buffer(unsigned char *buf, unsigned int buf_size)
83{
85 _compressed_buffer_size = buf_size;
86}
87
88/** Set decompressed buffer.
89 * @param buf decompressed buffer
90 * @param buf_size buffer size
91 */
92void
93ImageDecompressor::set_decompressed_buffer(unsigned char *buf, unsigned int buf_size)
94{
97}
98
99} // end namespace firevision
virtual void set_decompressed_buffer(unsigned char *buf, unsigned int buf_size)
Set decompressed buffer.
virtual ~ImageDecompressor()
Virtual empty destructor.
unsigned char * _compressed_buffer
Buffer containing the compressed image.
unsigned int _width
Width of image in pixels.
unsigned char * _decompressed_buffer
Buffer containing the decompressed image after decompression.
unsigned int _compressed_buffer_size
Size in bytes of _compressed_buffer.
virtual void set_compressed_buffer(unsigned char *buf, unsigned int buf_size)
Set compressed buffer.
virtual void set_image_dimensions(unsigned int width, unsigned int height)
Set image dimensions.
unsigned int _decompressed_buffer_size
Size in bytes of _decompressed_buffer.
unsigned int _height
Height of image in pixels.