gimpink.c 17.8 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 55 56 57 58 59
static void      gimp_ink_finalize       (GObject          *object);

static void      gimp_ink_paint          (GimpPaintCore    *paint_core,
                                          GimpDrawable     *drawable,
                                          GimpPaintOptions *paint_options,
                                          GimpPaintState    paint_state,
                                          guint32           time);
static TempBuf * gimp_ink_get_paint_area (GimpPaintCore    *paint_core,
                                          GimpDrawable     *drawable,
                                          GimpPaintOptions *paint_options);
60 61 62
static GimpUndo* gimp_ink_push_undo      (GimpPaintCore    *core,
                                          GimpImage        *image,
                                          const gchar      *undo_desc);
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78

static void      gimp_ink_motion         (GimpPaintCore    *paint_core,
                                          GimpDrawable     *drawable,
                                          GimpPaintOptions *paint_options,
                                          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);
79

80

81
G_DEFINE_TYPE (GimpInk, gimp_ink, GIMP_TYPE_PAINT_CORE)
Michael Natterer's avatar
Michael Natterer committed
82 83

#define parent_class gimp_ink_parent_class
84

85

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

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

Michael Natterer's avatar
Michael Natterer committed
104
  object_class->finalize           = gimp_ink_finalize;
105

106 107
  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
108
  paint_core_class->push_undo      = gimp_ink_push_undo;
109 110 111
}

static void
112
gimp_ink_init (GimpInk *ink)
113 114 115 116
{
}

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

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

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

133
  G_OBJECT_CLASS (parent_class)->finalize (object);
134 135
}

136
static void
137 138 139 140 141
gimp_ink_paint (GimpPaintCore    *paint_core,
                GimpDrawable     *drawable,
                GimpPaintOptions *paint_options,
                GimpPaintState    paint_state,
                guint32           time)
