![]() |
DVBCore
22.3.0
Open Source DVB Engine
|
Header file - macros and function prototypes for public use. More...
#include "techtype.h"
Go to the source code of this file.
Typedefs | |
typedef U32BIT | U32DHMS |
Functions | |
void | STB_GCInitialise (void) |
Initialises general control. | |
void | STB_GCSetSearchLangCode (U32BIT lang) |
Writes SI search language code into general control store. More... | |
U32BIT | STB_GCGetSearchLangCode (void) |
Reads the SI search language code from general control store. More... | |
U8BIT * | STB_GCGetLangCodeString (U32BIT lang) |
Converts the given 24bit ISO language code to a null-terminated string. More... | |
void | STB_GCSetCIStandby (BOOLEAN standby) |
Enables / disables CI standby state. | |
U8BIT * | STB_GCGetFullSerialString (void) |
Retrieves and returns the fulls serial string, incorporating the hardware version box serial number and application version. More... | |
U8BIT * | STB_GCGetVersionNumberString (void) |
Retrieves and returns the library version number as a string. More... | |
void | STB_GCSetAudioSignal (BOOLEAN state) |
Enables/disables audio signal bleep and writes value into general control store. More... | |
BOOLEAN | STB_GCGetAudioSignal (void) |
Reads the current audio signal bleep state from general control store. More... | |
void | STB_GCSetLocalTimeOffset (U8BIT ohour, U8BIT omin, BOOLEAN neg) |
Sets local time offset from GMT. More... | |
void | STB_GCGetLocalTimeOffset (U8BIT *ohour, U8BIT *omin, BOOLEAN *neg) |
Reads local time offset from GMT. More... | |
void | STB_GCSetLocalTimeChange (U16BIT code, U8BIT hour, U8BIT min, U8BIT secs, U8BIT ohour1, U8BIT omin1, U8BIT ohour2, U8BIT omin2, BOOLEAN neg) |
Sets new and old local time offset from GMT. More... | |
void | STB_GCGetLocalTimeChange (U16BIT code, U8BIT hour, U8BIT min, U8BIT secs, U8BIT *ohour, U8BIT *omin, BOOLEAN *neg) |
Reads local time offset from GMT. More... | |
void | STB_GCSetGMTTime (U8BIT hour, U8BIT min, U8BIT secs) |
Sets current GMT time. More... | |
U8BIT | STB_GCGetGMTHour (void) |
Reads the current GMT hour. More... | |
U8BIT | STB_GCGetGMTMin (void) |
Reads the current GMT minute. More... | |
U8BIT | STB_GCGetGMTSecs (void) |
Reads the current GMT seconds. More... | |
void | STB_GCSetGMTDate (U16BIT code) |
Sets current GMT date. More... | |
U16BIT | STB_GCGetGMTDate (void) |
Reads the current GMT date code. More... | |
E_STB_GC_WEEKDAY | STB_GCGetGMTWeekDay (void) |
Reads the current GMT weekday number. More... | |
U8BIT | STB_GCGetGMTDay (void) |
Reads the current GMT day number. More... | |
U8BIT | STB_GCGetGMTMonth (void) |
Reads the current GMT month number. More... | |
U16BIT | STB_GCGetGMTYear (void) |
Reads the current GMT year number. More... | |
void | STB_GCGetGMTDateTime (U16BIT *code, U8BIT *hour, U8BIT *min, U8BIT *secs) |
Reads the current GMT date code and time. More... | |
BOOLEAN | STB_GCIsFutureDateTime (U16BIT code, U8BIT hour, U8BIT min, U8BIT secs) |
Tests given date and time against current GMT date and time. More... | |
E_STB_GC_WEEKDAY | STB_GCGetDateWeekDay (U16BIT code) |
Returns the weekday number of the specified date code. More... | |
BOOLEAN | STB_GCIsDateDayWeek (U16BIT code) |
Tests whether the weekday of the specified date code is during the week. More... | |
BOOLEAN | STB_GCIsDateDayWeekend (U16BIT code) |
Tests whether the weekday of the specified date code is during the weekend. More... | |
void | STB_GCCalculateDateTime (U16BIT code, U8BIT hour, U8BIT min, U8BIT secs, U8BIT ohour, U8BIT omin, U8BIT osecs, U16BIT *rcode, U8BIT *rhour, U8BIT *rmin, U8BIT *rsecs, E_STB_GC_CALCTYPE calc) |
Adds or subtracts offset from a date/time. More... | |
void | STB_GCConvertDateTime (U16BIT code, U8BIT hour, U8BIT min, U8BIT secs, U16BIT *rcode, U8BIT *rhour, U8BIT *rmin, U8BIT *rsecs, E_STB_GC_CONVTYPE conv) |
Converts specified date / time to another. More... | |
BOOLEAN | STB_GCCompareDateTime (U16BIT code1, U8BIT hour1, U8BIT min1, U8BIT secs1, U16BIT code2, U8BIT hour2, U8BIT min2, U8BIT secs2, E_STB_GC_COMPTYPE comp) |
Compares one date/time to another. More... | |
S32BIT | STB_GCDateTimeDiff (U16BIT code1, U8BIT hour1, U8BIT min1, U8BIT secs1, U16BIT code2, U8BIT hour2, U8BIT min2, U8BIT secs2) |
Returns the difference in seconds between the two dates/times, as time1 - time2, so the result will be negative if time1 is earlier than time2, and positive otherwise. More... | |
U8BIT * | STB_GCGetTimeString (U16BIT code, U8BIT hour, U8BIT min, E_STB_GC_TIMETYPE format) |
Supplies specified time as local time string, in format requested. More... | |
U8BIT * | STB_GCGetDateString (U16BIT code, U8BIT hour, U8BIT min, E_STB_GC_DATETYPE format) |
Supplies specifed date as local date string, in format requested. More... | |
U8BIT * | STB_GCGetClockString (U8BIT hour, U8BIT min, U8BIT secs, E_STB_GC_CLOCKTYPE format) |
Supplies specified time as clock string, in format requested. More... | |
void | STB_GCGetDateInfo (U16BIT code, U8BIT hour, U8BIT min, U8BIT *day, U8BIT *wday, U8BIT *month, U16BIT *year) |
Get the day, weekday, month and the year from a date code and hour / minute offset. More... | |
void | STB_GCGetMJDDateInfo (U16BIT code, U8BIT *day, U8BIT *wday, U8BIT *month, U16BIT *year) |
Returns the date info from the given MJD date code. More... | |
void | STB_GCGetLocalDateTime (U16BIT *year, U8BIT *month, U8BIT *day, U8BIT *hour, U8BIT *mins) |
Get the local year, month, day, hour and minute. More... | |
void | STB_GCUseBroadcastTime (BOOLEAN state) |
Sets whether the date/time are taken from the broadcast or the system. The default is to use the broadcast for date/time. More... | |
U32DHMS | STB_GCCreateDebugDHMS (U32BIT date, U32BIT hour, U32BIT mins, U32BIT secs) |
Makes U32DHMS formated date/time from date code, hour, minutes, seconds. More... | |
U32DHMS | STB_GCCreateDHMS (U16BIT date, U8BIT hour, U8BIT mins, U8BIT secs) |
Makes U32DHMS formated date/time from date code, hour, minutes, seconds. More... | |
U32DHMS | STB_GCCreateDHMSFromSeconds (U32BIT num_seconds) |
Creates a DHMS value consisting of hours, minutes and seconds from a number of seconds. More... | |
U32DHMS | STB_GCCalculateDHMS (U32DHMS dhms, U32DHMS period, E_STB_GC_CALCTYPE calc) |
Calculates the date/time when the period is added/subtracted to/from dhms. More... | |
U32DHMS | STB_GCConvertDHMS (U32DHMS dhms, E_STB_GC_CONVTYPE conv) |
Converts the given date/time to local or GMT. More... | |
U32DHMS | STB_GCNowDHMSGmt (void) |
Reads the current GMT date code and time. More... | |
U32DHMS | STB_GCNowDHMSLocal (void) |
Reads the current Local date code and time. More... | |
U8BIT * | STB_GCGetDateStringDHMS (U32DHMS dhms, E_STB_GC_DATETYPE format) |
Supplies specifed date as local date string, in format requested. More... | |
U8BIT * | STB_GCGetTimeStringDHMS (U32DHMS dhms, E_STB_GC_TIMETYPE format) |
Supplies specified time as local time string, in format requested. More... | |
U32DHMS | STB_GCConvertTimestamp (U32BIT timestamp) |
Converts a timestamp expressed in number of seconds since midnight (UTC) 1 January 1970. More... | |
U32BIT | STB_GCConvertToTimestamp (U32DHMS time) |
Returns the number of seconds from midnight (UTC) 1 January 1970 to the specified U32DHMS time. More... | |
Header file - macros and function prototypes for public use.
void STB_GCCalculateDateTime | ( | U16BIT | code, |
U8BIT | hour, | ||
U8BIT | min, | ||
U8BIT | secs, | ||
U8BIT | ohour, | ||
U8BIT | omin, | ||
U8BIT | osecs, | ||
U16BIT * | rcode, | ||
U8BIT * | rhour, | ||
U8BIT * | rmin, | ||
U8BIT * | rsecs, | ||
E_STB_GC_CALCTYPE | calc | ||
) |
Adds or subtracts offset from a date/time.
U16BIT | code - date code. |
U8BIT | hour - hour (0-23). |
U8BIT | min - minute (0-59). |
U8BIT | secs - seconds (0-59). |
U8BIT | ohour - offset hour (0-23). |
U8BIT | omin - offset minute (0-59). |
U8BIT | osecs - offset seconds (0-59). |
U16BIT* | rcode - returns result date code. |
U8BIT* | rhour - returns result hour (0-23). |
U8BIT* | rmin - returns result minute (0-59). |
U8BIT* | rsecs - returns result seconds (0-59). |
U32DHMS STB_GCCalculateDHMS | ( | U32DHMS | dhms, |
U32DHMS | period, | ||
E_STB_GC_CALCTYPE | calc | ||
) |
Calculates the date/time when the period is added/subtracted to/from dhms.
dhms | base date/time |
period | days/hours/mins/secs to be added or subtracted |
calc | calculation to be performed CALC_ADD adds period to dhms CALC_SUB subtracts period from dhms |
BOOLEAN STB_GCCompareDateTime | ( | U16BIT | code1, |
U8BIT | hour1, | ||
U8BIT | min1, | ||
U8BIT | secs1, | ||
U16BIT | code2, | ||
U8BIT | hour2, | ||
U8BIT | min2, | ||
U8BIT | secs2, | ||
E_STB_GC_COMPTYPE | comp | ||
) |
Compares one date/time to another.
U16BIT | code1 - first date code. |
U8BIT | hour1 - first hour (0-23). |
U8BIT | min1 - first minute (0-59). |
U8BIT | secs1 - first seconds (0-59). |
U16BIT | code2 - second date code. |
U8BIT | hour2 - second hour (0-23). |
U8BIT | min2 - second minute (0-59). |
U8BIT | secs2 - second seconds (0-59). |
void STB_GCConvertDateTime | ( | U16BIT | code, |
U8BIT | hour, | ||
U8BIT | min, | ||
U8BIT | secs, | ||
U16BIT * | rcode, | ||
U8BIT * | rhour, | ||
U8BIT * | rmin, | ||
U8BIT * | rsecs, | ||
E_STB_GC_CONVTYPE | conv | ||
) |
Converts specified date / time to another.
U16BIT | code - date code. |
U8BIT | hour - hour (0-23). |
U8BIT | min - minute (0-59). |
U8BIT | secs - seconds (0-59). |
U16BIT* | rcode - returns result date code. |
U8BIT* | rhour - returns result hour (0-23). |
U8BIT* | rmin - returns result minute (0-59). |
U8BIT* | rsecs - returns result seconds (0-59). |
U32DHMS STB_GCConvertDHMS | ( | U32DHMS | dhms, |
E_STB_GC_CONVTYPE | conv | ||
) |
Converts the given date/time to local or GMT.
dhms | date/time to be converted |
conv | conversion to be performed CONV_LOCAL = convert to local CONV_GMT = convert to GMT |
U32DHMS STB_GCConvertTimestamp | ( | U32BIT | timestamp | ) |
Converts a timestamp expressed in number of seconds since midnight (UTC) 1 January 1970.
timestamp | number of seconds since midnight (UTC) 1 January 1970 |
U32BIT STB_GCConvertToTimestamp | ( | U32DHMS | time | ) |
Returns the number of seconds from midnight (UTC) 1 January 1970 to the specified U32DHMS time.
time | time in U32DHMS format |
U32DHMS STB_GCCreateDebugDHMS | ( | U32BIT | date, |
U32BIT | hour, | ||
U32BIT | mins, | ||
U32BIT | secs | ||
) |
Makes U32DHMS formated date/time from date code, hour, minutes, seconds.
U32BIT | date - date code. |
U32BIT | hour - value of hour (0-23). |
U32BIT | mins - value of minute (0-59). |
U32BIT | secs - value of seconds (0-59). |
U32DHMS STB_GCCreateDHMS | ( | U16BIT | date, |
U8BIT | hour, | ||
U8BIT | mins, | ||
U8BIT | secs | ||
) |
Makes U32DHMS formated date/time from date code, hour, minutes, seconds.
U16BIT | date |
U8BIT | hour |
U8BIT | mins |
U8BIT | secs |
U32DHMS STB_GCCreateDHMSFromSeconds | ( | U32BIT | num_seconds | ) |
Creates a DHMS value consisting of hours, minutes and seconds from a number of seconds.
num_seconds | number of seconds to be converted |
S32BIT STB_GCDateTimeDiff | ( | U16BIT | code1, |
U8BIT | hour1, | ||
U8BIT | min1, | ||
U8BIT | secs1, | ||
U16BIT | code2, | ||
U8BIT | hour2, | ||
U8BIT | min2, | ||
U8BIT | secs2 | ||
) |
Returns the difference in seconds between the two dates/times, as time1 - time2, so the result will be negative if time1 is earlier than time2, and positive otherwise.
code1 | - MJD date code |
hour1 | - MJD hour |
min1 | - MJD minutes |
secs1 | - MJD seconds |
code2 | - MJD date code |
hour2 | - MJD hour |
min2 | - MJD minutes |
secs2 | - MJD seconds |
BOOLEAN STB_GCGetAudioSignal | ( | void | ) |
Reads the current audio signal bleep state from general control store.
U8BIT* STB_GCGetClockString | ( | U8BIT | hour, |
U8BIT | min, | ||
U8BIT | secs, | ||
E_STB_GC_CLOCKTYPE | format | ||
) |
Supplies specified time as clock string, in format requested.
U8BIT | hour - value of hour (0-23). |
U8BIT | min - value of minute (0-59). |
U8BIT | secs - value of secs (0-59). |
E_STB_GC_CLOCKTYPE | format - string format required. |
void STB_GCGetDateInfo | ( | U16BIT | code, |
U8BIT | hour, | ||
U8BIT | min, | ||
U8BIT * | day, | ||
U8BIT * | wday, | ||
U8BIT * | month, | ||
U16BIT * | year | ||
) |
Get the day, weekday, month and the year from a date code and hour / minute offset.
U16BIT | code - date code. |
U8BIT | hour - value of hour (0-23). |
U8BIT | min - value of minute (0-59). |
U8BIT* | day - Day of the month returned value |
U8BIT* | wday - Week day returned value |
U8BIT* | month - Month number returned value |
U16BIT* | year - Year returned value |
U8BIT* STB_GCGetDateString | ( | U16BIT | code, |
U8BIT | hour, | ||
U8BIT | min, | ||
E_STB_GC_DATETYPE | format | ||
) |
Supplies specifed date as local date string, in format requested.
U16BIT | code - date code. |
U8BIT | hour - value of hour (0-23). |
U8BIT | min - value of minute (0-59). |
E_STB_GC_DATETYPE | format - string format required. |
U8BIT* STB_GCGetDateStringDHMS | ( | U32DHMS | dhms, |
E_STB_GC_DATETYPE | format | ||
) |
Supplies specifed date as local date string, in format requested.
U32DHMS | dhms - date time (gmt) |
E_STB_GC_DATETYPE | format - string format required. |
E_STB_GC_WEEKDAY STB_GCGetDateWeekDay | ( | U16BIT | code | ) |
Returns the weekday number of the specified date code.
U16BIT | code - date code. |
U8BIT* STB_GCGetFullSerialString | ( | void | ) |
Retrieves and returns the fulls serial string, incorporating the hardware version box serial number and application version.
U16BIT STB_GCGetGMTDate | ( | void | ) |
Reads the current GMT date code.
void STB_GCGetGMTDateTime | ( | U16BIT * | code, |
U8BIT * | hour, | ||
U8BIT * | min, | ||
U8BIT * | secs | ||
) |
Reads the current GMT date code and time.
U16BIT* | code - returns value of date code. |
U8BIT* | hour - returns value of hour (0-23). |
U8BIT* | min - returns value of minute (0-59). |
U8BIT* | secs - returns value of seconds (0-59). |
U8BIT STB_GCGetGMTDay | ( | void | ) |
Reads the current GMT day number.
U8BIT STB_GCGetGMTHour | ( | void | ) |
Reads the current GMT hour.
U8BIT STB_GCGetGMTMin | ( | void | ) |
Reads the current GMT minute.
U8BIT STB_GCGetGMTMonth | ( | void | ) |
Reads the current GMT month number.
U8BIT STB_GCGetGMTSecs | ( | void | ) |
Reads the current GMT seconds.
E_STB_GC_WEEKDAY STB_GCGetGMTWeekDay | ( | void | ) |
Reads the current GMT weekday number.
U16BIT STB_GCGetGMTYear | ( | void | ) |
Reads the current GMT year number.
U8BIT* STB_GCGetLangCodeString | ( | U32BIT | lang | ) |
Converts the given 24bit ISO language code to a null-terminated string.
U32BIT | lang - ISO language code. |
void STB_GCGetLocalDateTime | ( | U16BIT * | year, |
U8BIT * | month, | ||
U8BIT * | day, | ||
U8BIT * | hour, | ||
U8BIT * | min | ||
) |
Get the local year, month, day, hour and minute.
U16BIT* | year - Year returned value |
U8BIT* | month - Month number returned value (1-12) |
U8BIT* | day - Day of the month returned value (1-31) |
U8BIT* | hour - value of hour (0-23). |
U8BIT* | min - value of minute (0-59). |
void STB_GCGetLocalTimeChange | ( | U16BIT | code, |
U8BIT | hour, | ||
U8BIT | min, | ||
U8BIT | secs, | ||
U8BIT * | ohour, | ||
U8BIT * | omin, | ||
BOOLEAN * | neg | ||
) |
Reads local time offset from GMT.
U16BIT | code - date of change. |
U8BIT | hour - hour of change (0-23). |
U8BIT | min - minute of change (0-59). |
U8BIT | secs - seconds of change (0-59). |
U8BIT* | ohour - returns hour offset (0-23). |
U8BIT* | omin - returns minute offset (0-59). |
BOOLEAN* | neg - returns TRUE if offset is negative, else FALSE. |
void STB_GCGetLocalTimeOffset | ( | U8BIT * | ohour, |
U8BIT * | omin, | ||
BOOLEAN * | neg | ||
) |
Reads local time offset from GMT.
U8BIT* | ohour - returns hour offset (0-23). |
U8BIT* | omin - returns minute offset (0-59). |
BOOLEAN* | neg - returns TRUE if offset is negative, else FALSE. |
void STB_GCGetMJDDateInfo | ( | U16BIT | code, |
U8BIT * | day, | ||
U8BIT * | wday, | ||
U8BIT * | month, | ||
U16BIT * | year | ||
) |
Returns the date info from the given MJD date code.
code | - date code as a Modified Julian Date value |
day | - returns with day of the month |
wday | - returns with day of the week |
month | - returns with month number |
year | - returns with the year |
U32BIT STB_GCGetSearchLangCode | ( | void | ) |
Reads the SI search language code from general control store.
U8BIT* STB_GCGetTimeString | ( | U16BIT | code, |
U8BIT | hour, | ||
U8BIT | min, | ||
E_STB_GC_TIMETYPE | format | ||
) |
Supplies specified time as local time string, in format requested.
U16BIT | code - date code. |
U8BIT | hour - value of hour (0-23). |
U8BIT | min - value of minute (0-59). |
E_STB_GC_TIMETYPE | format - string format required. |
U8BIT* STB_GCGetTimeStringDHMS | ( | U32DHMS | dhms, |
E_STB_GC_TIMETYPE | format | ||
) |
Supplies specified time as local time string, in format requested.
U32DHMS | dhms - date time (gmt) |
E_STB_GC_TIMETYPE | format - string format required. |
U8BIT* STB_GCGetVersionNumberString | ( | void | ) |
Retrieves and returns the library version number as a string.
BOOLEAN STB_GCIsDateDayWeek | ( | U16BIT | code | ) |
Tests whether the weekday of the specified date code is during the week.
U16BIT | code - date code. |
BOOLEAN STB_GCIsDateDayWeekend | ( | U16BIT | code | ) |
Tests whether the weekday of the specified date code is during the weekend.
U16BIT | code - date code. |
BOOLEAN STB_GCIsFutureDateTime | ( | U16BIT | code, |
U8BIT | hour, | ||
U8BIT | min, | ||
U8BIT | secs | ||
) |
Tests given date and time against current GMT date and time.
U16BIT | code - value of date code. |
U8BIT | hour - value of hour (0-23). |
U8BIT | min - value of minute (0-59). |
U8BIT | secs - value of seconds (0-59). |
U32DHMS STB_GCNowDHMSGmt | ( | void | ) |
Reads the current GMT date code and time.
void |
U32DHMS STB_GCNowDHMSLocal | ( | void | ) |
Reads the current Local date code and time.
void |
void STB_GCSetAudioSignal | ( | BOOLEAN | state | ) |
Enables/disables audio signal bleep and writes value into general control store.
BOOLEAN | state - TRUE to turn on, else FALSE. |
void STB_GCSetGMTDate | ( | U16BIT | code | ) |
Sets current GMT date.
U16BIT | code - date code in UTC. |
void STB_GCSetGMTTime | ( | U8BIT | hour, |
U8BIT | min, | ||
U8BIT | secs | ||
) |
Sets current GMT time.
U8BIT | hour - value of hour (0-23). |
U8BIT | min - value of minute (0-59). |
U8BIT | secs - value of seconds (0-59). |
void STB_GCSetLocalTimeChange | ( | U16BIT | code, |
U8BIT | hour, | ||
U8BIT | min, | ||
U8BIT | secs, | ||
U8BIT | ohour1, | ||
U8BIT | omin1, | ||
U8BIT | ohour2, | ||
U8BIT | omin2, | ||
BOOLEAN | neg | ||
) |
Sets new and old local time offset from GMT.
U16BIT | code - date of change. |
U8BIT | hour - hour of change (0-23). |
U8BIT | min - minute of change (0-59). |
U8BIT | secs - seconds of change (0-59). |
U8BIT | ohour1 - old hour offset (0-23). |
U8BIT | omin1 - old minute offset (0-59). |
U8BIT | ohour2 - new hour offset (0-23). |
U8BIT | omin2 - new minute offset (0-59). |
BOOLEAN | neg - TRUE if offsets are negative, else FALSE. |
void STB_GCSetLocalTimeOffset | ( | U8BIT | ohour, |
U8BIT | omin, | ||
BOOLEAN | neg | ||
) |
Sets local time offset from GMT.
U8BIT | ohour - hour offset (0-23). |
U8BIT | omin - minute offset (0-59). |
BOOLEAN | neg - TRUE if offset is negative, else FALSE. |
void STB_GCSetSearchLangCode | ( | U32BIT | lang | ) |
Writes SI search language code into general control store.
U32BIT | lang - ISO language code. |
void STB_GCUseBroadcastTime | ( | BOOLEAN | state | ) |
Sets whether the date/time are taken from the broadcast or the system. The default is to use the broadcast for date/time.
state | - FALSE to use date/time from the system |