src/hb-ot-shape.cc

   1 /*
   2  * Copyright (C) 2009,2010  Red Hat, Inc.
   3  *
   4  *  This is part of HarfBuzz, a text shaping library.
   5  *
   6  * Permission is hereby granted, without written agreement and without
   7  * license or royalty fees, to use, copy, modify, and distribute this
   8  * software and its documentation for any purpose, provided that the
   9  * above copyright notice and the following two paragraphs appear in
  10  * all copies of this software.
  11  *
  12  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  13  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  14  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  15  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  16  * DAMAGE.
  17  *
  18  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  19  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  20  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  21  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  23  *
  24  * Red Hat Author(s): Behdad Esfahbod
  25  */
  26
  27 #include "hb-ot-shape.h"
  28
  29 #include "hb-buffer-private.hh"
  30
  31 #include "hb-open-type-private.hh"
  32
  33 #include "hb-ot-layout.h"
  34
  35 /* XXX vertical */
  36 hb_tag_t default_features[] = {
  37   HB_TAG('c','a','l','t'),
  38   HB_TAG('c','c','m','p'),
  39   HB_TAG('c','l','i','g'),
  40   HB_TAG('c','s','w','h'),
  41   HB_TAG('c','u','r','s'),
  42   HB_TAG('k','e','r','n'),
  43   HB_TAG('l','i','g','a'),
  44   HB_TAG('l','o','c','l'),
  45   HB_TAG('m','a','r','k'),
  46   HB_TAG('m','k','m','k'),
  47   HB_TAG('r','l','i','g')
  48 };
  49
  50 enum {
  51   MASK_ALWAYS_ON = 1 << 0,
  52   MASK_RTLM      = 1 << 1
  53 };
  54 #define MASK_BITS_USED 2
  55
  56 struct lookup_map {
  57   unsigned int index;
  58   hb_mask_t mask;
  59 };
  60
  61
  62 static void
  63 add_feature (hb_face_t    *face,
  64              hb_tag_t      table_tag,
  65              unsigned int  feature_index,
  66              hb_mask_t     mask,
  67              lookup_map   *lookups,
  68              unsigned int *num_lookups,
  69              unsigned int  room_lookups)
  70 {
  71   unsigned int i = room_lookups - *num_lookups;
  72   lookups += *num_lookups;
  73
  74   unsigned int *lookup_indices = (unsigned int *) lookups;
  75
  76   hb_ot_layout_feature_get_lookup_indexes (face, table_tag, feature_index, 0,
  77                                            &i,
  78                                            lookup_indices);
  79
  80   *num_lookups += i;
  81
  82   while (i--) {
  83     lookups[i].mask = mask;
  84     lookups[i].index = lookup_indices[i];
  85   }
  86 }
  87
  88 static int
  89 cmp_lookups (const void *p1, const void *p2)
  90 {
  91   const lookup_map *a = (const lookup_map *) p1;
  92   const lookup_map *b = (const lookup_map *) p2;
  93
  94   return a->index - b->index;
  95 }
  96
  97
  98 #define MAX_FEATURES 100
  99
 100 struct hb_mask_allocator_t {
 101
 102   struct feature_info_t {
 103     hb_tag_t tag;
 104     unsigned int value;
 105     bool global;
 106
 107     static int
 108     cmp (const void *p1, const void *p2)
 109     {
 110       const feature_info_t *a = (const feature_info_t *) p1;
 111       const feature_info_t *b = (const feature_info_t *) p2;
 112
 113       if (a->tag != b->tag)
 114         return a->tag < b->tag ? -1 : 1;
 115
 116       return p1 < p2 ? -1 : 1;
 117     }
 118   };
 119
 120   struct feature_map_t {
 121     hb_tag_t tag; /* should be first */
 122     unsigned int index;
 123     unsigned int shift;
 124     hb_mask_t mask;
 125
 126     static int
 127     cmp (const void *p1, const void *p2)
 128     {
 129       const feature_map_t *a = (const feature_map_t *) p1;
 130       const feature_map_t *b = (const feature_map_t *) p2;
 131
 132       return a->tag < b->tag ? -1 : a->tag > b->tag ? 1 : 0;
 133     }
 134   };
 135
 136   hb_mask_allocator_t (hb_face_t *face,
 137                        hb_tag_t table_tag,
 138                        unsigned int script_index,
 139                        unsigned int language_index) :
 140     face (face),
 141     table_tag (table_tag),
 142     script_index (script_index),
 143     language_index (language_index),
 144     count (0) {}
 145
 146   void add_feature (hb_tag_t tag,
 147                     unsigned int value,
 148                     bool global)
 149   {
 150     feature_info_t *info = &infos[count++];
 151     info->tag = tag;
 152     info->value = value;
 153     info->global = global;
 154   }
 155
 156   void compile (void)
 157   {
 158     global_mask = 0;
 159     next_bit = MASK_BITS_USED;
 160
 161     if (!count)
 162       return;
 163
 164     qsort (infos, count, sizeof (infos[0]), feature_info_t::cmp);
 165
 166     unsigned int j = 0;
 167     for (unsigned int i = 1; i < count; i++)
 168       if (infos[i].tag != infos[j].tag)
 169         infos[++j] = infos[i];
 170       else {
 171         if (!infos[j].global)
 172           infos[j].value = MAX (infos[j].value, infos[i].value);
 173       }
 174     count = j + 1;
 175
 176     /* Allocate bits now */
 177     j = 0;
 178     for (unsigned int i = 0; i < count; i++) {
 179       const feature_info_t *info = &infos[i];
 180
 181       unsigned int bits_needed;
 182
 183       if (info->global && info->value == 1)
 184         /* Uses the global bit */
 185         bits_needed = 0;
 186       else
 187         bits_needed = _hb_bit_storage (info->value);
 188
 189       if (!info->value || next_bit + bits_needed > 8 * sizeof (hb_mask_t))
 190         continue; /* Feature disabled, or not enough bits. */
 191
 192       unsigned int feature_index;
 193       if (!hb_ot_layout_language_find_feature (face, table_tag, script_index, language_index,
 194                                                info->tag, &feature_index))
 195         continue;
 196
 197       feature_map_t *map = &maps[j++];
 198
 199       map->tag = info->tag;
 200       map->index = feature_index;
 201       if (info->global && info->value == 1) {
 202         /* Uses the global bit */
 203         map->shift = 0;
 204         map->mask = 1;
 205       } else {
 206         map->shift = next_bit;
 207         map->mask = (1 << (next_bit + bits_needed)) - (1 << next_bit);
 208         next_bit += bits_needed;
 209       }
 210
 211       if (info->global && map->mask != 1)
 212         global_mask |= map->mask;
 213     }
 214     count = j;
 215   }
 216
 217   hb_mask_t get_global_mask (void) { return global_mask; }
 218   const feature_map_t *find_feature (hb_tag_t tag) const {
 219     static const feature_map_t off_map = { HB_TAG_NONE, Index::NOT_FOUND_INDEX, 0, 0 };
 220     const feature_map_t *map = (const feature_map_t *) bsearch (&tag, maps, count, sizeof (maps[0]), feature_map_t::cmp);
 221     return map ? map : &off_map;
 222   }
 223
 224
 225   private:
 226   hb_face_t *face;
 227   hb_tag_t table_tag;
 228   unsigned int script_index;
 229   unsigned int language_index;
 230
 231   unsigned int count;
 232   feature_info_t infos[MAX_FEATURES];
 233   feature_map_t maps[MAX_FEATURES];
 234
 235   hb_mask_t global_mask;
 236   unsigned int next_bit;
 237 };
 238
 239 static void
 240 setup_lookups (hb_face_t    *face,
 241                hb_buffer_t  *buffer,
 242                hb_feature_t *features,
 243                unsigned int  num_features,
 244                hb_tag_t      table_tag,
 245                lookup_map   *lookups,
 246                unsigned int *num_lookups,
 247                hb_direction_t original_direction)
 248 {
 249   unsigned int i, j, script_index, language_index, feature_index, room_lookups;
 250
 251   room_lookups = *num_lookups;
 252   *num_lookups = 0;
 253
 254   hb_ot_layout_table_choose_script (face, table_tag,
 255                                     hb_ot_tags_from_script (buffer->script),
 256                                     &script_index);
 257   hb_ot_layout_script_find_language (face, table_tag, script_index,
 258                                      hb_ot_tag_from_language (buffer->language),
 259                                      &language_index);
 260
 261   if (hb_ot_layout_language_get_required_feature_index (face, table_tag, script_index, language_index,
 262                                                         &feature_index))
 263     add_feature (face, table_tag, feature_index, 1, lookups, num_lookups, room_lookups);
 264
 265
 266   hb_mask_allocator_t allocator (face, table_tag, script_index, language_index);
 267
 268   switch (original_direction) {
 269     case HB_DIRECTION_LTR:
 270       allocator.add_feature (HB_TAG ('l','t','r','a'), 1, true);
 271       allocator.add_feature (HB_TAG ('l','t','r','m'), 1, true);
 272       break;
 273     case HB_DIRECTION_RTL:
 274       allocator.add_feature (HB_TAG ('r','t','l','a'), 1, true);
 275       //allocator.add_feature (HB_TAG ('r','t','l','m'), false);
 276       allocator.add_feature (HB_TAG ('r','t','l','m'), 1, true);
 277       break;
 278     case HB_DIRECTION_TTB:
 279     case HB_DIRECTION_BTT:
 280     default:
 281       break;
 282   }
 283
 284   for (i = 0; i < ARRAY_LENGTH (default_features); i++)
 285     allocator.add_feature (default_features[i], 1, true);
 286
 287   /* XXX complex-shaper features go here */
 288
 289   for (unsigned int i = 0; i < num_features; i++) {
 290     const hb_feature_t *feature = &features[i];
 291     allocator.add_feature (feature->tag, feature->value, (feature->start == 0 && feature->end == (unsigned int) -1));
 292   }
 293
 294
 295   /* Compile features */
 296   allocator.compile ();
 297
 298
 299   /* Gather lookup indices for features and set buffer masks at the same time */
 300
 301   const hb_mask_allocator_t::feature_map_t *map;
 302
 303   hb_mask_t global_mask = allocator.get_global_mask ();
 304   if (global_mask)
 305     buffer->set_masks (global_mask, global_mask, 0, (unsigned int) -1);
 306
 307   switch (original_direction) {
 308     case HB_DIRECTION_LTR:
 309       map = allocator.find_feature (HB_TAG ('l','t','r','a'));
 310       add_feature (face, table_tag, map->index, map->mask, lookups, num_lookups, room_lookups);
 311       map = allocator.find_feature (HB_TAG ('l','t','r','m'));
 312       add_feature (face, table_tag, map->index, map->mask, lookups, num_lookups, room_lookups);
 313       break;
 314     case HB_DIRECTION_RTL:
 315       map = allocator.find_feature (HB_TAG ('r','t','l','a'));
 316       add_feature (face, table_tag, map->index, map->mask, lookups, num_lookups, room_lookups);
 317       //map = allocator.find_feature (HB_TAG ('r','t','l','m'));
 318       add_feature (face, table_tag, map->index, MASK_RTLM, lookups, num_lookups, room_lookups);
 319       break;
 320     case HB_DIRECTION_TTB:
 321     case HB_DIRECTION_BTT:
 322     default:
 323       break;
 324   }
 325
 326   for (i = 0; i < ARRAY_LENGTH (default_features); i++)
 327   {
 328     map = allocator.find_feature (default_features[i]);
 329     add_feature (face, table_tag, map->index, map->mask, lookups, num_lookups, room_lookups);
 330   }
 331
 332   for (i = 0; i < num_features; i++)
 333   {
 334     hb_feature_t *feature = &features[i];
 335     map = allocator.find_feature (feature->tag);
 336     add_feature (face, table_tag, map->index, map->mask, lookups, num_lookups, room_lookups);
 337     if (!(feature->start == 0 && feature->end == (unsigned int)-1))
 338       buffer->set_masks (features[i].value << map->shift, map->mask, feature->start, feature->end);
 339   }
 340
 341
 342   /* Sort lookups and merge duplicates */
 343
 344   qsort (lookups, *num_lookups, sizeof (lookups[0]), cmp_lookups);
 345
 346   if (*num_lookups)
 347   {
 348     for (i = 1, j = 0; i < *num_lookups; i++)
 349       if (lookups[i].index != lookups[j].index)
 350         lookups[++j] = lookups[i];
 351       else
 352         lookups[j].mask |= lookups[i].mask;
 353     j++;
 354     *num_lookups = j;
 355   }
 356 }
 357
 358
 359 static hb_bool_t
 360 hb_ot_substitute_complex (hb_font_t    *font HB_UNUSED,
 361                           hb_face_t    *face,
 362                           hb_buffer_t  *buffer,
 363                           hb_feature_t *features,
 364                           unsigned int  num_features,
 365                           hb_direction_t original_direction)
 366 {
 367   lookup_map lookups[1000]; /* FIXME */
 368   unsigned int num_lookups = ARRAY_LENGTH (lookups);
 369   unsigned int i;
 370
 371   if (!hb_ot_layout_has_substitution (face))
 372     return FALSE;
 373
 374   setup_lookups (face, buffer, features, num_features,
 375                  HB_OT_TAG_GSUB,
 376                  lookups, &num_lookups,
 377                  original_direction);
 378
 379   for (i = 0; i < num_lookups; i++)
 380     hb_ot_layout_substitute_lookup (face, buffer, lookups[i].index, lookups[i].mask);
 381
 382   return TRUE;
 383 }
 384
 385 static hb_bool_t
 386 hb_ot_position_complex (hb_font_t    *font,
 387                         hb_face_t    *face,
 388                         hb_buffer_t  *buffer,
 389                         hb_feature_t *features,
 390                         unsigned int  num_features,
 391                         hb_direction_t original_direction)
 392 {
 393   lookup_map lookups[1000];
 394   unsigned int num_lookups = ARRAY_LENGTH (lookups);
 395   unsigned int i;
 396
 397   if (!hb_ot_layout_has_positioning (face))
 398     return FALSE;
 399
 400   setup_lookups (face, buffer, features, num_features,
 401                  HB_OT_TAG_GPOS,
 402                  lookups, &num_lookups,
 403                  original_direction);
 404
 405   for (i = 0; i < num_lookups; i++)
 406     hb_ot_layout_position_lookup (font, face, buffer, lookups[i].index, lookups[i].mask);
 407
 408   hb_ot_layout_position_finish (font, face, buffer);
 409
 410   return TRUE;
 411 }
 412
 413
 414 /* Main shaper */
 415
 416 /* Prepare */
 417
 418 static inline hb_bool_t
 419 is_variation_selector (hb_codepoint_t unicode)
 420 {
 421   return unlikely ((unicode >=  0x180B && unicode <=  0x180D) || /* MONGOLIAN FREE VARIATION SELECTOR ONE..THREE */
 422                    (unicode >=  0xFE00 && unicode <=  0xFE0F) || /* VARIATION SELECTOR-1..16 */
 423                    (unicode >= 0xE0100 && unicode <= 0xE01EF));  /* VARIATION SELECTOR-17..256 */
 424 }
 425
 426 static void
 427 hb_form_clusters (hb_buffer_t *buffer)
 428 {
 429   unsigned int count = buffer->len;
 430   for (unsigned int i = 1; i < count; i++)
 431     if (buffer->unicode->v.get_general_category (buffer->info[i].codepoint) == HB_CATEGORY_NON_SPACING_MARK)
 432       buffer->info[i].cluster = buffer->info[i - 1].cluster;
 433 }
 434
 435 static hb_direction_t
 436 hb_ensure_native_direction (hb_buffer_t *buffer)
 437 {
 438   hb_direction_t original_direction = buffer->direction;
 439
 440   /* TODO vertical */
 441   if (HB_DIRECTION_IS_HORIZONTAL (original_direction) &&
 442       original_direction != _hb_script_get_horizontal_direction (buffer->script))
 443   {
 444     hb_buffer_reverse_clusters (buffer);
 445     buffer->direction = HB_DIRECTION_REVERSE (buffer->direction);
 446   }
 447
 448   return original_direction;
 449 }
 450
 451
 452 /* Substitute */
 453
 454 static void
 455 hb_mirror_chars (hb_buffer_t *buffer)
 456 {
 457   hb_unicode_get_mirroring_func_t get_mirroring = buffer->unicode->v.get_mirroring;
 458
 459   if (HB_DIRECTION_IS_FORWARD (buffer->direction))
 460     return;
 461
 462   unsigned int count = buffer->len;
 463   for (unsigned int i = 0; i < count; i++) {
 464     hb_codepoint_t codepoint = get_mirroring (buffer->info[i].codepoint);
 465     if (likely (codepoint == buffer->info[i].codepoint))
 466       buffer->info[i].mask |= MASK_RTLM;
 467     else
 468       buffer->info[i].codepoint = codepoint;
 469   }
 470 }
 471
 472 static void
 473 hb_map_glyphs (hb_font_t    *font,
 474                hb_face_t    *face,
 475                hb_buffer_t  *buffer)
 476 {
 477   if (unlikely (!buffer->len))
 478     return;
 479
 480   unsigned int count = buffer->len - 1;
 481   for (unsigned int i = 0; i < count; i++) {
 482     if (unlikely (is_variation_selector (buffer->info[i + 1].codepoint))) {
 483       buffer->info[i].codepoint = hb_font_get_glyph (font, face, buffer->info[i].codepoint, buffer->info[i + 1].codepoint);
 484       i++;
 485     } else {
 486       buffer->info[i].codepoint = hb_font_get_glyph (font, face, buffer->info[i].codepoint, 0);
 487     }
 488   }
 489   buffer->info[count].codepoint = hb_font_get_glyph (font, face, buffer->info[count].codepoint, 0);
 490 }
 491
 492 static void
 493 hb_substitute_default (hb_font_t    *font,
 494                        hb_face_t    *face,
 495                        hb_buffer_t  *buffer,
 496                        hb_feature_t *features HB_UNUSED,
 497                        unsigned int  num_features HB_UNUSED)
 498 {
 499   hb_map_glyphs (font, face, buffer);
 500 }
 501
 502 static void
 503 hb_substitute_complex_fallback (hb_font_t    *font HB_UNUSED,
 504                                 hb_face_t    *face HB_UNUSED,
 505                                 hb_buffer_t  *buffer HB_UNUSED,
 506                                 hb_feature_t *features HB_UNUSED,
 507                                 unsigned int  num_features HB_UNUSED)
 508 {
 509   /* TODO Arabic */
 510 }
 511
 512
 513 /* Position */
 514
 515 static void
 516 hb_position_default (hb_font_t    *font,
 517                      hb_face_t    *face,
 518                      hb_buffer_t  *buffer,
 519                      hb_feature_t *features HB_UNUSED,
 520                      unsigned int  num_features HB_UNUSED)
 521 {
 522   hb_buffer_clear_positions (buffer);
 523
 524   unsigned int count = buffer->len;
 525   for (unsigned int i = 0; i < count; i++) {
 526     hb_glyph_metrics_t metrics;
 527     hb_font_get_glyph_metrics (font, face, buffer->info[i].codepoint, &metrics);
 528     buffer->pos[i].x_advance = metrics.x_advance;
 529     buffer->pos[i].y_advance = metrics.y_advance;
 530   }
 531 }
 532
 533 static void
 534 hb_position_complex_fallback (hb_font_t    *font HB_UNUSED,
 535                               hb_face_t    *face HB_UNUSED,
 536                               hb_buffer_t  *buffer HB_UNUSED,
 537                               hb_feature_t *features HB_UNUSED,
 538                               unsigned int  num_features HB_UNUSED)
 539 {
 540   /* TODO Mark pos */
 541 }
 542
 543 static void
 544 hb_truetype_kern (hb_font_t    *font,
 545                   hb_face_t    *face,
 546                   hb_buffer_t  *buffer,
 547                   hb_feature_t *features HB_UNUSED,
 548                   unsigned int  num_features HB_UNUSED)
 549 {
 550   /* TODO Check for kern=0 */
 551   unsigned int count = buffer->len;
 552   for (unsigned int i = 1; i < count; i++) {
 553     hb_position_t kern, kern1, kern2;
 554     kern = hb_font_get_kerning (font, face, buffer->info[i - 1].codepoint, buffer->info[i].codepoint);
 555     kern1 = kern >> 1;
 556     kern2 = kern - kern1;
 557     buffer->pos[i - 1].x_advance += kern1;
 558     buffer->pos[i].x_advance += kern2;
 559     buffer->pos[i].x_offset += kern2;
 560   }
 561 }
 562
 563 static void
 564 hb_position_complex_fallback_visual (hb_font_t    *font,
 565                                      hb_face_t    *face,
 566                                      hb_buffer_t  *buffer,
 567                                      hb_feature_t *features,
 568                                      unsigned int  num_features)
 569 {
 570   hb_truetype_kern (font, face, buffer, features, num_features);
 571 }
 572
 573
 574 /* Do it! */
 575
 576 void
 577 hb_ot_shape (hb_font_t    *font,
 578              hb_face_t    *face,
 579              hb_buffer_t  *buffer,
 580              hb_feature_t *features,
 581              unsigned int  num_features)
 582 {
 583   hb_direction_t original_direction;
 584   hb_bool_t substitute_fallback, position_fallback;
 585
 586   hb_form_clusters (buffer);
 587
 588   /* SUBSTITUTE */
 589
 590   buffer->clear_masks ();
 591
 592   /* Mirroring needs to see the original direction */
 593   hb_mirror_chars (buffer);
 594
 595   original_direction = hb_ensure_native_direction (buffer);
 596
 597   hb_substitute_default (font, face, buffer, features, num_features);
 598
 599   substitute_fallback = !hb_ot_substitute_complex (font, face, buffer, features, num_features, original_direction);
 600
 601   if (substitute_fallback)
 602     hb_substitute_complex_fallback (font, face, buffer, features, num_features);
 603
 604
 605   /* POSITION */
 606
 607   buffer->clear_masks ();
 608
 609   hb_position_default (font, face, buffer, features, num_features);
 610
 611   position_fallback = !hb_ot_position_complex (font, face, buffer, features, num_features, original_direction);
 612
 613   if (position_fallback)
 614     hb_position_complex_fallback (font, face, buffer, features, num_features);
 615
 616   if (HB_DIRECTION_IS_BACKWARD (buffer->direction))
 617     hb_buffer_reverse (buffer);
 618
 619   if (position_fallback)
 620     hb_position_complex_fallback_visual (font, face, buffer, features, num_features);
 621
 622   buffer->direction = original_direction;
 623 }