gimpink.c 17.9 KB
Newer Older
1
/* GIMP - The GNU Image Manipulation Program
2 3
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
4
 * This program is free software: you can redistribute it and/or modify
5
 * it under the terms of the GNU General Public License as published by
6
 * the Free Software Foundation; either version 3 of the License, or
7 8 9 10 11 12 13 14
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
15
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16
 */
Sven Neumann's avatar
Sven Neumann committed
17

18 19
#include "config.h"

Tor Lillqvist's avatar
Tor Lillqvist committed
20
#include <string.h>
21

22
#include <gegl.h>
Sven Neumann's avatar
Sven Neumann committed
23

24 25
#include "libgimpmath/gimpmath.h"

26
#include "paint-types.h"
Sven Neumann's avatar
Sven Neumann committed
27

Michael Natterer's avatar
Michael Natterer committed
28 29 30
#include "base/pixel-region.h"
#include "base/temp-buf.h"

31 32
#include "paint-funcs/paint-funcs.h"

33
#include "core/gimpdrawable.h"
34
#include "core/gimpimage.h"
35
#include "core/gimpimage-undo.h"
36

37
#include "gimpinkoptions.h"
38 39
#include "gimpink.h"
#include "gimpink-blob.h"
40
#include "gimpinkundo.h"
41

42
#include "gimp-intl.h"
43

44

45
#define SUBSAMPLE 8
46

47

48
/*  local function prototypes  */
49

50 51 52 53 54
static void      gimp_ink_finalize       (GObject          *object);

static void      gimp_ink_paint          (GimpPaintCore    *paint_core,
                                          GimpDrawable     *drawable,
                                          GimpPaintOptions *paint_options,
55
                                          const GimpCoords *coords,
56 57 58 59 60
                                          GimpPaintState    paint_state,
                                          guint32           time);
static TempBuf * gimp_ink_get_paint_area (GimpPaintCore    *paint_core,
                                          GimpDrawable     *drawable,
                                          GimpPaintOptions *paint_options);
61 62 63
static GimpUndo* gimp_ink_push_undo      (GimpPaintCore    *core,
                                          GimpImage        *image,
                                          const gchar      *undo_desc);
64 65 66 67

static void      gimp_ink_motion         (GimpPaintCore    *paint_core,
                                          GimpDrawable     *drawable,
                                          GimpPaintOptions *paint_options,
68
                                          const GimpCoords *coords,
69 70 71 72 73 74 75 76 77 78 79 80
                                          guint32           time);

static Blob    * ink_pen_ellipse         (GimpInkOptions   *options,
                                          gdouble           x_center,
                                          gdouble           y_center,
                                          gdouble           pressure,
                                          gdouble           xtilt,
                                          gdouble           ytilt,
                                          gdouble           velocity);

static void      render_blob             (Blob             *blob,
                                          PixelRegion      *dest);
81

82

83
G_DEFINE_TYPE (GimpInk, gimp_ink, GIMP_TYPE_PAINT_CORE)
Michael Natterer's avatar
Michael Natterer committed
84 85

#define parent_class gimp_ink_parent_class
86

87

88
void
89 90
gimp_ink_register (Gimp                      *gimp,
                   GimpPaintRegisterCallback  callback)
91
{
92 93
  (* callback) (gimp,
                GIMP_TYPE_INK,
94
                GIMP_TYPE_INK_OPTIONS,
95 96 97
                "gimp-ink",
                _("Ink"),
                "gimp-tool-ink");
98 99 100
}

static void
101
gimp_ink_class_init (GimpInkClass *klass)
102
{
103 104
  GObjectClass       *object_class     = G_OBJECT_CLASS (klass);
  GimpPaintCoreClass *paint_core_class = GIMP_PAINT_CORE_CLASS (klass);
105

Michael Natterer's avatar
Michael Natterer committed
106
  object_class->finalize           = gimp_ink_finalize;
107

108 109
  paint_core_class->paint          = gimp_ink_paint;
  paint_core_class->get_paint_area = gimp_ink_get_paint_area;
Michael Natterer's avatar
Michael Natterer committed
110
  paint_core_class->push_undo      = gimp_ink_push_undo;
111 112 113
}

