bertos/gfx/bitmap.c

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2003, 2004, 2005, 2006 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 1999 Bernie Innocenti <bernie@codewiz.org>
  31  *
  32  * -->
  33  *
  34  * \author Bernie Innocenti <bernie@codewiz.org>
  35  * \author Stefano Fedrigo <aleph@develer.com>
  36  *
  37  * \brief Bitmap manipulation routines.
  38  */
  39
  40 #include "gfx.h"
  41 #include "gfx_p.h"
  42
  43 #include "cfg/cfg_gfx.h"  /* CONFIG_GFX_CLIPPING */
  44 #include <cfg/macros.h>   /* MIN() */
  45 #include <cfg/debug.h>    /* ASSERT() */
  46
  47 #include <cpu/attr.h>     /* CPU_HARVARD */
  48
  49 #include <string.h>     /* memset() */
  50
  51 #if CONFIG_GFX_TEXT
  52 #include <gfx/font.h>   /* default_font */
  53 #endif
  54
  55
  56 /**
  57  * Initialize a Bitmap structure with the provided parameters.
  58  *
  59  * \note The pen position is reset to the origin.
  60  */
  61 void gfx_bitmapInit(Bitmap *bm, uint8_t *raster, coord_t w, coord_t h)
  62 {
  63         bm->raster = raster;
  64         bm->width = w;
  65         bm->height = h;
  66         #if (CONFIG_BITMAP_FMT == BITMAP_FMT_PLANAR_H_MSB)
  67                 bm->stride = (w + 7) / 8;
  68         #elif CONFIG_BITMAP_FMT == BITMAP_FMT_PLANAR_V_LSB
  69                 bm->stride = w;
  70         #else
  71                 #error Unknown value of CONFIG_BITMAP_FMT
  72         #endif /* CONFIG_BITMAP_FMT */
  73         bm->penX = 0;
  74         bm->penY = 0;
  75
  76 #if CONFIG_GFX_TEXT
  77         gfx_setFont(bm, &default_font);
  78         bm->styles = 0;
  79 #endif
  80
  81 #if CONFIG_GFX_CLIPPING
  82         bm->cr.xmin = 0;
  83         bm->cr.ymin = 0;
  84         bm->cr.xmax = w;
  85         bm->cr.ymax = h;
  86 #endif /* CONFIG_GFX_CLIPPING */
  87 }
  88
  89
  90 /**
  91  * Clear the whole bitmap surface to the background color.
  92  *
  93  * \note This function does \b not update the current pen position.
  94  * \note This function bypasses the current clipping area.
  95  */
  96 void gfx_bitmapClear(Bitmap *bm)
  97 {
  98         memset(bm->raster, 0, RAST_SIZE(bm->width, bm->height));
  99 }
 100
 101
 102 #if CPU_HARVARD
 103
 104 #include <avr/pgmspace.h> /* FIXME: memcpy_P() */
 105
 106 /**
 107  * Copy a raster picture located in program memory in the bitmap.
 108  * The size of the raster to copy *must* be the same of the raster bitmap.
 109  *
 110  * \note This function does \b not update the current pen position
 111  */
 112 void gfx_blit_P(Bitmap *bm, const pgm_uint8_t *raster)
 113 {
 114         memcpy_P(bm->raster, raster, RAST_SIZE(bm->width, bm->height));
 115 }
 116 #endif /* CPU_HARVARD */
 117
 118 #if CONFIG_GFX_CLIPPING
 119         /**
 120          * Clip destination coordinates inside a clipping range.
 121          *
 122          * This macro helps a drawing operation to adjust its
 123          * destination X and Y coordinates inside the destination
 124          * clipping range.
 125          *
 126          * The source start coordinate is adjusted as well
 127          * when destination start clipping occurs.
 128          */
 129         #define gfx_clip(dmin, dmax, smin, cmin, cmax) \
 130                 do { \
 131                         if ((dmin) < (cmin)) \
 132                         { \
 133                                 (smin) += (cmin) - (dmin); \
 134                                 (dmin) = (cmin); \
 135                         } \
 136                         (dmax) = MIN((dmax), (cmax)); \
 137                 } while(0)
 138
 139 #else /* !CONFIG_GFX_CLIPPING */
 140
 141         #define gfx_clip(dmin, dmax, smin, cmin, cmax) do { } while (0)
 142
 143 #endif /* !CONFIG_GFX_CLIPPING */
 144
 145
 146 /**
 147  * Copy a rectangular area of a bitmap on another bitmap.
 148  *
 149  * Blitting is a common copy operation involving two bitmaps.
 150  * A rectangular area of the source bitmap is copied bit-wise
 151  * to a different position in the destination bitmap.
 152  *
 153  * \note Using the same bitmap for \a src and \a dst is unsupported.
 154  *
 155  * \param dst  Bitmap where the operation writes.
 156  * \param rect The (xmin;ymin) coordinates provide the top/left offset
 157  *             for drawing in the destination bitmap.  If the source
 158  *             bitmap is larger than the rectangle, drawing is clipped.
 159  * \param src  Bitmap containing the source pixels.
 160  * \param srcx Starting X offset in the source bitmap.
 161  * \param srcy Starting Y offset in the source bitmap.
 162  */
 163 void gfx_blit(Bitmap *dst, const Rect *rect, const Bitmap *src, coord_t srcx, coord_t srcy)
 164 {
 165         coord_t dxmin, dymin, dxmax, dymax;
 166         coord_t dx, dy, sx, sy;
 167
 168         /*
 169          * Pre-clip coordinates inside src->width/height.
 170          */
 171         dxmin = rect->xmin;
 172         dymin = rect->ymin;
 173         dxmax = MIN(rect->xmax, rect->xmin + src->width);
 174         dymax = MIN(rect->ymax, rect->ymin + src->height);
 175
 176         /* Perform regular clipping */
 177         gfx_clip(dxmin, dxmax, srcx, dst->cr.xmin, dst->cr.xmax);
 178         gfx_clip(dymin, dymax, srcy, dst->cr.ymin, dst->cr.ymax);
 179
 180         //kprintf("dxmin=%d, sxmin=%d, dxmax=%d; ", dxmin, sxmin, dxmax);
 181         //kprintf("dymin=%d, symin=%d, dymax=%d\n", dymin, symin, dymax);
 182
 183         /* TODO: make it not as dog slow as this */
 184         for (dx = dxmin, sx = srcx; dx < dxmax; ++dx, ++sx)
 185                 for (dy = dymin, sy = srcy; dy < dymax; ++dy, ++sy)
 186                         BM_DRAWPIXEL(dst, dx, dy, BM_READPIXEL(src, sx, sy));
 187 }
 188
 189 /**
 190  * Blit a raster to a Bitmap.
 191  *
 192  * \todo Merge this function into gfx_blit()
 193  *
 194  * \see gfx_blit()
 195  */
 196 void gfx_blitRaster(Bitmap *dst, coord_t dxmin, coord_t dymin,
 197                 const uint8_t *raster, coord_t w, coord_t h, coord_t stride)
 198 {
 199         coord_t dxmax = dxmin + w, dymax = dymin + h;
 200         coord_t sxmin = 0, symin = 0;
 201         coord_t dx, dy, sx, sy;
 202
 203         /* Perform regular clipping */
 204         gfx_clip(dxmin, dxmax, sxmin, dst->cr.xmin, dst->cr.xmax);
 205         gfx_clip(dymin, dymax, symin, dst->cr.ymin, dst->cr.ymax);
 206
 207         //kprintf("dxmin=%d, sxmin=%d, dxmax=%d; ", dxmin, sxmin, dxmax);
 208         //kprintf("dymin=%d, symin=%d, dymax=%d\n", dymin, symin, dymax);
 209
 210         /* TODO: make it not as dog slow as this */
 211         for (dx = dxmin, sx = sxmin; dx < dxmax; ++dx, ++sx)
 212                 for (dy = dymin, sy = symin; dy < dymax; ++dy, ++sy)
 213                         BM_DRAWPIXEL(dst, dx, dy, RAST_READPIXEL(raster, sx, sy, stride));
 214 }
 215
 216 /**
 217  * Blit an Image to a Bitmap.
 218  *
 219  * \see gfx_blit()
 220  */
 221 void gfx_blitImage(Bitmap *dst, coord_t dxmin, coord_t dymin, const Image *image)
 222 {
 223         ASSERT(image);
 224
 225         gfx_blitRaster(dst, dxmin, dymin,
 226                         image->raster, image->width, image->height, image->stride);
 227 }
 228
 229
 230 #if CONFIG_GFX_CLIPPING || CONFIG_GFX_VCOORDS
 231
 232 /**
 233  * Set the bitmap clipping rectangle to the specified coordinates.
 234  *
 235  * All drawing performed on the bitmap will be clipped inside this
 236  * rectangle.
 237  *
 238  * The clipping rectangle is also used as a bounding box for the
 239  * logical view of the virtual coordinate system.
 240  *
 241  * \note Following the convention used for all other operations, the
 242  *       top-left pixels of the rectangle are included, while the
 243  *       bottom-right pixels are considered outside the clipping region.
 244  *
 245  * \see gfx_setViewRect
 246  */
 247 void gfx_setClipRect(Bitmap *bm, coord_t minx, coord_t miny, coord_t maxx, coord_t maxy)
 248 {
 249         ASSERT(minx < maxx);
 250         ASSERT(miny < maxy);
 251         ASSERT(miny >= 0);
 252         ASSERT(minx >= 0);
 253         ASSERT(maxx <= bm->width);
 254         ASSERT(maxy <= bm->height);
 255
 256         bm->cr.xmin = minx;
 257         bm->cr.ymin = miny;
 258         bm->cr.xmax = maxx;
 259         bm->cr.ymax = maxy;
 260
 261 //      kprintf("cr.xmin = %d, cr.ymin = %d, cr.xmax = %d, cr.ymax = %d\n",
 262 //              bm->cr.xMin, bm->cr.ymin, bm->cr.xmax, bm->cr.ymax);
 263 }
 264
 265 #endif /* CONFIG_GFX_CLIPPING */
 266