src/cairo-type3-glyph-surface.c

   1 /* -*- Mode: c; c-basic-offset: 4; indent-tabs-mode: t; tab-width: 8; -*- */
   2 /* cairo - a vector graphics library with display and print output
   3  *
   4  * Copyright © 2008 Adrian Johnson
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it either under the terms of the GNU Lesser General Public
   8  * License version 2.1 as published by the Free Software Foundation
   9  * (the "LGPL") or, at your option, under the terms of the Mozilla
  10  * Public License Version 1.1 (the "MPL"). If you do not alter this
  11  * notice, a recipient may use your version of this file under either
  12  * the MPL or the LGPL.
  13  *
  14  * You should have received a copy of the LGPL along with this library
  15  * in the file COPYING-LGPL-2.1; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA
  17  * You should have received a copy of the MPL along with this library
  18  * in the file COPYING-MPL-1.1
  19  *
  20  * The contents of this file are subject to the Mozilla Public License
  21  * Version 1.1 (the "License"); you may not use this file except in
  22  * compliance with the License. You may obtain a copy of the License at
  23  * http://www.mozilla.org/MPL/
  24  *
  25  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY
  26  * OF ANY KIND, either express or implied. See the LGPL or the MPL for
  27  * the specific language governing rights and limitations.
  28  *
  29  * The Original Code is the cairo graphics library.
  30  *
  31  * The Initial Developer of the Original Code is Adrian Johnson.
  32  *
  33  * Contributor(s):
  34  *      Adrian Johnson <ajohnson@redneon.com>
  35  */
  36
  37 #include "cairoint.h"
  38
  39 #if CAIRO_HAS_FONT_SUBSET
  40
  41 #include "cairo-type3-glyph-surface-private.h"
  42 #include "cairo-output-stream-private.h"
  43 #include "cairo-recording-surface-private.h"
  44 #include "cairo-analysis-surface-private.h"
  45 #include "cairo-default-context-private.h"
  46 #include "cairo-error-private.h"
  47 #include "cairo-image-surface-private.h"
  48 #include "cairo-surface-clipper-private.h"
  49
  50 static const cairo_surface_backend_t cairo_type3_glyph_surface_backend;
  51
  52 static cairo_status_t
  53 _cairo_type3_glyph_surface_clipper_intersect_clip_path (cairo_surface_clipper_t *clipper,
  54                                                         cairo_path_fixed_t *path,
  55                                                         cairo_fill_rule_t   fill_rule,
  56                                                         double              tolerance,
  57                                                         cairo_antialias_t   antialias)
  58 {
  59     cairo_type3_glyph_surface_t *surface = cairo_container_of (clipper,
  60                                                                cairo_type3_glyph_surface_t,
  61                                                                clipper);
  62
  63     if (path == NULL) {
  64         _cairo_output_stream_printf (surface->stream, "Q q\n");
  65         return CAIRO_STATUS_SUCCESS;
  66     }
  67
  68     return _cairo_pdf_operators_clip (&surface->pdf_operators,
  69                                       path,
  70                                       fill_rule);
  71 }
  72
  73 cairo_surface_t *
  74 _cairo_type3_glyph_surface_create (cairo_scaled_font_t                   *scaled_font,
  75                                    cairo_output_stream_t                 *stream,
  76                                    cairo_type3_glyph_surface_emit_image_t emit_image,
  77                                    cairo_scaled_font_subsets_t           *font_subsets)
  78 {
  79     cairo_type3_glyph_surface_t *surface;
  80     cairo_matrix_t invert_y_axis;
  81
  82     if (unlikely (stream != NULL && stream->status))
  83         return _cairo_surface_create_in_error (stream->status);
  84
  85     surface = malloc (sizeof (cairo_type3_glyph_surface_t));
  86     if (unlikely (surface == NULL))
  87         return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_NO_MEMORY));
  88
  89     _cairo_surface_init (&surface->base,
  90                          &cairo_type3_glyph_surface_backend,
  91                          NULL, /* device */
  92                          CAIRO_CONTENT_COLOR_ALPHA);
  93
  94     surface->scaled_font = scaled_font;
  95     surface->stream = stream;
  96     surface->emit_image = emit_image;
  97
  98     /* Setup the transform from the user-font device space to Type 3
  99      * font space. The Type 3 font space is defined by the FontMatrix
 100      * entry in the Type 3 dictionary. In the PDF backend this is an
 101      * identity matrix. */
 102     surface->cairo_to_pdf = scaled_font->scale_inverse;
 103     cairo_matrix_init_scale (&invert_y_axis, 1, -1);
 104     cairo_matrix_multiply (&surface->cairo_to_pdf, &surface->cairo_to_pdf, &invert_y_axis);
 105
 106     _cairo_pdf_operators_init (&surface->pdf_operators,
 107                                surface->stream,
 108                                &surface->cairo_to_pdf,
 109                                font_subsets);
 110
 111     _cairo_surface_clipper_init (&surface->clipper,
 112                                  _cairo_type3_glyph_surface_clipper_intersect_clip_path);
 113
 114     return &surface->base;
 115 }
 116
 117 static cairo_status_t
 118 _cairo_type3_glyph_surface_emit_image (cairo_type3_glyph_surface_t *surface,
 119                                        cairo_image_surface_t       *image,
 120                                        cairo_matrix_t              *image_matrix)
 121 {
 122     cairo_status_t status;
 123
 124     /* The only image type supported by Type 3 fonts are 1-bit masks */
 125     image = _cairo_image_surface_coerce_to_format (image, CAIRO_FORMAT_A1);
 126     status = image->base.status;
 127     if (unlikely (status))
 128         return status;
 129
 130     _cairo_output_stream_printf (surface->stream,
 131                                  "q %f %f %f %f %f %f cm\n",
 132                                  image_matrix->xx,
 133                                  image_matrix->xy,
 134                                  image_matrix->yx,
 135                                  image_matrix->yy,
 136                                  image_matrix->x0,
 137                                  image_matrix->y0);
 138
 139     status = surface->emit_image (image, surface->stream);
 140     cairo_surface_destroy (&image->base);
 141
 142     _cairo_output_stream_printf (surface->stream,
 143                                  "Q\n");
 144
 145     return status;
 146 }
 147
 148 static cairo_status_t
 149 _cairo_type3_glyph_surface_emit_image_pattern (cairo_type3_glyph_surface_t *surface,
 150                                                cairo_image_surface_t       *image,
 151                                                const cairo_matrix_t              *pattern_matrix)
 152 {
 153     cairo_matrix_t mat, upside_down;
 154     cairo_status_t status;
 155
 156     if (image->width == 0 || image->height == 0)
 157         return CAIRO_STATUS_SUCCESS;
 158
 159     mat = *pattern_matrix;
 160
 161     /* Get the pattern space to user space matrix  */
 162     status = cairo_matrix_invert (&mat);
 163
 164     /* cairo_pattern_set_matrix ensures the matrix is invertible */
 165     assert (status == CAIRO_STATUS_SUCCESS);
 166
 167     /* Make this a pattern space to Type 3 font space matrix */
 168     cairo_matrix_multiply (&mat, &mat, &surface->cairo_to_pdf);
 169
 170     /* PDF images are in a 1 unit by 1 unit image space. Turn the 1 by
 171      * 1 image upside down to convert to flip the Y-axis going from
 172      * cairo to PDF. Then scale the image up to the required size. */
 173     cairo_matrix_scale (&mat, image->width, image->height);
 174     cairo_matrix_init (&upside_down, 1, 0, 0, -1, 0, 1);
 175     cairo_matrix_multiply (&mat, &upside_down, &mat);
 176
 177     return _cairo_type3_glyph_surface_emit_image (surface, image, &mat);
 178 }
 179
 180 static cairo_status_t
 181 _cairo_type3_glyph_surface_finish (void *abstract_surface)
 182 {
 183     cairo_type3_glyph_surface_t *surface = abstract_surface;
 184
 185     return _cairo_pdf_operators_fini (&surface->pdf_operators);
 186 }
 187
 188 static cairo_int_status_t
 189 _cairo_type3_glyph_surface_paint (void                  *abstract_surface,
 190                                   cairo_operator_t       op,
 191                                   const cairo_pattern_t *source,
 192                                   const cairo_clip_t    *clip)
 193 {
 194     cairo_type3_glyph_surface_t *surface = abstract_surface;
 195     const cairo_surface_pattern_t *pattern;
 196     cairo_image_surface_t *image;
 197     void *image_extra;
 198     cairo_status_t status;
 199
 200     if (source->type != CAIRO_PATTERN_TYPE_SURFACE)
 201         return CAIRO_INT_STATUS_IMAGE_FALLBACK;
 202
 203     status = _cairo_surface_clipper_set_clip (&surface->clipper, clip);
 204     if (unlikely (status))
 205         return status;
 206
 207     pattern = (const cairo_surface_pattern_t *) source;
 208     status = _cairo_surface_acquire_source_image (pattern->surface,
 209                                                   &image, &image_extra);
 210     if (unlikely (status))
 211         goto fail;
 212
 213     status = _cairo_type3_glyph_surface_emit_image_pattern (surface,
 214                                                             image,
 215                                                             &pattern->base.matrix);
 216
 217 fail:
 218     _cairo_surface_release_source_image (pattern->surface, image, image_extra);
 219
 220     return status;
 221 }
 222
 223 static cairo_int_status_t
 224 _cairo_type3_glyph_surface_mask (void                   *abstract_surface,
 225                                  cairo_operator_t        op,
 226                                  const cairo_pattern_t  *source,
 227                                  const cairo_pattern_t  *mask,
 228                                  const cairo_clip_t     *clip)
 229 {
 230     return _cairo_type3_glyph_surface_paint (abstract_surface,
 231                                              op, mask,
 232                                              clip);
 233 }
 234
 235 static cairo_int_status_t
 236 _cairo_type3_glyph_surface_stroke (void                 *abstract_surface,
 237                                    cairo_operator_t      op,
 238                                    const cairo_pattern_t *source,
 239                                    const cairo_path_fixed_t     *path,
 240                                    const cairo_stroke_style_t   *style,
 241                                    const cairo_matrix_t *ctm,
 242                                    const cairo_matrix_t *ctm_inverse,
 243                                    double                tolerance,
 244                                    cairo_antialias_t     antialias,
 245                                    const cairo_clip_t   *clip)
 246 {
 247     cairo_type3_glyph_surface_t *surface = abstract_surface;
 248     cairo_int_status_t status;
 249
 250     status = _cairo_surface_clipper_set_clip (&surface->clipper, clip);
 251     if (unlikely (status))
 252         return status;
 253
 254     return _cairo_pdf_operators_stroke (&surface->pdf_operators,
 255                                         path,
 256                                         style,
 257                                         ctm,
 258                                         ctm_inverse);
 259 }
 260
 261 static cairo_int_status_t
 262 _cairo_type3_glyph_surface_fill (void                   *abstract_surface,
 263                                  cairo_operator_t        op,
 264                                  const cairo_pattern_t  *source,
 265                                  const cairo_path_fixed_t       *path,
 266                                  cairo_fill_rule_t       fill_rule,
 267                                  double                  tolerance,
 268                                  cairo_antialias_t       antialias,
 269                                  const cairo_clip_t             *clip)
 270 {
 271     cairo_type3_glyph_surface_t *surface = abstract_surface;
 272     cairo_int_status_t status;
 273
 274     status = _cairo_surface_clipper_set_clip (&surface->clipper, clip);
 275     if (unlikely (status))
 276         return status;
 277
 278     return _cairo_pdf_operators_fill (&surface->pdf_operators,
 279                                       path,
 280                                       fill_rule);
 281 }
 282
 283 static cairo_int_status_t
 284 _cairo_type3_glyph_surface_show_glyphs (void                 *abstract_surface,
 285                                         cairo_operator_t      op,
 286                                         const cairo_pattern_t *source,
 287                                         cairo_glyph_t        *glyphs,
 288                                         int                   num_glyphs,
 289                                         cairo_scaled_font_t  *scaled_font,
 290                                         const cairo_clip_t     *clip)
 291 {
 292     cairo_type3_glyph_surface_t *surface = abstract_surface;
 293     cairo_int_status_t status;
 294     cairo_scaled_font_t *font;
 295     cairo_matrix_t new_ctm, invert_y_axis;
 296
 297     status = _cairo_surface_clipper_set_clip (&surface->clipper, clip);
 298     if (unlikely (status))
 299         return status;
 300
 301     cairo_matrix_init_scale (&invert_y_axis, 1, -1);
 302     cairo_matrix_multiply (&new_ctm, &invert_y_axis, &scaled_font->ctm);
 303     cairo_matrix_multiply (&new_ctm, &surface->cairo_to_pdf, &new_ctm);
 304     font = cairo_scaled_font_create (scaled_font->font_face,
 305                                      &scaled_font->font_matrix,
 306                                      &new_ctm,
 307                                      &scaled_font->options);
 308     if (unlikely (font->status))
 309         return font->status;
 310
 311     status = _cairo_pdf_operators_show_text_glyphs (&surface->pdf_operators,
 312                                                     NULL, 0,
 313                                                     glyphs, num_glyphs,
 314                                                     NULL, 0,
 315                                                     FALSE,
 316                                                     font);
 317
 318     cairo_scaled_font_destroy (font);
 319
 320     return status;
 321 }
 322
 323 static const cairo_surface_backend_t cairo_type3_glyph_surface_backend = {
 324     CAIRO_INTERNAL_SURFACE_TYPE_TYPE3_GLYPH,
 325     _cairo_type3_glyph_surface_finish,
 326
 327     _cairo_default_context_create, /* XXX usable through a context? */
 328
 329     NULL, /* create similar */
 330     NULL, /* create similar image */
 331     NULL, /* map to image */
 332     NULL, /* unmap image */
 333
 334     NULL, /* source */
 335     NULL, /* acquire_source_image */
 336     NULL, /* release_source_image */
 337     NULL, /* snapshot */
 338
 339     NULL, /* copy page */
 340     NULL, /* show page */
 341
 342     NULL, /* _cairo_type3_glyph_surface_get_extents */
 343     NULL, /* _cairo_type3_glyph_surface_get_font_options */
 344
 345     NULL, /* flush */
 346     NULL, /* mark_dirty_rectangle */
 347
 348     _cairo_type3_glyph_surface_paint,
 349     _cairo_type3_glyph_surface_mask,
 350     _cairo_type3_glyph_surface_stroke,
 351     _cairo_type3_glyph_surface_fill,
 352     NULL, /* fill-stroke */
 353     _cairo_type3_glyph_surface_show_glyphs,
 354 };
 355
 356 static void
 357 _cairo_type3_glyph_surface_set_stream (cairo_type3_glyph_surface_t *surface,
 358                                        cairo_output_stream_t       *stream)
 359 {
 360     surface->stream = stream;
 361     _cairo_pdf_operators_set_stream (&surface->pdf_operators, stream);
 362 }
 363
 364 static cairo_status_t
 365 _cairo_type3_glyph_surface_emit_fallback_image (cairo_type3_glyph_surface_t *surface,
 366                                                 unsigned long                glyph_index)
 367 {
 368     cairo_scaled_glyph_t *scaled_glyph;
 369     cairo_status_t status;
 370     cairo_image_surface_t *image;
 371     cairo_matrix_t mat;
 372     double x, y;
 373
 374     status = _cairo_scaled_glyph_lookup (surface->scaled_font,
 375                                          glyph_index,
 376                                          CAIRO_SCALED_GLYPH_INFO_METRICS |
 377                                          CAIRO_SCALED_GLYPH_INFO_SURFACE,
 378                                          &scaled_glyph);
 379     if (unlikely (status))
 380         return status;
 381
 382     image = scaled_glyph->surface;
 383     if (image->width == 0 || image->height == 0)
 384         return CAIRO_STATUS_SUCCESS;
 385
 386     x = _cairo_fixed_to_double (scaled_glyph->bbox.p1.x);
 387     y = _cairo_fixed_to_double (scaled_glyph->bbox.p2.y);
 388     mat.xx = image->width;
 389     mat.xy = 0;
 390     mat.yx = 0;
 391     mat.yy = image->height;
 392     mat.x0 = x;
 393     mat.y0 = y;
 394     cairo_matrix_multiply (&mat, &mat, &surface->scaled_font->scale_inverse);
 395     mat.y0 *= -1;
 396
 397     return _cairo_type3_glyph_surface_emit_image (surface, image, &mat);
 398 }
 399
 400 void
 401 _cairo_type3_glyph_surface_set_font_subsets_callback (void                                  *abstract_surface,
 402                                                       cairo_pdf_operators_use_font_subset_t  use_font_subset,
 403                                                       void                                  *closure)
 404 {
 405     cairo_type3_glyph_surface_t *surface = abstract_surface;
 406
 407     if (unlikely (surface->base.status))
 408         return;
 409
 410     _cairo_pdf_operators_set_font_subsets_callback (&surface->pdf_operators,
 411                                                     use_font_subset,
 412                                                     closure);
 413 }
 414
 415 cairo_status_t
 416 _cairo_type3_glyph_surface_analyze_glyph (void               *abstract_surface,
 417                                           unsigned long       glyph_index)
 418 {
 419     cairo_type3_glyph_surface_t *surface = abstract_surface;
 420     cairo_scaled_glyph_t *scaled_glyph;
 421     cairo_int_status_t status, status2;
 422     cairo_output_stream_t *null_stream;
 423
 424     if (unlikely (surface->base.status))
 425         return surface->base.status;
 426
 427     null_stream = _cairo_null_stream_create ();
 428     if (unlikely (null_stream->status))
 429         return null_stream->status;
 430
 431     _cairo_type3_glyph_surface_set_stream (surface, null_stream);
 432
 433     _cairo_scaled_font_freeze_cache (surface->scaled_font);
 434     status = _cairo_scaled_glyph_lookup (surface->scaled_font,
 435                                          glyph_index,
 436                                          CAIRO_SCALED_GLYPH_INFO_RECORDING_SURFACE,
 437                                          &scaled_glyph);
 438
 439     if (_cairo_int_status_is_error (status))
 440         goto cleanup;
 441
 442     if (status == CAIRO_INT_STATUS_UNSUPPORTED) {
 443         status = CAIRO_INT_STATUS_SUCCESS;
 444         goto cleanup;
 445     }
 446
 447     status = _cairo_recording_surface_replay (scaled_glyph->recording_surface,
 448                                               &surface->base);
 449     if (unlikely (status))
 450         goto cleanup;
 451
 452     status = _cairo_pdf_operators_flush (&surface->pdf_operators);
 453     if (status == CAIRO_INT_STATUS_IMAGE_FALLBACK)
 454         status = CAIRO_INT_STATUS_SUCCESS;
 455
 456 cleanup:
 457     _cairo_scaled_font_thaw_cache (surface->scaled_font);
 458
 459     status2 = _cairo_output_stream_destroy (null_stream);
 460     if (status == CAIRO_INT_STATUS_SUCCESS)
 461         status = status2;
 462
 463     return status;
 464 }
 465
 466 cairo_status_t
 467 _cairo_type3_glyph_surface_emit_glyph (void                  *abstract_surface,
 468                                        cairo_output_stream_t *stream,
 469                                        unsigned long          glyph_index,
 470                                        cairo_box_t           *bbox,
 471                                        double                *width)
 472 {
 473     cairo_type3_glyph_surface_t *surface = abstract_surface;
 474     cairo_scaled_glyph_t *scaled_glyph;
 475     cairo_int_status_t status, status2;
 476     double x_advance, y_advance;
 477     cairo_matrix_t font_matrix_inverse;
 478
 479     if (unlikely (surface->base.status))
 480         return surface->base.status;
 481
 482     _cairo_type3_glyph_surface_set_stream (surface, stream);
 483
 484     _cairo_scaled_font_freeze_cache (surface->scaled_font);
 485     status = _cairo_scaled_glyph_lookup (surface->scaled_font,
 486                                          glyph_index,
 487                                          CAIRO_SCALED_GLYPH_INFO_METRICS |
 488                                          CAIRO_SCALED_GLYPH_INFO_RECORDING_SURFACE,
 489                                          &scaled_glyph);
 490     if (status == CAIRO_INT_STATUS_UNSUPPORTED) {
 491         status = _cairo_scaled_glyph_lookup (surface->scaled_font,
 492                                              glyph_index,
 493                                              CAIRO_SCALED_GLYPH_INFO_METRICS,
 494                                              &scaled_glyph);
 495         if (status == CAIRO_INT_STATUS_SUCCESS)
 496             status = CAIRO_INT_STATUS_IMAGE_FALLBACK;
 497     }
 498     if (_cairo_int_status_is_error (status)) {
 499         _cairo_scaled_font_thaw_cache (surface->scaled_font);
 500         return status;
 501     }
 502
 503     x_advance = scaled_glyph->metrics.x_advance;
 504     y_advance = scaled_glyph->metrics.y_advance;
 505     font_matrix_inverse = surface->scaled_font->font_matrix;
 506     status2 = cairo_matrix_invert (&font_matrix_inverse);
 507
 508     /* The invertability of font_matrix is tested in
 509      * pdf_operators_show_glyphs before any glyphs are mapped to the
 510      * subset. */
 511     assert (status2 == CAIRO_INT_STATUS_SUCCESS);
 512
 513     cairo_matrix_transform_distance (&font_matrix_inverse, &x_advance, &y_advance);
 514     *width = x_advance;
 515
 516     *bbox = scaled_glyph->bbox;
 517     _cairo_matrix_transform_bounding_box_fixed (&surface->scaled_font->scale_inverse,
 518                                                 bbox, NULL);
 519
 520     _cairo_output_stream_printf (surface->stream,
 521                                  "%f 0 %f %f %f %f d1\n",
 522                                  x_advance,
 523                                  _cairo_fixed_to_double (bbox->p1.x),
 524                                  - _cairo_fixed_to_double (bbox->p2.y),
 525                                  _cairo_fixed_to_double (bbox->p2.x),
 526                                  - _cairo_fixed_to_double (bbox->p1.y));
 527
 528     if (status == CAIRO_INT_STATUS_SUCCESS) {
 529         cairo_output_stream_t *mem_stream;
 530
 531         mem_stream = _cairo_memory_stream_create ();
 532         status = mem_stream->status;
 533         if (unlikely (status))
 534             goto FAIL;
 535
 536         _cairo_type3_glyph_surface_set_stream (surface, mem_stream);
 537
 538         _cairo_output_stream_printf (surface->stream, "q\n");
 539         status = _cairo_recording_surface_replay (scaled_glyph->recording_surface,
 540                                                   &surface->base);
 541
 542         status2 = _cairo_pdf_operators_flush (&surface->pdf_operators);
 543         if (status == CAIRO_INT_STATUS_SUCCESS)
 544             status = status2;
 545
 546         _cairo_output_stream_printf (surface->stream, "Q\n");
 547
 548         _cairo_type3_glyph_surface_set_stream (surface, stream);
 549         if (status == CAIRO_INT_STATUS_SUCCESS)
 550             _cairo_memory_stream_copy (mem_stream, stream);
 551
 552         status2 = _cairo_output_stream_destroy (mem_stream);
 553         if (status == CAIRO_INT_STATUS_SUCCESS)
 554             status = status2;
 555     }
 556
 557     if (status == CAIRO_INT_STATUS_IMAGE_FALLBACK)
 558         status = _cairo_type3_glyph_surface_emit_fallback_image (surface, glyph_index);
 559
 560   FAIL:
 561     _cairo_scaled_font_thaw_cache (surface->scaled_font);
 562
 563     return status;
 564 }
 565
 566 #endif /* CAIRO_HAS_FONT_SUBSET */