static void
114
gimp_ink_init (GimpInk *ink)
115 116 117 118
{
}

static void
119
gimp_ink_finalize (GObject *object)
120
{
121
  GimpInk *ink = GIMP_INK (object);
122

Michael Natterer's avatar
Michael Natterer committed
123 124 125 126 127 128
  if (ink->start_blob)
    {
      g_free (ink->start_blob);
      ink->start_blob = NULL;
    }

129
  if (ink->last_blob)
130
    {
131 132
      g_free (ink->last_blob);
      ink->last_blob = NULL;
133
    }
134

135
  G_OBJECT_CLASS (parent_class)->finalize (object);
136 137
}

138
static void
139 140 141
gimp_ink_paint (GimpPaintCore    *paint_core,
                GimpDrawable     *drawable,
                GimpPaintOptions *paint_options,
142
                const GimpCoords *coords,
143 144
                GimpPaintState    paint_state,
                guint32           time)
145
{
146
  GimpInk *ink = GIMP_INK (paint_core);
147 148

  switch (paint_state)
149
    {
150 151
      GimpCoords last_coords;

152
    case GIMP_PAINT_STATE_INIT:
153 154 155 156
      gimp_paint_core_get_last_coords (paint_core, &last_coords);

      if (coords->x == last_coords.x &&
          coords->y == last_coords.y)
157
        {
Michael Natterer's avatar
Michael Natterer committed
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
          /*  start with new blobs if we're not interpolating  */

          if (ink->start_blob)
            {
              g_free (ink->start_blob);
              ink->start_blob = NULL;
            }

          if (ink->last_blob)
            {
              g_free (ink->last_blob);
              ink->last_blob = NULL;
            }
        }
      else if (ink->last_blob)
        {
          /*  save the start blob of the line for undo otherwise  */

          if (ink->start_blob)
            g_free (ink->start_blob);

          ink->start_blob = blob_duplicate (ink->last_blob);
180
        }
181
      break;
182

183
    case GIMP_PAINT_STATE_MOTION:
184
      gimp_ink_motion (paint_core, drawable, paint_options, coords, time);
185
      break;
186

187
    case GIMP_PAINT_STATE_FINISH:
188 189
      break;
    }
190
}
jtl's avatar
jtl committed
191

192 193 194 195
static TempBuf *
gimp_ink_get_paint_area (GimpPaintCore    *paint_core,
                         GimpDrawable     *drawable,
                         GimpPaintOptions *paint_options)
196
{
Sven Neumann's avatar
Sven Neumann committed
197
  GimpInk *ink = GIMP_INK (paint_core);
198 199 200 201 202
  gint     x, y;
  gint     width, height;
  gint     dwidth, dheight;
  gint     x1, y1, x2, y2;
  gint     bytes;
jtl's avatar
jtl committed
203

204
  bytes = gimp_drawable_bytes_with_alpha (drawable);
205

Michael Natterer's avatar
Michael Natterer committed
206
  blob_bounds (ink->cur_blob, &x, &y, &width, &height);
207

208 209
  dwidth  = gimp_item_get_width  (GIMP_ITEM (drawable));
  dheight = gimp_item_get_height (GIMP_ITEM (drawable));
210

211 212 213 214
  x1 = CLAMP (x / SUBSAMPLE - 1,            0, dwidth);
  y1 = CLAMP (y / SUBSAMPLE - 1,            0, dheight);
  x2 = CLAMP ((x + width)  / SUBSAMPLE + 2, 0, dwidth);
  y2 = CLAMP ((y + height) / SUBSAMPLE + 2, 0, dheight);
215

216 217 218 219 220 221 222
  /*  configure the canvas buffer  */
  if ((x2 - x1) && (y2 - y1))
    paint_core->canvas_buf = temp_buf_resize (paint_core->canvas_buf, bytes,
                                              x1, y1,
                                              (x2 - x1), (y2 - y1));
  else
    return NULL;
Raph Levien's avatar
Raph Levien committed
223

224
  return paint_core->canvas_buf;
225
}
226

