include/dvb_misc.h

Go to the documentation of this file.

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

#include "techtype.h"
#include "mherrors.h"

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

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

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

/* Structure for holding date and time. */
typedef struct s_datetime
{
   /* Examples show the values that should be set to indicate the 1st February,
    * 2003 at 45 seconds past 1:23 PM.
    */

   /* Year, including century.
    * e.g. 2003
    */
   U32BIT year;

   /* Month number from 1 to 12, representing January to December
    * e.g. 2
    */
   U32BIT month;

   /* Day of the current month, from 1 to 31
    * e.g. 1
    */
   U32BIT day;

   /* Hour in 24 hour format, in the range 0 to 23
    * e.g. 13
    */
   U32BIT hour;

   /* Minute, in the range 0 to 59
    * e.g. 23
    */
   U32BIT minute;

   /* Second in the range 0 to 59
    * e.g. 45
    */
   U32BIT second;
} S_DateTime;


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

E_MhegErr DVB_MhegGetLocalTime(S_DateTime *pDateAndTime);

void DVB_MhegPromotionalLinkControl( BOOLEAN isEnabled );

#ifdef NOTIFY_KEYPRESS_REQ

E_MhegErr DVB_MhegSetInputRegister(S32BIT inputReg);

#endif  /* NOTIFY_KEYPRESS_REQ */

#ifdef INCLUDE_DEBUG_PACKAGE

E_MhegErr DVB_MhegOutputDebugString(U8BIT *debugString);

#endif  /* INCLUDE_DEBUG_PACKAGE */

#endif /* _DVB_MISC_H */