dvb/inc/ap_pvr.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_PVR_H

#define _AP_PVR_H

//---macro definitions for this file-------------------------------------------


//---Enumerations for public use-----------------------------------------------
typedef enum e_pvr_play_status
{
   PVR_PLAY_STATUS_NULL = 0,       // X     - no action
   PVR_PLAY_STATUS_STOP = 1,       // .     - stop
   PVR_PLAY_STATUS_PAUSE = 2,      // ||    - pause
   PVR_PLAY_STATUS_SF = 3,         // >|    - slow forward
   PVR_PLAY_STATUS_SR = 4,         // |<    - slow reverse
   PVR_PLAY_STATUS_NORMAL = 5,     // >     - play
   PVR_PLAY_STATUS_FF = 6,         // >>    - fast forward
   PVR_PLAY_STATUS_FR = 7,         // <<    - fast reverse
   PVR_PLAY_STATUS_QR = 8          // |<<   - quick repeat
} E_PVR_PLAY_STATUS;

typedef enum e_pvr_stop_type
{
   PVR_STOP_REC_ONLY = 0,
   PVR_STOP_PLAY = 1,
   PVR_STOP_PAUSE = 2
} E_PVR_STOP_TYPE;

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

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

BOOLEAN APVR_IsInitialised(void);

// ----play list----

U16BIT  APVR_GetPlayList(U32BIT **handle_list, U32BIT **name_list, U32BIT **rec_status_list,
   U32BIT **locked_list, U32BIT **selected_list, U32BIT **split_list);

void  APVR_ReleasePlayList(U32BIT *handle_list, U32BIT *name_list, U32BIT *rec_status_list,
   U32BIT *locked_list, U32BIT *selected_list, U32BIT *split_list);

// ----playing----

BOOLEAN APVR_PlayRecording(U32BIT recording_handle, BOOLEAN resume_playback);

U32BIT APVR_GetPlaybackHandle(void);

BOOLEAN APVR_IsPlaying(void);

BOOLEAN APVR_GetPlaybackElapsedTime(U32BIT handle, U8BIT *hours, U8BIT *mins, U8BIT *secs, U8BIT *progress);

void APVR_StopPlay(BOOLEAN return_to_live);

void APVR_NormalPlay(void);

void APVR_PausePlay(void);

void APVR_FFPlay(void);

void APVR_FRPlay(void);

E_PVR_PLAY_STATUS APVR_GetPlayMode(void);

S16BIT APVR_GetPlaySpeed(void);

// ---- recording ----

U8BIT APVR_PrepareNewRecording(U16BIT onet_id, U16BIT trans_id, U16BIT service_id, BOOLEAN *new_tuned_service);

BOOLEAN APVR_StartNewRecording(U16BIT disk_id, U8BIT path, U8BIT *recording_name, U16BIT event_id,
   U8BIT *prog_crid, U8BIT *other_crid, U32BIT *rec_handle);

BOOLEAN APVR_StopRecording(U32BIT recording_handle);

U8BIT APVR_GetActiveRecordingList(U32BIT **handle_list);

void APVR_ReleaseActiveRecordingList(U32BIT *handle_list);

BOOLEAN APVR_GetPathRecordingName(U8BIT path, U32BIT *name_ptr);

BOOLEAN APVR_DeleteRecording(U32BIT handle);

void APVR_SetTimeshiftBufferSize(U16BIT time_in_mins);

U8BIT APVR_StartPauseRecord(void);

U8BIT APVR_StartPausePlay(void);

void APVR_StopPauseRecord(BOOLEAN return_to_live);

BOOLEAN APVR_IsRecordingInProgress(void);

BOOLEAN APVR_IsRecordingHandle(U8BIT path, U32BIT recording_handle);

BOOLEAN APVR_GetRecordingHandle(U8BIT path, U32BIT *recording_handle_ptr);

// ---- disk ----
U8BIT APVR_GetTotalSpacePercentUsed(U16BIT disk_id);

void APVR_GetDiskTime(U16BIT disk_id, U8BIT *used_hour_ptr, U8BIT *used_min_ptr,
   U8BIT *free_hour_ptr, U8BIT *free_min_ptr,
   U8BIT *size_hour_ptr, U8BIT *size_min_ptr);

void APVR_GetDiskMbyte(U16BIT disk_id, U32BIT *used_mbyte_ptr, U32BIT *free_mbyte_ptr, U32BIT *size_mbyte_ptr);

BOOLEAN APVR_CheckSpaceForEvent(U16BIT disk_id, void *event_ptr);

BOOLEAN APVR_CheckSpaceDuration(U16BIT disk_id, U32BIT duration);

BOOLEAN APVR_CheckSpaceForDuration(U16BIT disk_id, U8BIT hours, U8BIT mins);

// ---- pause ----
U32BIT APVR_GetPauseProgress(void);

U8BIT APVR_GetPlaybackPath(void);

BOOLEAN APVR_IsEventInRecordList(U8BIT *prog_crid);

void APVR_RecordSeries(void *crid_ptr, BOOLEAN radio_service);

void APVR_RecordRecommendations(void *crid_ptr, BOOLEAN radio_service);

BOOLEAN APVR_FindNextSplitEvent(U32BIT curr_handle, U32BIT *next_handle);

void APVR_EitUpdated(void);

void APVR_PidsUpdated(U8BIT path);

void* APVR_GetPlaybackService(void);

BOOLEAN APVR_HandlePrivateTimer(U32BIT timer_handle);

#ifdef COMMON_INTERFACE

void APVR_CIRecordReplyReceived(BOOLEAN start_succeeded, U8BIT slot_id);
#endif

//---Global Function prototypes for internal use---------------------------------
void APVR_Initialise(void);

void APVR_Terminate(void);

BOOLEAN APVR_IsDecodingFile(void);

void APVR_SlowMoPlay(void);

// quick replay current playing recording
void APVR_QRPlay(void);

// quick replay current playing recording
void APVR_JTLPlay(void);

void APVR_TrickModeMuteOn(void);

void APVR_TrickModeMuteOff(void);

BOOLEAN APVR_DeleteAllSelectedRecordings(U32BIT *handles, U16BIT num_handles);

void APVR_UnselectAllRecordings(U32BIT *handles, U16BIT num_handles);

BOOLEAN APVR_AreSelectedRecordings(U32BIT *handles, U16BIT num_handles);

#endif // _AP_PVR_H