227 228 229 230 231 232 233 234 235 236 237 238
static GimpUndo *
gimp_ink_push_undo (GimpPaintCore *core,
                    GimpImage     *image,
                    const gchar   *undo_desc)
{
  return gimp_image_undo_push (image, GIMP_TYPE_INK_UNDO,
                               GIMP_UNDO_INK, undo_desc,
                               0,
                               "paint-core", core,
                               NULL);
}

239
static void
240 241 242
gimp_ink_motion (GimpPaintCore    *paint_core,
                 GimpDrawable     *drawable,
                 GimpPaintOptions *paint_options,
243
                 const GimpCoords *coords,
244
                 guint32           time)
245
{
246 247 248
  GimpInk        *ink     = GIMP_INK (paint_core);
  GimpInkOptions *options = GIMP_INK_OPTIONS (paint_options);
  GimpContext    *context = GIMP_CONTEXT (paint_options);
249
  GimpImage      *image;
250 251
  Blob           *blob_union = NULL;
  Blob           *blob_to_render;
252 253 254
  TempBuf        *area;
  guchar          col[MAX_CHANNELS];
  PixelRegion     blob_maskPR;
255

256
  image = gimp_item_get_image (GIMP_ITEM (drawable));
257

258 259 260
  if (! ink->last_blob)
    {
      ink->last_blob = ink_pen_ellipse (options,
261 262 263 264 265
                                        coords->x,
                                        coords->y,
                                        coords->pressure,
                                        coords->xtilt,
                                        coords->ytilt,
266
                                        100);
267

Michael Natterer's avatar
Michael Natterer committed
268 269 270 271 272
      if (ink->start_blob)
        g_free (ink->start_blob);

      ink->start_blob = blob_duplicate (ink->last_blob);

273
      blob_to_render = ink->last_blob;
274 275 276
    }
  else
    {
Sven Neumann's avatar
Sven Neumann committed
277
      Blob *blob = ink_pen_ellipse (options,
278 279 280 281 282 283
                                    coords->x,
                                    coords->y,
                                    coords->pressure,
                                    coords->xtilt,
                                    coords->ytilt,
                                    coords->velocity * 100);
284 285

      blob_union = blob_convex_union (ink->last_blob, blob);
Sven Neumann's avatar
Sven Neumann committed
286

287 288
      g_free (ink->last_blob);
      ink->last_blob = blob;
289

290 291
      blob_to_render = blob_union;
    }
292

293
  /* Get the buffer */
Michael Natterer's avatar
Michael Natterer committed
294
  ink->cur_blob = blob_to_render;
295
  area = gimp_paint_core_get_paint_area (paint_core, drawable, paint_options);
Michael Natterer's avatar
Michael Natterer committed
296 297
  ink->cur_blob = NULL;

298 299
  if (! area)
    return;
jtl's avatar
jtl committed
300

301 302
  gimp_image_get_foreground (image, context, gimp_drawable_type (drawable),
                             col);
303

304 305
  /*  set the alpha channel  */
  col[paint_core->canvas_buf->bytes - 1] = OPAQUE_OPACITY;
306

307
  /*  color the pixels  */
308
  color_pixels (temp_buf_get_data (paint_core->canvas_buf), col,
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
                area->width * area->height, area->bytes);

  gimp_paint_core_validate_canvas_tiles (paint_core,
                                         paint_core->canvas_buf->x,
                                         paint_core->canvas_buf->y,
                                         paint_core->canvas_buf->width,
                                         paint_core->canvas_buf->height);

  /*  draw the blob directly to the canvas_tiles  */
  pixel_region_init (&blob_maskPR, paint_core->canvas_tiles,
                     paint_core->canvas_buf->x,
                     paint_core->canvas_buf->y,
                     paint_core->canvas_buf->width,
                     paint_core->canvas_buf->height,
                     TRUE);

325
  render_blob (blob_to_render, &blob_maskPR);
326 327 328 329 330 331 332 333 334 335 336 337 338 339

  /*  draw the canvas_buf using the just rendered canvas_tiles as mask */
  pixel_region_init (&blob_maskPR, paint_core->canvas_tiles,
                     paint_core->canvas_buf->x,
                     paint_core->canvas_buf->y,
                     paint_core->canvas_buf->width,
                     paint_core->canvas_buf->height,
                     FALSE);

  gimp_paint_core_paste (paint_core, &blob_maskPR, drawable,
                         GIMP_OPACITY_OPAQUE,
                         gimp_context_get_opacity (context),
                         gimp_context_get_paint_mode (context),
                         GIMP_PAINT_CONSTANT);
340

341 342
  if (blob_union)
    g_free (blob_union);
343 344 345
}

