]> Pileus Git - ~andy/gtk/blobdiff - gdk/gdkpixbuf-render.c
Make GTK+ use an external gdk-pixbuf
[~andy/gtk] / gdk / gdkpixbuf-render.c
index 5496aeb5dd82d02eb389c396fb270b8fbb9ebd46..614719a82fda8d6aa09849faa494837e1673eeac 100644 (file)
@@ -5,25 +5,28 @@
  * Author: Federico Mena-Quintero <federico@gimp.org>
  *
  * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public
+ * 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.
+ * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU Library General Public
+ * 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 "config.h"
 #include <gdk/gdk.h>
-#include <libart_lgpl/art_rect.h>
-#include "gdk-pixbuf.h"
+#include <gdk-pixbuf/gdk-pixbuf.h>
+#include "gdkpixbuf.h"
+#include "gdkscreen.h"
+#include "gdkinternals.h"
+#include "gdkalias.h"
 
 \f
 
@@ -35,8 +38,8 @@
  * @src_y: source Y coordinate.
  * @dest_x: Destination X coordinate.
  * @dest_y: Destination Y coordinate.
- * @width: Width of region to threshold.
- * @height: Height of region to threshold.
+ * @width: Width of region to threshold, or -1 to use pixbuf width
+ * @height: Height of region to threshold, or -1 to use pixbuf height
  * @alpha_threshold: Opacity values below this will be painted as zero; all
  * other values will be painted as one.
  *
  *
  **/
 void
