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         cairo_surface_destroy (&image->base);
 129         return status;
 130     }
 131
 132     _cairo_output_stream_printf (surface->stream,
 133                                  "q %f %f %f %f %f %f cm\n",
 134                                  image_matrix->xx,
 135                                  image_matrix->xy,
 136                                  image_matrix->yx,
 137                                  image_matrix->yy,
 138                                  image_matrix->x0,
 139                                  image_matrix->y0);
 140
 141     status = surface->emit_image (image, surface->stream);
 142     cairo_surface_destroy (&image->base);
 143
 144     _cairo_output_stream_printf (surface->stream,
 145                                  "Q\n");
 146
 147     return status;
 148 }
 149
 150 static cairo_status_t
 151 _cairo_type3_glyph_surface_emit_image_pattern (cairo_type3_glyph_surface_t *surface,
 152                                                cairo_image_surface_t       *image,
 153                                                const cairo_matrix_t              *pattern_matrix)
 154 {
 155     cairo_matrix_t mat, upside_down;
 156     cairo_status_t status;
 157
 158     if (image->width == 0 || image->height == 0)
 159         return CAIRO_STATUS_SUCCESS;
 160
 161     mat = *pattern_matrix;
 162
 163     /* Get the pattern space to user space matrix  */
 164     status = cairo_matrix_invert (&mat);
 165
 166     /* cairo_pattern_set_matrix ensures the matrix is invertible */
 167     assert (status == CAIRO_STATUS_SUCCESS);
 168
 169     /* Make this a pattern space to Type 3 font space matrix */
 170     cairo_matrix_multiply (&mat, &mat, &surface->cairo_to_pdf);
 171
 172     /* PDF images are in a 1 unit by 1 unit image space. Turn the 1 by
 173      * 1 image upside down to convert to flip the Y-axis going from
 174      * cairo to PDF. Then scale the image up to the required size. */
 175     cairo_matrix_scale (&mat, image->width, image->height);
 176     cairo_matrix_init (&upside_down, 1, 0, 0, -1, 0, 1);
 177     cairo_matrix_multiply (&mat, &upside_down, &mat);
 178
 179     return _cairo_type3_glyph_surface_emit_image (surface, image, &mat);
 180 }
 181
 182 static cairo_status_t
 183 _cairo_type3_glyph_surface_finish (void *abstract_surface)
 184 {
 185     cairo_type3_glyph_surface_t *surface = abstract_surface;
 186
 187     return _cairo_pdf_operators_fini (&surface->pdf_operators);
 188 }
 189
 190 static cairo_int_status_t
 191 _cairo_type3_glyph_surface_paint (void                  *abstract_surface,
 192                                   cairo_operator_t       op,
 193                                   const cairo_pattern_t *source,
 194                                   const cairo_clip_t    *clip)
 195 {
 196     cairo_type3_glyph_surface_t *surface = abstract_surface;
 197     const cairo_surface_pattern_t *pattern;
 198     cairo_image_surface_t *image;
 199     void *image_extra;
 200     cairo_status_t status;
 201
 202     if (source->type != CAIRO_PATTERN_TYPE_SURFACE)
 203         return CAIRO_INT_STATUS_IMAGE_FALLBACK;
 204
 205     status = _cairo_surface_clipper_set_clip (&surface->clipper, clip);
 206     if (unlikely (status))
 207         return status;
 208
 209     pattern = (const cairo_surface_pattern_t *) source;
 210     status = _cairo_surface_acquire_source_image (pattern->surface,
 211                                                   &image, &image_extra);
 212     if (unlikely (status))
 213         goto fail;
 214
 215     status = _cairo_type3_glyph_surface_emit_image_pattern (surface,
 216                                                             image,
 217                                                             &pattern->base.matrix);
 218
 219 fail:
 220     _cairo_surface_release_source_image (pattern->surface, image, image_extra);
 221
 222     return status;
 223 }
 224
 225 static cairo_int_status_t
 226 _cairo_type3_glyph_surface_mask (void                   *abstract_surface,
 227                                  cairo_operator_t        op,
 228                                  const cairo_pattern_t  *source,
 229                                  const cairo_pattern_t  *mask,
 230                                  const cairo_clip_t     *clip)
 231 {
 232     return _cairo_type3_glyph_surface_paint (abstract_surface,
 233                                              op, mask,
 234                                              clip);
 235 }
 236
 237 static cairo_int_status_t
 238 _cairo_type3_glyph_surface_stroke (void                 *abstract_surface,
 239                                    cairo_operator_t      op,
 240                                    const cairo_pattern_t *source,
 241                                    const cairo_path_fixed_t     *path,
 242                                    const cairo_stroke_style_t   *style,
 243                                    const cairo_matrix_t *ctm,
 244                                    const cairo_matrix_t *ctm_inverse,
 245                                    double                tolerance,
 246                                    cairo_antialias_t     antialias,
 247                                    const cairo_clip_t   *clip)
 248 {
 249     cairo_type3_glyph_surface_t *surface = abstract_surface;
 250     cairo_int_status_t status;
 251
 252     status = _cairo_surface_clipper_set_clip (&surface->clipper, clip);
 253     if (unlikely (status))
 254         return status;
 255
 256     return _cairo_pdf_operators_stroke (&surface->pdf_operators,
 257                                         path,
 258                                         style,
 259                                         ctm,
 260                                         ctm_inverse);
 261 }
 262
 263 static cairo_int_status_t
 264 _cairo_type3_glyph_surface_fill (void                   *abstract_surface,
 265                                  cairo_operator_t        op,
 266                                  const cairo_pattern_t  *source,
 267                                  const cairo_path_fixed_t       *path,
 268                                  cairo_fill_rule_t       fill_rule,
 269                                  double                  tolerance,
 270                                  cairo_antialias_t       antialias,
 271                                  const cairo_clip_t             *clip)
 272 {
 273     cairo_type3_glyph_surface_t *surface = abstract_surface;
 274     cairo_int_status_t status;
 275
 276     status = _cairo_surface_clipper_set_clip (&surface->clipper, clip);
 277     if (unlikely (status))
 278         return status;
 279
 280     return _cairo_pdf_operators_fill (&surface->pdf_operators,
 281                                       path,
 282                                       fill_rule);
 283 }
 284
 285 static cairo_int_status_t
 286 _cairo_type3_glyph_surface_show_glyphs (void                 *abstract_surface,
 287                                         cairo_operator_t      op,
 288                                         const cairo_pattern_t *source,
 289                                         cairo_glyph_t        *glyphs,
 290                                         int                   num_glyphs,
 291                                         cairo_scaled_font_t  *scaled_font,
 292                                         const cairo_clip_t     *clip)
 293 {
 294     cairo_type3_glyph_surface_t *surface = abstract_surface;
 295     cairo_int_status_t status;
 296     cairo_scaled_font_t *font;
 297     cairo_matrix_t new_ctm, invert_y_axis;
 298
 299     status = _cairo_surface_clipper_set_clip (&surface->clipper, clip);
 300     if (unlikely (status))
 301         return status;
 302
 303     cairo_matrix_init_scale (&invert_y_axis, 1, -1);
 304     cairo_matrix_multiply (&new_ctm, &invert_y_axis, &scaled_font->ctm);
 305     cairo_matrix_multiply (&new_ctm, &surface->cairo_to_pdf, &new_ctm);
 306     font = cairo_scaled_font_create (scaled_font->font_face,
 307                                      &scaled_font->font_matrix,
 308                                      &new_ctm,
 309                                      &scaled_font->options);
 310     if (unlikely (font->status))
 311         return font->status;
 312
 313     status = _cairo_pdf_operators_show_text_glyphs (&surface->pdf_operators,
 314                                                     NULL, 0,
 315                                                     glyphs, num_glyphs,
 316                                                     NULL, 0,
 317                                                     FALSE,
 318                                                     font);
 319
 320     cairo_scaled_font_destroy (font);
 321
 322     return status;
 323 }
 324
 325 static const cairo_surface_backend_t cairo_type3_glyph_surface_backend = {
 326     CAIRO_INTERNAL_SURFACE_TYPE_TYPE3_GLYPH,
 327     _cairo_type3_glyph_surface_finish,
 328
 329     _cairo_default_context_create, /* XXX usable through a context? */
 330
 331     NULL, /* create similar */
 332     NULL, /* create similar image */
 333     NULL, /* map to image */
 334     NULL, /* unmap image */
 335
 336     NULL, /* source */
 337     NULL, /* acquire_source_image */
 338     NULL, /* release_source_image */
 339     NULL, /* snapshot */
 340
 341     NULL, /* copy page */
 342     NULL, /* show page */
 343
 344     NULL, /* _cairo_type3_glyph_surface_get_extents */
 345     NULL, /* _cairo_type3_glyph_surface_get_font_options */
 346
 347     NULL, /* flush */
 348     NULL, /* mark_dirty_rectangle */
 349
 350     _cairo_type3_glyph_surface_paint,
 351     _cairo_type3_glyph_surface_mask,
 352     _cairo_type3_glyph_surface_stroke,
 353     _cairo_type3_glyph_surface_fill,
 354     NULL, /* fill-stroke */
 355     _cairo_type3_glyph_surface_show_glyphs,
 356 };
 357
 358 static void
 359 _cairo_type3_glyph_surface_set_stream (cairo_type3_glyph_surface_t *surface,
 360                                        cairo_output_stream_t       *stream)
 361 {
 362     surface->stream = stream;
 363     _cairo_pdf_operators_set_stream (&surface->pdf_operators, stream);
 364 }
 365
 366 static cairo_status_t
 367 _cairo_type3_glyph_surface_emit_fallback_image (cairo_type3_glyph_surface_t *surface,
 368                                                 unsigned long                glyph_index)
 369 {
 370     cairo_scaled_glyph_t *scaled_glyph;
 371     cairo_status_t status;
 372     cairo_image_surface_t *image;
 373     cairo_matrix_t mat;
 374     double x, y;
 375
 376     status = _cairo_scaled_glyph_lookup (surface->scaled_font,
 377                                          glyph_index,
 378                                          CAIRO_SCALED_GLYPH_INFO_METRICS |
 379                                          CAIRO_SCALED_GLYPH_INFO_SURFACE,
 380                                          &scaled_glyph);
 381     if (unlikely (status))
 382         return status;
 383
 384     image = scaled_glyph->surface;
 385     if (image->width == 0 || image->height == 0)
 386         return CAIRO_STATUS_SUCCESS;
 387
 388     x = _cairo_fixed_to_double (scaled_glyph->bbox.p1.x);
 389     y = _cairo_fixed_to_double (scaled_glyph->bbox.p2.y);
 390     mat.xx = image->width;
 391     mat.xy = 0;
 392     mat.yx = 0;
 393     mat.yy = image->height;
 394     mat.x0 = x;
 395     mat.y0 = y;
 396     cairo_matrix_multiply (&mat, &mat, &surface->scaled_font->scale_inverse);
 397     mat.y0 *= -1;
 398
 399     return _cairo_type3_glyph_surface_emit_image (surface, image, &mat);
 400 }
 401
 402 void
 403 _cairo_type3_glyph_surface_set_font_subsets_callback (void                                  *abstract_surface,
 404                                                       cairo_pdf_operators_use_font_subset_t  use_font_subset,
 405                                                       void                                  *closure)
 406 {
 407     cairo_type3_glyph_surface_t *surface = abstract_surface;
 408
 409     if (unlikely (surface->base.status))
 410         return;
 411
 412     _cairo_pdf_operators_set_font_subsets_callback (&surface->pdf_operators,
 413                                                     use_font_subset,
 414                                                     closure);
 415 }
 416
 417 cairo_status_t
 418 _cairo_type3_glyph_surface_analyze_glyph (void               *abstract_surface,
 419                                           unsigned long       glyph_index)
 420 {
 421     cairo_type3_glyph_surface_t *surface = abstract_surface;
 422     cairo_scaled_glyph_t *scaled_glyph;
 423     cairo_int_status_t status, status2;
 424     cairo_output_stream_t *null_stream;
 425
 426     if (unlikely (surface->base.status))
 427         return surface->base.status;
 428
 429     null_stream = _cairo_null_stream_create ();
 430     if (unlikely (null_stream->status)) {
 431         status = null_stream->status;
 432         _cairo_output_stream_destroy (null_stream);
 433         return status;
 434     }
 435
 436     _cairo_type3_glyph_surface_set_stream (surface, null_stream);
 437
 438     _cairo_scaled_font_freeze_cache (surface->scaled_font);
 439     status = _cairo_scaled_glyph_lookup (surface->scaled_font,
 440                                          glyph_index,
 441                                          CAIRO_SCALED_GLYPH_INFO_RECORDING_SURFACE,
 442                                          &scaled_glyph);
 443
 444     if (_cairo_int_status_is_error (status))
 445         goto cleanup;
 446
 447     if (status == CAIRO_INT_STATUS_UNSUPPORTED) {
 448         status = CAIRO_INT_STATUS_SUCCESS;
 449         goto cleanup;
 450     }
 451
 452     status = _cairo_recording_surface_replay (scaled_glyph->recording_surface,
 453                                               &surface->base);
 454     if (unlikely (status))
 455         goto cleanup;
 456
 457     status = _cairo_pdf_operators_flush (&surface->pdf_operators);
 458     if (status == CAIRO_INT_STATUS_IMAGE_FALLBACK)
 459         status = CAIRO_INT_STATUS_SUCCESS;
 460
 461 cleanup:
 462     _cairo_scaled_font_thaw_cache (surface->scaled_font);
 463
 464     status2 = _cairo_output_stream_destroy (null_stream);
 465     if (status == CAIRO_INT_STATUS_SUCCESS)
 466         status = status2;
 467
 468     return status;
 469 }
 470
 471 cairo_status_t
 472 _cairo_type3_glyph_surface_emit_glyph (void                  *abstract_surface,
 473                                        cairo_output_stream_t *stream,
 474                                        unsigned long          glyph_index,
 475                                        cairo_box_t           *bbox,
 476                                        double                *width)
 477 {
 478     cairo_type3_glyph_surface_t *surface = abstract_surface;
 479     cairo_scaled_glyph_t *scaled_glyph;
 480     cairo_int_status_t status, status2;
 481     double x_advance, y_advance;
 482     cairo_matrix_t font_matrix_inverse;
 483
 484     if (unlikely (surface->base.status))
 485         return surface->base.status;
 486
 487     _cairo_type3_glyph_surface_set_stream (surface, stream);
 488
 489     _cairo_scaled_font_freeze_cache (surface->scaled_font);
 490     status = _cairo_scaled_glyph_lookup (surface->scaled_font,
 491                                          glyph_index,
 492                                          CAIRO_SCALED_GLYPH_INFO_METRICS |
 493                                          CAIRO_SCALED_GLYPH_INFO_RECORDING_SURFACE,
 494                                          &scaled_glyph);
 495     if (status == CAIRO_INT_STATUS_UNSUPPORTED) {
 496         status = _cairo_scaled_glyph_lookup (surface->scaled_font,
 497                                              glyph_index,
 498                                              CAIRO_SCALED_GLYPH_INFO_METRICS,
 499                                              &scaled_glyph);
 500         if (status == CAIRO_INT_STATUS_SUCCESS)
 501             status = CAIRO_INT_STATUS_IMAGE_FALLBACK;
 502     }
 503     if (_cairo_int_status_is_error (status)) {
 504         _cairo_scaled_font_thaw_cache (surface->scaled_font);
 505         return status;
 506     }
 507
 508     x_advance = scaled_glyph->metrics.x_advance;
 509     y_advance = scaled_glyph->metrics.y_advance;
 510     font_matrix_inverse = surface->scaled_font->font_matrix;
 511     status2 = cairo_matrix_invert (&font_matrix_inverse);
 512
 513     /* The invertability of font_matrix is tested in
 514      * pdf_operators_show_glyphs before any glyphs are mapped to the
 515      * subset. */
 516     assert (status2 == CAIRO_INT_STATUS_SUCCESS);
 517
 518     cairo_matrix_transform_distance (&font_matrix_inverse, &x_advance, &y_advance);
 519     *width = x_advance;
 520
 521     *bbox = scaled_glyph->bbox;
 522     _cairo_matrix_transform_bounding_box_fixed (&surface->scaled_font->scale_inverse,
 523                                                 bbox, NULL);
 524
 525     _cairo_output_stream_printf (surface->stream,
 526                                  "%f 0 %f %f %f %f d1\n",
 527                                  x_advance,
 528                                  _cairo_fixed_to_double (bbox->p1.x),
 529                                  - _cairo_fixed_to_double (bbox->p2.y),
 530                                  _cairo_fixed_to_double (bbox->p2.x),
 531                                  - _cairo_fixed_to_double (bbox->p1.y));
 532
 533     if (status == CAIRO_INT_STATUS_SUCCESS) {
 534         cairo_output_stream_t *mem_stream;
 535
 536         mem_stream = _cairo_memory_stream_create ();
 537         status = mem_stream->status;
 538         if (unlikely (status)) {
 539              _cairo_output_stream_destroy (mem_stream);
 540             goto FAIL;
 541         }
 542
 543         _cairo_type3_glyph_surface_set_stream (surface, mem_stream);
 544
 545         _cairo_output_stream_printf (surface->stream, "q\n");
 546         status = _cairo_recording_surface_replay (scaled_glyph->recording_surface,
 547                                                   &surface->base);
 548
 549         status2 = _cairo_pdf_operators_flush (&surface->pdf_operators);
 550         if (status == CAIRO_INT_STATUS_SUCCESS)
 551             status = status2;
 552
 553         _cairo_output_stream_printf (surface->stream, "Q\n");
 554
 555         _cairo_type3_glyph_surface_set_stream (surface, stream);
 556         if (status == CAIRO_INT_STATUS_SUCCESS)
 557             _cairo_memory_stream_copy (mem_stream, stream);
 558
 559         status2 = _cairo_output_stream_destroy (mem_stream);
 560         if (status == CAIRO_INT_STATUS_SUCCESS)
 561             status = status2;
 562     }
 563
 564     if (status == CAIRO_INT_STATUS_IMAGE_FALLBACK)
 565         status = _cairo_type3_glyph_surface_emit_fallback_image (surface, glyph_index);
 566
 567   FAIL:
 568     _cairo_scaled_font_thaw_cache (surface->scaled_font);
 569
 570     return status;
 571 }
 572
 573 #endif /* CAIRO_HAS_FONT_SUBSET */