Refactor BeRTOS to be in his own directory.
[bertos.git] / bertos / mware / rle.c
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
30  * Copyright 1999, 2000, 2001 Bernardo Innocenti <bernie@develer.com>
31  *
32  * -->
33  *
34  * \brief General-purpose run-length {en,de}coding algorithm (implementation)
35  *
36  * Original source code from http://www.compuphase.com/compress.htm
37  *
38  * \version $Id$
39  * \author Bernardo Innocenti <bernie@develer.com>
40  */
41
42 /*#*
43  *#* $Log$
44  *#* Revision 1.4  2006/07/19 12:56:28  bernie
45  *#* Convert to new Doxygen style.
46  *#*
47  *#* Revision 1.3  2005/11/04 16:20:02  bernie
48  *#* Fix reference to README.devlib in header.
49  *#*
50  *#* Revision 1.2  2004/08/25 14:12:09  rasky
51  *#* Aggiornato il comment block dei log RCS
52  *#*
53  *#* Revision 1.1  2004/08/04 02:35:54  bernie
54  *#* Import simple RLE algorithm.
55  *#*
56  *#*/
57
58 #include "rle.h"
59
60
61 /**
62  * Run-length encode \a len bytes from the \a input buffer
63  * to the \a output buffer.
64  */
65 int rle(unsigned char *output, const unsigned char *input, int len)
66 {
67         int count, index, i;
68         unsigned char first;
69         unsigned char *out;
70
71
72         out = output;
73         count = 0;
74         while (count < len)
75         {
76                 index = count;
77                 first = input[index++];
78
79                 /* Scan for bytes identical to the first one */
80                 while ((index < len) && (index - count < 127) && (input[index] == first))
81                         index++;
82
83                 if (index - count == 1)
84                 {
85                         /* Failed to "replicate" the current byte. See how many to copy.
86                          */
87                         while ((index < len) && (index - count < 127))
88                         {
89                                 /* Avoid a replicate run of only 2-bytes after a literal run.
90                                  * There is no gain in this, and there is a risc of loss if the
91                                  * run after the two identical bytes is another literal run.
92                                  * So search for 3 identical bytes.
93                                  */
94                                 if ((input[index] == input[index - 1]) &&
95                                         ((index > 1) && (input[index] == input[index - 2])))
96                                 {
97                                         /* Reset the index so we can back up these three identical
98                                          * bytes in the next run.
99                                          */
100                                         index -= 2;
101                                         break;
102                                 }
103
104                                 index++;
105                         }
106
107                         /* Output a run of uncompressed bytes: write length and values */
108                         *out++ = (unsigned char)(count - index);
109                         for (i = count; i < index; i++)
110                                 *out++ = input[i];
111             }
112                 else
113                 {
114                         /* Output a compressed run: write length and value */
115                         *out++ = (unsigned char)(index - count);
116                         *out++ = first;
117             }
118
119                 count = index;
120         }
121
122         /* Output EOF marker */
123         *out++ = 0;
124
125         return (out - output);
126 }
127
128
129 /**
130  * Run-length decode from the \a input buffer to the \a output
131  * buffer.
132  *
133  * \note The output buffer must be large enough to accomodate
134  *       all decoded output.
135  */
136 int unrle(unsigned char *output, const unsigned char *input)
137 {
138         signed char count;
139         unsigned char *out;
140         unsigned char value;
141
142
143         out = output;
144
145         for (;;)
146         {
147                 count = (signed char)*input++;
148                 if (count > 0)
149                 {
150                         /* replicate run */
151                         value = *input++;
152                         while (count--)
153                                 *out++ = value;
154                 }
155                 else if (count < 0)
156                 {
157                         /* literal run */
158                         while (count++)
159                                 *out++ = *input++;
160                 }
161                 else
162                         /* EOF */
163                         break;
164         }
165
166         return (out - output);
167 }