sym-text.c

   1 /*
   2  *      Hic Est Leo -- Text Symbolizer
   3  *
   4  *      (c) 2014 Martin Mares <mj@ucw.cz>
   5  */
   6
   7 #include <ucw/lib.h>
   8 #include <ucw/stkstring.h>
   9
  10 #include <math.h>
  11 #include <stdio.h>
  12 #include <ft2build.h>
  13 #include FT_FREETYPE_H
  14 #include <pango/pangoft2.h>
  15
  16 #include "leo.h"
  17 #include "osm.h"
  18 #include "sym.h"
  19 #include "map.h"
  20 #include "labeller.h"
  21
  22 /*** Fonts ***/
  23
  24 struct text_font {
  25   const char *family;
  26   double size;
  27   osm_val_t weight;
  28   osm_val_t style;
  29   PangoFontDescription *pango_font_desc;
  30   char key[1];
  31 };
  32
  33 #define HASH_NODE struct text_font
  34 #define HASH_PREFIX(x) text_font_##x
  35 #define HASH_KEY_ENDSTRING key
  36 #define HASH_WANT_LOOKUP
  37 #define HASH_LOOKUP_DETECT_NEW
  38 #define HASH_USE_POOL sym_mp
  39 #include <ucw/hashtable.h>
  40
  41 static PangoFontMap *pango_font_map;
  42 static PangoContext *pango_context;
  43
  44 static double pt_to_mm(double pt)
  45 {
  46   return pt / 72 * 25.4;
  47 }
  48
  49 static double mm_to_pt(double mm)
  50 {
  51   return mm / 25.4 * 72;
  52 }
  53
  54 static double pango_to_mm(double pango)
  55 {
  56   return pt_to_mm(pango / PANGO_SCALE);
  57 }
  58
  59 static double mm_to_pango(double mm)
  60 {
  61   return mm_to_pt(mm) * PANGO_SCALE;
  62 }
  63
  64 /*
  65  * Pango tries to do pixel-based optimizations in low resolutions.
  66  * Work around it by scaling everything up.
  67  */
  68 #define FONT_HACK_FACTOR 30
  69
  70 static struct text_font *font_get(struct text_font *req)
  71 {
  72   char *key = stk_printf("%s:%.6g:%u:%u", req->family, req->size, req->weight, req->style);
  73   int is_new = 0;
  74   struct text_font *font = text_font_lookup(key, &is_new);
  75   if (is_new)
  76     {
  77       msg(L_DEBUG, "Loading font %s (size %.6g, weight %s, style %s)", req->family, req->size, osm_val_decode(req->weight), osm_val_decode(req->style));
  78       font->family = mp_strdup(sym_mp, req->family);
  79       font->size = req->size;
  80       font->weight = req->weight;
  81       font->style = req->style;
  82
  83       PangoFontDescription *desc;
  84       desc = pango_font_description_new();
  85       ASSERT(desc);
  86       pango_font_description_set_family(desc, font->family);
  87       if (font->weight != VALUE_NORMAL)
  88         pango_font_description_set_weight(desc, PANGO_WEIGHT_BOLD);
  89       if (font->style != VALUE_NORMAL)
  90         pango_font_description_set_style(desc, PANGO_STYLE_ITALIC);
  91       pango_font_description_set_size(desc, mm_to_pango(font->size));
  92       font->pango_font_desc = desc;
  93
  94 #if 1
  95       // FIXME
  96       PangoFont *pfont = pango_font_map_load_font(pango_font_map, pango_context, desc);
  97       ASSERT(pfont);
  98       PangoFontDescription *d2 = pango_font_describe(pfont);
  99       ASSERT(d2);
 100       msg(L_DEBUG, "Font desc: %s", pango_font_description_to_string(d2));
 101
 102       PangoFontMetrics *fm = pango_font_get_metrics(pfont, NULL);
 103       ASSERT(fm);
 104       msg(L_DEBUG, "Font metrics: asc=%.6g desc=%.6g", pango_to_mm(pango_font_metrics_get_ascent(fm)), pango_to_mm(pango_font_metrics_get_descent(fm)));
 105 #endif
 106     }
 107   return font;
 108 }
 109
 110 static void font_init(void)
 111 {
 112   text_font_init();
 113
 114   pango_font_map = pango_ft2_font_map_new();
 115   ASSERT(pango_font_map);
 116   pango_ft2_font_map_set_resolution((PangoFT2FontMap *) pango_font_map, 72 * FONT_HACK_FACTOR, 72 * FONT_HACK_FACTOR);
 117   pango_context = pango_font_map_create_context(PANGO_FONT_MAP(pango_font_map));
 118   ASSERT(pango_context);
 119 }
 120
 121 static void text_size(struct sym_text *st)
 122 {
 123   PangoLayout *layout = pango_layout_new(pango_context);
 124   pango_layout_set_font_description(layout, st->font->pango_font_desc);
 125   pango_layout_set_text(layout, osm_val_decode(st->text), -1);
 126   pango_layout_context_changed(layout);
 127
 128   PangoRectangle ext;
 129   pango_layout_get_extents(layout, NULL, &ext);
 130   // st->tx = pango_to_mm(ext.x) / FONT_HACK_FACTOR;
 131   // st->ty = pango_to_mm(ext.y) / FONT_HACK_FACTOR;
 132   st->tw = pango_to_mm(ext.width) / FONT_HACK_FACTOR;
 133   st->th = pango_to_mm(pango_layout_get_baseline(layout)) / FONT_HACK_FACTOR;
 134   st->td = pango_to_mm(ext.height) / FONT_HACK_FACTOR - st->th;
 135
 136   g_object_unref(layout);
 137 }
 138
 139 /*** Elimination of duplicate texts ***/
 140
 141 // FIXME: Get rid of globals
 142 #define DUP_TILE_SIZE 10
 143 static int dup_tiles_w, dup_tiles_h;
 144 static struct sym_text **dup_tiles;
 145
 146 static void text_dup_init(void)
 147 {
 148   dup_tiles_w = 1 + page_map_width / DUP_TILE_SIZE;
 149   dup_tiles_h = 1 + page_map_height / DUP_TILE_SIZE;
 150   dup_tiles = xmalloc_zero(sizeof(struct sym_text *) * dup_tiles_w * dup_tiles_h);
 151   msg(L_DEBUG, "Allocated text tiles: %u x %u", dup_tiles_w, dup_tiles_h);
 152 }
 153
 154 static int text_dup_coord(int x, int y)
 155 {
 156   ASSERT(x >= 0 && x < dup_tiles_w && y >= 0 && y < dup_tiles_h);
 157   return x + y * dup_tiles_w;
 158 }
 159
 160 static double text_quad_dist(struct sym_text *a, struct sym_text *b)
 161 {
 162   double dx = a->x - b->x;
 163   double dy = a->y - b->y;
 164   return dx*dx + dy*dy;
 165 }
 166
 167 static bool text_dup_detect(struct sym_text *t, struct style_info *si)
 168 {
 169   // Out-of-frame texts are dropped immediately
 170   double x = t->x - page_offset_x;
 171   double y = t->y - page_offset_y;
 172   if (x < 0 || x >= page_map_width ||
 173       y < 0 || y >= page_map_height)
 174         return 0;
 175
 176   int tile_x = x / DUP_TILE_SIZE;
 177   int tile_y = y / DUP_TILE_SIZE;
 178
 179   double radius = 0;
 180   style_get_number(si, PROP_TEXT_DUP_THRESHOLD, &radius);
 181   if (radius)
 182     {
 183       // A rather simple-minded algorithm, but believed to be efficient enough.
 184       int r_tiles = 1 + radius / DUP_TILE_SIZE;
 185       int x_start = MAX(0, tile_x - r_tiles);
 186       int x_stop = MIN(dup_tiles_w - 1, tile_x + r_tiles);
 187       int y_start = MAX(0, tile_y - r_tiles);
 188       int y_stop = MIN(dup_tiles_h - 1, tile_y + r_tiles);
 189       for (int x = x_start; x <= x_stop; x++)
 190         for (int y = y_start; y <= y_stop; y++)
 191           {
 192             for (struct sym_text *d = dup_tiles[text_dup_coord(x, y)]; d; d = d->next_in_tile)
 193               if (d->text == t->text &&
 194                   text_quad_dist(d, t) <= radius*radius &&
 195                   d->text_color == t->text_color &&
 196                   d->font == t->font)
 197                 {
 198                   t->next_duplicate = d->next_duplicate;
 199                   d->next_duplicate = t;
 200                   return 0;
 201                 }
 202           }
 203     }
 204
 205   int tile_i = text_dup_coord(tile_x, tile_y);
 206   t->next_in_tile = dup_tiles[tile_i];
 207   dup_tiles[tile_i] = t;
 208   return 1;
 209 }
 210
 211 /*** Core of the symbolizer ***/
 212
 213 static void prepare_text_element(struct sym_text *t, struct svg *svg)
 214 {
 215   struct text_font *font = t->font;
 216   svg_push_element(svg, "text");
 217   svg_set_attr_dimen(svg, "x", t->x);
 218   svg_set_attr_dimen(svg, "y", t->y);
 219   svg_set_attr(svg, "font-family", font->family);
 220   svg_set_attr_dimen(svg, "font-size", font->size);
 221   if (font->weight != VALUE_NORMAL)
 222     svg_set_attr(svg, "font-weight", osm_val_decode(font->weight));
 223   if (font->style != VALUE_NORMAL)
 224     svg_set_attr(svg, "font-style", osm_val_decode(font->style));
 225 }
 226
 227 static struct symbol * sym_text_copy(struct symbol *sym)
 228 {
 229   struct sym_text *t = (struct sym_text *) sym;
 230
 231   struct sym_text *new = xmalloc(sizeof(struct sym_text));
 232   *new = *t;    // FIXME: Is this OK? with respect to pointer fields...
 233
 234   return (struct symbol *) new;
 235 }
 236
 237 static void sym_text_draw(struct symbol *sym, struct svg *svg)
 238 {
 239   struct sym_text *t = (struct sym_text *) sym;
 240
 241   if (t->next_duplicate)
 242     {
 243       // If there is a cluster of duplicate texts, average their positions
 244       double sx = 0, sy = 0;
 245       uns nn = 0;
 246       for (struct sym_text *u = t; u; u = u->next_duplicate)
 247         {
 248           sx += u->x;
 249           sy += u->y;
 250           nn++;
 251         }
 252       t->x = sx / nn;
 253       t->y = sy / nn;
 254     }
 255
 256   bool use_group = 0;
 257   bool want_rotate = (fabs(t->rotate) > 1e-5);
 258   if (t->opacity != 1 || want_rotate)
 259     {
 260       use_group = 1;
 261       svg_push_element(svg, "g");
 262       if (t->opacity != 1)
 263         svg_set_attr_float(svg, "opacity", t->opacity);
 264       if (want_rotate)
 265         svg_set_attr_format(svg, "transform", "rotate(%.2f %s %s)", -t->rotate, svg_format_dimen(svg, t->x), svg_format_dimen(svg, t->y));
 266     }
 267
 268   if (t->halo_radius)
 269     {
 270       prepare_text_element(t, svg);
 271       svg_set_attr(svg, "fill", "none");
 272       svg_set_attr_color(svg, "stroke", t->halo_color);
 273       svg_set_attr_dimen(svg, "stroke-width", t->halo_radius);
 274       svg_set_attr(svg, "stroke-linecap", "round");
 275       svg_set_attr(svg, "stroke-linejoin", "round");
 276       if (t->halo_opacity != 1)
 277         svg_set_attr_float(svg, "stroke-opacity", t->halo_opacity);
 278       svg_push_chars(svg)->name = osm_val_decode(t->text);
 279       svg_pop(svg);
 280       svg_pop(svg);
 281     }
 282
 283   prepare_text_element(t, svg);
 284   svg_set_attr_color(svg, "fill", t->text_color);
 285   svg_set_attr(svg, "stroke", "none");
 286   svg_push_chars(svg)->name = osm_val_decode(t->text);
 287   svg_pop(svg);
 288   svg_pop(svg);
 289
 290 #if 0
 291   // Draw bounding box for debugging
 292   svg_push_element(svg, "rect");
 293   svg_set_attr(svg, "fill", "none");
 294   svg_set_attr_color(svg, "stroke", 0x0000ff);
 295   svg_set_attr_dimen(svg, "stroke-width", 0.2);
 296   svg_set_attr_dimen(svg, "x", t->x);
 297   svg_set_attr_dimen(svg, "y", t->y - t->th);
 298   svg_set_attr_dimen(svg, "width", t->tw);
 299   svg_set_attr_dimen(svg, "height", t->th + t->td);
 300   svg_pop(svg);
 301
 302   svg_push_element(svg, "line");
 303   svg_set_attr(svg, "fill", "none");
 304   svg_set_attr_color(svg, "stroke", 0x0000ff);
 305   svg_set_attr_dimen(svg, "stroke-width", 0.2);
 306   svg_set_attr_dimen(svg, "x1", t->x);
 307   svg_set_attr_dimen(svg, "y1", t->y);
 308   svg_set_attr_dimen(svg, "x2", t->x + t->tw);
 309   svg_set_attr_dimen(svg, "y2", t->y);
 310   svg_pop(svg);
 311 #endif
 312
 313   if (use_group)
 314     svg_pop(svg);
 315 }
 316
 317 static osm_val_t get_text(struct osm_object *o, struct style_info *si)
 318 {
 319   struct style_prop *prop = style_get_and_check(si, PROP_TEXT, (1 << PROP_TYPE_STRING) | (1 << PROP_TYPE_IDENT));
 320   if (!prop)
 321     return 0;
 322
 323   if (prop->type == PROP_TYPE_IDENT && prop->val.id == VALUE_AUTO)
 324     {
 325       static const osm_key_t auto_text_keys[] = {
 326         KEY_NAME_CZ,            // FIXME: This should be configurable
 327         KEY_NAME,
 328         KEY_REF,
 329         KEY_OPERATOR,
 330         KEY_BRAND,
 331         KEY_ADDR_HOUSENUMBER,
 332       };
 333       for (uns i=0; i < ARRAY_SIZE(auto_text_keys); i++)
 334         {
 335           osm_val_t val = osm_obj_find_tag(o, auto_text_keys[i]);
 336           if (val)
 337             return val;
 338         }
 339       return 0;
 340     }
 341
 342   return osm_obj_find_tag(o, osm_key_encode(osm_val_decode(prop->val.id)));
 343 }
 344
 345 static void get_text_attrs(struct sym_text *st, struct style_info *si)
 346 {
 347   struct osm_object *o = st->s.o;
 348   if (o->type == OSM_TYPE_WAY && osm_way_cyclic_p((struct osm_way *) o))
 349     st->text_color = 0xc0c0c0;  // FIXME: This is an ugly hack, do we need it?
 350   else
 351     st->text_color = 0xffffff;
 352   style_get_color(si, PROP_TEXT_COLOR, &st->text_color);
 353
 354   struct text_font f = {
 355     .family = "Helvetica",
 356     .size = pt_to_mm(8),
 357   };
 358   osm_val_t fam = style_get_string(si, PROP_FONT_FAMILY);
 359   if (fam)
 360     f.family = osm_val_decode(fam);
 361   style_get_number(si, PROP_FONT_SIZE, &f.size);
 362   f.weight = style_get_ident(si, PROP_FONT_WEIGHT);
 363   if (!f.weight)
 364     f.weight = VALUE_NORMAL;
 365   if (f.weight != VALUE_NORMAL && f.weight != VALUE_BOLD)
 366     {
 367       osm_obj_warn(o, "Unknown font-weight %s", osm_val_decode(f.weight));
 368       f.weight = VALUE_NORMAL;
 369     }
 370   f.style = style_get_ident(si, PROP_FONT_STYLE);
 371   if (!f.style)
 372     f.style = VALUE_NORMAL;
 373   if (f.style != VALUE_NORMAL && f.style != VALUE_ITALIC)
 374     {
 375       osm_obj_warn(o, "Unknown font-style %s", osm_val_decode(f.weight));
 376       f.style = VALUE_NORMAL;
 377     }
 378   st->font = font_get(&f);
 379
 380   st->opacity = 1;
 381   style_get_number(si, PROP_TEXT_OPACITY, &st->opacity);
 382
 383   st->halo_color = st->text_color ^ 0xffffff;
 384   style_get_color(si, PROP_TEXT_HALO_COLOR, &st->halo_color);
 385   st->halo_radius = 0;
 386   style_get_number(si, PROP_TEXT_HALO_RADIUS, &st->halo_radius);
 387   st->halo_opacity = 1;
 388   style_get_number(si, PROP_TEXT_HALO_OPACITY, &st->halo_opacity);
 389
 390   double dx = 0, dy = 0;
 391   style_get_number(si, PROP_TEXT_OFFSET_X, &dx);
 392   style_get_number(si, PROP_TEXT_OFFSET_Y, &dy);
 393   style_get_number(si, PROP_TEXT_OFFSET, &dy);
 394   st->x += dx;
 395   st->y -= dy;
 396 }
 397
 398 static void text_fix_placement(struct sym_text *st)
 399 {
 400   // Fix texts which do not fit on the paper
 401   st->x = MIN(st->x, page_offset_x + page_map_width - st->tw);
 402   st->x = MAX(st->x, page_offset_x);
 403   st->y = MIN(st->y, page_offset_y + page_map_height - st->th);
 404   st->y = MAX(st->y, page_offset_y + st->td);
 405 }
 406
 407 static void sym_text_node(struct osm_object *o, struct style_info *si, osm_val_t text)
 408 {
 409   struct osm_node *n = (struct osm_node *) o;
 410
 411   struct sym_text *st = sym_text_new(o);
 412   st->text = text;
 413   st->x = n->x;
 414   st->y = n->y;
 415
 416   get_text_attrs(st, si);
 417   text_size(st);
 418
 419   osm_val_t ah = style_get_ident(si, PROP_TEXT_ANCHOR_HORIZONTAL);
 420   switch (ah)
 421     {
 422     case VALUE_LEFT:
 423       st->x -= st->tw;
 424       break;
 425     case VALUE_CENTER:
 426       st->x -= st->tw / 2;
 427       break;
 428     case 0:
 429     case VALUE_RIGHT:
 430       break;
 431     default:
 432       osm_obj_warn(o, "Unknown text-anchor-horizontal: %s", osm_val_decode(ah));
 433     }
 434
 435   osm_val_t av = style_get_ident(si, PROP_TEXT_ANCHOR_VERTICAL);
 436   switch (av)
 437     {
 438     case VALUE_ABOVE:           // FIXME: What's the difference between above and top?
 439     case VALUE_TOP:
 440       st->y -= st->td;
 441       break;
 442     case VALUE_CENTER:
 443       st->y -= (st->th + st->td) / 2;
 444       // Fall thru
 445     case 0:
 446     case VALUE_BOTTOM:
 447     case VALUE_BELOW:
 448       st->y += st->th;
 449       break;
 450     default:
 451       osm_obj_warn(o, "Unknown text-anchor-vertical: %s", osm_val_decode(av));
 452     }
 453
 454   text_fix_placement(st);
 455   if (!text_dup_detect(st, si))
 456     {
 457       msg(L_DEBUG, "Text <%s> dropped as duplicate", osm_val_decode(text));
 458       return;
 459     }
 460 }
 461
 462 static void sym_text_center(struct osm_object *o, struct style_info *si, osm_val_t text, double x, double y)
 463 {
 464   struct sym_text *st = sym_text_new(o);
 465   st->text = text;
 466   st->x = x;
 467   st->y = y;
 468
 469   get_text_attrs(st, si);
 470   text_size(st);
 471   st->x -= st->tw / 2;
 472   st->y += st->th - (st->th + st->td) / 2;
 473   text_fix_placement(st);
 474   labeller_add_label(&st->s, o, sym_zindex(o, si, 4.9));
 475 }
 476
 477 static void sym_text_way(struct osm_object *o, struct style_info *si, osm_val_t text)
 478 {
 479   double x, y;
 480   osm_val_t tp = style_get_ident(si, PROP_TEXT_POSITION);
 481
 482   switch (tp)
 483     {
 484     case VALUE_CENTER:
 485       if (osm_obj_center(o, &x, &y))
 486         sym_text_center(o, si, text, x, y);
 487       break;
 488     case VALUE_LINE:
 489       // FIXME
 490     default:
 491       osm_obj_warn(o, "Unknown text-position: %s", osm_val_decode(tp));
 492     }
 493 }
 494
 495 static void sym_text_mpg(struct osm_object *o, struct style_info *si, osm_val_t text)
 496 {
 497   double x, y;
 498   osm_val_t tp = style_get_ident(si, PROP_TEXT_POSITION);
 499
 500   switch (tp)
 501     {
 502     case VALUE_CENTER:
 503       if (osm_obj_center(o, &x, &y))
 504         sym_text_center(o, si, text, x, y);
 505       break;
 506     case VALUE_LINE:
 507       // FIXME
 508     default:
 509       osm_obj_warn(o, "Unknown text-position: %s", osm_val_decode(tp));
 510     }
 511 }
 512
 513 static void sym_text_gen(struct osm_object *o, struct style_info *si, struct svg *svg UNUSED)
 514 {
 515   osm_val_t text = get_text(o, si);
 516   if (!text)
 517     return;
 518
 519   switch (o->type)
 520     {
 521     case OSM_TYPE_NODE:
 522       sym_text_node(o, si, text);
 523       break;
 524     case OSM_TYPE_WAY:
 525       sym_text_way(o, si, text);
 526       break;
 527     case OSM_TYPE_MULTIPOLYGON:
 528       sym_text_mpg(o, si, text);
 529       break;
 530     default:
 531       osm_obj_warn(o, "Text symbolizer does not support this object type");
 532       return;
 533     }
 534 }
 535
 536 static void sym_text_init(void)
 537 {
 538   font_init();
 539   text_dup_init();
 540 }
 541
 542 struct symbolizer symbolizer_text = {
 543   .name = "text",
 544   .draw = sym_text_draw,
 545   .gen = sym_text_gen,
 546   .init = sym_text_init,
 547   .copy = sym_text_copy,
 548 };
 549
 550 struct sym_text *sym_text_new(struct osm_object *o)
 551 {
 552   return sym_new(SYMBOLIZER_TEXT, o, sizeof(struct sym_text));
 553 }
 554
 555 // FIXME: Hack
 556 void scale_text(struct svg *svg, double x, double y, osm_val_t text)
 557 {
 558   struct sym_text *st = sym_text_new(NULL);
 559
 560   struct text_font f = {
 561     .family = "Times",
 562     .weight = VALUE_NORMAL,
 563     .style = VALUE_NORMAL,
 564     .size = pt_to_mm(10),
 565   };
 566
 567   st->text = text;
 568   st->text_color = 0;
 569   st->x = x;
 570   st->y = y;
 571   st->font = font_get(&f);
 572   st->opacity = 1;
 573   st->halo_color = 0xffffff;
 574   st->halo_radius = 0.8;
 575   st->halo_opacity = 1;
 576   text_size(st);
 577   st->x -= st->tw / 2;
 578   sym_text_draw(&st->s, svg);
 579 }