static Blob *
346 347
ink_pen_ellipse (GimpInkOptions *options,
                 gdouble         x_center,
348 349 350 351 352
                 gdouble         y_center,
                 gdouble         pressure,
                 gdouble         xtilt,
                 gdouble         ytilt,
                 gdouble         velocity)
353
{
354
  BlobFunc blob_function;
355 356 357 358 359 360 361
  gdouble  size;
  gdouble  tsin, tcos;
  gdouble  aspect, radmin;
  gdouble  x,y;
  gdouble  tscale;
  gdouble  tscale_c;
  gdouble  tscale_s;
362

363 364
  /* Adjust the size depending on pressure. */

365
  size = options->size * (1.0 + options->size_sensitivity *
366
                          (2.0 * pressure - 1.0));
367

368 369 370 371
  /* Adjust the size further depending on pointer velocity and
   * velocity-sensitivity.  These 'magic constants' are 'feels
   * natural' tigert-approved. --ADM
   */
372 373 374 375 376

  if (velocity < 3.0)
    velocity = 3.0;

#ifdef VERBOSE
377
  g_printerr ("%g (%g) -> ", size, velocity);
378
#endif
379

380 381 382
  size = (options->vel_sensitivity *
          ((4.5 * size) / (1.0 + options->vel_sensitivity * (2.0 * velocity)))
          + (1.0 - options->vel_sensitivity) * size);
383 384

#ifdef VERBOSE
385
  g_printerr ("%g\n", (gfloat) size);
386 387 388 389
#endif

  /* Clamp resulting size to sane limits */

390 391
  if (size > options->size * (1.0 + options->size_sensitivity))
    size = options->size * (1.0 + options->size_sensitivity);
392

393 394
  if (size * SUBSAMPLE < 1.0)
    size = 1.0 / SUBSAMPLE;
395 396

  /* Add brush angle/aspect to tilt vectorially */
397

Raph Levien's avatar
Raph Levien committed
398
  /* I'm not happy with the way the brush widget info is combined with
399 400 401 402
   * tilt info from the brush. My personal feeling is that
   * representing both as affine transforms would make the most
   * sense. -RLL
   */
Raph Levien's avatar
Raph Levien committed
403

404
  tscale   = options->tilt_sensitivity * 10.0;
405 406 407
  tscale_c = tscale * cos (gimp_deg_to_rad (options->tilt_angle));
  tscale_s = tscale * sin (gimp_deg_to_rad (options->tilt_angle));

408
  x = (options->blob_aspect * cos (options->blob_angle) +
409
       xtilt * tscale_c - ytilt * tscale_s);
410
  y = (options->blob_aspect * sin (options->blob_angle) +
411 412
       ytilt * tscale_c + xtilt * tscale_s);

Raph Levien's avatar
Raph Levien committed
413
#ifdef VERBOSE
414 415 416
  g_printerr ("angle %g aspect %g; %g %g; %g %g\n",
              options->blob_angle, options->blob_aspect,
              tscale_c, tscale_s, x, y);
Raph Levien's avatar
Raph Levien committed
417
#endif
418

Sven Neumann's avatar
Sven Neumann committed
419
  aspect = sqrt (SQR (x) + SQR (y));
420 421 422

  if (aspect != 0)
    {
423 424
      tcos = x / aspect;
      tsin = y / aspect;
425 426 427
    }
  else
    {
428 429 430 431 432 433 434 435 436 437 438
      tsin = sin (options->blob_angle);
      tcos = cos (options->blob_angle);
    }

  aspect = CLAMP (aspect, 1.0, 10.0);

  radmin = MAX (1.0, SUBSAMPLE * size / aspect);

  switch (options->blob_type)
    {
    case GIMP_INK_BLOB_TYPE_ELLIPSE:
439
      blob_function = blob_ellipse;
440 441 442
      break;

    case GIMP_INK_BLOB_TYPE_SQUARE:
443
      blob_function = blob_square;
444 445 446
      break;

    case GIMP_INK_BLOB_TYPE_DIAMOND:
447 448 449 450 451
      blob_function = blob_diamond;
      break;

    default:
      g_return_val_if_reached (NULL);
452
      break;
453
    }
454

455 456 457 458 459 460
  return (* blob_function) (x_center * SUBSAMPLE,
                            y_center * SUBSAMPLE,
                            radmin * aspect * tcos,
                            radmin * aspect * tsin,
                            -radmin * tsin,
                            radmin * tcos);
461 462
}

