atsc_types.h

Go to the documentation of this file.

/*******************************************************************************
  * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
  *
  * 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 __ATSC_TYPES_H__
#define __ATSC_TYPES_H__
 
#include <inttypes.h>
#include <functional>
#include <stdio.h>
#include <unistd.h>
#include <string.h>
#include <vector>
#include <string>
#include <map>
 
#include "atsccore_prod_config.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "atsc_basetype.h"
 
 
#define ATSCCORE_ESG_URLS "atsc30core.esg.urls"
 
#define ATSCCORE_ESG_URLS_QUERY "atsc30core.esg.urls.query"
 
#define ATSCCORE_ESG_URLS_CLEAR "atsc30core.esg.clear"
 
#define ATSCCORE_SLS_URLS "atsc30core.sls.urls"
 
#define ATSCCORE_SLS_URLS_QUERY "atsc30core.sls.urls.query"
 
#define ATSCCORE_NRT_URLS "atsc30core.nrt.urls"
 
#define ATSCCORE_NRT_URLS_QUERY "atsc30core.nrt.urls.query"
 
#define ATSCCORE_APP_URLS "atsc30core.app.urls"
 
#define ATSCCORE_APP_URLS_QUERY "atsc30core.app.urls.query"
 
#define ATSCCORE_HELD_URLS "atsc30core.held.urls"
 
#define ATSCCORE_HELD_URLS_QUERY "atsc30core.held.urls.query"
 
#define ATSCCORE_HELD_MSGS "atsc30core.held.msgs"
 
#define ATSCCORE_HELD_MSGS_QUERY "atsc30core.held.msgs.query"
 
#define ATSCCORE_HELD_MSGS_CLEAR "atsc30core.held.msgs.clear"
 
#define ATSCCORE_FILES_CLEAR "atsc30core.files.clear"
 
#define ATSCCORE_FILES_REMOVE "atsc30core.files.remove"
 
#define ATSCCORE_DOWNLOAD_STATUS "atsc30core.download.status"
 
#define ATSCCORE_DOWNLOAD_STATUS_QUERY "atsc30core.download.status.query"
 
#define ATSCCORE_SUBSCRIBE "atsc30core.subscribe"
 
#define ATSCCORE_UNSUBSCRIBE "atsc30core.unsubscribe"
 
#define ATSCCORE_OBJECTS_LIST "atsc30core.objects.list"
 
#define ATSCCORE_SUBSCRIBE_LIST "atsc30core.subscribe.list"
 
#define ATSCCORE_STORAGE "atsc30core.storage"
 
typedef enum{
    eMethodNoMethod             = -1,       
    eMethodEsgUrls              = 0,
    eMethodEsgQueryUrls         = 1,        
    eMethodEsgClear             = 2,        
    eMethodSlsUrls              = 3,
    eMethodSlsQueryUrls         = 4,        
    eMethodNrtUrls              = 5,
    eMethodNrtQueryUrls         = 6,        
    eMethodAppUrls              = 7,
    eMethodAppQueryUrls         = 8,        
    eMethodHeldUrls             = 9,
    eMethodHeldQueryUrls        = 10,       
    eMethodHeldMsgs             = 11,
    eMethodHeldQueryMsgs        = 12,       
    eMethodHeldClearMsgs        = 13,       
    eMethodClearFiles           = 14,       
    eMethodRemoveFiles          = 15,       
    eMethodDownloadStatus       = 16,
    eMethodQueryDownloadStatus  = 17,       
    eMethodAtscSubscribe        = 18,       
    eMethodAtscUnSubscribe      = 19,       
    eMethodAtscListObjects      = 20,       
    eMethodAtscListSubscribe    = 21,       
    eMethodAtscStorage          = 22,       
}eJsonMethod_t;
 
typedef enum {
    ATSC_INVALID                    = -1,   
    ATSC_OK                         = 0,    
    ATSC_NOK                        = 1,    
    ATSC_INVALID_FRONTEND_INSTANCE  = 2,    
    ATSC_NOT_IMPLEMENTED            = 3,    
}eATSCResult_t;
 
typedef enum 
{
    eDemod8VSB      = 0,    
    eDemod64QAM     = 1,    
    eDemod256QAM    = 2,    
    eDemodATSC30    = 3,    
    eDemodMax       = 3     
} eDemod_t;
 
typedef enum 
{
    eRegionUS       = 0,    
    eRegionKorea,           
    eRegionIndia,           
    eRegionMax              
} eRegion_t;
 
typedef enum 
{
    eStandardNone       = 0,        
    eStandardATSC10     = 1,        
    eStandardATSC30     = 1 << 1    
} eStandard_t;
 
typedef enum{
    eScanScuccess   = 0,    
    eScanfailed     = 1,    
    eScanInProgress = 2,    
}eScanResult;
 
typedef enum {
    eHttpTypeGet    = 0,    
    eHttpTypePost   = 1,    
    eHttpTypePut    = 2,    
    eHttpTypeDelete = 3,    
    eHttpTypeNoOp   = 4     
}eHttpType_t;
 
typedef enum {
    eHttpResponseCodeContinue   = 100,  
    eHttpResponseCodeOk         = 200,  
    eHttpResponseCodeCreated    = 201,  
    eHttpResponseCodeAccepted   = 202,  
    eHttpResponseCodeNotFound   = 404,  
} eHttpResponseCode_t;
 
typedef enum {
    eContentTypeJson        = 0,    
    eContentTypeXml         = 1,    
    eContentTypeTextPlain   = 2,    
    eContentTypeTextHtml    = 3,    
}eContentType_t;
 
typedef enum
{
    eTunerScanStart = 0, 
    eTunerScanStop,      
    eTunerScanInfo,      
}eTunerScanType_t;
 
typedef struct{
    int iDemod;     
    int iLock;      
    int iCh;        
    int iServices;  
}sScanResult_t;
 
typedef struct {
    int32_t iCh;            
    int32_t iId;            
    int32_t iEas;           
    int32_t iSnr;           
    int32_t iRssi;          
    int32_t iLock;          
    int32_t iFreq;          
    int32_t iPlpId;         
    int32_t iActive;        
    int32_t iBitRate;       
    int32_t iRecoding;      
    int32_t iModel;         
    eDemod_t iDemod;        
    eRegion_t iRegionId;    
    timespec Time;          
}sFeStatus_t;
 
typedef struct {
    int32_t iCh;            
    int32_t iPlp;           
    int32_t iFreq;          
    int32_t iTunerId;       
    eDemod_t iDemod;        
    eRegion_t iRegionId;    
}sFeParams_t;
 
typedef struct{
    bool bRun;              
    bool bScan;             
    bool bChChange;         
    bool bScanning;         
    int32_t iCh;            
    int32_t iFreq;          
    int32_t iPlpId;         
    int32_t iLock;          
    int32_t iTunerId;       
    int32_t iBandwidth;     
    eDemod_t iDemod;        
    eRegion_t iRegionId;    
}sFeProp_t;
 
typedef struct{
    uint8_t cSectionCount;              
    uint8_t sHidden[16];                
    uint8_t sReserved[16];              
    uint8_t sReserved2[16];             
    uint8_t sModulation[16];            
    uint8_t sEtmLocation[16];           
    uint8_t sServiceType[16];           
    uint8_t sAccessControlled[16];      
    uint16_t sMajor[16];                
    uint16_t sMinor[16];                
    uint16_t sSourceId[16];             
    uint16_t sProgramNum[16];           
    uint16_t sChannelTsid[16];          
    uint16_t sDescriptorsLength[16];    
    char sShortName[16][14];            
    char sDescriptors[16][256];         
    uint32_t sCarrierFrequency[16];     
    timespec tTime;                     
}sMpeg2Tvct_t;
 
typedef struct{
    int32_t iProtocol;    
    int32_t iCategory;    
    int32_t iServiceId;   
    void *pParser;        
}sParser_t;
 
typedef struct {
    int32_t iAt1Start;  
    int32_t iAt1End;    
    int32_t iAt3Start;  
    int32_t iAt3End;    
    int32_t iTunerId;   
    int32_t iPlpId;     
    int32_t iRegionId;  
    eDemod_t iDemod;    
}sScanScenario_t;
 
typedef struct{
    int32_t iMethod;            
    int32_t iId;                
    std::string sParams;        
}sJsonRpcProperties_t;
 
typedef struct
{
    char sWifiMac[6];       
    char sEthMac[6];        
    uint8_t sWifiAddr[4];   
    uint8_t sEthAddr[4];    
}sNetworkInfo_t;
 
typedef struct {
    int32_t iStartCh;   
    int32_t iEndCh;     
    int32_t iId;        
    int32_t iDemod;     
    int32_t iCurrCh;    
    int32_t iPlpId;     
    int32_t iLock;      
    int32_t iSnr;       
    int32_t iRssi;      
}sScanFrequencyResult_t;
 
typedef struct{
    int32_t iContentLength;         
    int32_t iExpect;                
    char sMethod[32];               
    char sUri[256];                 
    char sContentLocation[256];     
}sHttpHeader_t;
 
typedef struct
{
    int32_t iCount;                               
    int32_t sDemods[ATSCCORE_FRONTEND_MAX];       
    int32_t sStartCh[ATSCCORE_FRONTEND_MAX];      
    int32_t sEndCh[ATSCCORE_FRONTEND_MAX];        
}sTunerScanReqParameter_t;
 
typedef struct
{
    uint8_t iRatingValue;   
    char slangAbr[64];      
    char slangStrn[64];     
}sRating_t;
 
typedef struct
{
    bool bDimensionGraduate;        
    uint8_t iDimensionLevels;       
    uint8_t iDimensionIdex;         
    char sDimensionGraduate[16];    
    char sDimensionTitle[128];      
    sRating_t sRating[128];         
}RrtDimension_t;
 
typedef struct
{
    uint8_t iRegionIdentifier;      
    char    sRegionIdText[32];      
    RrtDimension_t sDimension[32];  
}RrtElement_t;
 
typedef struct {
    RrtElement_t sRrtTable[8];  
}sRrtDataTable_t;
 
typedef struct {
    bool bLeap59;                   
    bool bLeap61;                   
    bool bDstStatus;                
    uint8_t iDstDayOfMonth;         
    uint8_t iDstHour;               
    int16_t iCurrentOffset;         
    uint16_t iPtpPrepend;           
    char sUtcLocalOffset[64];       
}sSystemTime_t;
 
typedef struct
{
    int32_t iHaat;      
    uint32_t iHeading;  
    FLOAT_32 fStrength; 
}sDirectional_t;
 
typedef struct
{
    int32_t iElevation;                 
    int32_t iEffectiveRadiatedPower;    
    int32_t iOtherDirectionalCount;     
    uint16_t iOtherBsidRf;              
    uint16_t iOtherBsid;                
    FLOAT_32 fLatitude;                 
    FLOAT_32 fLongtitude;               
    sDirectional_t sDirectional[32];    /* Structure represents the directional parameters for a signal. */
}sOtherRf_t;                            
typedef struct
{
    bool bHidden;                   
    bool bHideInGuide;              
    bool bBroadbandAccessRequired;  
    bool bEssential;                
    bool bSvcprotected;             
    int32_t iServiceId;             
    int32_t iMajorChannel;          
    int32_t iMinorChannel;          
    int32_t iServiceCategory;       
    uint8_t cSltSvcSeqNum;          
    char sGlobalServiceID[256];     
    char sDrmSystemID[256];         
    char sConfiguration[256];       
    char sServiceName[256];         
}sSvcServiceAttr_t;
 
