1 /* Copyright (C) 2001-2006 Artifex Software, Inc.
2    All Rights Reserved.
3 
4    This software is provided AS-IS with no warranty, either express or
5    implied.
6 
7    This software is distributed under license and may not be copied, modified
8    or distributed except as expressly authorized under the terms of that
9    license.  Refer to licensing information at http://www.artifex.com/
10    or contact Artifex Software, Inc.,  7 Mt. Lassen Drive - Suite A-134,
11    San Rafael, CA  94903, U.S.A., +1(415)492-9861, for further information.
12 */
13 
14 /*$Id: gxclpath.h 9285 2008-12-13 11:14:54Z leonardo $ */
15 /* Definitions and support procedures for higher-level band list commands */
16 /* Extends (requires) gxcldev.h */
17 
18 #ifndef gxclpath_INCLUDED
19 #  define gxclpath_INCLUDED
20 
21 /*
22  * Define the flags indicating whether a band knows the current values of
23  * various miscellaneous parameters (pcls->known).  The first N flags match
24  * the mask parameter for cmd_set_misc2 below.
25  */
26 #define cap_join_known		(1<<0)
27 #define cj_ac_sa_known		(1<<1)
28 #define flatness_known		(1<<2)
29 #define line_width_known	(1<<3)
30 #define miter_limit_known	(1<<4)
31 #define op_bm_tk_known		(1<<5)
32 /* segment_notes must fit in the first byte (i.e. be less than 1<<7). */
33 #define segment_notes_known	(1<<6) /* not used in pcls->known */
34 /* (flags beyond this point require an extra byte) */
35 #define opacity_alpha_known	(1<<7)
36 #define shape_alpha_known	(1<<8)
37 #define alpha_known		(1<<9)
38 #define misc2_all_known		((1<<10)-1)
39 /* End of misc2 flags. */
40 #define fill_adjust_known	(1<<10)
41 #define ctm_known		(1<<11)
42 #define dash_known		(1<<12)
43 #define clip_path_known		(1<<13)
44 #define stroke_all_known	((1<<14)-1)
45 #define color_space_known	(1<<14)
46 /*#define all_known             ((1<<15)-1) */
47 
48 /* Define the drawing color types for distinguishing different */
49 /* fill/stroke command variations. */
50 typedef enum {
51     cmd_dc_type_pure = 0,
52     cmd_dc_type_ht = 1,
53     cmd_dc_type_color = 2
54 } cmd_dc_type;
55 
56 /* Extend the command set.  See gxcldev.h for more information. */
57 typedef enum {
58     cmd_op_misc2 = 0xd0,	/* (see below) */
59     /* obsolete */
60     /* cmd_opv_set_color = 0xd0, */	/* Used if base values do not fit into 1 bit */
61     				/* #flags,#base[0],...#base[num_comp-1] if flags */
62 				/* colored halftone with base colors a,b,c,d */
63     /* obsolete */
64     /* cmd_opv_set_color_short = 0xd1, */ /* Used if base values fit into 1 bit */
65     					/* If num_comp <= 4 then use: */
66     					/* pqrsabcd, where a = base[0] */
67 					/* b = base[1], c= base[2], d = base[3] */
68 					/* p = level[0], q = level[1] */
69 					/* r = level[2], s = level[3] */
70     					/* If num_comp > 4 then use: */
71 					/* #flags, #bases */
72     cmd_opv_set_fill_adjust = 0xd2,	/* adjust_x/y(fixed) */
73     cmd_opv_set_ctm = 0xd3,	/* [per sput/sget_matrix] */
74     cmd_opv_set_color_space = 0xd4,	/* base(4)Indexed?(2)0(2) */
75 				/* [, hival#, table|map] */
76     /*
77      * cmd_opv_set_misc2_value is followed by a mask (a variable-length
78      * integer), and then by parameter values for the parameters selected
79      * by the mask.  See above for the "known" mask values.
80      */
81     /* cap_join: 0(2)cap(3)join(3) */
82     /* cj_ac_sa: 0(3)curve_join+1(3)acc.curves(1)stroke_adj(1) */
83     /* flatness: (float) */
84     /* line width: (float) */
85     /* miter limit: (float) */
86     /* op_bm_tk: blend mode(5)text knockout(1)o.p.mode(1)o.p.(1) */
87     /* segment notes: (byte) */
88     /* opacity/shape: alpha(float)mask(TBD) */
89     /* alpha: <<verbatim copy from imager state>> */
90     cmd_opv_set_misc2 = 0xd5,	/* mask#, selected parameters */
91     cmd_opv_set_dash = 0xd6,	/* adapt(1)abs.dot(1)n(6), dot */
92 				/* length(float), offset(float), */
93 				/* n x (float) */
94     cmd_opv_enable_clip = 0xd7,	/* (nothing) */
95     cmd_opv_disable_clip = 0xd8,	/* (nothing) */
96     cmd_opv_begin_clip = 0xd9,	/* (nothing) */
97     cmd_opv_end_clip = 0xda,	/* (nothing) */
98     cmd_opv_begin_image_rect = 0xdb, /* same as begin_image, followed by */
99 				/* x0#, w-x1#, y0#, h-y1# */
100     cmd_opv_begin_image = 0xdc,	/* image_type_table index, */
101 				/* [per image type] */
102     cmd_opv_image_data = 0xdd,	/* height# (premature EOD if 0), */
103 				/* raster#, <data> */
104     cmd_opv_image_plane_data = 0xde, /* height# (premature EOD if 0), */
105 				/* flags# (0 = same raster & data_x, */
106 				/* 1 = new raster & data_x, lsb first), */
107 				/* [raster#, [data_x#,]]* <data> */
108     cmd_opv_extend = 0xdf,	/* command, varies */
109     cmd_op_segment = 0xe0,	/* (see below) */
110     cmd_opv_rmoveto = 0xe0,	/* dx%, dy% */
111     cmd_opv_rlineto = 0xe1,	/* dx%, dy% */
112     cmd_opv_hlineto = 0xe2,	/* dx% */
113     cmd_opv_vlineto = 0xe3,	/* dy% */
114     cmd_opv_rmlineto = 0xe4,	/* dx1%,dy1%, dx2%,dy2% */
115     cmd_opv_rm2lineto = 0xe5,	/* dx1%,dy1%, dx2%,dy2%, dx3%,dy3% */
116     cmd_opv_rm3lineto = 0xe6,	/* dx1%,dy1%, dx2%,dy2%, dx3%,dy3%, */
117 				/* [-dx2,-dy2 implicit] */
118     cmd_opv_rrcurveto = 0xe7,	/* dx1%,dy1%, dx2%,dy2%, dx3%,dy3% */
119       cmd_opv_min_curveto = cmd_opv_rrcurveto,
120     cmd_opv_hvcurveto = 0xe8,	/* dx1%, dx2%,dy2%, dy3% */
121     cmd_opv_vhcurveto = 0xe9,	/* dy1%, dx2%,dy2%, dx3% */
122     cmd_opv_nrcurveto = 0xea,	/* dx2%,dy2%, dx3%,dy3% */
123     cmd_opv_rncurveto = 0xeb,	/* dx1%,dy1%, dx2%,dy2% */
124     cmd_opv_vqcurveto = 0xec,	/* dy1%, dx2%[,dy2=dx2 with sign */
125 				/* of dy1, dx3=dy1 with sign of dx2] */
126     cmd_opv_hqcurveto = 0xed,	/* dx1%, [dx2=dy2 with sign */
127 				/* of dx1,]%dy2, [dy3=dx1 with sign */
128 				/* of dy2] */
129     cmd_opv_scurveto = 0xee,	/* all implicit: previous op must have been */
130 				/* *curveto with one or more of dx/y1/3 = 0. */
131 				/* If h*: -dx3,dy3, -dx2,dy2, -dx1,dy1. */
132 				/* If v*: dx3,-dy3, dx2,-dy2, dx1,-dy1. */
133       cmd_opv_max_curveto = cmd_opv_scurveto,
134     cmd_opv_closepath = 0xef,	/* (nothing) */
135     cmd_op_path = 0xf0,		/* (see below) */
136     cmd_opv_fill = 0xf0,
137     /* cmd_opv_htfill = 0xf1, */ /* obsolete */
138     /* cmd_opv_colorfill = 0xf2, */ /* obsolete */
139     cmd_opv_eofill = 0xf3,
140     /* cmd_opv_hteofill = 0xf4, */ /* obsolete */
141     /* cmd_opv_coloreofill = 0xf5, */ /* obsolete */
142     cmd_opv_stroke = 0xf6,
143     /* cmd_opv_htstroke = 0xf7, */ /* obsolete */
144     /* cmd_opv_colorstroke = 0xf8, */ /* obsolete */
145     cmd_opv_polyfill = 0xf9,
146     /* cmd_opv_htpolyfill = 0xfa, */ /* obsolete */
147     /* cmd_opv_colorpolyfill = 0xfb */ /* obsolete */
148     cmd_opv_fill_trapezoid = 0xfc
149 } gx_cmd_xop;
150 
151 /*
152  * Further extended command set. This code always occupies a byte, which
153  * is the second byte of a command whose first byte is cmd_opv_extend.
154  */
155 typedef enum {
156     cmd_opv_ext_put_params = 0x00,          /* serialized parameter list */
157     cmd_opv_ext_create_compositor = 0x01,   /* compositor id,
158                                              * serialized compositor */
159     cmd_opv_ext_put_halftone = 0x02,        /* length of entire halftone */
160     cmd_opv_ext_put_ht_seg = 0x03,          /* segment length,
161                                              * halftone segment data */
162     cmd_opv_ext_put_drawing_color = 0x04    /* length, color type id,
163                                              * serialized color */
164 } gx_cmd_ext_op;
165 
166 #define cmd_segment_op_num_operands_values\
167   2, 2, 1, 1, 4, 6, 6, 6, 4, 4, 4, 4, 2, 2, 0, 0
168 
169 #define cmd_misc2_op_name_strings\
170   "cmd_opv_set_color", "set_color_short", "set_fill_adjust", "set_ctm",\
171   "set_color_space", "set_misc2", "set_dash", "enable_clip",\
172   "disable_clip", "begin_clip", "end_clip", "begin_image_rect",\
173   "begin_image", "image_data", "image_plane_data", "put_params"
174 
175 #define cmd_segment_op_name_strings\
176   "rmoveto", "rlineto", "hlineto", "vlineto",\
177   "rmlineto", "rm2lineto", "rm3lineto", "rrcurveto",\
178   "hvcurveto", "vhcurveto", "nrcurveto", "rncurveto",\
179   "vqcurveto", "hqcurveto", "scurveto", "closepath"
180 
181 #define cmd_path_op_name_strings\
182   "fill", "htfill", "colorfill", "eofill",\
183   "hteofill", "coloreofill", "stroke", "htstroke",\
184   "colorstroke", "polyfill", "htpolyfill", "colorpolyfill",\
185   "fill_trapezoid", "?fd?", "?fe?", "?ff?"
186 
187 /*
188  * We represent path coordinates as 'fixed' values in a variable-length,
189  * relative form (s/t = sign, x/y = integer, f/g = fraction):
190  *      00sxxxxx xfffffff ffffftyy yyyygggg gggggggg
191  *      01sxxxxx xxxxffff ffffffff
192  *      10sxxxxx xxxxxxxx xxxxffff ffffffff
193  *      110sxxxx xxxxxxff
194  *      111----- (a full-size `fixed' value)
195  */
196 #define is_bits(d, n) !(((d) + ((fixed)1 << ((n) - 1))) & (-(fixed)1 << (n)))
197 
198 /*
199  * Maximum size of a halftone segment. This leaves enough headroom to
200  * accommodate any reasonable requirements of the command buffer.
201  */
202 #define cbuf_ht_seg_max_size    (cbuf_size - 32)    /* leave some headroom */
203 
204 /* ---------------- Driver procedures ---------------- */
205 
206 /* In gxclpath.c */
207 dev_proc_fill_path(clist_fill_path);
208 dev_proc_stroke_path(clist_stroke_path);
209 dev_proc_fill_parallelogram(clist_fill_parallelogram);
210 dev_proc_fill_triangle(clist_fill_triangle);
211 
212 /* ---------------- Driver procedure support ---------------- */
213 
214 /* The procedures and macros defined here are used when writing */
215 /* (gxclimag.c, gxclpath.c). */
216 
217 /* Compare and update members of the imager state. */
218 #define state_neq(member)\
219   (cdev->imager_state.member != pis->member)
220 #define state_update(member)\
221   (cdev->imager_state.member = pis->member)
222 
223 /* ------ Exported by gxclpath.c ------ */
224 
225 /* Compute the colors used by a drawing color. */
226 gx_color_index cmd_drawing_colors_used(gx_device_clist_writer *cldev,
227 				       const gx_drawing_color *pdcolor);
228 
229 /*
230  * Compute whether a drawing operation will require the slow (full-pixel)
231  * RasterOp implementation.  If pdcolor is not NULL, it is the texture for
232  * the RasterOp.
233  */
234 bool cmd_slow_rop(gx_device *dev, gs_logical_operation_t lop,
235 		  const gx_drawing_color *pdcolor);
236 
237 /* Write out the color for filling, stroking, or masking. */
238 /* Return a cmd_dc_type. */
239 int cmd_put_drawing_color(gx_device_clist_writer * cldev,
240 			  gx_clist_state * pcls,
241 			  const gx_drawing_color * pdcolor,
242 			  cmd_rects_enum_t *pre);
243 
244 /* Clear (a) specific 'known' flag(s) for all bands. */
245 /* We must do this whenever the value of a 'known' parameter changes. */
246 void cmd_clear_known(gx_device_clist_writer * cldev, uint known);
247 
248 /* Compute the written CTM length. */
249 int cmd_write_ctm_return_length(gx_device_clist_writer * cldev, const gs_matrix *m);
250 int cmd_write_ctm_return_length_nodevice(const gs_matrix *m);
251 /* Write out CTM. */
252 int cmd_write_ctm(const gs_matrix *m, byte *dp, int len);
253 
254 /* Write out values of any unknown parameters. */
255 #define cmd_do_write_unknown(cldev, pcls, must_know)\
256   ( ~(pcls)->known & (must_know) ?\
257     cmd_write_unknown(cldev, pcls, must_know) : 0 )
258 int cmd_write_unknown(gx_device_clist_writer * cldev, gx_clist_state * pcls,
259 		      uint must_know);
260 
261 /* Check whether we need to change the clipping path in the device. */
262 bool cmd_check_clip_path(gx_device_clist_writer * cldev,
263 			 const gx_clip_path * pcpath);
264 
265 #endif /* gxclpath_INCLUDED */
266