ipxe/src/tests/pnm_test.c

/*
 * Copyright (C) 2013 Michael Brown <mbrown@fensystems.co.uk>.
 *
 * This program 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 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 Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

FILE_LICENCE ( GPL2_OR_LATER );

/** @file
 *
 * PNM self-tests
 *
 */

/* Forcibly enable assertions */
#undef NDEBUG

#include <string.h>
#include <assert.h>
#include <ipxe/pixbuf.h>
#include <ipxe/pnm.h>
#include <ipxe/test.h>

/** Define inline pixel data */
#define DATA(...) { __VA_ARGS__ }

/** A PNM test */
struct pnm_test {
	/** Source image */
	struct image *image;
	/** Pixel data */
	const uint32_t *data;
	/** Length of pixel data */
	size_t len;
	/** Width */
	unsigned int width;
	/** Height */
	unsigned int height;
};

/** Define a PNM test */
#define PNM( NAME, FILE, WIDTH, HEIGHT, DATA )				\
	static const char NAME ## _file[] = FILE;			\
	static const uint32_t NAME ## _data[] = DATA;			\
	static struct image NAME ## _image = {				\
		.refcnt = REF_INIT ( ref_no_free ),			\
		.name = #NAME,						\
		.data = ( userptr_t ) ( NAME ## _file ),		\
		.len = sizeof ( NAME ## _file ),			\
	};								\
	static struct pnm_test NAME = {					\
		.image = & NAME ## _image,				\
		.data = NAME ## _data,					\
		.len = sizeof ( NAME ## _data ),			\
		.width = WIDTH,						\
		.height = HEIGHT,					\
	};

/** PBM ASCII example (from Wikipedia) */
PNM ( pbm_ascii,
      "P1\n"
      "# This is an example bitmap of the letter \"J\"\n"
      "6 10\n"
      "0 0 0 0 1 0\n"
      "0 0 0 0 1 0\n"
      "0 0 0 0 1 0\n"
      "0 0 0 0 1 0\n"
      "0 0 0 0 1 0\n"
      "0 0 0 0 1 0\n"
      "1 0 0 0 1 0\n"
      "0 1 1 1 0 0\n"
      "0 0 0 0 0 0\n"
      "0 0 0 0 0 0\n",
      6, 10,
      DATA ( 0xffffff, 0xffffff, 0xffffff, 0xffffff, 0x000000, 0xffffff,
	     0xffffff, 0xffffff, 0xffffff, 0xffffff, 0x000000, 0xffffff,
	     0xffffff, 0xffffff, 0xffffff, 0xffffff, 0x000000, 0xffffff,
	     0xffffff, 0xffffff, 0xffffff, 0xffffff, 0x000000, 0xffffff,
	     0xffffff, 0xffffff, 0xffffff, 0xffffff, 0x000000, 0xffffff,
	     0xffffff, 0xffffff, 0xffffff, 0xffffff, 0x000000, 0xffffff,
	     0x000000, 0xffffff, 0xffffff, 0xffffff, 0x000000, 0xffffff,
	     0xffffff, 0x000000, 0x000000, 0x000000, 0xffffff, 0xffffff,
	     0xffffff, 0xffffff, 0xffffff, 0xffffff, 0xffffff, 0xffffff,
	     0xffffff, 0xffffff, 0xffffff, 0xffffff, 0xffffff, 0xffffff ) );

/** PGM ASCII example (from Wikipedia) */
PNM ( pgm_ascii,
      "P2\n"
      "# Shows the word \"FEEP\" (example from Netpbm man page on PGM)\n"
      "24 7\n"
      "15\n"
      "0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0\n"
      "0  3  3  3  3  0  0  7  7  7  7  0  0 11 11 11 11  0  0 15 15 15 15  0\n"
      "0  3  0  0  0  0  0  7  0  0  0  0  0 11  0  0  0  0  0 15  0  0 15  0\n"
      "0  3  3  3  0  0  0  7  7  7  0  0  0 11 11 11  0  0  0 15 15 15 15  0\n"
      "0  3  0  0  0  0  0  7  0  0  0  0  0 11  0  0  0  0  0 15  0  0  0  0\n"
      "0  3  0  0  0  0  0  7  7  7  7  0  0 11 11 11 11  0  0 15  0  0  0  0\n"
      "0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0\n"
      , 24, 7,
      DATA ( 0x000000, 0x000000, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x000000, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x000000, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x000000, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x333333, 0x333333, 0x333333, 0x333333, 0x000000,
	     0x000000, 0x777777, 0x777777, 0x777777, 0x777777, 0x000000,
	     0x000000, 0xbbbbbb, 0xbbbbbb, 0xbbbbbb, 0xbbbbbb, 0x000000,
	     0x000000, 0xffffff, 0xffffff, 0xffffff, 0xffffff, 0x000000,
	     0x000000, 0x333333, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x777777, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0xbbbbbb, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0xffffff, 0x000000, 0x000000, 0xffffff, 0x000000,
	     0x000000, 0x333333, 0x333333, 0x333333, 0x000000, 0x000000,
	     0x000000, 0x777777, 0x777777, 0x777777, 0x000000, 0x000000,
	     0x000000, 0xbbbbbb, 0xbbbbbb, 0xbbbbbb, 0x000000, 0x000000,
	     0x000000, 0xffffff, 0xffffff, 0xffffff, 0xffffff, 0x000000,
	     0x000000, 0x333333, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x777777, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0xbbbbbb, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0xffffff, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x333333, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x777777, 0x777777, 0x777777, 0x777777, 0x000000,
	     0x000000, 0xbbbbbb, 0xbbbbbb, 0xbbbbbb, 0xbbbbbb, 0x000000,
	     0x000000, 0xffffff, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x000000, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x000000, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x000000, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x000000, 0x000000, 0x000000, 0x000000, 0x000000 ) );

/** PPM ASCII example (from Wikipedia) */
PNM ( ppm_ascii,
      "P3\n"
      "# The P3 means colors are in ASCII, then 3 columns and 2 rows,\n"
      "# then 255 for max color, then RGB triplets\n"
      "3 2\n"
      "255\n"
      "255   0   0     0 255   0     0   0 255\n"
      "255 255   0   255 255 255     0   0   0\n",
      3, 2,
      DATA ( 0xff0000, 0x00ff00, 0x0000ff, 0xffff00, 0xffffff, 0x000000 ) );

/** PBM ASCII with no space between pixel values */
PNM ( pbm_ascii_no_space,
      "P1\n"
      "3 3\n"
      "001\n"
      "010\n"
      "111\n",
      3, 3,
      DATA ( 0xffffff, 0xffffff, 0x000000, 0xffffff, 0x000000, 0xffffff,
	     0x000000, 0x000000, 0x000000 ) );

/** PBM binary example (converted from Wikipedia) */
PNM ( pbm_binary,
      DATA ( 0x50, 0x34, 0x0a, 0x23, 0x20, 0x43, 0x52, 0x45, 0x41, 0x54, 0x4f,
	     0x52, 0x3a, 0x20, 0x47, 0x49, 0x4d, 0x50, 0x20, 0x50, 0x4e, 0x4d,
	     0x20, 0x46, 0x69, 0x6c, 0x74, 0x65, 0x72, 0x20, 0x56, 0x65, 0x72,
	     0x73, 0x69, 0x6f, 0x6e, 0x20, 0x31, 0x2e, 0x31, 0x0a, 0x36, 0x20,
	     0x31, 0x30, 0x0a, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08, 0x88, 0x70,
	     0x00, 0x00 ),
      6, 10,
      DATA ( 0xffffff, 0xffffff, 0xffffff, 0xffffff, 0x000000, 0xffffff,
	     0xffffff, 0xffffff, 0xffffff, 0xffffff, 0x000000, 0xffffff,
	     0xffffff, 0xffffff, 0xffffff, 0xffffff, 0x000000, 0xffffff,
	     0xffffff, 0xffffff, 0xffffff, 0xffffff, 0x000000, 0xffffff,
	     0xffffff, 0xffffff, 0xffffff, 0xffffff, 0x000000, 0xffffff,
	     0xffffff, 0xffffff, 0xffffff, 0xffffff, 0x000000, 0xffffff,
	     0x000000, 0xffffff, 0xffffff, 0xffffff, 0x000000, 0xffffff,
	     0xffffff, 0x000000, 0x000000, 0x000000, 0xffffff, 0xffffff,
	     0xffffff, 0xffffff, 0xffffff, 0xffffff, 0xffffff, 0xffffff,
	     0xffffff, 0xffffff, 0xffffff, 0xffffff, 0xffffff, 0xffffff ) );

/** PGM binary example (converted from Wikipedia) */
PNM ( pgm_binary,
      DATA ( 0x50, 0x35, 0x0a, 0x32, 0x34, 0x20, 0x37, 0x0a, 0x31, 0x35, 0x0a,
	     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
	     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
	     0x00, 0x00, 0x00, 0x03, 0x03, 0x03, 0x03, 0x00, 0x00, 0x07, 0x07,
	     0x07, 0x07, 0x00, 0x00, 0x0b, 0x0b, 0x0b, 0x0b, 0x00, 0x00, 0x0f,
	     0x0f, 0x0f, 0x0f, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00,
	     0x07, 0x00, 0x00, 0x00, 0x00, 0x00, 0x0b, 0x00, 0x00, 0x00, 0x00,
	     0x00, 0x0f, 0x00, 0x00, 0x0f, 0x00, 0x00, 0x03, 0x03, 0x03, 0x00,
	     0x00, 0x00, 0x07, 0x07, 0x07, 0x00, 0x00, 0x00, 0x0b, 0x0b, 0x0b,
	     0x00, 0x00, 0x00, 0x0f, 0x0f, 0x0f, 0x0f, 0x00, 0x00, 0x03, 0x00,
	     0x00, 0x00, 0x00, 0x00, 0x07, 0x00, 0x00, 0x00, 0x00, 0x00, 0x0b,
	     0x00, 0x00, 0x00, 0x00, 0x00, 0x0f, 0x00, 0x00, 0x00, 0x00, 0x00,
	     0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x07, 0x07, 0x07, 0x07, 0x00,
	     0x00, 0x0b, 0x0b, 0x0b, 0x0b, 0x00, 0x00, 0x0f, 0x00, 0x00, 0x00,
	     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
	     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
	     0x00, 0x00, 0x00 ),
      24, 7,
      DATA ( 0x000000, 0x000000, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x000000, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x000000, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x000000, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x333333, 0x333333, 0x333333, 0x333333, 0x000000,
	     0x000000, 0x777777, 0x777777, 0x777777, 0x777777, 0x000000,
	     0x000000, 0xbbbbbb, 0xbbbbbb, 0xbbbbbb, 0xbbbbbb, 0x000000,
	     0x000000, 0xffffff, 0xffffff, 0xffffff, 0xffffff, 0x000000,
	     0x000000, 0x333333, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x777777, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0xbbbbbb, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0xffffff, 0x000000, 0x000000, 0xffffff, 0x000000,
	     0x000000, 0x333333, 0x333333, 0x333333, 0x000000, 0x000000,
	     0x000000, 0x777777, 0x777777, 0x777777, 0x000000, 0x000000,
	     0x000000, 0xbbbbbb, 0xbbbbbb, 0xbbbbbb, 0x000000, 0x000000,
	     0x000000, 0xffffff, 0xffffff, 0xffffff, 0xffffff, 0x000000,
	     0x000000, 0x333333, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x777777, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0xbbbbbb, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0xffffff, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x333333, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x777777, 0x777777, 0x777777, 0x777777, 0x000000,
	     0x000000, 0xbbbbbb, 0xbbbbbb, 0xbbbbbb, 0xbbbbbb, 0x000000,
	     0x000000, 0xffffff, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x000000, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x000000, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x000000, 0x000000, 0x000000, 0x000000, 0x000000,
	     0x000000, 0x000000, 0x000000, 0x000000, 0x000000, 0x000000 ) );

/** PPM binary example (converted from Wikipedia) */
PNM ( ppm_binary,
      DATA ( 0x50, 0x36, 0x0a, 0x33, 0x20, 0x32, 0x0a, 0x32, 0x35, 0x35, 0x0a,
	     0xff, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff,
	     0x00, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00 ),
      3, 2,
      DATA ( 0xff0000, 0x00ff00, 0x0000ff, 0xffff00, 0xffffff, 0x000000 ) );

/**
 * Report PNM test result
 *
 * @v test		PNM test
 */
#define pnm_ok( test ) do {						\
	struct pixel_buffer *pixbuf;					\
	uint8_t data[ (test)->len ];					\
	int rc;								\
									\
	/* Sanity check */						\
	assert ( ( (test)->width * (test)->height *			\
		   sizeof ( (test)->data[0] ) ) == (test)->len );	\
									\
	/* Correct image data pointer */				\
	(test)->image->data =						\
		virt_to_user ( ( void * ) (test)->image->data );	\
									\
	/* Perform tests */						\
	ok ( image_probe ( (test)->image ) == 0 );			\
	ok ( (test)->image->type == &pnm_image_type );			\
	ok ( ( rc = image_pixbuf ( (test)->image, &pixbuf ) ) == 0 );	\
	if ( rc == 0 ) {						\
		ok ( pixbuf->width == (test)->width );			\
		ok ( pixbuf->height == (test)->height );		\
		ok ( pixbuf->len == (test)->len );			\
		copy_from_user ( data, pixbuf->data, 0,			\
				 sizeof ( data ) );			\
		ok ( memcmp ( data, (test)->data,			\
			      sizeof ( data ) ) == 0 );			\
		DBGC_HDA ( (test)->image, 0, data, sizeof ( data ) );	\
		pixbuf_put ( pixbuf );					\
	}								\
	} while ( 0 )

/**
 * Perform PNM self-test
 *
 */
static void pnm_test_exec ( void ) {

	pnm_ok ( &pbm_ascii );
	pnm_ok ( &pgm_ascii );
	pnm_ok ( &ppm_ascii );
	pnm_ok ( &pbm_ascii_no_space );
	pnm_ok ( &pbm_binary );
	pnm_ok ( &pgm_binary );
	pnm_ok ( &ppm_binary );
}

/** PNM self-test */
struct self_test pnm_test __self_test = {
	.name = "pnm",
	.exec = pnm_test_exec,
};