[thirdparty/cups.git] / driver / driver.h

/*
 * "$Id$"
 *
 *   Printer driver utilities header file for CUPS.
 *
 *   Copyright 2007 by Apple Inc.
 *   Copyright 1993-2005 by Easy Software Products.
 *
 *   These coded instructions, statements, and computer programs are the
 *   property of Apple Inc. and are protected by Federal copyright
 *   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
 *   which should have been included with this file.  If this file is
 *   file is missing or damaged, see the license at "http://www.cups.org/".
 */

#ifndef _CUPS_DRIVER_H_
#  define _CUPS_DRIVER_H_

#  ifdef __cplusplus
extern "C" {
#  endif /* __cplusplus */

/*
 * Include necessary headers...
 */

#  include <stdio.h>
#  include <stdlib.h>
#  include <time.h>
#  include <math.h>

#  if defined(WIN32) || defined(__EMX__)
#    include <io.h>
#  else
#    include <unistd.h>
#    include <fcntl.h>
#  endif /* WIN32 || __EMX__ */

#  include <cups/cups.h>
#  include <cups/raster.h>


/*
 * Common macros...
 */

#  ifndef min
#    define min(a,b)	((a) < (b) ? (a) : (b))
#    define max(a,b)	((a) > (b) ? (a) : (b))
#  endif /* !min */


/*
 * Constants...
 */

#define CUPS_MAX_CHAN	15		/* Maximum number of color components */
#define CUPS_MAX_LUT	4095		/* Maximum LUT value */
#define CUPS_MAX_RGB	4		/* Maximum number of sRGB components */


/*
 * Types/structures for the various routines.
 */

typedef struct cups_lut_s		/**** Lookup Table for Dithering ****/
{
  short		intensity;		/* Adjusted intensity */
  short		pixel;			/* Output pixel value */
  int		error;			/* Error from desired value */
} cups_lut_t;

typedef struct cups_dither_s		/**** Dithering State ****/
{
  int		width;			/* Width of buffer */
  int		row;			/* Current row */
  int		errors[96];		/* Error values */
} cups_dither_t;

typedef struct cups_sample_s		/**** Color sample point ****/
{
  unsigned char	rgb[3];			/* sRGB values */
  unsigned char	colors[CUPS_MAX_RGB];	/* Color values */
} cups_sample_t;

typedef struct cups_rgb_s		/**** Color separation lookup table ****/
{
  int		cube_size;		/* Size of color cube (2-N) on a side */
  int		num_channels;		/* Number of colors per sample */
  unsigned char	****colors;		/* 4-D array of sample values */
  int		cube_index[256];	/* Index into cube for a given sRGB value */
  int		cube_mult[256];		/* Multiplier value for a given sRGB value */
  int		cache_init;		/* Are cached values initialized? */
  unsigned char	black[CUPS_MAX_RGB];	/* Cached black (sRGB = 0,0,0) */
  unsigned char	white[CUPS_MAX_RGB];	/* Cached white (sRGB = 255,255,255) */
} cups_rgb_t;

typedef struct cups_cmyk_s		/**** Simple CMYK lookup table ****/
{
  unsigned char	black_lut[256];		/* Black generation LUT */
  unsigned char	color_lut[256];		/* Color removal LUT */
  int		ink_limit;		/* Ink limit */
  int		num_channels;		/* Number of components */
  short		*channels[CUPS_MAX_CHAN];
					/* Lookup tables */
} cups_cmyk_t;


/*
 * Globals...
 */

extern const unsigned char
			cups_srgb_lut[256];
					/* sRGB gamma lookup table */
extern const unsigned char
			cups_scmy_lut[256];
					/* sRGB gamma lookup table (inverted) */


/*
 * Prototypes...
 */

/*
 * Attribute function...
 */

extern ppd_attr_t	*cupsFindAttr(ppd_file_t *ppd, const char *name,
			              const char *colormodel,
			              const char *media,
				      const char *resolution,
				      char *spec, int specsize);
			       
/*
 * Byte checking functions...
 */

extern int		cupsCheckBytes(const unsigned char *, int);
extern int		cupsCheckValue(const unsigned char *, int,
			               const unsigned char);

/*
 * Dithering functions...
 */

extern void		cupsDitherLine(cups_dither_t *d, const cups_lut_t *lut,
			               const short *data, int num_channels,
				       unsigned char *p);
extern cups_dither_t	*cupsDitherNew(int width);
extern void		cupsDitherDelete(cups_dither_t *);

/*
 * Lookup table functions for dithering...
 */

extern cups_lut_t	*cupsLutNew(int num_vals, const float *vals);
extern void		cupsLutDelete(cups_lut_t *lut);
extern cups_lut_t	*cupsLutLoad(ppd_file_t *ppd,
			             const char *colormodel,
				     const char *media,
			             const char *resolution,
				     const char *ink);


/*
 * Bit packing functions...
 */

extern void		cupsPackHorizontal(const unsigned char *,
			                   unsigned char *, int,
					   const unsigned char, const int);
extern void		cupsPackHorizontal2(const unsigned char *,
			                    unsigned char *, int, const int);
extern void		cupsPackHorizontalBit(const unsigned char *,
			                      unsigned char *, int,
					      const unsigned char,
					      const unsigned char);
extern void		cupsPackVertical(const unsigned char *, unsigned char *,
			                 int, const unsigned char, const int);

/*
 * Color separation functions...
 */

extern void		cupsRGBDelete(cups_rgb_t *rgb);
extern void		cupsRGBDoGray(cups_rgb_t *rgb,
			              const unsigned char *input,
			              unsigned char *output, int num_pixels);
extern void		cupsRGBDoRGB(cups_rgb_t *rgb,
			             const unsigned char *input,
			             unsigned char *output, int num_pixels);
extern cups_rgb_t	*cupsRGBLoad(ppd_file_t *ppd,
			             const char *colormodel,
				     const char *media,
			             const char *resolution);
extern cups_rgb_t	*cupsRGBNew(int num_samples, cups_sample_t *samples,
			            int cube_size, int num_channels);

/*
 * CMYK separation functions...
 */

extern cups_cmyk_t	*cupsCMYKNew(int num_channels);
extern void		cupsCMYKDelete(cups_cmyk_t *cmyk);
extern void		cupsCMYKDoBlack(const cups_cmyk_t *cmyk,
			                const unsigned char *input,
			                short *output, int num_pixels);
extern void		cupsCMYKDoCMYK(const cups_cmyk_t *cmyk,
			               const unsigned char *input,
			               short *output, int num_pixels);
extern void		cupsCMYKDoGray(const cups_cmyk_t *cmyk,
			               const unsigned char *input,
			               short *output, int num_pixels);
extern void		cupsCMYKDoRGB(const cups_cmyk_t *cmyk,
			              const unsigned char *input,
			              short *output, int num_pixels);
extern cups_cmyk_t	*cupsCMYKLoad(ppd_file_t *ppd,
			              const char *colormodel,
				      const char *media,
			              const char *resolution);
extern void		cupsCMYKSetBlack(cups_cmyk_t *cmyk,
			                 float lower, float upper);
extern void		cupsCMYKSetCurve(cups_cmyk_t *cmyk, int channel,
			                 int num_xypoints,
					 const float *xypoints);
extern void		cupsCMYKSetGamma(cups_cmyk_t *cmyk, int channel,
			                 float gamval, float density);
extern void		cupsCMYKSetInkLimit(cups_cmyk_t *cmyk, float limit);
extern void		cupsCMYKSetLtDk(cups_cmyk_t *cmyk, int channel,
			                float light, float dark);


/*
 * Convenience macro for writing print data...
 */

#  define cupsWritePrintData(s,n) fwrite((s), 1, (n), stdout)

#  ifdef __cplusplus
}
#  endif /* __cplusplus */

