OpenModem/bertos/gfx/bitmap.c

/**
 * \file
 * <!--
 * This file is part of BeRTOS.
 *
 * Bertos is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (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
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * As a special exception, you may use this file as part of a free software
 * library without restriction.  Specifically, if other files instantiate
 * templates or use macros or inline functions from this file, or you compile
 * this file and link it with other files to produce an executable, this
 * file does not by itself cause the resulting executable to be covered by
 * the GNU General Public License.  This exception does not however
 * invalidate any other reasons why the executable file might be covered by
 * the GNU General Public License.
 *
 * Copyright 2003, 2004, 2005, 2006 Develer S.r.l. (http://www.develer.com/)
 * Copyright 1999 Bernie Innocenti <bernie@codewiz.org>
 *
 * -->
 *
 * \author Bernie Innocenti <bernie@codewiz.org>
 * \author Stefano Fedrigo <aleph@develer.com>
 *
 * \brief Bitmap manipulation routines.
 * \sa gfx.h
 */

#include "gfx.h"
#include "gfx_p.h"

#include "cfg/cfg_gfx.h"  /* CONFIG_GFX_CLIPPING */
#include <cfg/macros.h>   /* MIN() */
#include <cfg/debug.h>    /* ASSERT() */

#include <cpu/attr.h>     /* CPU_HARVARD */

#include <string.h>     /* memset() */

#if CONFIG_GFX_TEXT
#include <gfx/font.h>   /* default_font */
#endif


/**
 * Initialize a Bitmap structure with the provided parameters.
 *
 * \note The pen position is reset to the origin.
 */
void gfx_bitmapInit(Bitmap *bm, uint8_t *raster, coord_t w, coord_t h)
{
	bm->raster = raster;
	bm->width = w;
	bm->height = h;
	#if (CONFIG_BITMAP_FMT == BITMAP_FMT_PLANAR_H_MSB)
		bm->stride = (w + 7) / 8;
	#elif CONFIG_BITMAP_FMT == BITMAP_FMT_PLANAR_V_LSB
		bm->stride = w;
	#else
		#error Unknown value of CONFIG_BITMAP_FMT
	#endif /* CONFIG_BITMAP_FMT */
	bm->penX = 0;
	bm->penY = 0;

#if CONFIG_GFX_TEXT
	gfx_setFont(bm, &default_font);
	bm->styles = 0;
#endif

#if CONFIG_GFX_CLIPPING
	bm->cr.xmin = 0;
	bm->cr.ymin = 0;
	bm->cr.xmax = w;
	bm->cr.ymax = h;
#endif /* CONFIG_GFX_CLIPPING */
}


/**
 * Clear the whole bitmap surface to the background color.
 *
 * \note This function does \b not update the current pen position.
 * \note This function bypasses the current clipping area.
 */
void gfx_bitmapClear(Bitmap *bm)
{
	memset(bm->raster, 0, RAST_SIZE(bm->width, bm->height));
}


#if CPU_HARVARD

#include <avr/pgmspace.h> /* FIXME: memcpy_P() */

/**
 * Copy a raster picture located in program memory in the bitmap.
 * The size of the raster to copy *must* be the same of the raster bitmap.
 *
 * \note This function does \b not update the current pen position
 */
void gfx_blit_P(Bitmap *bm, const pgm_uint8_t *raster)
{
	memcpy_P(bm->raster, raster, RAST_SIZE(bm->width, bm->height));
}
#endif /* CPU_HARVARD */

#if CONFIG_GFX_CLIPPING
	/**
	 * Clip destination coordinates inside a clipping range.
	 *
	 * This macro helps a drawing operation to adjust its
	 * destination X and Y coordinates inside the destination
	 * clipping range.
	 *
	 * The source start coordinate is adjusted as well
	 * when destination start clipping occurs.
	 */
	#define gfx_clip(dmin, dmax, smin, cmin, cmax) \
		do { \
			if ((dmin) < (cmin)) \
			{ \
				(smin) += (cmin) - (dmin); \
				(dmin) = (cmin); \
			} \
			(dmax) = MIN((dmax), (cmax)); \
		} while(0)

#else /* !CONFIG_GFX_CLIPPING */

	#define gfx_clip(dmin, dmax, smin, cmin, cmax) do { } while (0)

#endif /* !CONFIG_GFX_CLIPPING */


/**
 * Copy a rectangular area of a bitmap on another bitmap.
 *
 * Blitting is a common copy operation involving two bitmaps.
 * A rectangular area of the source bitmap is copied bit-wise
 * to a different position in the destination bitmap.
 *
 * \note Using the same bitmap for \a src and \a dst is unsupported.
 *
 * \param dst  Bitmap where the operation writes.
 * \param rect The (xmin;ymin) coordinates provide the top/left offset
 *             for drawing in the destination bitmap.  If the source
 *             bitmap is larger than the rectangle, drawing is clipped.
 * \param src  Bitmap containing the source pixels.
 * \param srcx Starting X offset in the source bitmap.
 * \param srcy Starting Y offset in the source bitmap.
 */