463

464 465 466
/*********************************/
/*  Rendering functions          */
/*********************************/
467

468
/* Some of this stuff should probably be combined with the
469 470 471 472 473 474 475 476
 * code it was copied from in paint_core.c; but I wanted
 * to learn this stuff, so I've kept it simple.
 *
 * The following only supports CONSTANT mode. Incremental
 * would, I think, interact strangely with the way we
 * do things. But it wouldn't be hard to implement at all.
 */

Sven Neumann's avatar
Sven Neumann committed
477 478 479 480 481
enum
{
  ROW_START,
  ROW_STOP
};
482 483 484 485

/* The insertion sort here, for SUBSAMPLE = 8, tends to beat out
 * qsort() by 4x with CFLAGS=-O2, 2x with CFLAGS=-g
 */
486 487
static void
insert_sort (gint *data,
488
             gint  n)
489
{
490
  gint i, j, k;
491

492
  for (i = 2; i < 2 * n; i += 2)
493
    {
Sven Neumann's avatar
Sven Neumann committed
494 495 496
      gint tmp1 = data[i];
      gint tmp2 = data[i + 1];

497
      j = 0;
Sven Neumann's avatar
Sven Neumann committed
498

499
      while (data[j] < tmp1)
500
        j += 2;
501

502
      for (k = i; k > j; k -= 2)
503 504 505 506
        {
          data[k]     = data[k - 2];
          data[k + 1] = data[k - 1];
        }
507

508 509
      data[j]     = tmp1;
      data[j + 1] = tmp2;
510 511 512 513 514
    }
}

static void
fill_run (guchar *dest,
515 516
          guchar  alpha,
          gint    w)
517 518 519 520 521 522 523 524
{
  if (alpha == 255)
    {
      memset (dest, 255, w);
    }
  else
    {
      while (w--)
525 526 527 528
        {
          *dest = MAX (*dest, alpha);
          dest++;
        }
529 530 531 532
    }
}

static void
533
render_blob_line (Blob   *blob,
534 535 536 537
                  guchar *dest,
                  gint    x,
                  gint    y,
                  gint    width)
