ap_tmr.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
 *
 * 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
 *******************************************************************************/
// pre-processor mechanism so multiple inclusions don't cause compilation error

#ifndef _AP_TMR_H
#define _AP_TMR_H

#include "techtype.h"
#include "stbgc.h"

//---Constant and macro definitions for public use-----------------------------
#define INVALID_TIMER_HANDLE        0

#define TMR_MAX_NAME_LENGTH         128

#define TMR_PVR_CRID_LEN_MAX        65

#define TMR_PVR_ADDINFO_LEN_MAX     255
#if 0
#define TMR_HOURS_THRESHOLD_EXC     24
#define TMR_MINS_THRESHOLD_EXC      60
#endif

/* The number of hours added to a timer to allow an event triggered recording to overrun
 * before the recording is stopped */
#define EVENT_DURATION_OVERRUN_TIME    2

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

typedef enum
{
   TIMER_TYPE_NONE = 0x00,
   TIMER_TYPE_ALARM = 0x01,
   TIMER_TYPE_SLEEP = 0x02,
   TIMER_TYPE_PVR_RECORD = 0x04,
   TIMER_TYPE_PRIVATE = 0x08,
   TIMER_TYPE_ALL = 0xff
} E_TIMER_TYPE;

typedef enum
{
   TIMER_FREQ_ONCE,
   TIMER_FREQ_WEEKLY,
   TIMER_FREQ_WEEKENDDAYS,
   TIMER_FREQ_WEEKDAYS,
   TIMER_FREQ_DAILY,
   TIMER_FREQ_HOURLY
} E_TIMER_FREQ;

//---Global type defs for public use-------------------------------------------
// service data structures:
typedef struct
{
   BOOLEAN change_service;
   U16BIT service_id;
   U16BIT transport_id;
   U16BIT orig_net_id;
   BOOLEAN ramp_volume;
} S_ALARM_INFO;

typedef struct
{
   U32DHMS duration;
   BOOLEAN event_triggered;
   U16BIT event_id;
   U16BIT service_id;
   U16BIT transport_id;
   U16BIT orig_net_id;
   U8BIT prog_crid[TMR_PVR_CRID_LEN_MAX];
   U8BIT other_crid[TMR_PVR_CRID_LEN_MAX];
   U16BIT disk_id;
   BOOLEAN recommendation;
   U16BIT notify_time;        /* Time in seconds to receive notification that a recording will soon start */
} S_PVR_RECORD_INFO;

typedef struct s_timer
{
   E_TIMER_TYPE type;
   U8BIT name[TMR_MAX_NAME_LENGTH];
   E_TIMER_FREQ frequency;
   U32DHMS start_time;
   BOOLEAN ram_only;        /* If TRUE, don't save the timer in NVM */
   union
   {
      S_ALARM_INFO alarm;
      S_PVR_RECORD_INFO record;
   } u;
} S_TIMER_INFO;

typedef struct s_avrec_settings
{
   U16BIT av_rec_lcn;
   BOOLEAN standby_mode;
} S_AVREC_SETTINGS;

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

void ATMR_Initialise(void);

U32BIT ATMR_AddTimer(S_TIMER_INFO *info);

U32BIT ATMR_AddTimerForEvent(void *event_ptr, void *serv_ptr, BOOLEAN record, BOOLEAN event_triggered);

BOOLEAN ATMR_UpdateTimerDuration(U32BIT handle, U32DHMS duration);

BOOLEAN ATMR_UpdateTimer(U32BIT handle, S_TIMER_INFO *info);

BOOLEAN ATMR_DeleteTimer(U32BIT handle);

BOOLEAN ATMR_GetTimerList(U32BIT **timer_list, U16BIT *list_size, E_TIMER_TYPE list_type,
   BOOLEAN date_time_order);

void ATMR_ReleaseTimerList(U32BIT *timer_list, U16BIT list_size);

BOOLEAN ATMR_InitialiseTimer(S_TIMER_INFO *timer_info, E_TIMER_TYPE timer_type, void *serv_ptr,
   void *event_ptr);

