File: algorithm.h

package info (click to toggle)
splix 2.0.0-2.2
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 2,912 kB
  • ctags: 653
  • sloc: cpp: 4,514; makefile: 332; sh: 86; ansic: 42
file content (81 lines) | stat: -rw-r--r-- 2,695 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/*
 * 	    algorithm.h               (C) 2006-2008, Aurélien Croc (AP²C)
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; version 2 of the License.
 * 
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the
 *  Free Software Foundation, Inc.,
 *  59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 *  $Id: algorithm.h 157 2008-02-09 02:01:24Z ap2c $
 * 
 */
#ifndef _ALGORITHM_H_
#define _ALGORITHM_H_

class Request;
class BandPlane;

/**
  * @brief This super class is an interface to implement a compression 
  *        algorithm.
  */
class Algorithm
{
    protected:

    public:
        /**
          * Initialize the instance.
          */
        Algorithm();
        /**
          * Destroy the instance.
          */
        virtual ~Algorithm();

    public:
        /**
          * Compress data.
          * @param request the request instance
          * @param data the data to compress
          * @param width the width of the data / band / page
          * @param height the height of the data / band / page
          * @return a pointer to a @ref BandPlane instance or NULL.
          */
        virtual BandPlane*      compress(const Request& request, 
                                    unsigned char *data, unsigned long width,
                                    unsigned long height) = 0;
        /**
          * Reverse line and column.
          * the byte at (x=1, y=0) is placed at (x=0, y=1) etc.
          * This is used by algorithm 0x11 (at least).
          * @return TRUE if this operation is needed. Otherwise returns FALSE.
          */
        virtual bool            reverseLineColumn() {return false;}
        /**
          * Inverse the byte.
          * Do a NOT operation on each byte.
          * @return TRUE if this operation is needed. Otherwise returns FALSE.
          */
        virtual bool            inverseByte() {return false;}
        /**
          * Split into bands
          * @return TRUE if each planes has to ben split into bands. Otherwise 
          *         it returns FALSE.
          */
        virtual bool            splitIntoBands() {return false;}
};

#endif /* _ALGORITHM_H_ */

/* vim: set expandtab tabstop=4 shiftwidth=4 smarttab tw=80 cin enc=utf8: */