glue_queue.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_QUEUE_H
#define _GLUE_QUEUE_H

#include "mherrors.h"
#include "dvb_misc.h"
#include "mheg5_control.h"
#include "mheg5_keypress.h"
#include "dvbevents.h"
#include "dmxtype.h"
#include "dvblocator.h"
#include "fs_types.h"
#include "dtvstring.h"

#define MAX_MSG_SIZE    32    /*bytes*/

typedef void (*F_QueueNotify)( void );

typedef enum
{
   PRTY_CRITICAL,    /*start/stop/key-press*/
   PRTY_NORMAL,      /*Events*/
   PRTY_RESULTS,     /*query results*/
   PRTY_DSMCC_HIGH,
   PRTY_DSMCC_LOW,
   PRTY_INVALID
} E_PRIORITY;

typedef enum
{
   DT_NONE,
   DT_VALUE,
   DT_ALLOC,
   DT_CONTENT,
   DT_D_CONTENT,
   DT_F_CONTENT,
   DT_S_CONTENT
} E_DATA_TYPE;

typedef void (*F_MSG_PROCESS)( void *data );

/* MHEG5StartEvent parameters. */
typedef struct s_StartDsmApp
{
   S32BIT serviceIndex;
} S_StartDsmApp;


typedef struct s_keypressevent
{
   E_MHEG5_KEY key;
} S_KeyPressEvent;

typedef struct s_DsmccEvent
{
   U32BIT id;
   void *hCarousel;
} S_DsmccEvent;

typedef struct s_CiStart
{
   S_STRING name;
   U32BIT module_id;
} S_CiStart;

typedef struct s_CiStop
{
   U32BIT module_id;
} S_CiStop;

/* MHEG5StopEvent parameters. */
typedef struct MHEG5StopEventParams_tag
{
   U8BIT action;
} MHEG5StopEventParams_t;

/* MHEG5ResetScreenEvent params */
typedef struct MHEG5ResetResolutionParams_tag
{
   U16BIT screenWidth;
   U16BIT screenHeight;
   E_MhegErr *pResult;
} MHEG5ResetResolutionParams_t;

/* MHEG5TimerEvent parameters. */
typedef struct MHEG5TimerEventParams_tag
{
   BOOLEAN triggered;
   void *callerRef;
   void *timerHandle;
} MHEG5TimerEventParams_t;

typedef struct s_fileAck
{
   S_CONTENT content;
   E_FsStatus status;
} S_FileSystemAck;

/* MHEG5CiFileAcknowledgeEvent parameters. */
typedef struct MHEG5CiFileAcknowledgeEventParams_tag
{
   /* structure is same format as S_CONTENT */
   U32BIT fileSize;
   U8BIT *pFileData;
   F_DESTROY clr_func;
   FS_HANDLE clr_hdl;
   BOOLEAN fileOK;
} MHEG5CiFileAcknowledgeEventParams_t;

#ifdef INCLUDE_IC
/* MHEG5HttpResponseEvent parameters. */
typedef struct MHEG5HttpResponseEventParams_tag
{
   U32BIT len;
   U8BIT *data;
   U32BIT requestId;
   U32BIT status;
   U32BIT code;
   U8BIT requestType;
} MHEG5HttpResponseEventParams_t;

#ifdef INCLUDE_ICS
/* MHEG5StreamerEvent parameters. */
typedef struct MHEG5StreamerEventParams_tag
{
   U32BIT requestId;
   U32BIT eventType;
   U32BIT status;
   U32BIT code;
   S32BIT triggerId;
} MHEG5StreamerEventParams_t;
#endif  /* INCLUDE_ICS */

#endif  /* INCLUDE_IC */

typedef struct MHEG5FsStorageParams_tag
{
   U8BIT blockSize;
   U8BIT blocks;
   BOOLEAN group;
   U16BIT identifier;
} MHEG5FsStorageParams_t;

typedef struct s_dvpeventtype
{
   E_DvbEvent eType;
   U32BIT eData;
} S_DvpEventType;

#ifdef INCLUDE_SURFACE_THRESHOLD
typedef struct MHEG5SurfaceThresholdEventParams_tag
{
   S32BIT pixels;
} MHEG5SurfaceThresholdEventParams_t;
#endif

/* Event parameters. */
typedef struct s_mhg_message
{
   F_MSG_PROCESS proc_msg_func;
   E_DATA_TYPE data_type;
   union
   {
      S_CONTENT content;
      S_STRING string;
      S_CiStart ciStart;
      S_CiStop ciStop;
      S_DsmccEvent dsmEvent;
      S_DvpEventType dvpEvent;
      S_KeyPressEvent keypress;
      S_FileSystemAck fsAck;
      S_StartDsmApp start;
      MHEG5StopEventParams_t stop;
      MHEG5TimerEventParams_t timer;
      MHEG5CiFileAcknowledgeEventParams_t ciFileAcknowledge;
       #ifdef INCLUDE_IC
      MHEG5HttpResponseEventParams_t httpResponse;
       #ifdef INCLUDE_ICS
      MHEG5StreamerEventParams_t streamer;
       #endif /* INCLUDE_ICS */
       #endif /* INCLUDE_IC */
      MHEG5ResetResolutionParams_t resetRes;
       #ifdef INCLUDE_FREESAT
      MHEG5FsStorageParams_t fsStorage;
       #endif
       #ifdef INCLUDE_SURFACE_THRESHOLD
      MHEG5SurfaceThresholdEventParams_t surfaceThreshold;
       #endif
   } data;
} MHEG5eventMessage_t, S_MhegMessage;

E_MhegErr VQ_Open( S_MhegConfig *cfg_params );


void VQ_Close(void);

E_MhegErr VQ_PutMsg( S_MhegMessage *pMsg, E_PRIORITY priority );


E_MhegErr VQ_GetMsg( S_MhegMessage *pElem );

U16BIT VQ_GetSizeFree( E_PRIORITY priority );

BOOLEAN VQ_EventNeedsProcessing( void );

void* VQ_RegisterNotify( F_QueueNotify normal_rcvd, F_QueueNotify critical_rcvd,
   F_QueueNotify critical_done );

void VQ_UnRegisterNotify( void *qn );

#endif /*_GLUE_QUEUE_H*/