#endif /* !_CUPS_DRIVER_H_ */

/*
 * End of "$Id$".
 */
Commit	Line	Data
ac884b6a MS	1	/*
	2	* "$Id$"
	3	*
	4	* Printer driver utilities header file for CUPS.
	5	*
	6	* Copyright 2007 by Apple Inc.
	7	* Copyright 1993-2005 by Easy Software Products.
	8	*
	9	* These coded instructions, statements, and computer programs are the
	10	* property of Apple Inc. and are protected by Federal copyright
	11	* law. Distribution and use rights are outlined in the file "LICENSE.txt"
	12	* which should have been included with this file. If this file is
	13	* file is missing or damaged, see the license at "http://www.cups.org/".
	14	*/
	15
	16	#ifndef _CUPS_DRIVER_H_
	17	# define _CUPS_DRIVER_H_
	18
	19	# ifdef __cplusplus
	20	extern "C" {
	21	# endif /* __cplusplus */
	22
	23	/*
	24	* Include necessary headers...
	25	*/
	26
	27	# include <stdio.h>
	28	# include <stdlib.h>
	29	# include <time.h>
	30	# include <math.h>
	31
	32	# if defined(WIN32) \|\| defined(__EMX__)
	33	# include <io.h>
	34	# else
	35	# include <unistd.h>
	36	# include <fcntl.h>
	37	# endif /* WIN32 \|\| __EMX__ */
	38
	39	# include <cups/cups.h>
	40	# include <cups/raster.h>
	41
	42
	43	/*
	44	* Common macros...
	45	*/
	46
	47	# ifndef min
	48	# define min(a,b) ((a) < (b) ? (a) : (b))
	49	# define max(a,b) ((a) > (b) ? (a) : (b))
	50	# endif /* !min */
	51
	52
	53	/*
	54	* Constants...
	55	*/
	56
	57	#define CUPS_MAX_CHAN 15 /* Maximum number of color components */
	58	#define CUPS_MAX_LUT 4095 /* Maximum LUT value */
	59	#define CUPS_MAX_RGB 4 /* Maximum number of sRGB components */
	60
	61
	62	/*
	63	* Types/structures for the various routines.
	64	*/
65
66	typedef struct cups_lut_s /** Lookup Table for Dithering **/
67	{
68	short intensity; /* Adjusted intensity */
69	short pixel; /* Output pixel value */
70	int error; /* Error from desired value */
71	} cups_lut_t;
72
73	typedef struct cups_dither_s /** Dithering State **/
74	{
75	int width; /* Width of buffer */
76	int row; /* Current row */
77	int errors[96]; /* Error values */
78	} cups_dither_t;
79
80	typedef struct cups_sample_s /** Color sample point **/
81	{
82	unsigned char rgb[3]; /* sRGB values */
83	unsigned char colors[CUPS_MAX_RGB]; /* Color values */
84	} cups_sample_t;
85
86	typedef struct cups_rgb_s /** Color separation lookup table **/
87	{
88	int cube_size; /* Size of color cube (2-N) on a side */
89	int num_channels; /* Number of colors per sample */
90	unsigned char ***colors; / 4-D array of sample values */
91	int cube_index[256]; /* Index into cube for a given sRGB value */
92	int cube_mult[256]; /* Multiplier value for a given sRGB value */
93	int cache_init; /* Are cached values initialized? */
94	unsigned char black[CUPS_MAX_RGB]; /* Cached black (sRGB = 0,0,0) */
95	unsigned char white[CUPS_MAX_RGB]; /* Cached white (sRGB = 255,255,255) */
96	} cups_rgb_t;
97
98	typedef struct cups_cmyk_s /** Simple CMYK lookup table **/
99	{
100	unsigned char black_lut[256]; /* Black generation LUT */
101	unsigned char color_lut[256]; /* Color removal LUT */
102	int ink_limit; /* Ink limit */
103	int num_channels; /* Number of components */
104	short *channels[CUPS_MAX_CHAN];
105	/* Lookup tables */
106	} cups_cmyk_t;
107
108
109	/*
110	* Globals...
111	*/
112
113	extern const unsigned char
114	cups_srgb_lut[256];
115	/* sRGB gamma lookup table */
116	extern const unsigned char
117	cups_scmy_lut[256];
118	/* sRGB gamma lookup table (inverted) */
119
120
121	/*
122	* Prototypes...
123	*/
124
125	/*
126	* Attribute function...
127	*/
128
129	extern ppd_attr_t cupsFindAttr(ppd_file_t ppd, const char *name,
130	const char *colormodel,
131	const char *media,
132	const char *resolution,
133	char *spec, int specsize);
134
135	/*
136	* Byte checking functions...
137	*/
138
139	extern int cupsCheckBytes(const unsigned char *, int);
140	extern int cupsCheckValue(const unsigned char *, int,
141	const unsigned char);
142
143	/*
144	* Dithering functions...
145	*/
146
147	extern void cupsDitherLine(cups_dither_t d, const cups_lut_t lut,
148	const short *data, int num_channels,
149	unsigned char *p);
150	extern cups_dither_t *cupsDitherNew(int width);
151	extern void cupsDitherDelete(cups_dither_t *);
152
153	/*
154	* Lookup table functions for dithering...
155	*/
156
157	extern cups_lut_t cupsLutNew(int num_vals, const float vals);
158	extern void cupsLutDelete(cups_lut_t *lut);
159	extern cups_lut_t cupsLutLoad(ppd_file_t ppd,
160	const char *colormodel,
161	const char *media,
162	const char *resolution,
163	const char *ink);
164
165
166	/*
167	* Bit packing functions...
168	*/
169
170	extern void cupsPackHorizontal(const unsigned char *,
171	unsigned char *, int,
172	const unsigned char, const int);
173	extern void cupsPackHorizontal2(const unsigned char *,
174	unsigned char *, int, const int);
175	extern void cupsPackHorizontalBit(const unsigned char *,
176	unsigned char *, int,
177	const unsigned char,
178	const unsigned char);
179	extern void cupsPackVertical(const unsigned char , unsigned char ,
180	int, const unsigned char, const int);
181
182	/*
183	* Color separation functions...
184	*/
185
186	extern void cupsRGBDelete(cups_rgb_t *rgb);
187	extern void cupsRGBDoGray(cups_rgb_t *rgb,
188	const unsigned char *input,
189	unsigned char *output, int num_pixels);
190	extern void cupsRGBDoRGB(cups_rgb_t *rgb,
191	const unsigned char *input,
192	unsigned char *output, int num_pixels);
193	extern cups_rgb_t cupsRGBLoad(ppd_file_t ppd,
194	const char *colormodel,
195	const char *media,
196	const char *resolution);
197	extern cups_rgb_t cupsRGBNew(int num_samples, cups_sample_t samples,
198	int cube_size, int num_channels);
199
200	/*
201	* CMYK separation functions...
202	*/
203
204	extern cups_cmyk_t *cupsCMYKNew(int num_channels);
205	extern void cupsCMYKDelete(cups_cmyk_t *cmyk);
206	extern void cupsCMYKDoBlack(const cups_cmyk_t *cmyk,
207	const unsigned char *input,
208	short *output, int num_pixels);
209	extern void cupsCMYKDoCMYK(const cups_cmyk_t *cmyk,
210	const unsigned char *input,
211	short *output, int num_pixels);
212	extern void cupsCMYKDoGray(const cups_cmyk_t *cmyk,
213	const unsigned char *input,
214	short *output, int num_pixels);
215	extern void cupsCMYKDoRGB(const cups_cmyk_t *cmyk,
216	const unsigned char *input,
217	short *output, int num_pixels);
218	extern cups_cmyk_t cupsCMYKLoad(ppd_file_t ppd,
219	const char *colormodel,
220	const char *media,
221	const char *resolution);
222	extern void cupsCMYKSetBlack(cups_cmyk_t *cmyk,
223	float lower, float upper);
224	extern void cupsCMYKSetCurve(cups_cmyk_t *cmyk, int channel,
225	int num_xypoints,
226	const float *xypoints);
227	extern void cupsCMYKSetGamma(cups_cmyk_t *cmyk, int channel,
228	float gamval, float density);
229	extern void cupsCMYKSetInkLimit(cups_cmyk_t *cmyk, float limit);
230	extern void cupsCMYKSetLtDk(cups_cmyk_t *cmyk, int channel,
231	float light, float dark);
232
233
234	/*
235	* Convenience macro for writing print data...
236	*/
237
238	# define cupsWritePrintData(s,n) fwrite((s), 1, (n), stdout)
239
240	# ifdef __cplusplus
241	}
242	# endif /* __cplusplus */
243
244	#endif /* !_CUPS_DRIVER_H_ */
245
246	/*
247	* End of "$Id$".
248	*/
249