/** * Class definition for a MicroBitImage. * * An MicroBitImage is a simple bitmap representation of an image. * n.b. This is a mutable, managed type. */ #include "MicroBit.h" /* * The null image. We actally create a small one byte buffer here, just to keep NULL pointers out of the equation. */ MicroBitImage MicroBitImage::EmptyImage(1,1); /** * Default Constructor. * Creates a new reference to the empty MicroBitImage bitmap * * Example: * @code * MicroBitImage i(); //an empty image * @endcode */ MicroBitImage::MicroBitImage() { // Create new reference to the EmptyImage and we're done. init_empty(); } /** * Constructor. * Create a blank bitmap representation of a given size. * * @param x the width of the image. * @param y the height of the image. * * Bitmap buffer is linear, with 8 bits per pixel, row by row, * top to bottom with no word alignment. Stride is therefore the image width in pixels. * in where w and h are width and height respectively, the layout is therefore: * * |[0,0]...[w,o][1,0]...[w,1] ... [[w,h] * * A copy of the image is made in RAM, as images are mutable. * * TODO: Consider an immutable flavour, which might save us RAM for animation spritesheets... * ...as these could be kept in FLASH. */ MicroBitImage::MicroBitImage(const int16_t x, const int16_t y) { this->init(x,y,NULL); } /** * Copy Constructor. * Add ourselves as a reference to an existing MicroBitImage. * * @param image The MicroBitImage to reference. * * Example: * @code * MicroBitImage i("0,1,0,1,0\n"); * MicroBitImage i2(i); //points to i * @endcode */ MicroBitImage::MicroBitImage(const MicroBitImage &image) { bitmap = image.bitmap; width = image.width; height = image.height; ref = image.ref; (*ref)++; } /** * Constructor. * Create a blank bitmap representation of a given size. * * @param s A text based representation of the image given whitespace delimited numeric values. * * Example: * @code * MicroBitImage i("0,1,0,1,0\n1,0,1,0,1\n0,1,0,1,0\n1,0,1,0,1\n0,1,0,1,0\n"); // 5x5 image * @endcode */ MicroBitImage::MicroBitImage(const char *s) { int width = 0; int height = 0; int count = 0; int digit = 0; char parseBuf[10]; const char *parseReadPtr; char *parseWritePtr; uint8_t *bitmapPtr; if (s == NULL) { init_empty(); return; } // First pass: Parse the string to determine the geometry of the image. // We do this from first principles to avoid unecessary load of the strtok() libs etc. parseReadPtr = s; while (*parseReadPtr) { if (isdigit(*parseReadPtr)) { // Ignore numbers. digit = 1; } else if (*parseReadPtr =='\n') { if (digit) { count++; digit = 0; } height++; width = count > width ? count : width; count = 0; } else { if (digit) { count++; digit = 0; } } parseReadPtr++; } // Store the geomtery. this->width = width; this->height = height; this->bitmap = (uint8_t *) malloc(width * height); this->ref = (int16_t *) malloc(sizeof(int16_t)); *ref = 1; // Second pass: collect the data. parseReadPtr = s; parseWritePtr = parseBuf; bitmapPtr = this->bitmap; while (*parseReadPtr) { if (isdigit(*parseReadPtr)) { *parseWritePtr = *parseReadPtr; parseWritePtr++; } else { *parseWritePtr = 0; if (parseWritePtr > parseBuf) { *bitmapPtr = atoi(parseBuf); bitmapPtr++; parseWritePtr = parseBuf; } } parseReadPtr++; } } /** * Constructor. * Create a bitmap representation of a given size, based on a given buffer. * * @param x the width of the image. * @param y the height of the image. * @param bitmap a 2D array representing the image. * * Example: * @code * const uint8_t heart[] = { 0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 1, 1, 1, 0, 0, 1, 1, 1, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, }; // a cute heart * MicroBitImage i(10,5,heart); * @endcode */ MicroBitImage::MicroBitImage(const int16_t x, const int16_t y, const uint8_t *bitmap) { this->init(x,y,bitmap); } /** * Destructor. * Removes buffer resources held by the instance. */ MicroBitImage::~MicroBitImage() { if(--(*ref) == 0) { free(bitmap); free(ref); } } /** * Internal constructor which defaults to the EmptyImage instance variable */ void MicroBitImage::init_empty() { bitmap = MicroBitImage::EmptyImage.bitmap; width = MicroBitImage::EmptyImage.width; height = MicroBitImage::EmptyImage.height; ref = MicroBitImage::EmptyImage.ref; (*ref)++; } /** * Internal constructor which provides sanity checking and initialises class properties. * * @param x the width of the image * @param y the height of the image * @param bitmap an array of integers that make up an image. */ void MicroBitImage::init(const int16_t x, const int16_t y, const uint8_t *bitmap) { //sanity check size of image - you cannot have a negative sizes if(x < 0 || y < 0) { init_empty(); return; } // Create a copy of the array this->width = x; this->height = y; // create a linear buffer to represent the image. We could use a jagged/2D array here, but experimentation // showed this had a negative effect on memory management (heap fragmentation etc). this->bitmap = (uint8_t *) malloc(width*height); if (bitmap) this->printImage(x,y,bitmap); else this->clear(); ref = (int16_t *) malloc(sizeof(int16_t)); *ref = 1; } /** * Copy assign operation. * * Called when one MicroBitImage is assigned the value of another using the '=' operator. * Decrement our reference count and free up the buffer as necessary. * Then, update our buffer to refer to that of the supplied MicroBitImage, * and increase its reference count. * * @param s The MicroBitImage to reference. * * Example: * @code * const uint8_t heart[] = { 0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 1, 1, 1, 0, 0, 1, 1, 1, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, }; // a cute heart * MicroBitImage i(10,5,heart); * MicroBitImage i1(); * i1 = 1; // i1 now references i * @endcode */ MicroBitImage& MicroBitImage::operator = (const MicroBitImage& i) { if(this == &i) return *this; if(--(*ref) == 0) { free(bitmap); free(ref); } bitmap = i.bitmap; width = i.width; height = i.height; ref = i.ref; (*ref)++; return *this; } /** * Equality operation. * * Called when one MicroBitImage is tested to be equal to another using the '==' operator. * * @param i The MicroBitImage to test ourselves against. * @return true if this MicroBitImage is identical to the one supplied, false otherwise. * * Example: * @code * MicroBitImage i(); * MicroBitImage i1(); * * if(i == i1) //will be true * print("true"); * @endcode */ bool MicroBitImage::operator== (const MicroBitImage& i) { if (bitmap == i.bitmap) return true; else return ((width == i.width) && (height == i.height) && (memcmp(bitmap, i.bitmap,width*height)==0)); } /** * Clears all pixels in this image * * Example: * @code * MicroBitImage i("0,1,0,1,0\n1,0,1,0,1\n0,1,0,1,0\n1,0,1,0,1\n0,1,0,1,0\n"); // 5x5 image * i.clear(); * @endcode */ void MicroBitImage::clear() { memclr(this->bitmap, width*height); } /** * Sets the pixel at the given co-ordinates to a given value. * @param x The co-ordinate of the pixel to change w.r.t. top left origin. * @param y The co-ordinate of the pixel to change w.r.t. top left origin. * @param value The new value of the pixel (the brightness level 0-255) * * Example: * @code * MicroBitImage i("0,1,0,1,0\n1,0,1,0,1\n0,1,0,1,0\n1,0,1,0,1\n0,1,0,1,0\n"); // 5x5 image * i.setPixelValue(0,0,255); * @endcode */ void MicroBitImage::setPixelValue(int16_t x , int16_t y, uint8_t value) { //sanity check if(x >= width || y >= height || x < 0 || y < 0) return; this->bitmap[y*width+x] = value; } /** * Determines the value of a given pixel. * @return The value assigned to the given pixel location (the brightness level 0-255) * * Example: * @code * MicroBitImage i("0,1,0,1,0\n1,0,1,0,1\n0,1,0,1,0\n1,0,1,0,1\n0,1,0,1,0\n"); // 5x5 image * i.getPixelValue(0,0); //should be 0; * @endcode */ int MicroBitImage::getPixelValue(int16_t x , int16_t y) { //sanity check if(x >= width || y >= height || x < 0 || y < 0) return MICROBIT_INVALID_VALUE; return this->bitmap[y*width+x]; } /** * Replaces the content of this image with that of a given * 2D array representing the image. * Origin is in the top left corner of the image. * * @param x the width of the image. * @param y the height of the image. * @param bitmap a 2D array representing the image. * * Example: * @code * const uint8_t heart[] = { 0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 1, 1, 1, 0, 0, 1, 1, 1, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, }; // a cute heart * MicroBitImage i(); * i.printImage(0,0,heart); * @endcode */ void MicroBitImage::printImage(int16_t width, int16_t height, const uint8_t *bitmap) { const uint8_t *pIn; uint8_t *pOut; int pixelsToCopyX, pixelsToCopyY; // Sanity check. if (width <= 0 || width <= 0 || bitmap == NULL) return; // Calcualte sane start pointer. pixelsToCopyX = min(width,this->width); pixelsToCopyY = min(height,this->height); pIn = bitmap; pOut = this->bitmap; // Copy the image, stride by stride. for (int i=0; iwidth; } } /** * Pastes a given bitmap at the given co-ordinates. * Any pixels in the relvant area of this image are replaced. * * @param image The MicroBitImage to paste. * @param x The leftmost X co-ordinate in this image where the given image should be pasted. * @param y The uppermost Y co-ordinate in this image where the given image should be pasted. * @param alpha set to 1 if transparency clear pixels in given image should be treated as transparent. Set to 0 otherwise. * @return The number of pixels written. * * Example: * @code * const uint8_t heart[] = { 0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 1, 1, 1, 0, 0, 1, 1, 1, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, }; // a cute heart * MicroBitImage i(10,5,heart); //if you show this image - you will see a big heart * i.paste(-5,0,i); //displays a small heart :) * @endcode */ int MicroBitImage::paste(const MicroBitImage &image, int16_t x, int16_t y, uint8_t alpha) { uint8_t *pIn, *pOut; int cx, cy; int pxWritten = 0; // Sanity check. // We permit writes that overlap us, but ones that are clearly out of scope we can filter early. if (x >= width || y >= height || x+image.width <= 0 || y+image.height <= 0) return 0; //Calculate the number of byte we need to copy in each dimension. cx = x < 0 ? min(image.width + x, width) : min(image.width, width - x); cy = y < 0 ? min(image.height + y, height) : min(image.height, height - y); // Calcualte sane start pointer. pIn = image.bitmap; pIn += (x < 0) ? -x : 0; pIn += (y < 0) ? -image.width*y : 0; pOut = bitmap; pOut += (x > 0) ? x : 0; pOut += (y > 0) ? width*y : 0; // Copy the image, stride by stride // If we want primitive transparecy, we do this byte by byte. // If we don't, use a more efficient block memory copy instead. Every little helps! if (alpha) { for (int i=0; i= width || y >= height || c < MICROBIT_FONT_ASCII_START || c > font.asciiEnd) return; // Paste. int offset = (c-MICROBIT_FONT_ASCII_START) * 5; for (int row=0; rowbitmap[y1*width+x1] = (v & (0x10 >> col)) ? 255 : 0; } } } /** * Shifts the pixels in this Image a given number of pixels to the Left. * * @param n The number of pixels to shift. * * Example: * @code * const uint8_t heart[] = { 0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 1, 1, 1, 0, 0, 1, 1, 1, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, }; // a cute heart * MicroBitImage i(10,5,heart); //if you show this image - you will see a big heart * i.shiftLeft(5); //displays a small heart :) * @endcode */ void MicroBitImage::shiftLeft(int16_t n) { uint8_t *p = bitmap; int pixels = width-n; if (n <= 0 ) return; if(n >= width) { clear(); return; } for (int y = 0; y < height; y++) { // Copy, and blank fill the rightmost column. memcpy(p, p+n, pixels); memclr(p+pixels, n); p += width; } } /** * Shifts the pixels in this Image a given number of pixels to the Right. * * @param n The number of pixels to shift. * * Example: * @code * const uint8_t heart[] = { 0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 1, 1, 1, 0, 0, 1, 1, 1, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, }; // a cute heart * MicroBitImage i(10,5,heart); * i.shiftLeft(5); //displays a small heart :) * i.shiftRight(5); //displays a big heart :) * @endcode */ void MicroBitImage::shiftRight(int16_t n) { uint8_t *p = bitmap; int pixels = width-n; if (n <= 0) return; if(n >= width) { clear(); return; } for (int y = 0; y < height; y++) { // Copy, and blank fill the leftmost column. memmove(p+n, p, pixels); memclr(p, n); p += width; } } /** * Shifts the pixels in this Image a given number of pixels to Upward. * * @param n The number of pixels to shift. * * Example: * @code * const uint8_t heart[] = { 0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 1, 1, 1, 0, 0, 1, 1, 1, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, }; // a cute heart * MicroBitImage i(10,5,heart); * i.shiftUp(1); * @endcode */ void MicroBitImage::shiftUp(int16_t n) { uint8_t *pOut, *pIn; if (n <= 0 ) return; if(n >= height) { clear(); return; } pOut = bitmap; pIn = bitmap+width*n; for (int y = 0; y < height; y++) { // Copy, and blank fill the leftmost column. if (y < height-n) memcpy(pOut, pIn, width); else memclr(pOut, width); pIn += width; pOut += width; } } /** * Shifts the pixels in this Image a given number of pixels to Downward. * * @param n The number of pixels to shift. * * Example: * @code * const uint8_t heart[] = { 0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 1, 1, 1, 0, 0, 1, 1, 1, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, }; // a cute heart * MicroBitImage i(10,5,heart); * i.shiftDown(1); * @endcode */ void MicroBitImage::shiftDown(int16_t n) { uint8_t *pOut, *pIn; if (n <= 0 ) return; if(n >= height) { clear(); return; } pOut = bitmap + width*(height-1); pIn = pOut - width*n; for (int y = 0; y < height; y++) { // Copy, and blank fill the leftmost column. if (y < height-n) memcpy(pOut, pIn, width); else memclr(pOut, width); pIn -= width; pOut -= width; } } /** * Gets the width of this image. * * @return The width of this image. * * Example: * @code * const uint8_t heart[] = { 0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 1, 1, 1, 0, 0, 1, 1, 1, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, }; // a cute heart * MicroBitImage i(10,5,heart); * i.getWidth(); //equals 10... * @endcode */ int MicroBitImage::getWidth() { return width; } /** * Gets the height of this image. * * @return The height of this image. * * Example: * @code * const uint8_t heart[] = { 0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 1, 1, 1, 0, 0, 1, 1, 1, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, }; // a cute heart * MicroBitImage i(10,5,heart); * i.getHeight(); //equals 5... * @endcode */ int MicroBitImage::getHeight() { return height; } /** * Converts the bitmap to a csv string. * * Example: * @code * const uint8_t heart[] = { 0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 1, 1, 1, 0, 0, 1, 1, 1, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, }; // a cute heart * MicroBitImage i(10,5,heart); * uBit.serial.printString(i.toString()); // "0,1,0,1,0,0,0,0,0,0\n..." * @endcode */ ManagedString MicroBitImage::toString() { //width including commans and \n * height int stringSize = ((width * 2) * height); //plus one for string terminator char parseBuffer[stringSize + 1]; parseBuffer[stringSize] = '\0'; uint8_t *bitmapPtr = bitmap; int parseIndex = 0; int widthCount = 0; while (parseIndex < stringSize) { if(*bitmapPtr) parseBuffer[parseIndex] = '1'; else parseBuffer[parseIndex] = '0'; parseIndex++; if(widthCount == width-1) { parseBuffer[parseIndex] = '\n'; widthCount = 0; } else { parseBuffer[parseIndex] = ','; widthCount++; } parseIndex++; bitmapPtr++; } return ManagedString(parseBuffer); } /** * Crops the image to the given dimensions * * @param startx the location to start the crop in the x-axis * @param starty the location to start the crop in the y-axis * @param width the width of the desired cropped region * @param height the height of the desired cropped region * * Example: * @code * const uint8_t heart[] = { 0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 1, 1, 1, 0, 0, 1, 1, 1, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, }; // a cute heart * MicroBitImage i(10,5,heart); * uBit.serial.printString(i.crop(0,0,2,2).toString()); // "0,1\n1,1\n" * @endcode */ MicroBitImage MicroBitImage::crop(int startx, int starty, int cropWidth, int cropHeight) { int newWidth = startx + cropWidth; int newHeight = starty + cropHeight; if (newWidth >= width || newWidth <=0) newWidth = width; if (newHeight >= height || newHeight <= 0) newHeight = height; //allocate our storage. uint8_t cropped[newWidth * newHeight]; //calculate the pointer to where we want to begin cropping uint8_t *copyPointer = bitmap + (width * starty) + startx; //get a reference to our storage uint8_t *pastePointer = cropped; //go through row by row and select our image. for (int i = starty; i < newHeight; i++) { memcpy(pastePointer, copyPointer, newWidth); copyPointer += width; pastePointer += newHeight; } return MicroBitImage(newWidth, newHeight, cropped); }