538
{
539 540 541
  gint  buf[4 * SUBSAMPLE];
  gint *data    = buf;
  gint  n       = 0;
542 543
  gint  i, j;
  gint  current = 0;  /* number of filled rows at this point
544 545
                       * in the scan line
                       */
546
  gint last_x;
547 548

  /* Sort start and ends for all lines */
549

550
  j = y * SUBSAMPLE - blob->y;
551
  for (i = 0; i < SUBSAMPLE; i++)
552 553
    {
      if (j >= blob->height)
554
        break;
555

556
      if ((j > 0) && (blob->data[j].left <= blob->data[j].right))
557 558 559 560 561 562 563
        {
          data[2 * n]                     = blob->data[j].left;
          data[2 * n + 1]                 = ROW_START;
          data[2 * SUBSAMPLE + 2 * n]     = blob->data[j].right;
          data[2 * SUBSAMPLE + 2 * n + 1] = ROW_STOP;
          n++;
        }
564 565 566 567 568 569
      j++;
    }

  /*   If we have less than SUBSAMPLE rows, compress */
  if (n < SUBSAMPLE)
    {
570
      for (i = 0; i < 2 * n; i++)
571
        data[2 * n + i] = data[2 * SUBSAMPLE + i];
572 573 574 575 576 577 578 579 580 581 582 583
    }

  /*   Now count start and end separately */
  n *= 2;

  insert_sort (data, n);

  /* Discard portions outside of tile */

  while ((n > 0) && (data[0] < SUBSAMPLE*x))
    {
      if (data[1] == ROW_START)
584
        current++;
585
      else
586
        current--;
587 588 589 590 591 592
      data += 2;
      n--;
    }

  while ((n > 0) && (data[2*(n-1)] >= SUBSAMPLE*(x+width)))
    n--;
593

594 595 596
  /* Render the row */

  last_x = 0;
597
  for (i = 0; i < n;)
598
    {
599
      gint cur_x = data[2 * i] / SUBSAMPLE - x;
600
      gint pixel;
601 602 603

      /* Fill in portion leading up to this pixel */
      if (current && cur_x != last_x)
604
        fill_run (dest + last_x, (255 * current) / SUBSAMPLE, cur_x - last_x);
605 606

      /* Compute the value for this pixel */
607
      pixel = current * SUBSAMPLE;
608 609

      while (i<n)
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
        {
          gint tmp_x = data[2 * i] / SUBSAMPLE;

          if (tmp_x - x != cur_x)
            break;

          if (data[2 * i + 1] == ROW_START)
            {
              current++;
              pixel += ((tmp_x + 1) * SUBSAMPLE) - data[2 * i];
            }
          else
            {
              current--;
              pixel -= ((tmp_x + 1) * SUBSAMPLE) - data[2 * i];
            }

          i++;
        }
629

630
      dest[cur_x] = MAX (dest[cur_x], (pixel * 255) / (SUBSAMPLE * SUBSAMPLE));
631 632 633 634 635

      last_x = cur_x + 1;
    }

  if (current != 0)
636
    fill_run (dest + last_x, (255 * current)/ SUBSAMPLE, width - last_x);
637 638 639
}

static void
640 641
render_blob (Blob        *blob,
             PixelRegion *dest)
642
{
643
  gpointer  pr;
644

645 646
  for (pr = pixel_regions_register (1, dest);
       pr != NULL;
647 648
       pr = pixel_regions_process (pr))
    {
Sven Neumann's avatar
Sven Neumann committed
649 650 651
      guchar *d = dest->data;
      gint    h = dest->h;
      gint    y;
652

Sven Neumann's avatar
Sven Neumann committed
653
      for (y = 0; y < h; y++, d += dest->rowstride)
654
        {
Sven Neumann's avatar
Sven Neumann committed
655
          render_blob_line (blob, d, dest->x, dest->y + y, dest->w);
656
        }
657 658
    }
}