OrgApache/incubator-nuttx
OrgApache
/
incubator-nuttx
mirror of https://github.com/apache/incubator-nuttx.git
1
0
Fork 0
Code Issues Releases Wiki Activity
incubator-nuttx/libs/libnx/nxfonts/nxfonts_cache.c

891 lines
24 KiB
C
Raw Blame History

/****************************************************************************
* libs/libnx/nxfonts/nxfonts_cache.c
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <sys/types.h>
#include <stdint.h>
#include <string.h>
#include <assert.h>
#include <errno.h>
#include <debug.h>
#include <nuttx/mutex.h>
#include <nuttx/nx/nxfonts.h>
#include "nxcontext.h"
/****************************************************************************
* Private Types
****************************************************************************/
/* This describes a rendering function */
typedef CODE int (*nxf_renderer_t)(FAR nxgl_mxpixel_t *dest, uint16_t height,
uint16_t width, uint16_t stride,
FAR const struct nx_fontbitmap_s *bm,
nxgl_mxpixel_t color);
/* This structure defines one font cache */
struct nxfonts_fcache_s
{
FAR struct nxfonts_fcache_s *flink; /* Supports a singly linked list */
NXHANDLE font; /* Font handle associated with fontid */
mutex_t flock; /* Serializes access to the font cache */
uint16_t fontid; /* ID of font in this cache */
int16_t fclients; /* Number of connected clients */
uint8_t maxglyphs; /* Maximum size of glyph[] array */
uint8_t nglyphs; /* Current size of glyph[] array */
uint8_t bpp; /* Bits per pixel */
nxgl_mxpixel_t fgcolor; /* Foreground color */
nxgl_mxpixel_t bgcolor; /* Background color */
nxf_renderer_t renderer; /* Font renderer */
/* Glyph cache data storage */
FAR struct nxfonts_glyph_s *head; /* Head of the list of glyphs */
FAR struct nxfonts_glyph_s *tail; /* Tail of the list of glyphs */
};
/****************************************************************************
* Private Data
****************************************************************************/
/* Head of a list of font caches */
static FAR struct nxfonts_fcache_s *g_fcaches;
static mutex_t g_cachelock = NXMUTEX_INITIALIZER;
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: nxf_removecache
*
* Description:
* Removes the entry 'glyph' from the font cache.
*
* Assumptions:
* The caller holds the font cache list lock.
*
****************************************************************************/
static inline void nxf_removecache(FAR struct nxfonts_fcache_s *fcache,
FAR struct nxfonts_fcache_s *prev)
{
/* Remove the cache from the list. First check for removal from the head */
if (prev == NULL)
{
/* Replace the head with the node following glyph */
g_fcaches = fcache->flink;
}
/* No.. Remove from the head or from mid-list */
else
{
prev->flink = fcache->flink;
}
fcache->flink = NULL;
}
/****************************************************************************
* Name: nxf_removeglyph
*
* Description:
* Removes the entry 'glyph' from the font cache.
*
****************************************************************************/
static inline void nxf_removeglyph(FAR struct nxfonts_fcache_s *priv,
FAR struct nxfonts_glyph_s *glyph,
FAR struct nxfonts_glyph_s *prev)
{
ginfo("fcache=%p glyph=%p\n", priv, glyph);
/* Remove the glyph for the list. First check for removal from the head
* (which, I think, never actually happens).
*/
if (prev == NULL)
{
/* Replace the head with the node following glyph */
priv->head = glyph->flink;
/* If there is no node following glyph, then the list is empty */
if (priv->head == NULL)
{
priv->tail = NULL;
}
}
/* Check for removal from the tail (we know that the list cannot become
* empty in either of the next two cases).
*/
else if (glyph->flink == NULL)
{
priv->tail = prev;
prev->flink = NULL;
}
/* No.. Remove from mid-list */
else
{
prev->flink = glyph->flink;
}
glyph->flink = NULL;
/* Decrement the count of glyphs in the font cache */
DEBUGASSERT(priv->nglyphs > 0);
priv->nglyphs--;
}
/****************************************************************************
* Name: nxf_addglyph
*
* Description:
* Add the entry 'glyph' to the head font cache list.
*
****************************************************************************/
static inline void nxf_addglyph(FAR struct nxfonts_fcache_s *priv,
FAR struct nxfonts_glyph_s *glyph)
{
ginfo("fcache=%p glyph=%p\n", priv, glyph);
/* Add the glyph to the head of the list */
glyph->flink = priv->head;
if (priv->head == NULL)
{
priv->tail = glyph;
}
priv->head = glyph;
/* Increment the count of glyphs in the font cache. */
DEBUGASSERT(priv->nglyphs < priv->maxglyphs);
priv->nglyphs++;
}
/****************************************************************************
* Name: nxf_findglyph
*
* Description:
* Find the glyph for the specific character 'ch' in the list of pre-
* rendered fonts in the font cache.
*
* This is logically a part of nxf_cache_getglyph(). nxf_cache_getglyph()
* will attempt to find the cached glyph before rendering a new one. So
* this function has two unexpected side-effects: (1) If the font cache
* is full and the font is not found, then the least-recently-used glyph
* is deleted to make space for the new glyph that will be allocated.
*
* (2) If the glyph is found, then it is moved to the head of the list of
* glyphs since it is now the most recently used (leaving the least
* recently used glyph at the tail of the list).
*
* Assumptions:
* The caller has exclusive access to the font cache.
*
****************************************************************************/
static FAR struct nxfonts_glyph_s *
nxf_findglyph(FAR struct nxfonts_fcache_s *priv, uint8_t ch)
{
FAR struct nxfonts_glyph_s *glyph;
FAR struct nxfonts_glyph_s *prev;
ginfo("fcache=%p ch=%c (%02x)\n",
priv, (ch >= 32 && ch < 128) ? ch : '.', ch);
/* Try to find the glyph in the list of pre-rendered glyphs */
for (prev = NULL, glyph = priv->head;
glyph != NULL;
prev = glyph, glyph = glyph->flink)
{
/* Check if we found the glyph for this character */
if (glyph->code == ch)
{
/* This is now the most recently used glyph. Move it to the head
* of the list (if it is not already at the head of the list).
*/
if (prev != NULL)
{
nxf_removeglyph(priv, glyph, prev);
nxf_addglyph(priv, glyph);
}
/* And return the glyph that we found */
return glyph;
}
/* Is this the last glyph in the list? Has the cache reached its
* limit for the number of cached fonts?
*/
if (glyph->flink == NULL && priv->nglyphs >= priv->maxglyphs)
{
/* Yes.. then remove it from the list and free the glyph memory.
* We do this because we have all of the information in hand now
* and we will surely need to have this space later.
*/
nxf_removeglyph(priv, glyph, prev);
lib_free(glyph);
return NULL;
}
}
return NULL;
}
/****************************************************************************
* Name: nxf_fillglyph
*
* Description:
* Fill the glyph memory with the background color
*
****************************************************************************/
static inline void nxf_fillglyph(FAR struct nxfonts_fcache_s *priv,
FAR struct nxfonts_glyph_s *glyph)
{
int row;
int col;
UNUSED(row); /* Not used in all configurations */
UNUSED(col);
/* Initialize the glyph memory to the background color. */
#if !defined(CONFIG_NXFONTS_DISABLE_1BPP) || !defined(CONFIG_NXFONTS_DISABLE_2BPP) || \
!defined(CONFIG_NXFONTS_DISABLE_4BPP) || !defined(CONFIG_NXFONTS_DISABLE_8BPP)
/* For pixel depths of 1, 2, 4, and 8, build up an 8-bit value containing
* multiple background colored pixels.
*/
if (priv->bpp <= 8)
{
uint8_t pixel = (uint8_t)priv->bgcolor;
FAR uint8_t *ptr;
#ifndef CONFIG_NXFONTS_DISABLE_1BPP
/* Pack a 1-bit pixel to 2 pixels */
if (priv->bpp < 2)
{
/* Pack 1-bit pixels into a 2-bits */
pixel &= 0x01;
pixel = (pixel) << 1 | pixel;
}
#endif
#if !defined(CONFIG_NXFONTS_DISABLE_1BPP) || !defined(CONFIG_NXFONTS_DISABLE_2BPP)
/* Pack a 2-bit pixel to a 4-bit nibble */
if (priv->bpp < 4)
{
/* Pack 2-bit pixels into a nibble */
pixel &= 0x03;
pixel = (pixel) << 2 | pixel;
}
#endif
#if !defined(CONFIG_NXFONTS_DISABLE_1BPP) || !defined(CONFIG_NXFONTS_DISABLE_2BPP) || \
!defined(CONFIG_NXFONTS_DISABLE_4BPP)
/* Pack the 4-bit nibble into a byte */
if (priv->bpp < 8)
{
pixel &= 0x0f;
pixel = (pixel) << 4 | pixel;
}
#endif
/* Then fill the glyph with the packed background color */
ptr = (FAR uint8_t *)glyph->bitmap;
for (row = 0; row < glyph->height; row++)
{
for (col = 0; col < glyph->stride; col++)
{
/* Transfer the packed bytes into the buffer */
*ptr++ = pixel;
}
}
}
else
#endif
#if !defined(CONFIG_NXFONTS_DISABLE_16BPP)
if (priv->bpp == 16)
{
FAR uint16_t *ptr = (FAR uint16_t *)glyph->bitmap;
for (row = 0; row < glyph->height; row++)
{
/* Just copy the color value into the glyph memory */
for (col = 0; col < glyph->width; col++)
{
*ptr++ = priv->bgcolor;
}
}
}
else
#endif
#ifndef CONFIG_NXFONTS_DISABLE_24BPP
if (priv->bpp == 24)
{
FAR uint32_t *ptr = (FAR uint32_t *)glyph->bitmap;
FAR uint32_t pixel[3];
/* Get two 32-bit values for alternating 32 representations */
pixel[0] = (uint32_t)priv->bgcolor << 8 |
(uint32_t)priv->bgcolor >> 16;
pixel[1] = (uint32_t)priv->bgcolor << 16 |
(uint32_t)priv->bgcolor >> 8;
pixel[2] = (uint32_t)priv->bgcolor << 24 |
(uint32_t)priv->bgcolor;
for (row = 0; row < glyph->height; row++)
{
/* Copy the color value into the glyph memory */
col = 0;
for (; ; )
{
*ptr++ = pixel[0];
if (++col >= glyph->width)
{
break;
}
*ptr++ = pixel[1];
if (++col >= glyph->width)
{
break;
}
*ptr++ = pixel[2];
if (++col >= glyph->width)
{
break;
}
}
}
}
else
#endif
#if !defined(CONFIG_NXFONTS_DISABLE_32BPP)
if (priv->bpp == 32)
{
FAR uint32_t *ptr = (FAR uint32_t *)glyph->bitmap;
for (row = 0; row < glyph->height; row++)
{
/* Just copy the color value into the glyph memory */
for (col = 0; col < glyph->width; col++)
{
*ptr++ = priv->bgcolor;
}
}
}
else
#endif
{
DEBUGPANIC();
}
}
/****************************************************************************
* Name: nxf_renderglyph
*
* Description:
* Allocate memory for a new glyph and render the bitmap font into the
* allocated glyph memory.
*
* Assumptions:
* The caller holds the font cache lock.
*
****************************************************************************/
static inline FAR struct nxfonts_glyph_s *
nxf_renderglyph(FAR struct nxfonts_fcache_s *priv,
FAR const struct nx_fontbitmap_s *fbm, uint8_t ch)
{
FAR struct nxfonts_glyph_s *glyph = NULL;
size_t bmsize;
unsigned int height;
unsigned int width;
unsigned int stride;
int ret;
ginfo("fcache=%p fbm=%p ch=%c (%02x)\n",
priv, fbm, (ch >= 32 && ch < 128) ? ch : '.', ch);
/* Get the size of the glyph */
width = fbm->metric.width + fbm->metric.xoffset;
height = fbm->metric.height + fbm->metric.yoffset;
/* Get the physical width of the glyph in bytes */
stride = (width * priv->bpp + 7) >> 3;
/* Allocate the glyph (always succeeds) */
bmsize = stride * height;
glyph = (FAR struct nxfonts_glyph_s *)
lib_malloc(SIZEOF_NXFONTS_GLYPH_S(bmsize));
if (glyph != NULL)
{
/* Save the character code, dimensions, and physical width of the
* glyph.
*/
glyph->code = ch;
glyph->width = width;
glyph->height = height;
glyph->stride = stride;
/* Initialize the glyph memory to the background color. */
nxf_fillglyph(priv, glyph);
/* Then render the glyph into the allocated, initialized memory */
ret = priv->renderer((FAR nxgl_mxpixel_t *)glyph->bitmap,
glyph->height, glyph->width, glyph->stride,
fbm, priv->fgcolor);
if (ret < 0)
{
/* Actually, the renderer never returns a failure */
gerr("ERROR: nxf_renderglyph: Renderer failed\n");
lib_free(glyph);
return NULL;
}
/* Add the new glyph to the font cache */
nxf_addglyph(priv, glyph);
}
return glyph;
}
/****************************************************************************
* Name: nxf_findcache
*
* Description:
* Find a font cache tht matches the font charcteristics.
*
* Assumptions:
* The caller holds the font cache list lock.
*
****************************************************************************/
static FAR struct nxfonts_fcache_s *
nxf_findcache(enum nx_fontid_e fontid, nxgl_mxpixel_t fgcolor,
nxgl_mxpixel_t bgcolor, int bpp)
{
FAR struct nxfonts_fcache_s *fcache;
ginfo("fontid=%d fgcolor=%ju bgcolor=%ju bpp=%d\n",
fontid, (uintmax_t)fgcolor, (uintmax_t)bgcolor, bpp);
/* Search for a cache for this font characteristics */
for (fcache = g_fcaches; fcache != NULL; fcache = fcache->flink)
{
/* Does this font have the same characteristics? */
if (fcache->fontid == fontid &&
fcache->fgcolor == fgcolor &&
fcache->bgcolor == bgcolor &&
fcache->bpp == bpp)
{
/* Yes... return it */
ginfo("Returning fcache=%p\n", fcache);
return fcache;
}
}
ginfo("Not found\n");
return NULL;
}
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: nxf_cache_connect
*
* Description:
* Create a new font cache for the provided 'fontid'. If the cache
* already, then just increment a reference count return the handle for
* the existing font cache.
*
* Input Parameters:
* fontid - Identifies the font supported by this cache
* fgcolor - Foreground color
* bgcolor - Background color
* bpp - Bits per pixel
* maxglyphs - Maximum number of glyphs permitted in the cache
*
* Returned Value:
* On success a non-NULL handle is returned that then may sequently be
* used with nxf_getglyph() to extract fonts from the font cache. NULL
* returned on any failure with the errno value set to indicate the nature
* of the error.
*
****************************************************************************/
FCACHE nxf_cache_connect(enum nx_fontid_e fontid,
nxgl_mxpixel_t fgcolor, nxgl_mxpixel_t bgcolor,
int bpp, int maxglyphs)
{
FAR struct nxfonts_fcache_s *priv;
int errcode;
ginfo("fontid=%d fgcolor=%ju bgcolor=%ju bpp=%d maxglyphs=%d\n",
fontid, (uintmax_t)fgcolor, (uintmax_t)bgcolor, bpp, maxglyphs);
/* Get exclusive access to the font cache list */
nxmutex_lock(&g_cachelock);
/* Find a font cache with the matching font characteristics */
priv = nxf_findcache(fontid, fgcolor, bgcolor, bpp);
if (priv == NULL)
{
/* There isn't one... we will have to create a new font cache for this
* client.
*/
/* Allocate memory for the (empty) font cache */
priv = (FAR struct nxfonts_fcache_s *)
lib_zalloc(sizeof(struct nxfonts_fcache_s));
if (priv == NULL)
{
errcode = ENOMEM;
goto errout_with_lock;
}
/* Initialize the font cache */
priv->fontid = fontid;
priv->fclients = 1;
priv->maxglyphs = maxglyphs;
priv->bpp = bpp;
priv->fgcolor = fgcolor;
priv->bgcolor = bgcolor;
/* Select the rendering function */
/* Select renderer -- Some additional logic would be required to
* support pixel depths that are not directly addressable (1,2,4, and
* 24).
*/
switch (bpp)
{
#ifndef CONFIG_NXFONTS_DISABLE_1BPP
case 1:
priv->renderer = (nxf_renderer_t)nxf_convert_1bpp;
break;
#endif
#ifndef CONFIG_NXFONTS_DISABLE_2BPP
case 2:
priv->renderer = (nxf_renderer_t)nxf_convert_2bpp;
break;
#endif
#ifndef CONFIG_NXFONTS_DISABLE_4BPP
case 4:
priv->renderer = (nxf_renderer_t)nxf_convert_4bpp;
break;
#endif
#ifndef CONFIG_NXFONTS_DISABLE_8BPP
case 8:
priv->renderer = (nxf_renderer_t)nxf_convert_8bpp;
break;
#endif
#ifndef CONFIG_NXFONTS_DISABLE_16BPP
case 16:
priv->renderer = (nxf_renderer_t)nxf_convert_16bpp;
break;
#endif
#ifndef CONFIG_NXFONTS_DISABLE_24BPP
case 24:
priv->renderer = (nxf_renderer_t)nxf_convert_24bpp;
break;
#endif
#ifndef CONFIG_NXFONTS_DISABLE_32BPP
case 32:
priv->renderer = (nxf_renderer_t)nxf_convert_32bpp;
break;
#endif
default:
gerr("ERROR: Unsupported pixel depth: %d\n", bpp);
errcode = ENOSYS;
goto errout_with_fcache;
}
/* Select the font */
priv->font = nxf_getfonthandle(fontid);
if (priv->font == NULL)
{
errcode = get_errno();
gerr("ERROR: Failed to get font ID %d: %d\n", fontid, errcode);
goto errout_with_fcache;
}
/* Initialize the mutual exclusion mutex */
nxmutex_init(&priv->flock);
/* Add the new font cache to the list of font caches */
priv->flink = g_fcaches;
g_fcaches = priv;
}
else
{
/* A font cache with these characteristics already exists. Just make
* sure that it is as least a big as the size requested.
*/
if (priv->maxglyphs < maxglyphs)
{
priv->maxglyphs = maxglyphs;
}
/* Increment the number of clients of the font cache */
priv->fclients++;
}
nxmutex_unlock(&g_cachelock);
ginfo("fhandle=%p\n", priv);
return (FCACHE)priv;
errout_with_fcache:
lib_free(priv);
errout_with_lock:
nxmutex_unlock(&g_cachelock);
set_errno(errcode);
return NULL;
}
/****************************************************************************
* Name: nxf_cache_disconnect
*
* Description:
* Decrement the reference count on the font cache and, if the reference
* count goes to zero, free all resources used by the font cache. The
* font handle is invalid upon return in either case.
*
* Input Parameters:
* fhandle - A font cache handle previously returned by
* nxf_cache_connect();
*
* Returned Value:
* None
*
****************************************************************************/
void nxf_cache_disconnect(FCACHE fhandle)
{
FAR struct nxfonts_fcache_s *priv = (FAR struct nxfonts_fcache_s *)fhandle;
FAR struct nxfonts_fcache_s *fcache;
FAR struct nxfonts_fcache_s *prev;
FAR struct nxfonts_glyph_s *glyph;
FAR struct nxfonts_glyph_s *next;
ginfo("fhandle=%p\n", fhandle);
DEBUGASSERT(priv != NULL && priv->fclients > 0);
/* Get exclusive access to the font cache */
nxmutex_lock(&priv->flock);
/* Is this the last client of the font cache? */
if (priv->fclients <= 1)
{
/* Get exclusive access to the font cache list */
nxmutex_lock(&g_cachelock);
/* Remove the font cache from the list of caches. This is a singly
* linked list, so we must do this the hard way.
*/
for (prev = NULL, fcache = g_fcaches;
fcache != priv && fcache != NULL;
fcache = fcache->flink)
{
}
DEBUGASSERT(fcache == priv);
nxf_removecache(fcache, prev);
nxmutex_unlock(&g_cachelock);
/* Free all allocated glyph memory */
for (glyph = priv->head; glyph != NULL; glyph = next)
{
next = glyph->flink;
lib_free(glyph);
}
/* Destroy the serializing lock... while we are holding it? */
nxmutex_destroy(&priv->flock);
/* Finally, free the font cache structure itself */
lib_free(priv);
}
else
{
/* No.. just decrement the number of clients connected to the font
* cache.
*/
priv->fclients--;
nxmutex_unlock(&priv->flock);
}
}
/****************************************************************************
* Name: nxf_cache_getfonthandle
*
* Description:
* Return the handle to the font set used by this instance of the font
* cache.
*
* Input Parameters:
* fhandle - A font cache handle previously returned by
* nxf_cache_connect();
*
* Returned Value:
* Zero (OK) is returned if the metrics were
*
* Returned Value:
* On success, a non-NULL font handle is returned.
*
****************************************************************************/
NXHANDLE nxf_cache_getfonthandle(FCACHE fhandle)
{
FAR struct nxfonts_fcache_s *priv = (FAR struct nxfonts_fcache_s *)fhandle;
DEBUGASSERT(priv != NULL && priv->font != NULL);
return priv->font;
}
/****************************************************************************
* Name: nxf_cache_getglyph
*
* Description:
* Get the font glyph for the character code 'ch' from the font cache. If
* the glyph for that character code does not exist in the font cache, it
* be rendered.
*
* Returned Value:
* On success, a non-NULL pointer to the rendered glyph in the font cache
* is returned. NULL is returned on any failure.
*
****************************************************************************/
FAR const struct nxfonts_glyph_s *
nxf_cache_getglyph(FCACHE fhandle, uint8_t ch)
{
FAR struct nxfonts_fcache_s *priv = (FAR struct nxfonts_fcache_s *)fhandle;
FAR struct nxfonts_glyph_s *glyph;
FAR const struct nx_fontbitmap_s *fbm;
ginfo("ch=%c (%02x)\n", (ch >= 32 && ch < 128) ? ch : '.', ch);
/* Get exclusive access to the font cache */
nxmutex_lock(&priv->flock);
/* First, try to find the glyph in the cache of pre-rendered glyphs */
glyph = nxf_findglyph(priv, ch);
if (glyph == NULL)
{
/* No, it is not cached... Does the code map to a font? */
fbm = nxf_getbitmap(priv->font, ch);
if (fbm)
{
/* Yes.. render the glyph for the font */
glyph = nxf_renderglyph(priv, fbm, ch);
}
}
nxmutex_unlock(&priv->flock);
return glyph;
}
Reference in New Issue View Git Blame Copy Permalink