-gdk_pixbuf_render_threshold_alpha (GdkPixbuf *pixbuf, GdkBitmap *bitmap,
-                                  int src_x, int src_y,
+gdk_pixbuf_render_threshold_alpha (GdkPixbuf *pixbuf,
+                                  GdkBitmap *bitmap,
+                                  int src_x,  int src_y,
                                   int dest_x, int dest_y,
-                                  int width, int height,
+                                  int width,  int height,
                                   int alpha_threshold)
 {
-       ArtPixBuf *apb;
-       GdkGC *gc;
-       GdkColor color;
-       int x, y;
-       guchar *p;
-       int start, start_status;
-       int status;
-
-       g_return_if_fail (pixbuf != NULL);
-       apb = pixbuf->art_pixbuf;
-
-       g_return_if_fail (apb->format == ART_PIX_RGB);
-       g_return_if_fail (apb->n_channels == 3 || apb->n_channels == 4);
-       g_return_if_fail (apb->bits_per_sample == 8);
-
-       g_return_if_fail (bitmap != NULL);
-       g_return_if_fail (src_x >= 0 && src_x + width <= apb->width);
-       g_return_if_fail (src_y >= 0 && src_y + height <= apb->height);
-
-       g_return_if_fail (alpha_threshold >= 0 && alpha_threshold <= 255);
-
-       gc = gdk_gc_new (bitmap);
-
-       if (!apb->has_alpha) {
-               color.pixel = (alpha_threshold == 255) ? 0 : 1;
-               gdk_gc_set_foreground (gc, &color);
-               gdk_draw_rectangle (bitmap, gc, TRUE, dest_x, dest_y, width, height);
-               gdk_gc_unref (gc);
-               return;
+  GdkGC *gc;
+  GdkColor color;
+  int x, y;
+  guchar *p;
+  int start, start_status;
+  int status;
+
+  g_return_val_if_fail (gdk_pixbuf_get_colorspace (pixbuf) == GDK_COLORSPACE_RGB, NULL);
+  g_return_val_if_fail (gdk_pixbuf_get_n_channels (pixbuf) == 3 ||
+                        gdk_pixbuf_get_n_channels (pixbuf) == 4, NULL);
+  g_return_val_if_fail (gdk_pixbuf_get_bits_per_sample (pixbuf) == 8, NULL);
+
+  if (width == -1) 
+    width = gdk_pixbuf_get_width (pixbuf);
+  if (height == -1)
+    height = gdk_pixbuf_get_height (pixbuf);
+
+  g_return_if_fail (bitmap != NULL);
+  g_return_if_fail (width >= 0 && height >= 0);
+  g_return_if_fail (src_x >= 0 && src_x + width <= gdk_pixbuf_get_width (pixbuf));
+  g_return_if_fail (src_y >= 0 && src_y + height <= gdk_pixbuf_get_height (pixbuf));
+
+  g_return_if_fail (alpha_threshold >= 0 && alpha_threshold <= 255);
+
+  if (width == 0 || height == 0)
+    return;
+
+  gc = _gdk_drawable_get_scratch_gc (bitmap, FALSE);
+
+  if (!gdk_pixbuf_get_has_alpha (pixbuf))
+    {
+      color.pixel = (alpha_threshold == 255) ? 0 : 1;
+      gdk_gc_set_foreground (gc, &color);
+      gdk_draw_rectangle (bitmap, gc, TRUE, dest_x, dest_y, width, height);
+      return;
+    }
+
+  color.pixel = 0;
+  gdk_gc_set_foreground (gc, &color);
+  gdk_draw_rectangle (bitmap, gc, TRUE, dest_x, dest_y, width, height);
+
+  color.pixel = 1;
+  gdk_gc_set_foreground (gc, &color);
+
+  for (y = 0; y < height; y++)
+    {
+      p = (gdk_pixbuf_get_pixels (pixbuf) + (y + src_y) * gdk_pixbuf_get_rowstride (pixbuf) + src_x * gdk_pixbuf_get_n_channels (pixbuf)
+          + gdk_pixbuf_get_n_channels (pixbuf) - 1);
+           
+      start = 0;
+      start_status = *p < alpha_threshold;
+           
+      for (x = 0; x < width; x++)
+       {
+         status = *p < alpha_threshold;
+         
+         if (status != start_status)
+           {
+             if (!start_status)
+               gdk_draw_line (bitmap, gc,
+                              start + dest_x, y + dest_y,
+                              x - 1 + dest_x, y + dest_y);
+             
+             start = x;
+             start_status = status;
+           }
+         
+         p += gdk_pixbuf_get_n_channels (pixbuf);
        }
-
-       color.pixel = 0;
-       gdk_gc_set_foreground (gc, &color);
-       gdk_draw_rectangle (bitmap, gc, TRUE, dest_x, dest_y, width, height);
-
-       color.pixel = 1;
-       gdk_gc_set_foreground (gc, &color);
-
-       for (y = 0; y < height; y++) {
-               p = (apb->pixels + (y + src_y) * apb->rowstride + src_x * apb->n_channels
-                    + apb->n_channels - 1);
-
-               start = 0;
-               start_status = *p < alpha_threshold;
-
-               for (x = 0; x < width; x++) {
-                       status = *p < alpha_threshold;
-
-                       if (status != start_status) {
-                               if (!start_status)
-                                       gdk_draw_line (bitmap, gc,
-                                                      start + dest_x, y + dest_y,
-                                                      x - 1 + dest_x, y + dest_y);
-
-                               start = x;
-                               start_status = status;
-                       }
-
-                       p += apb->n_channels;
-               }
-
-               if (!start_status)
-                       gdk_draw_line (bitmap, gc,
-                                      start + dest_x, y + dest_y,
-                                      x - 1 + dest_x, y + dest_y);
-       }
-
-       gdk_gc_unref (gc);
-}
-
-\f
-
-/* Creates a buffer by stripping the alpha channel of a pixbuf */
-static guchar *
-remove_alpha (ArtPixBuf *apb, int x, int y, int width, int height, int *rowstride)
-{
-       guchar *buf;
-       int xx, yy;
-       guchar *src, *dest;
-
-       g_assert (apb->n_channels == 4);
-       g_assert (apb->has_alpha);
-       g_assert (x >= 0 && x + width <= apb->width);
-       g_assert (y >= 0 && y + height <= apb->height);
-
-       *rowstride = 4 * ((width * 3 + 3) / 4);
-
-       buf = g_new (guchar, *rowstride * height);
-
-       for (yy = 0; yy < height; yy++) {
-               src = apb->pixels + apb->rowstride * (yy + y) + x * apb->n_channels;
-               dest = buf + *rowstride * yy;
-
-               for (xx = 0; xx < width; xx++) {
-                       *dest++ = *src++;
-                       *dest++ = *src++;
-                       *dest++ = *src++;
-                       src++;
-               }
-       }
-
-       return buf;
+      
+      if (!start_status)
+       gdk_draw_line (bitmap, gc,
+                      start + dest_x, y + dest_y,
+                      x - 1 + dest_x, y + dest_y);
+    }
 }
 
 /**
- * gdk_pixbuf_render_to_drawable:
+ * gdk_pixbuf_render_pixmap_and_mask:
  * @pixbuf: A pixbuf.
- * @drawable: Destination drawable.
- * @gc: GC used for rendering.
- * @src_x: Source X coordinate within pixbuf.
- * @src_y: Source Y coordinate within pixbuf.
- * @dest_x: Destination X coordinate within drawable.
- * @dest_y: Destination Y coordinate within drawable.
- * @width: Width of region to render, in pixels.
- * @height: Height of region to render, in pixels.
- * @dither: Dithering mode for GdkRGB.
- * @x_dither: X offset for dither.
- * @y_dither: Y offset for dither.
- * 
- * Renders a rectangular portion of a pixbuf to a drawable while using the
- * specified GC.  This is done using GdkRGB, so the specified drawable must have
- * the GdkRGB visual and colormap.  Note that this function will ignore the
- * opacity information for images with an alpha channel; the GC must already
- * have the clipping mask set if you want transparent regions to show through.
+ * @pixmap_return: Location to store a pointer to the created pixmap,
+ *   or %NULL if the pixmap is not needed.
+ * @mask_return: Location to store a pointer to the created mask,
+ *   or %NULL if the mask is not needed.
+ * @alpha_threshold: Threshold value for opacity values.
  *
- * For an explanation of dither offsets, see the GdkRGB documentation.  In
- * brief, the dither offset is important when re-rendering partial regions of an
- * image to a rendered version of the full image, or for when the offsets to a
- * base position change, as in scrolling.  The dither matrix has to be shifted
- * for consistent visual results.  If you do not have any of these cases, the
- * dither offsets can be both zero.
+ * Creates a pixmap and a mask bitmap which are returned in the @pixmap_return
+ * and @mask_return arguments, respectively, and renders a pixbuf and its
+ * corresponding thresholded alpha mask to them.  This is merely a convenience
+ * function; applications that need to render pixbufs with dither offsets or to
+ * given drawables should use gdk_draw_pixbuf() and gdk_pixbuf_render_threshold_alpha().
+ *
+ * The pixmap that is created is created for the colormap returned
+ * by gdk_rgb_get_colormap(). You normally will want to instead use
+ * the actual colormap for a widget, and use
+ * gdk_pixbuf_render_pixmap_and_mask_for_colormap().
+ *
+ * If the pixbuf does not have an alpha channel, then *@mask_return will be set
+ * to %NULL.
  **/
 void
-gdk_pixbuf_render_to_drawable (GdkPixbuf *pixbuf,
-                              GdkDrawable *drawable, GdkGC *gc,
-                              int src_x, int src_y,
-                              int dest_x, int dest_y,
-                              int width, int height,
-                              GdkRgbDither dither,
-                              int x_dither, int y_dither)
+gdk_pixbuf_render_pixmap_and_mask (GdkPixbuf  *pixbuf,
+                                  GdkPixmap **pixmap_return,
+                                  GdkBitmap **mask_return,
+                                  int         alpha_threshold)
 {
-       ArtPixBuf *apb;
-       guchar *buf;
-       int rowstride;
-
-       g_return_if_fail (pixbuf != NULL);
-       apb = pixbuf->art_pixbuf;
-       
-       g_return_if_fail (apb->format == ART_PIX_RGB);
-       g_return_if_fail (apb->n_channels == 3 || apb->n_channels == 4);
-       g_return_if_fail (apb->bits_per_sample == 8);
-
-       g_return_if_fail (drawable != NULL);
-       g_return_if_fail (gc != NULL);
-
-       g_return_if_fail (src_x >= 0 && src_x + width <= apb->width);
-       g_return_if_fail (src_y >= 0 && src_y + height <= apb->height);
-
-       /* This will have to be modified once libart supports other image types.
-        * Also, GdkRGB does not have gdk_draw_rgb_32_image_dithalign(), so we
-        * have to pack the buffer first.
-        */
-
-       if (apb->has_alpha)
-               buf = remove_alpha (apb, src_x, src_y, width, height, &rowstride);
-       else {
-               buf = apb->pixels + src_y * apb->rowstride + src_x * 3;
-               rowstride = apb->rowstride;
-       }
-
-       gdk_draw_rgb_image_dithalign (drawable, gc,
-                                     dest_x, dest_y,
-                                     width, height,
-                                     dither,
-                                     buf, rowstride,
-                                     x_dither, y_dither);
-
-       if (apb->has_alpha)
-               g_free (buf);
+  gdk_pixbuf_render_pixmap_and_mask_for_colormap (pixbuf,
+                                                 gdk_rgb_get_colormap (),
+                                                 pixmap_return, mask_return,
+                                                 alpha_threshold);
 }
 
-\f
-
 /**
- * gdk_pixbuf_render_to_drawable_alpha:
+ * gdk_pixbuf_render_pixmap_and_mask_for_colormap:
  * @pixbuf: A pixbuf.
- * @drawable: Destination drawable.
- * @src_x: Source X coordinate within pixbuf.
- * @src_y: Source Y coordinates within pixbuf.
- * @dest_x: Destination X coordinate within drawable.
- * @dest_y: Destination Y coordinate within drawable.
- * @width: Width of region to render, in pixels.
- * @height: Height of region to render, in pixels.
- * @alpha_mode: If the image does not have opacity information, this is ignored.
- * Otherwise, specifies how to handle transparency when rendering.
- * @alpha_threshold: If the image does have opacity information and @alpha_mode
- * is GDK_PIXBUF_ALPHA_BILEVEL, specifies the threshold value for opacity
- * values.
- * @dither: Dithering mode for GdkRGB.
- * @x_dither: X offset for dither.
- * @y_dither: Y offset for dither.
+ * @colormap: A #GdkColormap
+ * @pixmap_return: Location to store a pointer to the created pixmap,
+ *   or %NULL if the pixmap is not needed.
+ * @mask_return: Location to store a pointer to the created mask,
+ *   or %NULL if the mask is not needed.
+ * @alpha_threshold: Threshold value for opacity values.
+ *
+ * Creates a pixmap and a mask bitmap which are returned in the @pixmap_return
+ * and @mask_return arguments, respectively, and renders a pixbuf and its
+ * corresponding tresholded alpha mask to them.  This is merely a convenience
+ * function; applications that need to render pixbufs with dither offsets or to
+ * given drawables should use gdk_draw_pixbuf(), and gdk_pixbuf_render_threshold_alpha().
  *
- * Renders a rectangular portion of a pixbuf to a drawable.  This is done using
- * GdkRGB, so the specified drawable must have the GdkRGB visual and colormap.
+ * The pixmap that is created uses the #GdkColormap specified by @colormap.
+ * This colormap must match the colormap of the window where the pixmap
+ * will eventually be used or an error will result.
  *
- * When used with #GDK_PIXBUF_ALPHA_BILEVEL, this function has to create a bitmap
- * out of the thresholded alpha channel of the image and, it has to set this
- * bitmap as the clipping mask for the GC used for drawing.  This can be a
- * significant performance penalty depending on the size and the complexity of
- * the alpha channel of the image.  If performance is crucial, consider handling
- * the alpha channel yourself (possibly by caching it in your application) and
- * using gdk_pixbuf_render_to_drawable() or GdkRGB directly instead.
+ * If the pixbuf does not have an alpha channel, then *@mask_return will be set
+ * to %NULL.
  **/
 void
-gdk_pixbuf_render_to_drawable_alpha (GdkPixbuf *pixbuf, GdkDrawable *drawable,
-                                    int src_x, int src_y,
-                                    int dest_x, int dest_y,
-                                    int width, int height,
-                                    GdkPixbufAlphaMode alpha_mode,
-                                    int alpha_threshold,
-                                    GdkRgbDither dither,
-                                    int x_dither, int y_dither)
+gdk_pixbuf_render_pixmap_and_mask_for_colormap (GdkPixbuf   *pixbuf,
+                                               GdkColormap *colormap,
+                                               GdkPixmap  **pixmap_return,
+                                               GdkBitmap  **mask_return,
+                                               int          alpha_threshold)
 {
-       ArtPixBuf *apb;
-       GdkBitmap *bitmap = NULL;
-       GdkGC *gc;
-
-       g_return_if_fail (pixbuf != NULL);
-       apb = pixbuf->art_pixbuf;
-
-       g_return_if_fail (apb->format == ART_PIX_RGB);
-       g_return_if_fail (apb->n_channels == 3 || apb->n_channels == 4);
-       g_return_if_fail (apb->bits_per_sample == 8);
-
-       g_return_if_fail (drawable != NULL);
-       g_return_if_fail (src_x >= 0 && src_x + width <= apb->width);
-       g_return_if_fail (src_y >= 0 && src_y + height <= apb->height);
-
-       gc = gdk_gc_new (drawable);
-
-       if (apb->has_alpha) {
-               /* Right now we only support GDK_PIXBUF_ALPHA_BILEVEL, so we
-                * unconditionally create the clipping mask.
-                */
-
-               bitmap = gdk_pixmap_new (NULL, width, height, 1);
-               gdk_pixbuf_render_threshold_alpha (pixbuf, bitmap,
-                                                  src_x, src_y,
-                                                  0, 0,
-                                                  width, height,
-                                                  alpha_threshold);
-
-               gdk_gc_set_clip_mask (gc, bitmap);
-               gdk_gc_set_clip_origin (gc, dest_x, dest_y);
+  GdkScreen *screen;
+
+  g_return_if_fail (GDK_IS_PIXBUF (pixbuf));
+  g_return_if_fail (GDK_IS_COLORMAP (colormap));
+
+  screen = gdk_colormap_get_screen (colormap);
+  
+  if (pixmap_return)
+    {
+      GdkGC *gc;
+      *pixmap_return = gdk_pixmap_new (gdk_screen_get_root_window (screen),
+                                      gdk_pixbuf_get_width (pixbuf), gdk_pixbuf_get_height (pixbuf),
+                                      gdk_colormap_get_visual (colormap)->depth);
+
+      gdk_drawable_set_colormap (GDK_DRAWABLE (*pixmap_return), colormap);
+      gc = _gdk_drawable_get_scratch_gc (*pixmap_return, FALSE);
+
+      /* If the pixbuf has an alpha channel, using gdk_pixbuf_draw would give
+       * random pixel values in the area that are within the mask, but semi-
+       * transparent. So we treat the pixbuf like a pixbuf without alpha channel;
+       * see bug #487865.
+       */
+      if (gdk_pixbuf_get_has_alpha (pixbuf))
+        gdk_draw_rgb_32_image (*pixmap_return, gc,
+                               0, 0,
+                               gdk_pixbuf_get_width (pixbuf), gdk_pixbuf_get_height (pixbuf),
+                               GDK_RGB_DITHER_NORMAL,
+                               gdk_pixbuf_get_pixels (pixbuf), gdk_pixbuf_get_rowstride (pixbuf));
+      else
+        gdk_draw_pixbuf (*pixmap_return, gc, pixbuf, 
+                         0, 0, 0, 0,
+                         gdk_pixbuf_get_width (pixbuf), gdk_pixbuf_get_height (pixbuf),
+                         GDK_RGB_DITHER_NORMAL,
+                         0, 0);
+    }
+  
+  if (mask_return)
+    {
+      if (gdk_pixbuf_get_has_alpha (pixbuf))
+       {
+         *mask_return = gdk_pixmap_new (gdk_screen_get_root_window (screen),
+                                        gdk_pixbuf_get_width (pixbuf), gdk_pixbuf_get_height (pixbuf), 1);
+
+         gdk_pixbuf_render_threshold_alpha (pixbuf, *mask_return,
+                                            0, 0, 0, 0,
+                                            gdk_pixbuf_get_width (pixbuf), gdk_pixbuf_get_height (pixbuf),
+                                            alpha_threshold);
        }
-
-       gdk_pixbuf_render_to_drawable (pixbuf, drawable, gc,
-                                      src_x, src_y,
-                                      dest_x, dest_y,
-                                      width, height,
-                                      dither,
-                                      x_dither, y_dither);
-
-       if (bitmap)
-               gdk_bitmap_unref (bitmap);
-       gdk_gc_unref (gc);
+      else
+       *mask_return = NULL;
+    }
 }
 
-/**
- * gdk_pixbuf_render_pixmap:
- * @pixbuf: A pixbuf
- * @pixmap: A pointer to a pixmap to fill in.
- * @mask_retval: A pointer to the mask to be filled in.
- * @alpha_threshold: Specifies the threshold value for opacity
- * values if the pixbuf has opacity.
- *
- * Generates a #GdkPixmap from a #GdkPixbuf, along with an optional mask.  The
- * alpha threshold can be used to determine how the mask is created, if the
- * pixbuf has an alpha channel.  This function is mainly provided for
- * compatibility reasons, as you will rarely want a #GdkPixmap.
- * 
- **/
-void
-gdk_pixbuf_render_pixmap (GdkPixbuf  *pixbuf,
-                         GdkPixmap **pixmap,
-                         GdkBitmap **mask_retval,
-                         gint        alpha_threshold)
-{
-       GdkBitmap *mask = NULL;
-
-        g_return_if_fail(pixbuf != NULL);
-
-        /* generate mask */
-        if (gdk_pixbuf_get_has_alpha(pixbuf)) {
-                mask = gdk_pixmap_new(NULL,
-                                      gdk_pixbuf_get_width(pixbuf),
-                                      gdk_pixbuf_get_height(pixbuf),
-                                      1);
+#define __GDK_PIXBUF_RENDER_C__
+#include "gdkaliasdef.c"
 
-                gdk_pixbuf_render_threshold_alpha(pixbuf, mask,
-                                                  0, 0, 0, 0,
-                                                  gdk_pixbuf_get_width(pixbuf),
-                                                  gdk_pixbuf_get_height(pixbuf),
-                                                  alpha_threshold);
-        }
-
-        /* Draw to pixmap */
-        if (pixmap != NULL) {
-                GdkGC* gc;
-
-                *pixmap = gdk_pixmap_new(NULL,
-                                         gdk_pixbuf_get_width(pixbuf),
-                                         gdk_pixbuf_get_height(pixbuf),
-                                         gdk_rgb_get_visual()->depth);
-
-                gc = gdk_gc_new(*pixmap);
-
-                gdk_gc_set_clip_mask(gc, mask);
-
-                gdk_pixbuf_render_to_drawable(pixbuf, *pixmap,
-                                              gc,
-                                              0, 0, 0, 0,
-                                              gdk_pixbuf_get_width(pixbuf),
-                                              gdk_pixbuf_get_height(pixbuf),
-                                              GDK_RGB_DITHER_NORMAL,
-                                              0, 0);
-
-                gdk_gc_unref(gc);
-        }
-
-        if (mask_retval)
-                *mask_retval = mask;
-        else
-                gdk_bitmap_unref(mask);
-}