142
{
143
  GimpInk *ink = GIMP_INK (paint_core);
144 145

  switch (paint_state)
146
    {
147
    case GIMP_PAINT_STATE_INIT:
Michael Natterer's avatar
Michael Natterer committed
148
      if (paint_core->cur_coords.x == paint_core->last_coords.x &&
149 150
          paint_core->cur_coords.y == paint_core->last_coords.y)
        {
Michael Natterer's avatar
Michael Natterer committed
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
          /*  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);
173
        }
174
      break;
175

176
    case GIMP_PAINT_STATE_MOTION:
177
      gimp_ink_motion (paint_core, drawable, paint_options, time);
178
      break;
179

180
    case GIMP_PAINT_STATE_FINISH:
181 182
      break;
    }
183
}
jtl's avatar
jtl committed
184

185 186 187 188
static TempBuf *
gimp_ink_get_paint_area (GimpPaintCore    *paint_core,
                         GimpDrawable     *drawable,
                         GimpPaintOptions *paint_options)
189
{
Sven Neumann's avatar
Sven Neumann committed
190
  GimpInk *ink = GIMP_INK (paint_core);
191 192 193 194 195
  gint     x, y;
  gint     width, height;
  gint     dwidth, dheight;
  gint     x1, y1, x2, y2;
  gint     bytes;
jtl's avatar
jtl committed
196

197
  bytes = gimp_drawable_bytes_with_alpha (drawable);
198

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

201 202
  dwidth  = gimp_item_get_width  (GIMP_ITEM (drawable));
  dheight = gimp_item_get_height (GIMP_ITEM (drawable));
203

204 205 206 207
  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);
208

209 210 211 212 213 214 215
  /*  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
216

217
  return paint_core->canvas_buf;
218
}
219

220 221 222 223 224 225 226 227 228 229 230 231
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);
}

232
static void
233 234 235 236
gimp_ink_motion (GimpPaintCore    *paint_core,
                 GimpDrawable     *drawable,
                 GimpPaintOptions *paint_options,
                 guint32           time)
237
{
238 239 240
  GimpInk        *ink     = GIMP_INK (paint_core);
  GimpInkOptions *options = GIMP_INK_OPTIONS (paint_options);
  GimpContext    *context = GIMP_CONTEXT (paint_options);
241
  GimpImage      *image;
242 243
  Blob           *blob_union = NULL;
  Blob           *blob_to_render;
244 245 246
  TempBuf        *area;
  guchar          col[MAX_CHANNELS];
  PixelRegion     blob_maskPR;
247

248
  image = gimp_item_get_image (GIMP_ITEM (drawable));
249

250 251 252 253 254 255 256 257
  if (! ink->last_blob)
    {
      ink->last_blob = ink_pen_ellipse (options,
                                        paint_core->cur_coords.x,
                                        paint_core->cur_coords.y,
                                        paint_core->cur_coords.pressure,
                                        paint_core->cur_coords.xtilt,
                                        paint_core->cur_coords.ytilt,
258
                                        100);
259

Michael Natterer's avatar
Michael Natterer committed
260 261 262 263 264
      if (ink->start_blob)
        g_free (ink->start_blob);

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

265
      blob_to_render = ink->last_blob;
266 267 268
    }
  else
    {
Sven Neumann's avatar
Sven Neumann committed
269 270 271 272 273 274 275
      Blob *blob = ink_pen_ellipse (options,
                                    paint_core->cur_coords.x,
                                    paint_core->cur_coords.y,
                                    paint_core->cur_coords.pressure,
                                    paint_core->cur_coords.xtilt,
                                    paint_core->cur_coords.ytilt,
                                    paint_core->cur_coords.velocity * 100);
276 277

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

279 280
      g_free (ink->last_blob);
      ink->last_blob = blob;
281

282 283
      blob_to_render = blob_union;
    }
284

285
  /* Get the buffer */
Michael Natterer's avatar
Michael Natterer committed
286
  ink->cur_blob = blob_to_render;
287
  area = gimp_paint_core_get_paint_area (paint_core, drawable, paint_options);
Michael Natterer's avatar
Michael Natterer committed
288 289
  ink->cur_blob = NULL;

290 291
  if (! area)
    return;
jtl's avatar
jtl committed
292

293 294
  gimp_image_get_foreground (image, context, gimp_drawable_type (drawable),
                             col);
295

296 297
  /*  set the alpha channel  */
  col[paint_core->canvas_buf->bytes - 1] = OPAQUE_OPACITY;
298

299
  /*  color the pixels  */
300
  color_pixels (temp_buf_get_data (paint_core->canvas_buf), col,
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
                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);

317
  render_blob (blob_to_render, &blob_maskPR);
318 319 320 321 322 323 324 325 326 327 328 329 330 331

  /*  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);
332

333 334
  if (blob_union)
    g_free (blob_union);
335 336 337
}

static Blob *
338 339
ink_pen_ellipse (GimpInkOptions *options,
                 gdouble         x_center,
340 341 342 343 344
                 gdouble         y_center,
                 gdouble         pressure,
                 gdouble         xtilt,
                 gdouble         ytilt,
                 gdouble         velocity)
345
{
346
  BlobFunc blob_function;
347 348 349 350 351 352 353
  gdouble  size;
  gdouble  tsin, tcos;
  gdouble  aspect, radmin;
  gdouble  x,y;
  gdouble  tscale;
  gdouble  tscale_c;
  gdouble  tscale_s;
354

355 356
  /* Adjust the size depending on pressure. */

357
  size = options->size * (1.0 + options->size_sensitivity *
358
                          (2.0 * pressure - 1.0));
359

360 361 362 363
  /* Adjust the size further depending on pointer velocity and
   * velocity-sensitivity.  These 'magic constants' are 'feels
   * natural' tigert-approved. --ADM
   */
364 365 366 367 368

  if (velocity < 3.0)
    velocity = 3.0;

#ifdef VERBOSE
369
  g_printerr ("%g (%g) -> ", size, velocity);
370
#endif
371

372 373 374
  size = (options->vel_sensitivity *
          ((4.5 * size) / (1.0 + options->vel_sensitivity * (2.0 * velocity)))
          + (1.0 - options->vel_sensitivity) * size);
375 376

#ifdef VERBOSE
377
  g_printerr ("%g\n", (gfloat) size);
378 379 380 381
#endif

  /* Clamp resulting size to sane limits */

382 383
  if (size > options->size * (1.0 + options->size_sensitivity))
    size = options->size * (1.0 + options->size_sensitivity);
384

385 386
  if (size * SUBSAMPLE < 1.0)
    size = 1.0 / SUBSAMPLE;
387 388

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

Raph Levien's avatar
Raph Levien committed
390
  /* I'm not happy with the way the brush widget info is combined with
391 392 393 394
   * 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
395

396
  tscale   = options->tilt_sensitivity * 10.0;
397 398 399
  tscale_c = tscale * cos (gimp_deg_to_rad (options->tilt_angle));
  tscale_s = tscale * sin (gimp_deg_to_rad (options->tilt_angle));

400
  x = (options->blob_aspect * cos (options->blob_angle) +
401
       xtilt * tscale_c - ytilt * tscale_s);
402
  y = (options->blob_aspect * sin (options->blob_angle) +
403 404
       ytilt * tscale_c + xtilt * tscale_s);

Raph Levien's avatar
Raph Levien committed
405
#ifdef VERBOSE
406 407 408
  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
409
#endif
410

Sven Neumann's avatar
Sven Neumann committed
411
  aspect = sqrt (SQR (x) + SQR (y));
412 413 414

  if (aspect != 0)
    {
415 416
      tcos = x / aspect;
      tsin = y / aspect;
417 418 419
    }
  else
    {
420 421 422 423 424 425 426 427 428 429 430
      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:
431
      blob_function = blob_ellipse;
432 433 434
      break;

    case GIMP_INK_BLOB_TYPE_SQUARE:
435
      blob_function = blob_square;
436 437 438
      break;

    case GIMP_INK_BLOB_TYPE_DIAMOND:
439 440 441 442 443
      blob_function = blob_diamond;
      break;

    default:
      g_return_val_if_reached (NULL);
444
      break;
445
    }
446

447 448 449 450 451 452
  return (* blob_function) (x_center * SUBSAMPLE,
                            y_center * SUBSAMPLE,
                            radmin * aspect * tcos,
                            radmin * aspect * tsin,
                            -radmin * tsin,
                            radmin * tcos);
453 454
}

455

456 457 458
/*********************************/
/*  Rendering functions          */
/*********************************/
459

460
/* Some of this stuff should probably be combined with the
461 462 463 464 465 466 467 468
 * 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
469 470 471 472 473
enum
{
  ROW_START,
  ROW_STOP
};
474 475 476 477

/* The insertion sort here, for SUBSAMPLE = 8, tends to beat out
 * qsort() by 4x with CFLAGS=-O2, 2x with CFLAGS=-g
 */
478 479
static void
insert_sort (gint *data,
480
             gint  n)
481
{
482
  gint i, j, k;
483

484
  for (i = 2; i < 2 * n; i += 2)
485
    {
Sven Neumann's avatar
Sven Neumann committed
486 487 488
      gint tmp1 = data[i];
      gint tmp2 = data[i + 1];

489
      j = 0;
Sven Neumann's avatar
Sven Neumann committed
490

491
      while (data[j] < tmp1)
492
        j += 2;
493

494
      for (k = i; k > j; k -= 2)
495 496 497 498
        {
          data[k]     = data[k - 2];
          data[k + 1] = data[k - 1];
        }
499

500 501
      data[j]     = tmp1;
      data[j + 1] = tmp2;
502 503 504 505 506
    }
}

static void
fill_run (guchar *dest,
507 508
          guchar  alpha,
          gint    w)
509 510 511 512 513 514 515 516
{
  if (alpha == 255)
    {
      memset (dest, 255, w);
    }
  else
    {
      while (w--)
517 518 519 520
        {
          *dest = MAX (*dest, alpha);
          dest++;
        }
521 522 523 524
    }
}

static void
525
render_blob_line (Blob   *blob,
526 527 528 529
                  guchar *dest,
                  gint    x,
                  gint    y,
                  gint    width)
530
{
531 532 533
  gint  buf[4 * SUBSAMPLE];
  gint *data    = buf;
  gint  n       = 0;
534 535
  gint  i, j;
  gint  current = 0;  /* number of filled rows at this point
536 537
                       * in the scan line
                       */
538
  gint last_x;
539 540

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

542
  j = y * SUBSAMPLE - blob->y;
543
  for (i = 0; i < SUBSAMPLE; i++)
544 545
    {
      if (j >= blob->height)
546
        break;
547

548
      if ((j > 0) && (blob->data[j].left <= blob->data[j].right))
549 550 551 552 553 554 555
        {
          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++;
        }
556 557 558 559 560 561
      j++;
    }

  /*   If we have less than SUBSAMPLE rows, compress */
  if (n < SUBSAMPLE)
    {
562
      for (i = 0; i < 2 * n; i++)
563
        data[2 * n + i] = data[2 * SUBSAMPLE + i];
564 565 566 567 568 569 570 571 572 573 574 575
    }

  /*   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)
576
        current++;
577
      else
578
        current--;
579 580 581 582 583 584
      data += 2;
      n--;
    }

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

586 587 588
  /* Render the row */

  last_x = 0;
589
  for (i = 0; i < n;)
590
    {
591
      gint cur_x = data[2 * i] / SUBSAMPLE - x;
592
      gint pixel;
593 594 595

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

      /* Compute the value for this pixel */
599
      pixel = current * SUBSAMPLE;
600 601

      while (i<n)
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
        {
          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++;
        }
621

622
      dest[cur_x] = MAX (dest[cur_x], (pixel * 255) / (SUBSAMPLE * SUBSAMPLE));
623 624 625 626 627

      last_x = cur_x + 1;
    }

  if (current != 0)
628
    fill_run (dest + last_x, (255 * current)/ SUBSAMPLE, width - last_x);
629 630 631
}

static void
632 633
render_blob (Blob        *blob,
             PixelRegion *dest)
634
{
635
  gpointer  pr;
636

637 638
  for (pr = pixel_regions_register (1, dest);
       pr != NULL;
639 640
       pr = pixel_regions_process (pr))
    {
Sven Neumann's avatar
Sven Neumann committed
641 642 643
      guchar *d = dest->data;
      gint    h = dest->h;
      gint    y;
644

Sven Neumann's avatar
Sven Neumann committed
645
      for (y = 0; y < h; y++, d += dest->rowstride)
646
        {
Sven Neumann's avatar
Sven Neumann committed
647
          render_blob_line (blob, d, dest->x, dest->y + y, dest->w);
648
        }
649 650
    }
}