typedef struct
{
    int iSvcSimulcastMajorChNum;        
    int iSvcSimulcastMinorChNum;        
}sSvcSimulcastTSID_t;
 
typedef struct
{
    int32_t iSlsDestinationUdpPort;     
    int32_t iSlsMinorProtocolVersion;   
    int32_t iSlsMajorProtocolVersion;   
    int32_t iSlsProtocol;               
    char sSlsDestinationIpAddress[256]; 
    char sSlsSourceIpAddress[256];      
}sBroadcastSvcSignaling_t;
 
typedef struct
{
    uint8_t cSvcUrlType;    
}sSvcInetUrl_t;
 
typedef struct
{
    uint8_t cType;  
}sOtherBsid_t;
 
typedef struct{
    int32_t iCapabilityBytes;                       
    int32_t iOtherRfCount;                          
    char sSaCapability[256];                        
    char sSaCapabilityStringCode[256];              
    char sBooleanOp[2];                             
    timespec stTime;                                
    sSvcServiceAttr_t sSvcServiceAttr;              /* Structure to store attributes of a service.*/
    sSvcSimulcastTSID_t sSvcSimulcastTsid;          /* Structure to store simulcast transport stream IDs. */
    sBroadcastSvcSignaling_t sBrdcastSvcSignal;     /* Store broadcast service signaling information. */
    sSvcInetUrl_t sScvInetUrl;                      /* Represents an Internet URL service. */
    sOtherBsid_t sOtherBsid;                        /* Structure represents an Other BSID. */
    sOtherRf_t sOtherRf[32];                        /* Represents the RF (Radio Frequency) parameters for another BSID. */
} sSltService_t;
 
typedef struct
{
    uint8_t cSltUrlType;        
}sSltInetUrl_t;
 
typedef struct{
    int32_t iBsid;                  
    int32_t iVersion;               
    int32_t iNumberOfService;       
    uint32_t iSourceIp;             
    timespec stTime;                
    sSltInetUrl_t sSltInetUrl;      
    sSltService_t sService[32];     
}sServiceListTable_t;
 
typedef struct {
    int32_t iServiceId;             
    int32_t iMajorCh;               
    int32_t iMinorCh;               
    int32_t iPhyCh;                 
}sUserServiceInfo_t;
 
typedef std::function<void(sFeStatus_t)> FeStatusCbFunc;
 
typedef std::function<void(sFeParams_t)> FeParamsCbFunc;
 
typedef std::function<void(std::string)> OnScreenNotify;
 
#ifdef __cplusplus
};
#endif
 
#endif /* __ATSC_TYPES_H__ */