source/glue/inc/glue_memory.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2011 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 _GLUE_MEMORY_H
#define _GLUE_MEMORY_H

/*---includes for this file--------------------------------------------------*/

#include "stb_memory.h"
#include "dtvstring.h"

#include <string.h>     /* for memcpy() */

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

/* Strip the callingFunction function pointer in retail builds */
#ifdef MHG_TRACK_MEM

   #define SRCMEM_SYSTEM     1
   #define SRCMEM_DSMCC      2
   #define SRCMEM_SIQURY     3
   #define SRCMEM_SSF        4
   #define SRCMEM_FT2        5
   #define SRCMEM_APP        6
   #define SRCMEM_OSD        7
   #define SRCMEM_SURF       8
   #define SRCMEM_HBB        9
   #define MAX_MEM_SRCS      10

   #ifndef F_IDENT
   #define F_IDENT __FUNCTION__
   #endif

/* MHEG engine initial overhead */
   #define SYS_Alloc(sz)      MHEG5getMemFunc((void *)F_IDENT, sz, __LINE__, SRCMEM_SYSTEM )
   #define SYS_Free           MHEG5freeMemFunc

/* DSM-CC */
   #define DSMAlloc(sz)       MHEG5getMemFunc((void *)F_IDENT, sz, __LINE__, SRCMEM_DSMCC )
   #define DSMFree            MHEG5freeMemFunc

/* Freetype */
   #define FT2_MemAlloc(sz)   MHEG5getMemFunc((void *)F_IDENT, sz, __LINE__, SRCMEM_FT2 )
   #define FT2_MemFree        MHEG5freeMemFunc

/* Mheg application */
   #define MHEG5getMem(size)  MHEG5getMemFunc((void *)F_IDENT, size, __LINE__, SRCMEM_APP )
   #define MHEG5freeMem       MHEG5freeMemFunc

/* Mheg Graphics */
   #define OSD_MemAlloc(sz)   MHEG5getMemFunc((void *)F_IDENT, sz, __LINE__, SRCMEM_OSD )
   #define OSD_MemFree        MHEG5freeMemFunc

   #define STR_DataAlloc(l)   STR_DataAllocFunc(l, __LINE__)

   #define MH5GlueStringAlloc(l)    MH5GlueStringAllocFunc(l, __LINE__)
   #define MH5GlueStringCreate(l)   MH5GlueStringCreateFunc(l, d, __LINE__)
   #define MH5GlueStringCopy(s)     MH5GlueStringCopyFunc(s, __LINE__)
   #define MH5GlueStringConcat(s1, s2) MH5GlueStringConcatFunc(s1, s2, __LINE__)

#else

   #define SYS_Alloc           STB_MemAlloc
   #define SYS_Free            STB_MemFree

   #define DSMAlloc           STB_MemAlloc
   #define DSMFree            STB_MemFree

   #define FT2_MemAlloc       STB_MemAlloc
   #define FT2_MemFree        STB_MemFree

   #define MHEG5getMem        STB_MemAlloc
   #define MHEG5freeMem       STB_MemFree

   #define OSD_MemAlloc       STB_MemAlloc
   #define OSD_MemFree        STB_MemFree

#endif /* MHG_TRACK_MEM */

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

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

/*---Global variable declarations for public use-----------------------------*/

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

BOOLEAN MH5GlueMemoryInitialise(void);
void MH5GlueMemoryTerminate(void);

/*
   system dependend memory handling
 */

void MHEG5freeMemFunc(void *what);


#ifdef MHG_TRACK_MEM

/*******************************************************************************
 *@begin
 * NAME: MHEG5getMemFunc
 *       Allocate a block of memory from the free pool.
 *
 * Returns : Pointer to allocated memory, or NULL if allocation fails.
 *
 * Parameter         Flow    Description
 * ------------------------------------------------------------------------------
 * callingFunction   IN      Pointer to the calling function (only when MHEG5LOG
 *                           is defined.
 * size              IN      Size in bytes of the memory region to allocate.
 *
 * Additional information:
 *
 *   This function should be called using the macro MHEG5getMem. This ensures
 *   that the callingFunction parameter is only passed in when MHEG5LOG is
 *   defined.
 *
 *@end
 *******************************************************************************/
void* MHEG5getMemFunc(void *callingFunction, int size, int line, int src);

void mh5emt_print(unsigned int which);

/*******************************************************************************
 *@begin
 * NAME: STR_DataAlloc(Func)
 *       Allocate a block of memory from the free pool for strings
 *
 * Returns : Pointer to allocated memory, or NULL if allocation fails.
 *
 * Parameter    Flow    Description
 * --------------------------------------------------------------------------
 * size          IN     Size in bytes of the memory region to allocate.
 * line          IN     Line number in source (with 'Func')
 *
 * Additional information:
 *
 *   This function should be called using the macro MHEG5getMem. This ensures
 *   that the callingFunction parameter is only passed in when MHEG5LOG is
 *   defined.
 *
 *@end
 *******************************************************************************/
unsigned char* STR_DataAllocFunc( unsigned int size, int line );

S_STRING MH5GlueStringAllocFunc( U32BIT size, int line );
S_STRING MH5GlueStringCreateFunc( U32BIT size, U8BIT *data, int line );
S_STRING MH5GlueStringCopyFunc( S_STRING source, int line );
S_STRING MH5GlueStringConcatFunc(S_STRING src1, S_STRING src2);

#else   /* MHG_TRACK_MEM */

unsigned char* STR_DataAlloc( unsigned int size );

S_STRING MH5GlueStringAlloc( U32BIT size );
S_STRING MH5GlueStringCreate( U32BIT size, U8BIT *data );
S_STRING MH5GlueStringCopy( S_STRING source );
S_STRING MH5GlueStringConcat(S_STRING src1, S_STRING src2);


#endif  /* MHG_TRACK_MEM */

void STR_Shutdown(void);
void STR_TidyUp(void);
void STR_DataFree( unsigned char *data, unsigned int size );
void MH5GlueStringFree( S_STRING *pStr );

#endif /*_GLUE_MEMORY_H*/