mg_font.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2010 Ocean Blue Software Ltd
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _MG_FONT_H
#define _MG_FONT_H

#include <ft2build.h>
#include FT_FREETYPE_H
#include FT_PFR_H

#include "techtype.h"

#define FIRST_CACHE_CHAR    ('!')
#define CHAR_CACHE_SIZE     0x5e
#define BUILT_IN_FONT       0

#define FTYPE_TTF 0
#define FTYPE_PFR 1

/*---Constant and macro definitions for public use-----------------------------*/

/*---Enumerations for public use-----------------------------------------------*/

typedef enum
{
   NORMAL_SD,
   NORMAL_HD
} E_HDMode;

/*---Global type defs for public use-------------------------------------------*/

/* Function initialising 'VBox' must ensure that
 * the box maps wholely on the visible screen
 * (i.e. for SD screen, within 0,0 to 720,576
 *  or for a typical HD screen, within 0,0 to 1920,1080 )
 */
typedef struct _VBox
{
   U16BIT left;
   U16BIT top;
   U16BIT width;
   U16BIT height;
} VBox, *pVBox;

typedef struct _CacheSbit
{
   U32BIT bmp_ndx;
   S8BIT advance;
   S8BIT top;
   S8BIT left;
   U8BIT height;
   U8BIT width;
   S8BIT sdleft;
} CacheSbit;

typedef struct sFontSize
{
   struct sFontSize *next;
   U16BIT height;
   U16BIT width;
   VBox bound_box;
   U32BIT mem_size;      /*sizeof bitmaps in sbit_cache*/
   CacheSbit *sbit_cache;
   U32BIT cache_hit;
   U32BIT cache_last;
   U32BIT fnt_id;
   S8BIT space_adv;
   S8BIT figure_adv;
   U8BIT bb_sd_height;       /* in SD coord value */
   U8BIT bb_sd_width;
   U8BIT bb_sd_top;
   U8BIT spxl_xleftoffset;
   U8BIT pnts_xleftoffset;
} S_FontSize;

typedef struct sFontDetails
{
   struct sFontDetails *next;
   U8BIT *file_data;
   U32BIT file_size;
   FT_Face face;
   S_FontSize *first_sz;
   FT_UInt glyph_ndx_space;
   FT_UInt space_horiz_adv;
   FT_UInt fig_horiz_adv;
   FT_UInt horiz_adv[CHAR_CACHE_SIZE];    /* for chars 0x20..0x7e */
   FT_UInt glyph_ndx[CHAR_CACHE_SIZE];    /* for chars 0x21..0x7e */
   U16BIT font_ndx;
   U16BIT face_type;
   U32BIT current_fnt_id;
   FT_UInt metric_resolution;
} S_FontDetails;


/*---Global Function prototypes for public use---------------------------------*/

S_FontDetails* MG_GetFontPtr( S16BIT font_index );
void MG_ReleaseFontPtr( S_FontDetails *fp );
S_FontSize* MG_GetFontSize( U16BIT fnt_index, U8BIT fnt_size, U8BIT fnt_style );
void MG_CheckCache( S_FontSize *sz_data );
S_FontDetails* MG_FindFont( S_FontSize *f_sz );

extern E_HDMode mg_hd_mode;

#endif /*_MG_FONT_H*/