summaryrefslogtreecommitdiff
path: root/support/dktools/dk4rle.h
blob: 0c5ae02fd0d14fd4e948ad2569240e689b699727 (plain)
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
/*
Copyright (C) 2015-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/

/*
	WARNING: This file was generated by the dkct program (see
	http://dktools.sourceforge.net/ for details).
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: dk4rle.ctr
*/

#ifndef DK4RLE_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4RLE_H_INCLUDED 1


#line 10 "dk4rle.ctr"

/**	@file	dk4rle.h	Run length encoder as
described in the PS and PDF specifications.

Use the dk4rle_init() function to initialize the encoder first.

Add binary data byte by byte, use dk4rle_add(). If this function
returns DK4_EDSTM_ACCEPT, the byte was successfully stored in the encoder,
no further action is necessary. If the function returns DK4_EDSTM_FINISHED,
either a run or a sequence of literal bytes was completed; use
dk4rle_output() to retrieve the output data.

After passing all bytes to the encoder there is probably data in the
encoder not yet retrieved. Use the dk4rle_finish() function to check.
If the function returns DK4_EDSTM_FINISHED, use dk4rle_output() to retrieve
the final output data.
*/

#ifndef	DK4CONF_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4conf.h"
#else
#include <dktools-4/dk4conf.h>
#endif
#endif

#ifndef	DK4ERROR_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4error.h"
#else
#include <dktools-4/dk4error.h>
#endif
#endif


/**	Run-length encoder.
*/
typedef struct {
  unsigned char	 ob[144];	/**< Buffer for both input and output. */
  unsigned char	*ib;		/**< Pointer to ob[1], input buffer. */
  size_t	 oused;		/**< Output buffer size. */
  size_t	 iused;		/**< Number of input bytes available. */
  size_t	 ao_si;		/**< Index to save bytes from after output. */
  size_t	 ao_ss;		/**< Size of buffer part to save after out. */
  size_t	 ao_iu;		/**< Number of input bytes after output. */
  int		 ao_st;		/**< New state after output. */
  int		 st;		/**< Current state. */
  int		 lwo;		/**< Flag: Last operation was output. */
  int		 weod;		/**< Flag: Write EOD marker at end. */
} dk4_rl_enc_t;

#ifdef __cplusplus
extern "C" {
#endif

/**	Initialize encoder before using it.
	@param	enc	Encoder to initialize.
	@param	weod	Flag: Write EOD marker at end of data.
	@param	erp	Error report, may be NULL.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS	if enc is NULL.
*/
void
dk4rle_init(dk4_rl_enc_t *enc, int weod, dk4_er_t *erp);

/**	Add a single byte to the encoder.
	@param	enc	Encoder.
	@param	ibyte	Input byte to process.
	@param	erp	Error report, may be NULL.
	@return	Action to take, one from:
	- DK4_EDSTM_ACCEPT<br>
	  if the input byte was successfully stored in the internal data
	  structures without completing a run. No further action
	  necessary.
	- DK4_EDSTM_FINISHED<br>
	  if a run was completed. Use dk4rle_output() to obtain the
	  output data.
	- DK4_EDSTM_ERROR<br>
	  if an error occured.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS	if enc is NULL.
*/
int
dk4rle_add(dk4_rl_enc_t *enc, unsigned char ibyte, dk4_er_t *erp);

/**	Finish data stream, process final data still stored in the
	encoder.
	@param	enc	Encoder.
	@param	erp	Error report, may be NULL.
	@return	Action to take, one from:
	- DK4_EDSTM_ACCEPT<br>
	  if the input byte was successfully stored in the internal data
	  structures without completing a run. No further action
	  necessary.
	- DK4_EDSTM_FINISHED<br>
	  if a run was completed. Use dk4rle_output() to obtain the
	  output data.
	- DK4_EDSTM_ERROR<br>
	  if an error occured.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS	if enc is NULL.
*/
int
dk4rle_finish(dk4_rl_enc_t *enc, dk4_er_t *erp);

/**	Retrieve encoder output.
	@param	dptr	Address of pointer to set to output bytes, should
			be initialized to NULL.
	@param	szptr	Address of size variable for buffer length,
			should be initialized to 0.
	@param	enc	Encoder.
	@param	erp	Error report, may be NULL.
	@return	1 if there is data available, 0 otherwise.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS	if enc is NULL.
*/
int
dk4rle_output(
  const unsigned char	**dptr,
  size_t		 *szptr,
  dk4_rl_enc_t	const	 *enc,
  dk4_er_t		 *erp
);

#ifdef __cplusplus
}
#endif




#endif