gimppixelfetcher.c 8.49 KB
Newer Older
Manish Singh's avatar
Manish Singh committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
/* LIBGIMP - The GIMP Library
 * Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
 *
 * gimppixelfetcher.c
 *
 * FIXME: fix the following comment:
 * Contains all kinds of miscellaneous routines factored out from different
 * plug-ins. They stay here until their API has crystalized a bit and we can
 * put them into the file where they belong (Maurits Rijk
 * <lpeek.mrijk@consunet.nl> if you want to blame someone for this mess)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#include "config.h"

#include "gimp.h"


struct _GimpPixelFetcher
{
  gint                      col, row;
  gint                      img_width;
  gint                      img_height;
  gint                      sel_x1, sel_y1, sel_x2, sel_y2;
  gint                      img_bpp;
  gint                      tile_width, tile_height;
  guchar                    bg_color[4];
  GimpPixelFetcherEdgeMode  mode;
  GimpDrawable             *drawable;
  GimpTile                 *tile;
  gboolean                  tile_dirty;
  gboolean                  shadow;
};

49 50 51 52 53 54 55 56 57 58

/*  local function prototypes  */

static guchar * gimp_pixel_fetcher_provide_tile (GimpPixelFetcher *pf,
                                                 gint              x,
                                                 gint              y);


/*  public functions  */

59 60 61 62 63 64 65 66 67 68
/**
 * gimp_pixel_fetcher_new:
 * @drawable: the #GimpDrawable the new region will be attached to.
 * @shadow:   a #gboolean indicating whether the region is attached to
 *            the shadow tiles or the real %drawable tiles.
 *
 * Initialize a pixel region from the drawable.
 *
 * Return value: a pointer to a #GimpPixelRgn structure (or NULL).
 **/
Manish Singh's avatar
Manish Singh committed
69
GimpPixelFetcher *
70 71
gimp_pixel_fetcher_new (GimpDrawable *drawable,
                        gboolean      shadow)
Manish Singh's avatar
Manish Singh committed
72 73
{
  GimpPixelFetcher *pf;
74 75 76 77 78 79 80 81 82
  gint              width;
  gint              height;
  gint              bpp;

  g_return_val_if_fail (drawable != NULL, NULL);

  width  = gimp_drawable_width  (drawable->drawable_id);
  height = gimp_drawable_height (drawable->drawable_id);
  bpp    = gimp_drawable_bpp    (drawable->drawable_id);
Manish Singh's avatar
Manish Singh committed
83

84 85 86
  g_return_val_if_fail (width > 0 && height > 0 && bpp > 0, NULL);

  pf = g_new0 (GimpPixelFetcher, 1);
Manish Singh's avatar
Manish Singh committed
87 88 89 90 91 92 93

  gimp_drawable_mask_bounds (drawable->drawable_id,
                             &pf->sel_x1, &pf->sel_y1,
                             &pf->sel_x2, &pf->sel_y2);

  pf->col           = -1;
  pf->row           = -1;
94 95 96
  pf->img_width     = width;
  pf->img_height    = height;
  pf->img_bpp       = bpp;
Manish Singh's avatar
Manish Singh committed
97 98 99 100 101 102 103 104 105 106
  pf->tile_width    = gimp_tile_width ();
  pf->tile_height   = gimp_tile_height ();
  pf->bg_color[0]   = 0;
  pf->bg_color[1]   = 0;
  pf->bg_color[2]   = 0;
  pf->bg_color[3]   = 255;
  pf->mode          = GIMP_PIXEL_FETCHER_EDGE_NONE;
  pf->drawable      = drawable;
  pf->tile          = NULL;
  pf->tile_dirty    = FALSE;
107
  pf->shadow        = shadow;
Manish Singh's avatar
Manish Singh committed
108 109 110 111

  return pf;
}

112 113 114 115 116 117
/**
 * gimp_pixel_fetcher_destroy:
 * @pf: a pointer to a previously initialized #GimpPixelFetcher.
 *
 * Close a previously initializd pixel region.
 **/