BOOLEAN ATMR_GetTimerInfo(U32BIT handle, S_TIMER_INFO *timer_info);

BOOLEAN ATMR_StartRecord(U8BIT path);

void ATMR_RecordingFailed(U8BIT path);

void* ATMR_GetRecordService(U8BIT path);

U8BIT* ATMR_GetName(U32BIT handle);

void ATMR_SetName(U32BIT handle, U8BIT *name);

U32DHMS ATMR_GetStartDateTime(U32BIT handle);

U32DHMS ATMR_GetDuration(U32BIT handle);

U32DHMS ATMR_GetEndDateTime(U32BIT handle);

E_TIMER_TYPE ATMR_GetType(U32BIT handle);

E_TIMER_FREQ ATMR_GetFrequency(U32BIT handle);

BOOLEAN ATMR_GetChangeService(U32BIT handle);

BOOLEAN ATMR_GetRampVolume(U32BIT handle);

U16BIT ATMR_GetEventId(U32BIT handle);

U16BIT ATMR_GetServiceId(U32BIT handle);

U16BIT ATMR_GetTransportId(U32BIT handle);

U16BIT ATMR_GetOriginalNetworkId(U32BIT handle);

BOOLEAN ATMR_GetMissed(U32BIT handle);

U8BIT* ATMR_GetProgrammeCrid(U32BIT handle);

BOOLEAN ATMR_HasSeriesCrid(U32BIT handle);

BOOLEAN ATMR_HasRecommendationCrid(U32BIT handle);

U16BIT ATMR_GetDiskId(U32BIT handle);

void ATMR_SetDiskId(U32BIT handle, U16BIT disk_id);

U32BIT ATMR_GetRecordingHandle(U32BIT handle);

void ATMR_HandleTimerEvent(U32BIT timer_handle);

BOOLEAN ATMR_CheckRecordStatus(BOOLEAN recordings_can_start);

void ATMR_EitUpdated(void);

void ATMR_DeleteRecordingTimer(U32BIT recording_handle);

U8BIT ATMR_GetNumSimultaneousRecordings(U8BIT max_recordings, U32DHMS start_date_time,
   U32DHMS end_date_time, U32BIT **conflicting_timers);

void* ATMR_RecordEvent(void *serv_ptr, void *event_ptr, U8BIT *prog_crid, U8BIT *series_crid,
   BOOLEAN is_series, BOOLEAN check_alternatives);

BOOLEAN ATMR_RecordSplitEvent(void *serv_ptr, U8BIT *prog_crid, U32DHMS start_date_time,
   BOOLEAN radio_service, BOOLEAN search_forward);

U32BIT ATMR_GetFirstWakeupTime(U32DHMS *rec_date_time, U16BIT *onet_id, U16BIT *trans_id,
   U16BIT *service_id);

U32BIT ATMR_FindTimerFromEvent(U16BIT onet_id, U16BIT trans_id, U16BIT serv_id, U16BIT event_id);

U32BIT ATMR_FindTimerFromCrid(U8BIT *prog_crid);

U32BIT ATMR_FindTimerFromCridAndEvent(U8BIT *prog_crid, U16BIT service_id, U16BIT event_id);

void ATMR_DeleteTimersForSeriesRecommendations(U8BIT *crid, BOOLEAN is_recommendation);

void ATMR_SetAdditionalInfo(U32BIT handle, U8BIT *info, U32BIT size);

U8BIT* ATMR_GetAdditionalInfo(U32BIT handle, U32BIT *size);

S32BIT ATMR_GetStartPadding(U32BIT handle);

BOOLEAN ATMR_SetStartPadding(U32BIT handle, S32BIT start_padding);

S32BIT ATMR_GetEndPadding(U32BIT handle);

BOOLEAN ATMR_SetEndPadding(U32BIT handle, S32BIT end_padding);

void ATMR_DumpAllTimers(void);

#endif // _AP_TMR_H