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