118 119 120 121 122 123 124 125 126 127 128
void
gimp_pixel_fetcher_destroy (GimpPixelFetcher *pf)
{
  g_return_if_fail (pf != NULL);

  if (pf->tile)
    gimp_tile_unref (pf->tile, pf->tile_dirty);

  g_free (pf);
}

129 130 131 132 133 134 135
/**
 * gimp_pixel_fetcher_set_edge_mode:
 * @pf:   a pointer to a previously initialized #GimpPixelFetcher.
 * @mode: the new edge mode from #GimpPixelFetcherEdgeMode.
 *
 * Change the edage mode of a previously initialized pixel region.
 **/
Manish Singh's avatar
Manish Singh committed
136 137 138 139
void
gimp_pixel_fetcher_set_edge_mode (GimpPixelFetcher         *pf,
                                  GimpPixelFetcherEdgeMode  mode)
{
140 141
  g_return_if_fail (pf != NULL);

Manish Singh's avatar
Manish Singh committed
142 143 144
  pf->mode = mode;
}

145 146 147 148 149 150 151
/**
 * gimp_pixel_fetcher_set_bg_color:
 * @pf:    a pointer to a previously initialized #GimpPixelFetcher.
 * @color: the color to be used as bg color.
 *
 * Change the background color of a previously initialized pixel region.
 **/
Manish Singh's avatar
Manish Singh committed
152
void
153 154
gimp_pixel_fetcher_set_bg_color (GimpPixelFetcher *pf,
                                 const GimpRGB    *color)
Manish Singh's avatar
Manish Singh committed
155
{
156 157
  g_return_if_fail (pf != NULL);
  g_return_if_fail (color != NULL);
Manish Singh's avatar
Manish Singh committed
158 159 160 161 162

  switch (pf->img_bpp)
    {
    case 2: pf->bg_color[1] = 255;
    case 1:
163
      pf->bg_color[0] = gimp_rgb_intensity_uchar (color);
Manish Singh's avatar
Manish Singh committed
164 165 166 167
      break;

    case 4: pf->bg_color[3] = 255;
    case 3:
168
      gimp_rgb_get_uchar (color,
Manish Singh's avatar
Manish Singh committed
169 170 171 172 173
                          pf->bg_color, pf->bg_color + 1, pf->bg_color + 2);
      break;
    }
}

174 175 176 177 178 179 180 181 182
/**
 * gimp_pixel_fetcher_get_pixel:
 * @pf:    a pointer to a previously initialized #GimpPixelFetcher.
 * @x:     the x coordinate of the pixel to get.
 * @y:     the y coordinate of the pixel to get.
 * @pixel: the memory location where to return the pixel.
 *
 * Get a pixel from the pixel region.
 **/
Manish Singh's avatar
Manish Singh committed
183
void
184
gimp_pixel_fetcher_get_pixel (GimpPixelFetcher *pf,
Manish Singh's avatar
Manish Singh committed
185 186
                              gint              x,
                              gint              y,
187
                              guchar           *pixel)
Manish Singh's avatar
Manish Singh committed
188 189 190 191
{
  guchar *p;
  gint    i;

192 193 194 195 196 197
  g_return_if_fail (pf != NULL);
  g_return_if_fail (pixel != NULL);

  if (pf->mode == GIMP_PIXEL_FETCHER_EDGE_NONE &&
      (x < pf->sel_x1 || x >= pf->sel_x2 ||
       y < pf->sel_y1 || y >= pf->sel_y2))
Manish Singh's avatar
Manish Singh committed
198 199 200 201
    {
      return;
    }

202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
  if (x < 0 || x >= pf->img_width ||
      y < 0 || y >= pf->img_height)
    {
      switch (pf->mode)
        {
        case GIMP_PIXEL_FETCHER_EDGE_WRAP:
          if (x < 0 || x >= pf->img_width)
            {
              x %= pf->img_width;

              if (x < 0)
                x += pf->img_width;
            }

          if (y < 0 || y >= pf->img_height)
            {
              y %= pf->img_height;

              if (y < 0)
                y += pf->img_height;
            }
          break;

        case GIMP_PIXEL_FETCHER_EDGE_SMEAR:
          x = CLAMP (x, 0, pf->img_width - 1);
          y = CLAMP (y, 0, pf->img_height - 1);
          break;

        case GIMP_PIXEL_FETCHER_EDGE_BLACK:
          for (i = 0; i < pf->img_bpp; i++)
            pixel[i] = 0;
          return;

        case GIMP_PIXEL_FETCHER_EDGE_BACKGROUND:
          for (i = 0; i < pf->img_bpp; i++)
            pixel[i] = pf->bg_color[i];
          return;

        default:
          return;
        }
    }

Manish Singh's avatar
Manish Singh committed
245 246 247
  p = gimp_pixel_fetcher_provide_tile (pf, x, y);

  i = pf->img_bpp;
248

Manish Singh's avatar
Manish Singh committed
249
  do
250 251 252
    {
      *pixel++ = *p++;
    }
Manish Singh's avatar
Manish Singh committed
253 254 255
  while (--i);
}

