mh5fileorm.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 * Copyright © 2000 Koninklijke Philips Electronics N.V
 *
 * 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 _MH5FORM_H_
#define _MH5FORM_H_

/*---includes for this file--------------------------------------------------*/
#include "mh5base.h"
#include "mh5root.h"
#include "fs_types.h"
#include "mh5gate.h"

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

/* File Request Priority types and masks */
#define FRP_CACHE_DEFAULT  0x007F
#define FRP_CACHE_MASK     0x00FF
#define FRP_APPLICATION    0x0100
#define FRP_SCENE          0x0200
#define FRP_GROUP          0x0300
#define FRP_EXISTS         0x0400
#define FRP_VERIFY         0x0800
#define FRP_HASH           0x1000
#define FRP_CERT           0x2000
#define FRP_SERVER         0x3000
#define FRP_DEFER_SERV     0x4000
#define FRP_IN_APP         0x8000

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

/*---Global type defs for public use-----------------------------------------*/
typedef enum
{
   MHEG5_FILE_ORM_RESET_SCENE_OBJECTS,
   MHEG5_FILE_ORM_RESET_ALL_OBJECTS,
   MHEG5_FILE_ORM_RESET_ALL
} MHEG5FileOrmResetMode;

typedef void (*F_CB_Good)( void *userData, S_CONTENT *content );
typedef void (*F_CB_Fail)( void *userData );
typedef void (*F_CB_Post)(void *userData, MHEG5String responseData, MHEG5Int responseCode);
typedef void (*F_CB_CiMsg)(void *userData, MHEG5String output, MHEG5Bool success);


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

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

void MHEG5FileOrmInit(void);


void MHEG5FileOrmReset(MHEG5FileOrmResetMode resetMode);


BOOLEAN MHEG5FileOrmIsReset(MHEG5FileOrmResetMode *resetMode);


BOOLEAN MHEG5FileOrmProcess(void);


void MHEG5FileOrmClear( void *orm_ref );


void* MHEG5FileOrmGet( MHEG5String name, U16BIT priority, void *userData,
   F_CB_Good cbGood, F_CB_Fail cbFail );

void* MHEG5FileOrmRetrieve( E_FS_ORIGIN origin, S_STRING location, S_STRING name,
   U16BIT priority, void *userData, F_CB_Good cbGood, F_CB_Fail cbFail);

#ifdef COMMON_INTERFACE

MHEG5Bool MHEG5FileOrmSendCiMessage(MHEG5String input, F_CB_CiMsg callback, void *userData);
#endif /*COMMON_INTERFACE*/

#ifdef INCLUDE_IC

MHEG5Bool MHEG5FileOrmReturnData(MHEG5String url, MHEG5String data, F_CB_Post callback, void *userData);

#endif /* INCLUDE_IC */


void MHEG5FileOrmPreloadHint(MHEG5String name);

void MHEG5ciFileAcknowledge(BOOLEAN fileOK, U8BIT *pFileData, U32BIT length);

#endif /*_MH5FORM_H*/