c79bcc4a76de1ce708397e9a33b63aeb3221cf2c
[blender.git] / intern / raskter / raskter.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2012 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Peter Larabell.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file raskter.c
29  *  \ingroup RASKTER
30  */
31
32 #include <stdlib.h>
33 #include "raskter.h"
34
35 /* from BLI_utildefines.h */
36 #define MIN2(x, y)               ( (x) < (y) ? (x) : (y) )
37 #define MAX2(x, y)               ( (x) > (y) ? (x) : (y) )
38
39 struct PolyVert {
40         int x;
41         int y;
42 };
43
44 struct e_Status {
45         int x;
46         int ybeg;
47         int xshift;
48         int xdir;
49         int drift;
50         int drift_inc;
51         int drift_dec;
52         int num;
53         struct e_Status *e_next;
54 };
55
56 struct r_BufferStats {
57         float *buf;
58         int sizex;
59         int sizey;
60         int ymin;
61         int ymax;
62         int xmin;
63         int xmax;
64 };
65
66 struct r_FillContext {
67         struct e_Status *all_edges, *possible_edges;
68         struct r_BufferStats rb;
69 };
70
71 /*
72  * Sort all the edges of the input polygon by Y, then by X, of the "first" vertex encountered.
73  * This will ensure we can scan convert the entire poly in one pass.
74  *
75  * Really the poly should be clipped to the frame buffer's dimensions here for speed of drawing
76  * just the poly. Since the DEM code could end up being coupled with this, we'll keep it separate
77  * for now.
78  */
79 static void preprocess_all_edges(struct r_FillContext *ctx,
80                                  struct PolyVert *verts, int num_verts, struct e_Status *open_edge)
81 {
82         int i;
83         int xbeg;
84         int ybeg;
85         int xend;
86         int yend;
87         int dx;
88         int dy;
89         int temp_pos;
90         int xdist;
91         struct e_Status *e_new;
92         struct e_Status *next_edge;
93         struct e_Status **next_edge_ref;
94         struct PolyVert *v;
95         /* set up pointers */
96         v = verts;
97         ctx->all_edges = NULL;
98         /* initialize some boundaries */
99         ctx->rb.xmax = v[0].x;
100         ctx->rb.xmin = v[0].x;
101         ctx->rb.ymax = v[0].y;
102         ctx->rb.ymin = v[0].y;
103         /* loop all verts */
104         for (i = 0; i < num_verts; i++) {
105                 /* determine beginnings and endings of edges, linking last vertex to first vertex */
106                 xbeg = v[i].x;
107                 ybeg = v[i].y;
108                 /* keep track of our x and y bounds */
109                 if (xbeg >= ctx->rb.xmax) {
110                         ctx->rb.xmax = xbeg;
111                 }
112                 else if (xbeg <= ctx->rb.xmin) {
113                         ctx->rb.xmin = xbeg;
114                 }
115                 if (ybeg >= ctx->rb.ymax) {
116                         ctx->rb.ymax= ybeg;
117                 }
118                 else if (ybeg <= ctx->rb.ymin) {
119                         ctx->rb.ymin=ybeg;
120                 }
121                 if (i) {
122                         /* we're not at the last vert, so end of the edge is the previous vertex */
123                         xend = v[i - 1].x;
124                         yend = v[i - 1].y;
125                 }
126                 else {
127                         /* we're at the first vertex, so the "end" of this edge is the last vertex */
128                         xend = v[num_verts - 1].x;
129                         yend = v[num_verts - 1].y;
130                 }
131                 /* make sure our edges are facing the correct direction */
132                 if (ybeg > yend) {
133                         /* flip the Xs */
134                         temp_pos = xbeg;
135                         xbeg = xend;
136                         xend = temp_pos;
137                         /* flip the Ys */
138                         temp_pos = ybeg;
139                         ybeg = yend;
140                         yend = temp_pos;
141                 }
142
143                 /* calculate y delta */
144                 dy = yend - ybeg;
145                 /* dont draw horizontal lines directly, they are scanned as part of the edges they connect, so skip em. :) */
146                 if (dy) {
147                         /* create the edge and determine it's slope (for incremental line drawing) */
148                         e_new = open_edge++;
149
150                         /* calculate x delta */
151                         dx = xend - xbeg;
152                         if (dx > 0) {
153                                 e_new->xdir = 1;
154                                 xdist = dx;
155                         }
156                         else {
157                                 e_new->xdir = -1;
158                                 xdist = -dx;
159                         }
160
161                         e_new->x = xbeg;
162                         e_new->ybeg = ybeg;
163                         e_new->num = dy;
164                         e_new->drift_dec = dy;
165
166                         /* calculate deltas for incremental drawing */
167                         if (dx >= 0) {
168                                 e_new->drift = 0;
169                         }
170                         else {
171                                 e_new->drift = -dy + 1;
172                         }
173                         if (dy >= xdist) {
174                                 e_new->drift_inc = xdist;
175                                 e_new->xshift = 0;
176                         }
177                         else {
178                                 e_new->drift_inc = xdist % dy;
179                                 e_new->xshift = (xdist / dy) * e_new->xdir;
180                         }
181                         next_edge_ref = &ctx->all_edges;
182                         /* link in all the edges, in sorted order */
183                         for (;;) {
184                                 next_edge = *next_edge_ref;
185                                 if (!next_edge || (next_edge->ybeg > ybeg) || ((next_edge->ybeg == ybeg) && (next_edge->x >= xbeg))) {
186                                         e_new->e_next = next_edge;
187                                         *next_edge_ref = e_new;
188                                         break;
189                                 }
190                                 next_edge_ref = &next_edge->e_next;
191                         }
192                 }
193         }
194 }
195
196 /*
197  * This function clips drawing to the frame buffer. That clipping will likely be moved into the preprocessor
198  * for speed, but waiting on final design choices for curve-data before eliminating data the DEM code will need
199  * if it ends up being coupled with this function.
200  */
201 static int rast_scan_fill(struct r_FillContext *ctx, struct PolyVert *verts, int num_verts, float intensity)
202 {
203         int x_curr;                 /* current pixel position in X */
204         int y_curr;                 /* current scan line being drawn */
205         int yp;                     /* y-pixel's position in frame buffer */
206         int swixd = 0;              /* whether or not edges switched position in X */
207         float *cpxl;                /* pixel pointers... */
208         float *mpxl;
209         float *spxl;
210         struct e_Status *e_curr;    /* edge pointers... */
211         struct e_Status *e_temp;
212         struct e_Status *edgbuf;
213         struct e_Status **edgec;
214
215
216         /*
217          * If the number of verts specified to render as a polygon is less than 3,
218          * return immediately. Obviously we cant render a poly with sides < 3. The
219          * return for this we set to 1, simply so it can be distinguished from the
220          * next place we could return, /home/guest/blender-svn/soc-2011-tomato/intern/raskter/raskter.
221          * which is a failure to allocate memory.
222          */
223         if (num_verts < 3) {
224                 return(1);
225         }
226
227         /*
228          * Try to allocate an edge buffer in memory. needs to be the size of the edge tracking data
229          * multiplied by the number of edges, which is always equal to the number of verts in
230          * a 2D polygon. Here we return 0 to indicate a memory allocation failure, as opposed to a 1 for
231          * the preceeding error, which was a rasterization request on a 2D poly with less than
232          * 3 sides.
233          */
234         if ((edgbuf = (struct e_Status *)(malloc(sizeof(struct e_Status) * num_verts))) == NULL) {
235                 return(0);
236         }
237
238         /*
239          * Do some preprocessing on all edges. This constructs a table structure in memory of all
240          * the edge properties and can "flip" some edges so sorting works correctly.
241          */
242         preprocess_all_edges(ctx, verts, num_verts, edgbuf);
243
244         /* can happen with a zero area mask */
245         if (ctx->all_edges == NULL) {
246                 free(edgbuf);
247                 return(1);
248         }
249         /*
250          * Set the pointer for tracking the edges currently in processing to NULL to make sure
251          * we don't get some crazy value after initialization.
252          */
253         ctx->possible_edges = NULL;
254
255         /*
256          * Loop through all scan lines to be drawn. Since we sorted by Y values during
257          * preprocess_all_edges(), we can already exact values for the lowest and
258          * highest Y values we could possibly need by induction. The preprocessing sorted
259          * out edges by Y position, we can cycle the current edge being processed once
260          * it runs out of Y pixels. When we have no more edges, meaning the current edge
261          * is NULL after setting the "current" edge to be the previous current edge's
262          * "next" edge in the Y sorted edge connection chain, we can stop looping Y values,
263          * since we can't possibly have more scan lines if we ran out of edges. :)
264          *
265          * TODO: This clips Y to the frame buffer, which should be done in the preprocessor, but for now is done here.
266          *       Will get changed once DEM code gets in.
267          */
268         for (y_curr = ctx->all_edges->ybeg; (ctx->all_edges || ctx->possible_edges); y_curr++) {
269
270                 /*
271                  * Link any edges that start on the current scan line into the list of
272                  * edges currently needed to draw at least this, if not several, scan lines.
273                  */
274
275                 /*
276                  * Set the current edge to the beginning of the list of edges to be rasterized
277                  * into this scan line.
278                  *
279                  * We could have lots of edge here, so iterate over all the edges needed. The
280                  * preprocess_all_edges() function sorted edges by X within each chunk of Y sorting
281                  * so we safely cycle edges to thier own "next" edges in order.
282                  *
283                  * At each iteration, make sure we still have a non-NULL edge.
284                  */
285                 for (edgec = &ctx->possible_edges; ctx->all_edges && (ctx->all_edges->ybeg == y_curr);) {
286                         x_curr = ctx->all_edges->x;                  /* Set current X position. */
287                         for (;;) {                                   /* Start looping edges. Will break when edges run out. */
288                                 e_curr = *edgec;                         /* Set up a current edge pointer. */
289                                 if (!e_curr || (e_curr->x >= x_curr)) {  /* If we have an no edge, or we need to skip some X-span, */
290                                         e_temp = ctx->all_edges->e_next;     /* set a temp "next" edge to test. */
291                                         *edgec = ctx->all_edges;             /* Add this edge to the list to be scanned. */
292                                         ctx->all_edges->e_next = e_curr;     /* Set up the next edge. */
293                                         edgec = &ctx->all_edges->e_next;     /* Set our list to the next edge's location in memory. */
294                                         ctx->all_edges = e_temp;             /* Skip the NULL or bad X edge, set pointer to next edge. */
295                                         break;                               /* Stop looping edges (since we ran out or hit empty X span. */
296                                 }
297                                 else {
298                                         edgec = &e_curr->e_next;             /* Set the pointer to the edge list the "next" edge. */
299                                 }
300                         }
301                 }
302
303                 /*
304                  * Determine the current scan line's offset in the pixel buffer based on its Y position.
305                  * Basically we just multiply the current scan line's Y value by the number of pixels in each line.
306                  */
307                 yp = y_curr * ctx->rb.sizex;
308                 /*
309                  * Set a "scan line pointer" in memory. The location of the buffer plus the row offset.
310                  */
311                 spxl = ctx->rb.buf + (yp);
312                 /*
313                  * Set up the current edge to the first (in X) edge. The edges which could possibly be in this
314                  * list were determined in the preceeding edge loop above. They were already sorted in X by the
315                  * initial processing function.
316                  *
317                  * At each iteration, test for a NULL edge. Since we'll keep cycling edge's to their own "next" edge
318                  * we will eventually hit a NULL when the list runs out.
319                  */
320                 for (e_curr = ctx->possible_edges; e_curr; e_curr = e_curr->e_next) {
321                         /*
322                          * Calculate a span of pixels to fill on the current scan line.
323                          *
324                          * Set the current pixel pointer by adding the X offset to the scan line's start offset.
325                          * Cycle the current edge the next edge.
326                          * Set the max X value to draw to be one less than the next edge's first pixel. This way we are
327                          * sure not to ever get into a situation where we have overdraw. (drawing the same pixel more than
328                          * one time because it's on a vertex connecting two edges)
329                          *
330                          * Then blast through all the pixels in the span, advancing the pointer and setting the color to white.
331                          *
332                          * TODO: Here we clip to the scan line, this is not efficient, and should be done in the preprocessor,
333                          *       but for now it is done here until the DEM code comes in.
334                          */
335
336                         /* set up xmin and xmax bounds on this scan line */
337                         cpxl = spxl + MAX2(e_curr->x, 0);
338                         e_curr = e_curr->e_next;
339                         mpxl = spxl + MIN2(e_curr->x, ctx->rb.sizex) - 1;
340
341                         if ((y_curr >= 0) && (y_curr < ctx->rb.sizey)) {
342                                 /* draw the pixels. */
343                                 for (; cpxl <= mpxl; *cpxl++ += intensity) {}
344                         }
345                 }
346
347                 /*
348                  * Loop through all edges of polygon that could be hit by this scan line,
349                  * and figure out their x-intersections with the next scan line.
350                  *
351                  * Either A.) we wont have any more edges to test, or B.) we just add on the
352                  * slope delta computed in preprocessing step. Since this draws non-antialiased
353                  * polygons, we dont have fractional positions, so we only move in x-direction
354                  * when needed to get all the way to the next pixel over...
355                  */
356                 for (edgec = &ctx->possible_edges; (e_curr = *edgec);) {
357                         if (!(--(e_curr->num))) {
358                                 *edgec = e_curr->e_next;
359                         }
360                         else {
361                                 e_curr->x += e_curr->xshift;
362                                 if ((e_curr->drift += e_curr->drift_inc) > 0) {
363                                         e_curr->x += e_curr->xdir;
364                                         e_curr->drift -= e_curr->drift_dec;
365                                 }
366                                 edgec = &e_curr->e_next;
367                         }
368                 }
369                 /*
370                  * It's possible that some edges may have crossed during the last step, so we'll be sure
371                  * that we ALWAYS intersect scan lines in order by shuffling if needed to make all edges
372                  * sorted by x-intersection coordinate. We'll always scan through at least once to see if
373                  * edges crossed, and if so, we set the 'swixd' flag. If 'swixd' gets set on the initial
374                  * pass, then we know we need to sort by x, so then cycle through edges again and perform
375                  * the sort.-
376                  */
377                 if (ctx->possible_edges) {
378                         for (edgec = &ctx->possible_edges; (e_curr = *edgec)->e_next; edgec = &(*edgec)->e_next) {
379                                 /* if the current edge hits scan line at greater X than the next edge, we need to exchange the edges */
380                                 if (e_curr->x > e_curr->e_next->x) {
381                                         *edgec = e_curr->e_next;
382                                         /* exchange the pointers */
383                                         e_temp = e_curr->e_next->e_next;
384                                         e_curr->e_next->e_next = e_curr;
385                                         e_curr->e_next = e_temp;
386                                         /* set flag that we had at least one switch */
387                                         swixd = 1;
388                                 }
389                         }
390                         /* if we did have a switch, look for more (there will more if there was one) */
391                         for (;;) {
392                                 /* reset exchange flag so it's only set if we encounter another one */
393                                 swixd = 0;
394                                 for (edgec = &ctx->possible_edges; (e_curr = *edgec)->e_next; edgec = &(*edgec)->e_next) {
395                                         /* again, if current edge hits scan line at higher X than next edge, exchange the edges and set flag */
396                                         if (e_curr->x > e_curr->e_next->x) {
397                                                 *edgec = e_curr->e_next;
398                                                 /* exchange the pointers */
399                                                 e_temp = e_curr->e_next->e_next;
400                                                 e_curr->e_next->e_next = e_curr;
401                                                 e_curr->e_next = e_temp;
402                                                 /* flip the exchanged flag */
403                                                 swixd = 1;
404                                         }
405                                 }
406                                 /* if we had no exchanges, we're done reshuffling the pointers */
407                                 if (!swixd) {
408                                         break;
409                                 }
410                         }
411                 }
412         }
413
414         free(edgbuf);
415         return 1;
416 }
417
418 int PLX_raskterize(float(*base_verts)[2], int num_base_verts,
419                    float *buf, int buf_x, int buf_y)
420 {
421         int i;                                   /* i: Loop counter. */
422         struct PolyVert *ply;                   /* ply: Pointer to a list of integer buffer-space vertex coordinates. */
423         struct r_FillContext ctx = {0};
424         const float buf_x_f = (float)(buf_x);
425         const float buf_y_f = (float)(buf_y);
426         /*
427          * Allocate enough memory for our PolyVert list. It'll be the size of the PolyVert
428          * data structure multiplied by the number of base_verts.
429          *
430          * In the event of a failure to allocate the memory, return 0, so this error can
431          * be distinguished as a memory allocation error.
432          */
433         if ((ply = (struct PolyVert *)(malloc(sizeof(struct PolyVert) * num_base_verts))) == NULL) {
434                 return(0);
435         }
436
437         ctx.rb.buf = buf;                            /* Set the output buffer pointer. */
438         ctx.rb.sizex = buf_x;                        /* Set the output buffer size in X. (width) */
439         ctx.rb.sizey = buf_y;                        /* Set the output buffer size in Y. (height) */
440         /*
441          * Loop over all verts passed in to be rasterized. Each vertex's X and Y coordinates are
442          * then converted from normalized screen space (0.0 <= POS <= 1.0) to integer coordinates
443          * in the buffer-space coordinates passed in inside buf_x and buf_y.
444          *
445          * It's worth noting that this function ONLY outputs fully white pixels in a mask. Every pixel
446          * drawn will be 1.0f in value, there is no anti-aliasing.
447          */
448
449         for (i = 0; i < num_base_verts; i++) {                      /* Loop over all base_verts. */
450                 ply[i].x = (int)((base_verts[i][0] * buf_x_f) + 0.5f);  /* Range expand normalized X to integer buffer-space X. */
451                 ply[i].y = (int)((base_verts[i][1] * buf_y_f) + 0.5f);  /* Range expand normalized Y to integer buffer-space Y. */
452         }
453
454         i = rast_scan_fill(&ctx, ply, num_base_verts,1.0f);  /* Call our rasterizer, passing in the integer coords for each vert. */
455
456         free(ply);                                      /* Free the memory allocated for the integer coordinate table. */
457         return(i);                                      /* Return the value returned by the rasterizer. */
458 }