256 257 258 259 260 261 262 263 264
/**
 * gimp_pixel_fetcher_put_pixel:
 * @pf:    a pointer to a previously initialized #GimpPixelFetcher.
 * @x:     the x coordinate of the pixel to set.
 * @y:     the y coordinate of the pixel to set.
 * @pixel: the pixel to set.
 *
 * Set a pixel in the pixel region.
 **/
Manish Singh's avatar
Manish Singh committed
265
void
266
gimp_pixel_fetcher_put_pixel (GimpPixelFetcher *pf,
Manish Singh's avatar
Manish Singh committed
267 268
                              gint              x,
                              gint              y,
269
                              const guchar     *pixel)
Manish Singh's avatar
Manish Singh committed
270 271 272 273
{
  guchar *p;
  gint    i;

274 275 276 277 278
  g_return_if_fail (pf != NULL);
  g_return_if_fail (pixel != NULL);

  if (x < pf->sel_x1 || x >= pf->sel_x2 ||
      y < pf->sel_y1 || y >= pf->sel_y2)
Manish Singh's avatar
Manish Singh committed
279 280 281 282 283 284 285
    {
      return;
    }

  p = gimp_pixel_fetcher_provide_tile (pf, x, y);

  i = pf->img_bpp;
286

Manish Singh's avatar
Manish Singh committed
287
  do
288 289 290
    {
      *p++ = *pixel++;
    }
Manish Singh's avatar
Manish Singh committed
291
  while (--i);
292 293

  pf->tile_dirty = TRUE;
Manish Singh's avatar
Manish Singh committed
294 295 296
}


297
/*  private functions  */
Manish Singh's avatar
Manish Singh committed
298

299 300 301 302
static guchar *
gimp_pixel_fetcher_provide_tile (GimpPixelFetcher *pf,
                                 gint              x,
                                 gint              y)
Manish Singh's avatar
Manish Singh committed
303
{
304 305
  gint col, row;
  gint coloff, rowoff;
Manish Singh's avatar
Manish Singh committed
306

307 308 309 310
  col    = x / pf->tile_width;
  coloff = x % pf->tile_width;
  row    = y / pf->tile_height;
  rowoff = y % pf->tile_height;
Manish Singh's avatar
Manish Singh committed
311

312 313 314 315
  if ((col != pf->col) || (row != pf->row) || (pf->tile == NULL))
    {
      if (pf->tile != NULL)
        gimp_tile_unref (pf->tile, pf->tile_dirty);
Manish Singh's avatar
Manish Singh committed
316

317 318 319
      pf->tile = gimp_drawable_get_tile (pf->drawable, pf->shadow, row, col);
      pf->tile_dirty = FALSE;
      gimp_tile_ref (pf->tile);
Manish Singh's avatar
Manish Singh committed
320

321 322
      pf->col = col;
      pf->row = row;
Manish Singh's avatar
Manish Singh committed
323 324
    }

325
  return pf->tile->data + pf->img_bpp * (pf->tile->ewidth * rowoff + coloff);
Manish Singh's avatar
Manish Singh committed
326
}