Merge branch 'image_palette'

3 files changed, 134 insertions, 7 deletions

diff --git a/src/gdisp/gdisp_image.c b/src/gdisp/gdisp_image.c
index 356ba64f..347ed6aa 100644
--- a/src/gdisp/gdisp_image.c
+++ b/src/gdisp/gdisp_image.c
@@ -33,6 +33,9 @@
 	extern gdispImageError gdispImageCache_BMP(gdispImage *img);
 	extern gdispImageError gdispGImageDraw_BMP(GDisplay *g, gdispImage *img, coord_t x, coord_t y, coord_t cx, coord_t cy, coord_t sx, coord_t sy);
 	extern delaytime_t gdispImageNext_BMP(gdispImage *img);
+	extern uint16_t gdispImageGetPaletteSize_BMP(gdispImage *img);
+	extern color_t gdispImageGetPalette_BMP(gdispImage *img, uint16_t index);
+	extern bool_t gdispImageAdjustPalette_BMP(gdispImage *img, uint16_t index, color_t newColor);
 #endif
 
 #if GDISP_NEED_IMAGE_JPG
@@ -53,41 +56,49 @@
 
 /* The structure defining the routines for image drawing */
 typedef struct gdispImageHandlers {
-	gdispImageError	(*open)(gdispImage *img);			/* The open function */
-	void			(*close)(gdispImage *img);			/* The close function */
-	gdispImageError	(*cache)(gdispImage *img);			/* The cache function */
+	gdispImageError	(*open)(gdispImage *img);					/* The open function */
+	void			(*close)(gdispImage *img);					/* The close function */
+	gdispImageError	(*cache)(gdispImage *img);					/* The cache function */
 	gdispImageError	(*draw)(GDisplay *g,
 							gdispImage *img,
 							coord_t x, coord_t y,
 							coord_t cx, coord_t cy,
-							coord_t sx, coord_t sy);	/* The draw function */
-	delaytime_t		(*next)(gdispImage *img);			/* The next frame function */
+							coord_t sx, coord_t sy);			/* The draw function */
+	delaytime_t		(*next)(gdispImage *img);					/* The next frame function */
+	uint16_t		(*getPaletteSize)(gdispImage *img);			/* Retrieve the size of the palette (number of entries) */
+	color_t			(*getPalette)(gdispImage *img, uint16_t index);							/* Retrieve a specific color value of the palette */
+	bool_t			(*adjustPalette)(gdispImage *img, uint16_t index, color_t newColor);	/* Replace a color value in the palette */
 } gdispImageHandlers;
 
 static gdispImageHandlers ImageHandlers[] = {
 	#if GDISP_NEED_IMAGE_NATIVE
 		{	gdispImageOpen_NATIVE,	gdispImageClose_NATIVE,
 			gdispImageCache_NATIVE,	gdispGImageDraw_NATIVE,	gdispImageNext_NATIVE,
+			0,						0,						0
 		},
 	#endif
 	#if GDISP_NEED_IMAGE_GIF
 		{	gdispImageOpen_GIF,		gdispImageClose_GIF,
 			gdispImageCache_GIF,	gdispGImageDraw_GIF,	gdispImageNext_GIF,
+			0,						0,						0
 		},
 	#endif
 	#if GDISP_NEED_IMAGE_BMP
-		{	gdispImageOpen_BMP,		gdispImageClose_BMP,
-			gdispImageCache_BMP,	gdispGImageDraw_BMP,	gdispImageNext_BMP,
+		{	gdispImageOpen_BMP,				gdispImageClose_BMP,
+			gdispImageCache_BMP,			gdispGImageDraw_BMP,		gdispImageNext_BMP,
+			gdispImageGetPaletteSize_BMP,	gdispImageGetPalette_BMP,	gdispImageAdjustPalette_BMP
 		},
 	#endif
 	#if GDISP_NEED_IMAGE_JPG
 		{	gdispImageOpen_JPG,		gdispImageClose_JPG,
 			gdispImageCache_JPG,	gdispGImageDraw_JPG,	gdispImageNext_JPG,
+			0,						0,						0
 		},
 	#endif
 	#if GDISP_NEED_IMAGE_PNG
 		{	gdispImageOpen_PNG,		gdispImageClose_PNG,
 			gdispImageCache_PNG,	gdispGImageDraw_PNG,	gdispImageNext_PNG,
+			0,						0,						0
 		},
 	#endif
 };
@@ -172,6 +183,25 @@ delaytime_t gdispImageNext(gdispImage *img) {
 	return img->fns->next(img);
 }
 
+uint16_t gdispImageGetPaletteSize(gdispImage *img) {
+	if (!img->fns) return 0;
+	if (!img->fns->getPaletteSize) return 0;
+	return img->fns->getPaletteSize(img);
+}
+
+color_t gdispImageGetPalette(gdispImage *img, uint16_t index) {
+	if (!img->fns) return 0;
+	if (!img->fns->getPalette) return 0;
+	return img->fns->getPalette(img, index);
+}
+
+bool_t gdispImageAdjustPalette(gdispImage *img, uint16_t index, color_t newColor) {
+	if (!img->fns) return FALSE;
+	if (!img->fns->adjustPalette) return FALSE;
+	return img->fns->adjustPalette(img, index, newColor);
+}
+
+
 // Helper Routines
 void *gdispImageAlloc(gdispImage *img, size_t sz) {
 	#if GDISP_NEED_IMAGE_ACCOUNTING
diff --git a/src/gdisp/gdisp_image.h b/src/gdisp/gdisp_image.h
index 2b6fdf19..76773887 100644
--- a/src/gdisp/gdisp_image.h
+++ b/src/gdisp/gdisp_image.h
@@ -247,6 +247,42 @@ extern "C" {
 	 * 			frame/page.
 	 */
 	delaytime_t gdispImageNext(gdispImage *img);
+
+	/**
+	 * @brief	Get the number of entries in the color palette.
+	 * @return	The number of entries in the color palette or 0 if the image doesn't use a color palette.
+	 *
+	 * @param[in] img	The image structure
+	 * 
+	 * @pre		gdispImageOpen() must have returned successfully.
+	 */
+	uint16_t gdispImageGetPaletteSize(gdispImage *img);
+	
+	/**
+	 * @brief	Get an entry in the color palette.
+	 * @return	The color value at a given position in the color palette.
+	 *
+	 * @param[in] img	The image structure
+	 * @param[in] index	The index of the color palette entry
+	 * 
+	 * @pre		gdispImageOpen() must have returned successfully.
+	 *
+	 * @note	This function will return 0 if the index is out of bounds or if the image doesn't use a color palette.
+	 */
+	color_t gdispImageGetPalette(gdispImage *img, uint16_t index);
+	
+	/**
+	 * @brief	Modify an entry in the color palette.
+	 * @return	@p TRUE on success, @p FALSE otherwise.
+	 *
+	 * @param[in] img		The image structure
+	 * @param[in] index		The index of the color palette entry
+	 * @param[in] newColor	The new color value of the specified entry
+	 * 
+	 * @pre		gdispImageOpen() must have returned successfully.
+	 * @note	This function will return @p FALSE if the index is out of bounds or if the image doesn't use a color palette.
+	 */
+	bool_t gdispImageAdjustPalette(gdispImage *img, uint16_t index, color_t newColor);
 	
 #ifdef __cplusplus
 }
diff --git a/src/gdisp/gdisp_image_bmp.c b/src/gdisp/gdisp_image_bmp.c
index 371fdf2d..2ea4e95f 100644
--- a/src/gdisp/gdisp_image_bmp.c
+++ b/src/gdisp/gdisp_image_bmp.c
@@ -829,4 +829,65 @@ delaytime_t gdispImageNext_BMP(gdispImage *img) {
 	return TIME_INFINITE;
 }
 
+uint16_t gdispImageGetPaletteSize_BMP(gdispImage *img) {
+	#if GDISP_NEED_IMAGE_BMP_1 || GDISP_NEED_IMAGE_BMP_4 || GDISP_NEED_IMAGE_BMP_8
+		gdispImagePrivate_BMP *priv;
+	
+		priv = (gdispImagePrivate_BMP *)img->priv;
+		if (!priv)
+			return 0;
+	
+		if (!(priv->bmpflags & BMP_PALETTE))
+			return 0;
+	
+		return priv->palsize;
+	#else
+		return 0;
+	#endif
+}
+
+color_t gdispImageGetPalette_BMP(gdispImage *img, uint16_t index) {
+	#if GDISP_NEED_IMAGE_BMP_1 || GDISP_NEED_IMAGE_BMP_4 || GDISP_NEED_IMAGE_BMP_8
+		gdispImagePrivate_BMP *priv;
+	
+		priv = (gdispImagePrivate_BMP *)img->priv;
+		if (!priv)
+			return 0;
+	
+		if (!(priv->bmpflags & BMP_PALETTE))
+			return 0;
+	
+		if (index >= priv->palsize)
+			return 0;
+	
+		return priv->palette[(uint8_t)index];
+	
+	#else
+		return 0;
+	#endif
+}
+
+bool_t gdispImageAdjustPalette_BMP(gdispImage *img, uint16_t index, color_t newColor) {
+	#if GDISP_NEED_IMAGE_BMP_1 || GDISP_NEED_IMAGE_BMP_4 || GDISP_NEED_IMAGE_BMP_8
+		gdispImagePrivate_BMP *priv;
+	
+		priv = (gdispImagePrivate_BMP *)img->priv;
+		if (!priv)
+			return FALSE;
+	
+		if (!(priv->bmpflags & BMP_PALETTE))
+			return FALSE;
+	
+		if (index >= priv->palsize)
+			return FALSE;
+
+		priv->palette[(uint8_t)index] = newColor;
+
+		return TRUE;
+	
+	#else
+		return 0;
+	#endif
+}
+
 #endif /* GFX_USE_GDISP && GDISP_NEED_IMAGE && GDISP_NEED_IMAGE_BMP */