1 #define __SP_CAIRO_RENDERER_C__
3 /** \file
4 * Rendering with Cairo.
5 */
6 /*
7 * Author:
8 * Miklos Erdelyi <erdelyim@gmail.com>
9 *
10 * Copyright (C) 2006 Miklos Erdelyi
11 *
12 * Licensed under GNU GPL
13 */
15 #ifdef HAVE_CONFIG_H
16 # include "config.h"
17 #endif
19 #ifdef HAVE_CAIRO_PDF
21 #ifndef PANGO_ENABLE_BACKEND
22 #define PANGO_ENABLE_BACKEND
23 #endif
25 #ifndef PANGO_ENABLE_ENGINE
26 #define PANGO_ENABLE_ENGINE
27 #endif
30 #include <signal.h>
31 #include <errno.h>
33 #include <libnr/n-art-bpath.h>
34 #include <libnr/nr-matrix-ops.h>
35 #include <libnr/nr-matrix-fns.h>
36 #include <libnr/nr-matrix-translate-ops.h>
37 #include <libnr/nr-scale-matrix-ops.h>
39 #include <glib/gmem.h>
41 #include <glibmm/i18n.h>
42 #include "display/nr-arena.h"
43 #include "display/nr-arena-item.h"
44 #include "display/nr-arena-group.h"
45 #include "display/curve.h"
46 #include "display/canvas-bpath.h"
47 #include "sp-item.h"
48 #include "sp-item-group.h"
49 #include "style.h"
50 #include "marker.h"
51 #include "sp-linear-gradient.h"
52 #include "sp-radial-gradient.h"
53 #include "sp-root.h"
54 #include "sp-shape.h"
55 #include "sp-use.h"
56 #include "sp-text.h"
57 #include "sp-flowtext.h"
58 #include "sp-image.h"
59 #include "sp-symbol.h"
60 #include "sp-pattern.h"
61 #include "sp-mask.h"
62 #include "sp-clippath.h"
64 #include <unit-constants.h>
66 #include "cairo-renderer.h"
67 #include "cairo-render-context.h"
68 #include "extension/system.h"
70 #include "io/sys.h"
72 #include <cairo.h>
74 // include support for only the compiled-in surface types
75 #ifdef CAIRO_HAS_PDF_SURFACE
76 #include <cairo-pdf.h>
77 #endif
78 #ifdef CAIRO_HAS_PS_SURFACE
79 #include <cairo-ps.h>
80 #endif
82 //#define TRACE(_args) g_printf _args
83 #define TRACE(_args)
85 // FIXME: expose these from sp-clippath/mask.cpp
86 struct SPClipPathView {
87 SPClipPathView *next;
88 unsigned int key;
89 NRArenaItem *arenaitem;
90 NRRect bbox;
91 };
93 struct SPMaskView {
94 SPMaskView *next;
95 unsigned int key;
96 NRArenaItem *arenaitem;
97 NRRect bbox;
98 };
100 namespace Inkscape {
101 namespace Extension {
102 namespace Internal {
104 CairoRenderer::CairoRenderer(void)
105 {}
107 CairoRenderer::~CairoRenderer(void)
108 {
109 /* restore default signal handling for SIGPIPE */
110 #if !defined(_WIN32) && !defined(__WIN32__)
111 (void) signal(SIGPIPE, SIG_DFL);
112 #endif
114 return;
115 }
117 CairoRenderContext*
118 CairoRenderer::createContext(void)
119 {
120 CairoRenderContext *new_context = new CairoRenderContext(this);
121 g_assert( new_context != NULL );
123 new_context->_state_stack = NULL;
124 new_context->_state = NULL;
126 // create initial render state
127 CairoRenderState *state = new_context->_createState();
128 nr_matrix_set_identity(&state->transform);
129 new_context->_state_stack = g_slist_prepend(new_context->_state_stack, state);
130 new_context->_state = state;
132 return new_context;
133 }
135 void
136 CairoRenderer::destroyContext(CairoRenderContext *ctx)
137 {
138 delete ctx;
139 }
141 /*
143 Here comes the rendering part which could be put into the 'render' methods of SPItems'
145 */
147 /* The below functions are copy&pasted plus slightly modified from *_invoke_print functions. */
148 static void sp_item_invoke_render(SPItem *item, CairoRenderContext *ctx);
149 static void sp_group_render(SPItem *item, CairoRenderContext *ctx);
150 static void sp_use_render(SPItem *item, CairoRenderContext *ctx);
151 static void sp_shape_render(SPItem *item, CairoRenderContext *ctx);
152 static void sp_text_render(SPItem *item, CairoRenderContext *ctx);
153 static void sp_flowtext_render(SPItem *item, CairoRenderContext *ctx);
154 static void sp_image_render(SPItem *item, CairoRenderContext *ctx);
155 static void sp_symbol_render(SPItem *item, CairoRenderContext *ctx);
157 static void sp_shape_render (SPItem *item, CairoRenderContext *ctx)
158 {
159 NRRect pbox;
161 SPShape *shape = SP_SHAPE(item);
163 if (!shape->curve) return;
165 /* fixme: Think (Lauris) */
166 sp_item_invoke_bbox(item, &pbox, NR::identity(), TRUE);
167 NR::Matrix const i2d = sp_item_i2d_affine(item);
169 SPStyle* style = SP_OBJECT_STYLE (item);
170 CairoRenderer *renderer = ctx->getRenderer();
172 NRBPath bp;
173 bp.path = SP_CURVE_BPATH(shape->curve);
175 ctx->renderPath(&bp, style, &pbox);
177 for (NArtBpath* bp = SP_CURVE_BPATH(shape->curve); bp->code != NR_END; bp++) {
178 for (int m = SP_MARKER_LOC_START; m < SP_MARKER_LOC_QTY; m++) {
179 if (sp_shape_marker_required (shape, m, bp)) {
181 SPMarker* marker = SP_MARKER (shape->marker[m]);
182 SPItem* marker_item = sp_item_first_item_child (SP_OBJECT (shape->marker[m]));
184 NR::Matrix tr(sp_shape_marker_get_transform(shape, bp));
186 if (marker->markerUnits == SP_MARKER_UNITS_STROKEWIDTH) {
187 tr = NR::scale(style->stroke_width.computed) * tr;
188 }
190 tr = marker_item->transform * marker->c2p * tr;
192 NR::Matrix old_tr = marker_item->transform;
193 marker_item->transform = tr;
194 renderer->renderItem (ctx, marker_item);
195 marker_item->transform = old_tr;
196 }
197 }
198 }
199 }
201 static void sp_group_render(SPItem *item, CairoRenderContext *ctx)
202 {
203 SPGroup *group = SP_GROUP(item);
204 CairoRenderer *renderer = ctx->getRenderer();
205 TRACE(("group op: %f\n", SP_SCALE24_TO_FLOAT(SP_OBJECT_STYLE(item)->opacity.value)));
207 GSList *l = g_slist_reverse(group->childList(false));
208 while (l) {
209 SPObject *o = SP_OBJECT (l->data);
210 if (SP_IS_ITEM(o)) {
211 renderer->renderItem (ctx, SP_ITEM (o));
212 }
213 l = g_slist_remove (l, o);
214 }
215 }
217 static void sp_use_render(SPItem *item, CairoRenderContext *ctx)
218 {
219 bool translated = false;
220 NRMatrix tp;
221 SPUse *use = SP_USE(item);
222 CairoRenderer *renderer = ctx->getRenderer();
224 if ((use->x._set && use->x.computed != 0) || (use->y._set && use->y.computed != 0)) {
225 nr_matrix_set_translate(&tp, use->x.computed, use->y.computed);
226 ctx->pushState();
227 ctx->transform(&tp);
228 translated = true;
229 }
231 if (use->child && SP_IS_ITEM(use->child)) {
232 renderer->renderItem(ctx, SP_ITEM(use->child));
233 }
235 if (translated) {
236 ctx->popState();
237 }
238 }
240 static void sp_text_render(SPItem *item, CairoRenderContext *ctx)
241 {
242 SPText *group = SP_TEXT (item);
243 group->layout.showGlyphs(ctx);
244 }
246 static void sp_flowtext_render(SPItem *item, CairoRenderContext *ctx)
247 {
248 SPFlowtext *group = SP_FLOWTEXT(item);
249 group->layout.showGlyphs(ctx);
250 }
252 static void sp_image_render(SPItem *item, CairoRenderContext *ctx)
253 {
254 SPImage *image;
255 NRMatrix tp, s, t;
256 guchar *px;
257 int w, h, rs;
259 image = SP_IMAGE (item);
261 if (!image->pixbuf) return;
262 if ((image->width.computed <= 0.0) || (image->height.computed <= 0.0)) return;
264 px = gdk_pixbuf_get_pixels (image->pixbuf);
265 w = gdk_pixbuf_get_width (image->pixbuf);
266 h = gdk_pixbuf_get_height (image->pixbuf);
267 rs = gdk_pixbuf_get_rowstride (image->pixbuf);
269 double x = image->x.computed;
270 double y = image->y.computed;
271 double width = image->width.computed;
272 double height = image->height.computed;
274 if (image->aspect_align != SP_ASPECT_NONE) {
275 calculatePreserveAspectRatio (image->aspect_align, image->aspect_clip, (double)w, (double)h,
276 &x, &y, &width, &height);
277 }
279 if (image->aspect_clip == SP_ASPECT_SLICE && !ctx->getCurrentState()->has_overflow) {
280 ctx->addClippingRect(image->x.computed, image->y.computed, image->width.computed, image->height.computed);
281 }
283 nr_matrix_set_translate (&tp, x, y);
284 nr_matrix_set_scale (&s, width / (double)w, height / (double)h);
285 nr_matrix_multiply (&t, &s, &tp);
287 ctx->renderImage (px, w, h, rs, &t, SP_OBJECT_STYLE (item));
288 }
290 static void sp_symbol_render(SPItem *item, CairoRenderContext *ctx)
291 {
292 SPSymbol *symbol = SP_SYMBOL(item);
293 if (!SP_OBJECT_IS_CLONED (symbol))
294 return;
296 /* Cloned <symbol> is actually renderable */
297 ctx->pushState();
298 ctx->transform(&symbol->c2p);
300 // apply viewbox if set
301 if (0 /*symbol->viewBox_set*/) {
302 NRMatrix vb2user;
303 double x, y, width, height;
304 double view_width, view_height;
305 x = 0.0;
306 y = 0.0;
307 width = 1.0;
308 height = 1.0;
310 view_width = symbol->viewBox.x1 - symbol->viewBox.x0;
311 view_height = symbol->viewBox.y1 - symbol->viewBox.y0;
313 calculatePreserveAspectRatio(symbol->aspect_align, symbol->aspect_clip, view_width, view_height,
314 &x, &y,&width, &height);
316 // [itemTransform *] translate(x, y) * scale(w/vw, h/vh) * translate(-vx, -vy);
317 nr_matrix_set_identity(&vb2user);
318 vb2user[0] = width / view_width;
319 vb2user[3] = height / view_height;
320 vb2user[4] = x - symbol->viewBox.x0 * vb2user[0];
321 vb2user[5] = y - symbol->viewBox.y0 * vb2user[3];
323 ctx->transform(&vb2user);
324 }
326 sp_group_render(item, ctx);
327 ctx->popState();
328 }
330 static void sp_root_render(SPItem *item, CairoRenderContext *ctx)
331 {
332 SPRoot *root = SP_ROOT(item);
333 CairoRenderer *renderer = ctx->getRenderer();
335 if (!ctx->getCurrentState()->has_overflow && SP_OBJECT(item)->parent)
336 ctx->addClippingRect(root->x.computed, root->y.computed, root->width.computed, root->height.computed);
338 ctx->pushState();
339 renderer->setStateForItem(ctx, item);
340 ctx->transform(root->c2p);
341 sp_group_render(item, ctx);
342 ctx->popState();
343 }
345 static void sp_item_invoke_render(SPItem *item, CairoRenderContext *ctx)
346 {
347 if (SP_IS_ROOT(item)) {
348 TRACE(("root\n"));
349 return sp_root_render(item, ctx);
350 } else if (SP_IS_GROUP(item)) {
351 TRACE(("group\n"));
352 return sp_group_render(item, ctx);
353 } else if (SP_IS_SHAPE(item)) {
354 TRACE(("shape\n"));
355 return sp_shape_render(item, ctx);
356 } else if (SP_IS_USE(item)) {
357 TRACE(("use begin---\n"));
358 sp_use_render(item, ctx);
359 TRACE(("---use end\n"));
360 } else if (SP_IS_SYMBOL(item)) {
361 TRACE(("symbol\n"));
362 return sp_symbol_render(item, ctx);
363 } else if (SP_IS_TEXT(item)) {
364 TRACE(("text\n"));
365 return sp_text_render(item, ctx);
366 } else if (SP_IS_FLOWTEXT(item)) {
367 TRACE(("flowtext\n"));
368 return sp_flowtext_render(item, ctx);
369 } else if (SP_IS_IMAGE(item)) {
370 TRACE(("image\n"));
371 return sp_image_render(item, ctx);
372 }
373 }
375 void
376 CairoRenderer::setStateForItem(CairoRenderContext *ctx, SPItem const *item)
377 {
378 SPStyle const *style = SP_OBJECT_STYLE(item);
379 ctx->setStateForStyle(style);
381 CairoRenderState *state = ctx->getCurrentState();
382 state->clip_path = item->clip_ref->getObject();
383 state->mask = item->mask_ref->getObject();
385 // If parent_has_userspace is true the parent state's transform
386 // has to be used for the mask's/clippath's context.
387 // This is so because we use the image's/(flow)text's transform for positioning
388 // instead of explicitly specifying it and letting the renderer do the
389 // transformation before rendering the item.
390 if (SP_IS_TEXT(item) || SP_IS_FLOWTEXT(item) || SP_IS_IMAGE(item))
391 state->parent_has_userspace = TRUE;
392 TRACE(("set op: %f\n", state->opacity));
393 }
395 void
396 CairoRenderer::renderItem(CairoRenderContext *ctx, SPItem *item)
397 {
398 ctx->pushState();
399 setStateForItem(ctx, item);
401 CairoRenderState *state = ctx->getCurrentState();
402 state->need_layer = ( state->mask || state->clip_path || state->opacity != 1.0 );
404 if (state->need_layer) {
405 state->merge_opacity = FALSE;
406 ctx->pushLayer();
407 }
408 ctx->transform(item->transform);
409 sp_item_invoke_render(item, ctx);
411 if (state->need_layer)
412 ctx->popLayer();
414 ctx->popState();
415 }
417 bool
418 CairoRenderer::setupDocument(CairoRenderContext *ctx, SPDocument *doc)
419 {
420 g_assert( ctx != NULL );
422 if (ctx->_vector_based_target) {
423 // width and height in pt
424 ctx->_width = sp_document_width(doc) * PT_PER_PX;
425 ctx->_height = sp_document_height(doc) * PT_PER_PX;
426 } else {
427 ctx->_width = sp_document_width(doc);
428 ctx->_height = sp_document_height(doc);
429 }
431 NRRect d;
432 bool pageBoundingBox = true;
433 if (pageBoundingBox) {
434 d.x0 = d.y0 = 0;
435 d.x1 = ceil(ctx->_width);
436 d.y1 = ceil(ctx->_height);
437 } else {
438 SPItem* doc_item = SP_ITEM(sp_document_root(doc));
439 sp_item_invoke_bbox(doc_item, &d, sp_item_i2r_affine(doc_item), TRUE);
440 if (ctx->_vector_based_target) {
441 // convert from px to pt
442 d.x0 *= PT_PER_PX;
443 d.x1 *= PT_PER_PX;
444 d.y0 *= PT_PER_PX;
445 d.y1 *= PT_PER_PX;
446 }
447 }
448 TRACE(("%f x %f\n", ctx->_width, ctx->_height));
450 return ctx->setupSurface(d.x1-d.x0, d.y1-d.y0);
451 }
453 #include "macros.h" // SP_PRINT_*
455 void
456 CairoRenderer::applyClipPath(CairoRenderContext *ctx, SPClipPath const *cp)
457 {
458 g_assert( ctx != NULL && ctx->_is_valid );
460 if (cp == NULL)
461 return;
463 CairoRenderContext::CairoRenderMode saved_mode = ctx->getRenderMode();
464 ctx->setRenderMode(CairoRenderContext::RENDER_MODE_CLIP);
466 NRMatrix saved_ctm;
467 if (cp->clipPathUnits == SP_CONTENT_UNITS_OBJECTBOUNDINGBOX) {
468 NRMatrix t;
469 //SP_PRINT_DRECT("clipd", cp->display->bbox);
470 NRRect clip_bbox(cp->display->bbox);
471 nr_matrix_set_scale(&t, clip_bbox.x1 - clip_bbox.x0, clip_bbox.y1 - clip_bbox.y0);
472 t.c[4] = clip_bbox.x0;
473 t.c[5] = clip_bbox.y0;
474 nr_matrix_multiply(&t, &t, &ctx->getCurrentState()->transform);
475 ctx->getTransform(&saved_ctm);
476 ctx->setTransform(&t);
477 }
479 TRACE(("BEGIN clip\n"));
480 SPObject *co = SP_OBJECT(cp);
481 for (SPObject *child = sp_object_first_child(co) ; child != NULL; child = SP_OBJECT_NEXT(child) ) {
482 if (SP_IS_ITEM(child)) {
483 SPItem *item = SP_ITEM(child);
484 renderItem(ctx, item);
485 }
486 }
487 TRACE(("END clip\n"));
489 // do clipping only if this was the first call to applyClipPath
490 if (ctx->getClipMode() == CairoRenderContext::CLIP_MODE_PATH
491 && saved_mode == CairoRenderContext::RENDER_MODE_NORMAL)
492 cairo_clip(ctx->_cr);
494 if (cp->clipPathUnits == SP_CONTENT_UNITS_OBJECTBOUNDINGBOX)
495 ctx->setTransform(&saved_ctm);
497 ctx->setRenderMode(saved_mode);
498 }
500 void
501 CairoRenderer::applyMask(CairoRenderContext *ctx, SPMask const *mask)
502 {
503 g_assert( ctx != NULL && ctx->_is_valid );
505 if (mask == NULL)
506 return;
508 //SP_PRINT_DRECT("maskd", &mask->display->bbox);
509 NRRect mask_bbox(mask->display->bbox);
510 // TODO: should the bbox be transformed if maskUnits != userSpaceOnUse ?
511 if (mask->maskContentUnits == SP_CONTENT_UNITS_OBJECTBOUNDINGBOX) {
512 NRMatrix t;
513 nr_matrix_set_scale(&t, mask_bbox.x1 - mask_bbox.x0, mask_bbox.y1 - mask_bbox.y0);
514 t.c[4] = mask_bbox.x0;
515 t.c[5] = mask_bbox.y0;
516 nr_matrix_multiply(&t, &t, &ctx->getCurrentState()->transform);
517 ctx->setTransform(&t);
518 }
520 // clip mask contents
521 ctx->addClippingRect(mask_bbox.x0, mask_bbox.y0, mask_bbox.x1 - mask_bbox.x0, mask_bbox.y1 - mask_bbox.y0);
523 ctx->pushState();
525 TRACE(("BEGIN mask\n"));
526 SPObject *co = SP_OBJECT(mask);
527 for (SPObject *child = sp_object_first_child(co) ; child != NULL; child = SP_OBJECT_NEXT(child) ) {
528 if (SP_IS_ITEM(child)) {
529 SPItem *item = SP_ITEM(child);
530 renderItem(ctx, item);
531 }
532 }
533 TRACE(("END mask\n"));
535 ctx->popState();
536 }
538 void
539 calculatePreserveAspectRatio(unsigned int aspect_align, unsigned int aspect_clip, double vp_width, double vp_height,
540 double *x, double *y, double *width, double *height)
541 {
542 if (aspect_align == SP_ASPECT_NONE)
543 return;
545 double scalex, scaley, scale;
546 double new_width, new_height;
547 scalex = *width / vp_width;
548 scaley = *height / vp_height;
549 scale = (aspect_clip == SP_ASPECT_MEET) ? MIN(scalex, scaley) : MAX(scalex, scaley);
550 new_width = vp_width * scale;
551 new_height = vp_height * scale;
552 /* Now place viewbox to requested position */
553 switch (aspect_align) {
554 case SP_ASPECT_XMIN_YMIN:
555 break;
556 case SP_ASPECT_XMID_YMIN:
557 *x -= 0.5 * (new_width - *width);
558 break;
559 case SP_ASPECT_XMAX_YMIN:
560 *x -= 1.0 * (new_width - *width);
561 break;
562 case SP_ASPECT_XMIN_YMID:
563 *y -= 0.5 * (new_height - *height);
564 break;
565 case SP_ASPECT_XMID_YMID:
566 *x -= 0.5 * (new_width - *width);
567 *y -= 0.5 * (new_height - *height);
568 break;
569 case SP_ASPECT_XMAX_YMID:
570 *x -= 1.0 * (new_width - *width);
571 *y -= 0.5 * (new_height - *height);
572 break;
573 case SP_ASPECT_XMIN_YMAX:
574 *y -= 1.0 * (new_height - *height);
575 break;
576 case SP_ASPECT_XMID_YMAX:
577 *x -= 0.5 * (new_width - *width);
578 *y -= 1.0 * (new_height - *height);
579 break;
580 case SP_ASPECT_XMAX_YMAX:
581 *x -= 1.0 * (new_width - *width);
582 *y -= 1.0 * (new_height - *height);
583 break;
584 default:
585 break;
586 }
587 *width = new_width;
588 *height = new_height;
589 }
591 #include "clear-n_.h"
593 } /* namespace Internal */
594 } /* namespace Extension */
595 } /* namespace Inkscape */
597 #undef TRACE
599 /* End of GNU GPL code */
601 #endif /* HAVE_CAIRO_PDF */
604 /*
605 Local Variables:
606 mode:c++
607 c-file-style:"stroustrup"
608 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
609 indent-tabs-mode:nil
610 fill-column:99
611 End:
612 */
613 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :