db1590f87157d01848bb288b6a2e92544493ea79
[colloquium.git] / libstorycode / narrative_render_cairo.c
1 /*
2  * narrative_render_cairo.c
3  *
4  * Copyright © 2013-2019 Thomas White <taw@bitwiz.org.uk>
5  *
6  * This file is part of Colloquium.
7  *
8  * Colloquium is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
20  *
21  */
22
23
24 #ifdef HAVE_CONFIG_H
25 #include <config.h>
26 #endif
27
28 #include <cairo.h>
29 #include <cairo-pdf.h>
30 #include <pango/pangocairo.h>
31 #include <assert.h>
32 #include <string.h>
33 #include <stdlib.h>
34 #include <math.h>
35
36 #include "slide.h"
37 #include "narrative.h"
38 #include "stylesheet.h"
39 #include "imagestore.h"
40 #include "slide_render_cairo.h"
41 #include "narrative_render_cairo.h"
42
43 #include "narrative_priv.h"
44
45 const double dummy_h_val = 1024.0;
46
47
48 static double lcalc(struct length l, double pd)
49 {
50         if ( l.unit == LENGTH_UNIT ) {
51                 return l.len;
52         } else {
53                 return l.len * pd;
54         }
55 }
56
57
58 static PangoAlignment to_pangoalignment(enum alignment align)
59 {
60         switch ( align ) {
61                 case ALIGN_LEFT : return PANGO_ALIGN_LEFT;
62                 case ALIGN_RIGHT : return PANGO_ALIGN_RIGHT;
63                 case ALIGN_CENTER : return PANGO_ALIGN_CENTER;
64                 default: return PANGO_ALIGN_LEFT;
65         }
66 }
67
68
69 static void wrap_text(struct narrative_item *item, PangoContext *pc,
70                       Stylesheet *ss, const char *stn, double w,
71                       size_t sel_start, size_t sel_end)
72 {
73         PangoAlignment palignment;
74         PangoRectangle rect;
75         const char *font;
76         PangoFontDescription *fontdesc;
77         enum alignment align;
78         struct length paraspace[4];
79         double wrap_w;
80         PangoAttrList *attrs;
81         PangoAttribute *attr;
82         struct colour fgcol;
83         guint16 r, g, b;
84
85         font = stylesheet_get_font(ss, stn, &fgcol, &align);
86         if ( font == NULL ) return;
87         fontdesc = pango_font_description_from_string(font);
88
89         if ( item->align == ALIGN_INHERIT ) {
90                 /* Use value from stylesheet */
91                 palignment = to_pangoalignment(align);
92         } else {
93                 /* Use item-specific value */
94                 palignment = to_pangoalignment(item->align);
95         }
96
97         if ( stylesheet_get_paraspace(ss, stn, paraspace) ) return;
98         item->space_l = lcalc(paraspace[0], w);
99         item->space_r = lcalc(paraspace[1], w);
100         item->space_t = lcalc(paraspace[2], dummy_h_val);
101         item->space_b = lcalc(paraspace[3], dummy_h_val);
102
103         /* Calculate width of actual text */
104         wrap_w = w - item->space_l - item->space_r;
105
106         /* Set foreground colour */
107         attrs = pango_attr_list_new();
108         r = fgcol.rgba[0] * 65535;
109         g = fgcol.rgba[1] * 65535;
110         b = fgcol.rgba[2] * 65535;
111         attr = pango_attr_foreground_new(r, g, b);
112         pango_attr_list_insert(attrs, attr);
113
114         /* Add attributes for selected text */
115         if ( sel_start > 0 || sel_end > 0 ) {
116                 PangoAttribute *attr;
117                 attr = pango_attr_background_new(42919, 58853, 65535);
118                 attr->start_index = sel_start;
119                 attr->end_index = sel_end;
120                 pango_attr_list_insert(attrs, attr);
121         }
122
123         if ( item->layout == NULL ) {
124                 item->layout = pango_layout_new(pc);
125         }
126         pango_layout_set_width(item->layout, pango_units_from_double(wrap_w));
127         pango_layout_set_text(item->layout, item->text, -1);
128         pango_layout_set_alignment(item->layout, palignment);
129         pango_layout_set_font_description(item->layout, fontdesc);
130         pango_layout_set_attributes(item->layout, attrs);
131
132         /* FIXME: Handle *bold*, _underline_, /italic/ etc. */
133         //pango_layout_set_attributes(item->layout, attrs);
134         //pango_attr_list_unref(attrs);
135
136         pango_layout_get_extents(item->layout, NULL, &rect);
137         item->h = pango_units_to_double(rect.height)+item->space_t+item->space_b;
138 }
139
140
141 /* Render a thumbnail of the slide */
142 static cairo_surface_t *render_thumbnail(Slide *s, Stylesheet *ss, ImageStore *is,
143                                          int w, int h)
144 {
145         cairo_surface_t *surf;
146         cairo_surface_t *full_surf;
147         cairo_t *cr;
148         double logical_w, logical_h;
149         PangoContext *pc;
150         const int rh = 1024; /* "reasonably big" height for slide */
151         int rw;
152         struct slide_pos sel;
153
154         slide_get_logical_size(s, ss, &logical_w, &logical_h);
155         rw = rh*(logical_w/logical_h);
156
157         sel.para = 0;  sel.pos = 0;  sel.trail = 0;
158
159         /* Render at a reasonably big size.  Rendering to a small surface makes
160          * rounding of text positions (due to font hinting) cause significant
161          * differences between the thumbnail and "normal" rendering. */
162         full_surf = cairo_image_surface_create(CAIRO_FORMAT_RGB24, rw, rh);
163         cr = cairo_create(full_surf);
164         cairo_scale(cr, (double)rw/logical_w, (double)rh/logical_h);
165         pc = pango_cairo_create_context(cr);
166         slide_render_cairo(s, cr, is, ss, 0, pango_language_get_default(), pc,
167                            NULL, sel, sel);
168         g_object_unref(pc);
169         cairo_destroy(cr);
170
171         /* Scale down to the actual size of the thumbnail */
172         surf = cairo_image_surface_create(CAIRO_FORMAT_RGB24, w, h);
173         cr = cairo_create(surf);
174         cairo_scale(cr, (double)w/rw, (double)h/rh);
175         cairo_set_source_surface(cr, full_surf, 0.0, 0.0);
176         cairo_paint(cr);
177         cairo_destroy(cr);
178
179         cairo_surface_destroy(full_surf);
180         return surf;
181 }
182
183
184 static void wrap_slide(struct narrative_item *item, Stylesheet *ss, ImageStore *is, int sel_block)
185 {
186         double w, h;
187
188         item->space_l = 0.0;
189         item->space_r = 0.0;
190         item->space_t = 10.0;
191         item->space_b = 10.0;
192
193         slide_get_logical_size(item->slide, ss, &w, &h);
194         item->slide_h = 320.0;  /* Actual height of thumbnail */
195         item->slide_w = rint(item->slide_h*w/h);
196
197         item->h = item->slide_h + item->space_t + item->space_b;
198
199         if ( item->slide_thumbnail != NULL ) {
200                 cairo_surface_destroy(item->slide_thumbnail);
201         }
202         item->slide_thumbnail = render_thumbnail(item->slide, ss, is,
203                                                  item->slide_w, item->slide_h);
204         item->selected = sel_block;
205 }
206
207
208 static size_t pos_trail_to_offset(struct narrative_item *item, int offs, int trail)
209 {
210         glong char_offs;
211         char *ptr;
212
213         if ( item->type == NARRATIVE_ITEM_SLIDE ) {
214                 return offs;
215         }
216
217         char_offs = g_utf8_pointer_to_offset(item->text, item->text+offs);
218         char_offs += trail;
219         ptr = g_utf8_offset_to_pointer(item->text, char_offs);
220         return ptr - item->text;
221 }
222
223
224 static int positions_equal(struct edit_pos a, struct edit_pos b)
225 {
226         if ( a.para != b.para ) return 0;
227         if ( a.pos != b.pos ) return 0;
228         if ( a.trail != b.trail ) return 0;
229         return 1;
230 }
231
232
233 static void sort_positions(struct edit_pos *a, struct edit_pos *b)
234 {
235         if ( a->para > b->para ) {
236                 size_t tpos;
237                 int tpara, ttrail;
238                 tpara = b->para;   tpos = b->pos;  ttrail = b->trail;
239                 b->para = a->para;  b->pos = a->pos;  b->trail = a->trail;
240                 a->para = tpara;    a->pos = tpos;    a->trail = ttrail;
241         }
242
243         if ( (a->para == b->para) && (a->pos > b->pos) )
244         {
245                 size_t tpos = b->pos;
246                 int ttrail = b->trail;
247                 b->pos = a->pos;  b->trail = a->trail;
248                 a->pos = tpos;    a->trail = ttrail;
249         }
250 }
251
252
253 int narrative_wrap_range(Narrative *n, Stylesheet *stylesheet, PangoLanguage *lang,
254                          PangoContext *pc, double w, ImageStore *is,
255                          int min, int max,
256                          struct edit_pos sel_start, struct edit_pos sel_end)
257 {
258         int i;
259         struct length pad[4];
260         int sel_s, sel_e;
261
262         if ( stylesheet_get_padding(stylesheet, "NARRATIVE", pad) ) return 1;
263         n->space_l = lcalc(pad[0], w);
264         n->space_r = lcalc(pad[1], w);
265         n->space_t = lcalc(pad[2], dummy_h_val);
266         n->space_b = lcalc(pad[3], dummy_h_val);
267
268         n->w = w;
269         w -= n->space_l + n->space_r;
270
271         sort_positions(&sel_start, &sel_end);
272         if ( min < 0 ) min = 0;
273         if ( max >= n->n_items ) max = n->n_items-1;
274
275         if ( !positions_equal(sel_start, sel_end) ) {
276                 struct narrative_item *item;
277                 item = &n->items[sel_start.para];
278                 sel_s = pos_trail_to_offset(item, sel_start.pos, sel_start.trail);
279                 item = &n->items[sel_end.para];
280                 sel_e = pos_trail_to_offset(item, sel_end.pos, sel_end.trail);
281         } else {
282                 sel_s = 0;
283                 sel_e = 0;
284         }
285
286         for ( i=min; i<=max; i++ ) {
287
288                 size_t srt, end;
289                 int sel_block = 0;
290
291                 if ( i >= sel_start.para && i <= sel_end.para ) {
292                         if ( i == sel_start.para ) {
293                                 srt = sel_s;
294                         } else {
295                                 srt = 0;
296                         }
297                         if ( i == sel_end.para ) {
298                                 end = sel_e;
299                         } else {
300                                 end = G_MAXUINT;
301                         }
302                         if ( i > sel_start.para && i < sel_end.para ) {
303                                 end = G_MAXUINT;
304                         }
305                         sel_block = 1;
306                 } else {
307                         srt = 0;
308                         end = 0;
309                 }
310
311                 switch ( n->items[i].type ) {
312
313                         case NARRATIVE_ITEM_TEXT :
314                         wrap_text(&n->items[i], pc, stylesheet,
315                                   "NARRATIVE", w, srt, end);
316                         break;
317
318                         case NARRATIVE_ITEM_BP :
319                         wrap_text(&n->items[i], pc, stylesheet,
320                                   "NARRATIVE.BP", w, srt, end);
321                         break;
322
323                         case NARRATIVE_ITEM_PRESTITLE :
324                         wrap_text(&n->items[i], pc, stylesheet,
325                                   "NARRATIVE.PRESTITLE", w, srt, end);
326                         break;
327
328                         case NARRATIVE_ITEM_SLIDE :
329                         wrap_slide(&n->items[i], stylesheet, is, sel_block);
330                         break;
331
332                         default :
333                         break;
334
335                 }
336         }
337
338         return 0;
339 }
340
341
342 double narrative_item_get_height(Narrative *n, int i)
343 {
344         return n->items[i].h;
345 }
346
347
348 double narrative_get_height(Narrative *n)
349 {
350         int i;
351         double total = 0.0;
352         for ( i=0; i<n->n_items; i++ ) {
353                 total += n->items[i].h;
354         }
355         return total + n->space_t + n->space_b;
356 }
357
358
359 static void draw_slide(struct narrative_item *item, cairo_t *cr)
360 {
361         double x, y;
362
363         cairo_save(cr);
364         cairo_translate(cr, item->space_l, item->space_t);
365
366         x = 0.0;  y = 0.0;
367         cairo_user_to_device(cr, &x, &y);
368         x = rint(x);  y = rint(y);
369         cairo_device_to_user(cr, &x, &y);
370
371         if ( item->selected ) {
372                 cairo_rectangle(cr, x-5.0, y-5.0, item->slide_w+10.0, item->slide_h+10.0);
373                 cairo_set_source_rgb(cr, 0.655, 0.899, 1.0);
374                 cairo_fill(cr);
375         }
376
377         cairo_rectangle(cr, x, y, item->slide_w, item->slide_h);
378         cairo_set_source_surface(cr, item->slide_thumbnail, 0.0, 0.0);
379         cairo_fill(cr);
380
381         cairo_rectangle(cr, x+0.5, y+0.5, item->slide_w, item->slide_h);
382         cairo_set_source_rgb(cr, 0.0, 0.0, 0.0);
383         cairo_set_line_width(cr, 1.0);
384         cairo_stroke(cr);
385
386         cairo_restore(cr);
387 }
388
389
390 static void draw_text(struct narrative_item *item, cairo_t *cr)
391 {
392         if ( item->layout == NULL ) return;
393
394         cairo_save(cr);
395         cairo_translate(cr, item->space_l, item->space_t);
396
397         //if ( (hpos + cur_h > min_y) && (hpos < max_y) ) {
398                 cairo_set_source_rgba(cr, 0.0, 0.0, 0.0, 1.0);
399                 pango_cairo_update_layout(cr, item->layout);
400                 pango_cairo_show_layout(cr, item->layout);
401                 cairo_fill(cr);
402         //} /* else paragraph is not visible */
403
404         cairo_restore(cr);
405 }
406
407
408 int narrative_render_item_cairo(Narrative*n, cairo_t *cr, int i)
409 {
410         switch ( n->items[i].type ) {
411
412                 case NARRATIVE_ITEM_TEXT :
413                 case NARRATIVE_ITEM_PRESTITLE :
414                 draw_text(&n->items[i], cr);
415                 break;
416
417                 case NARRATIVE_ITEM_BP :
418                 draw_text(&n->items[i], cr);
419                 break;
420
421                 case NARRATIVE_ITEM_SLIDE :
422                 draw_slide(&n->items[i], cr);
423                 break;
424
425                 default :
426                 return 1;
427
428         }
429
430         return 0;
431 }
432
433
434 /* NB You must first call narrative_wrap() */
435 int narrative_render_cairo(Narrative *n, cairo_t *cr, Stylesheet *stylesheet)
436 {
437         int i, r;
438         enum gradient bg;
439         struct colour bgcol;
440         struct colour bgcol2;
441         cairo_pattern_t *patt = NULL;
442
443         r = stylesheet_get_background(stylesheet, "NARRATIVE", &bg, &bgcol, &bgcol2);
444         if ( r ) return 1;
445
446         /* Overall background */
447         cairo_rectangle(cr, 0.0, 0.0, n->w, narrative_get_height(n));
448         switch ( bg ) {
449
450                 case GRAD_NONE:
451                 cairo_set_source_rgb(cr, bgcol.rgba[0], bgcol.rgba[1], bgcol.rgba[2]);
452                 break;
453
454                 case GRAD_VERT:
455                 patt = cairo_pattern_create_linear(0.0, 0.0, 0.0, narrative_get_height(n));
456                 cairo_pattern_add_color_stop_rgb(patt, 0.0,
457                                                  bgcol.rgba[0], bgcol.rgba[1], bgcol.rgba[2]);
458                 cairo_pattern_add_color_stop_rgb(patt, 1.0,
459                                                  bgcol2.rgba[0], bgcol2.rgba[1], bgcol2.rgba[2]);
460                 cairo_set_source(cr, patt);
461                 break;
462
463                 case GRAD_HORIZ:
464                 patt = cairo_pattern_create_linear(0.0, 0.0, n->w, 0.0);
465                 cairo_pattern_add_color_stop_rgb(patt, 0.0,
466                                                  bgcol.rgba[0], bgcol.rgba[1], bgcol.rgba[2]);
467                 cairo_pattern_add_color_stop_rgb(patt, 1.0,
468                                                  bgcol2.rgba[0], bgcol2.rgba[1], bgcol2.rgba[2]);
469                 cairo_set_source(cr, patt);
470                 break;
471
472         }
473         cairo_fill(cr);
474
475         cairo_save(cr);
476         cairo_translate(cr, n->space_l, n->space_t);
477
478         for ( i=0; i<n->n_items; i++ ) {
479                 narrative_render_item_cairo(n, cr, i);
480                 cairo_translate(cr, 0.0, n->items[i].h);
481         }
482
483         cairo_restore(cr);
484
485         return 0;
486 }