Adafruit_ImageReader.h

Go to the documentation of this file.

#ifndef __ADAFRUIT_IMAGE_READER_H__
#define __ADAFRUIT_IMAGE_READER_H__

#include "Adafruit_SPIFlash.h"
#include "Adafruit_SPITFT.h"

enum ImageReturnCode {
  IMAGE_SUCCESS,            // Successful load (or image clipped off screen)
  IMAGE_ERR_FILE_NOT_FOUND, // Could not open file
  IMAGE_ERR_FORMAT,         // Not a supported image format
  IMAGE_ERR_MALLOC          // Could not allocate image (loadBMP() only)
};

enum ImageFormat {
  IMAGE_NONE, // No image was loaded; IMAGE_ERR_* condition
  IMAGE_1,    // GFXcanvas1 image (NOT YET SUPPORTED)
  IMAGE_8,    // GFXcanvas8 image (NOT YET SUPPORTED)
  IMAGE_16    // GFXcanvas16 image (SUPPORTED)
};

class Adafruit_Image {
public:
  Adafruit_Image(void);
  ~Adafruit_Image(void);
  int16_t width(void) const;  // Return image width in pixels
  int16_t height(void) const; // Return image height in pixels
  void draw(Adafruit_SPITFT &tft, int16_t x, int16_t y);
  ImageFormat getFormat(void) const { return (ImageFormat)format; }
  void *getCanvas(void) const;
  uint16_t *getPalette(void) const { return palette; }
  GFXcanvas1 *getMask(void) const { return mask; };

protected:
  // MOST OF THESE ARE NOT SUPPORTED YET -- WIP
  union {                  // Single pointer, only one variant is used:
    GFXcanvas1 *canvas1;   
    GFXcanvas8 *canvas8;   
    GFXcanvas16 *canvas16; 
  } canvas;                
  GFXcanvas1 *mask;        
  uint16_t *palette;       
  uint8_t format;          
  void dealloc(void);      
  friend class Adafruit_ImageReader; 
};

class Adafruit_ImageReader {
public:
  Adafruit_ImageReader(FatVolume &fs);
  ~Adafruit_ImageReader(void);
  ImageReturnCode drawBMP(const char *filename, Adafruit_SPITFT &tft, int16_t x,
                          int16_t y, boolean transact = true);
  ImageReturnCode loadBMP(const char *filename, Adafruit_Image &img);
  ImageReturnCode bmpDimensions(const char *filename, int32_t *w, int32_t *h);
  void printStatus(ImageReturnCode stat, Stream &stream = Serial);

protected:
  FatVolume *filesys; 
  File32 file;        
  ImageReturnCode coreBMP(const char *filename, Adafruit_SPITFT *tft,
                          uint16_t *dest, int16_t x, int16_t y,
                          Adafruit_Image *img, boolean transact);
  uint16_t readLE16(void);
  uint32_t readLE32(void);
};

#endif // __ADAFRUIT_IMAGE_READER_H__