void gfx_blit(Bitmap *dst, const Rect *rect, const Bitmap *src, coord_t srcx, coord_t srcy)
{
	coord_t dxmin, dymin, dxmax, dymax;
	coord_t dx, dy, sx, sy;

	/*
	 * Pre-clip coordinates inside src->width/height.
	 */
	dxmin = rect->xmin;
	dymin = rect->ymin;
	dxmax = MIN(rect->xmax, rect->xmin + src->width);
	dymax = MIN(rect->ymax, rect->ymin + src->height);

	/* Perform regular clipping */
	gfx_clip(dxmin, dxmax, srcx, dst->cr.xmin, dst->cr.xmax);
	gfx_clip(dymin, dymax, srcy, dst->cr.ymin, dst->cr.ymax);

	//kprintf("dxmin=%d, sxmin=%d, dxmax=%d; ", dxmin, sxmin, dxmax);
	//kprintf("dymin=%d, symin=%d, dymax=%d\n", dymin, symin, dymax);

	/* TODO: make it not as dog slow as this */
	for (dx = dxmin, sx = srcx; dx < dxmax; ++dx, ++sx)
		for (dy = dymin, sy = srcy; dy < dymax; ++dy, ++sy)
			BM_DRAWPIXEL(dst, dx, dy, BM_READPIXEL(src, sx, sy));
}

/**
 * Blit a raster to a Bitmap.
 *
 * \todo Merge this function into gfx_blit()
 *
 * \see gfx_blit()
 */
void gfx_blitRaster(Bitmap *dst, coord_t dxmin, coord_t dymin,
		const uint8_t *raster, coord_t w, coord_t h, coord_t stride)
{
	coord_t dxmax = dxmin + w, dymax = dymin + h;
	coord_t sxmin = 0, symin = 0;
	coord_t dx, dy, sx, sy;

	/* Perform regular clipping */
	gfx_clip(dxmin, dxmax, sxmin, dst->cr.xmin, dst->cr.xmax);
	gfx_clip(dymin, dymax, symin, dst->cr.ymin, dst->cr.ymax);

	//kprintf("dxmin=%d, sxmin=%d, dxmax=%d; ", dxmin, sxmin, dxmax);
	//kprintf("dymin=%d, symin=%d, dymax=%d\n", dymin, symin, dymax);

	/* TODO: make it not as dog slow as this */
	for (dx = dxmin, sx = sxmin; dx < dxmax; ++dx, ++sx)
		for (dy = dymin, sy = symin; dy < dymax; ++dy, ++sy)
			BM_DRAWPIXEL(dst, dx, dy, RAST_READPIXEL(raster, sx, sy, stride));
}

/**
 * Blit an Image to a Bitmap.
 *
 * \see gfx_blit()
 */
void gfx_blitImage(Bitmap *dst, coord_t dxmin, coord_t dymin, const Image *image)
{
	ASSERT(image);

	gfx_blitRaster(dst, dxmin, dymin,
			image->raster, image->width, image->height, image->stride);
}


#if CONFIG_GFX_CLIPPING || CONFIG_GFX_VCOORDS

/**
 * Set the bitmap clipping rectangle to the specified coordinates.
 *
 * All drawing performed on the bitmap will be clipped inside this
 * rectangle.
 *
 * The clipping rectangle is also used as a bounding box for the
 * logical view of the virtual coordinate system.
 *
 * \note Following the convention used for all other operations, the
 *       top-left pixels of the rectangle are included, while the
 *       bottom-right pixels are considered outside the clipping region.
 *
 * \see gfx_setViewRect
 */
void gfx_setClipRect(Bitmap *bm, coord_t minx, coord_t miny, coord_t maxx, coord_t maxy)
{
	ASSERT(minx < maxx);
	ASSERT(miny < maxy);
	ASSERT(miny >= 0);
	ASSERT(minx >= 0);
	ASSERT(maxx <= bm->width);
	ASSERT(maxy <= bm->height);

	bm->cr.xmin = minx;
	bm->cr.ymin = miny;
	bm->cr.xmax = maxx;
	bm->cr.ymax = maxy;

//	kprintf("cr.xmin = %d, cr.ymin = %d, cr.xmax = %d, cr.ymax = %d\n",
//		bm->cr.xMin, bm->cr.ymin, bm->cr.xmax, bm->cr.ymax);
}

#endif /* CONFIG_GFX_CLIPPING */