stbpvrpr.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 _STBPVRPR_H
#define _STBPVRPR_H

#include "techtype.h"
#include "stbhwav.h"
#include "stbhwdmx.h"

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

//---Enumerations for public use-----------------------------------------------
typedef enum
{
   PVR_PID_TYPE_VIDEO,
   PVR_PID_TYPE_AUDIO,
   PVR_PID_TYPE_PCR,
   PVR_PID_TYPE_SUBTITLES,
   PVR_PID_TYPE_SECTION,
   PVR_PID_TYPE_TELETEXT
} E_PVR_PID_TYPE;


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

typedef enum e_stb_pvr_start_mode
{
   START_RUNNING = 0,
   START_PAUSED = 1,
   START_AVSYNC = 2,
   START_EXPORT_PES = 3,
   START_IMPORT_TS = 4,
   START_IMPORT_PES = 5
} E_STB_PVR_START_MODE;

typedef enum e_stb_pvr_play_mode
{
   PLAY_NO_TRICK = 0,
   PLAY_TRICK_FORWARDS = 1,
   PLAY_TRICK_REVERSE = 2,
   PLAY_TRICK_FRAME = 3
} E_STB_PVR_PLAY_MODE;

typedef struct s_pvr_pid_info
{
   E_PVR_PID_TYPE type;
   U16BIT pid;
   union
   {
      E_STB_AV_VIDEO_CODEC video_codec;
      E_STB_AV_AUDIO_CODEC audio_codec;
   } u;
} S_PVR_PID_INFO;


//---Global Function prototypes for public use---------------------------------
U8BIT STB_PVRInitPlayback(U8BIT num_audio_decoders, U8BIT num_video_decoders);

U8BIT STB_PVRInitRecording(U8BIT num_tuners);

void STB_PVRSetPlayStartMode(U8BIT audio_decoder, U8BIT video_decoder, E_STB_PVR_START_MODE mode);

void STB_PVRPlayHasVideo(U8BIT audio_decoder, U8BIT video_decoder, BOOLEAN has_video);

void STB_PVRSetPlaybackNotifyTime(U8BIT audio_decoder, U8BIT video_decoder, U32BIT notify_time);

BOOLEAN STB_PVRPlayStart(U16BIT disk_id, U8BIT audio_decoder, U8BIT video_decoder, U8BIT demux,
   U8BIT *basename);

BOOLEAN STB_PVRPlayChangeAudio(U8BIT audio_decoder, U8BIT video_decoder, U16BIT pid, U8BIT codec);

BOOLEAN STB_PVRIsPlayStarted(U8BIT audio_decoder, U8BIT video_decoder);

BOOLEAN STB_PVRPlaySetPosition(U8BIT audio_decoder, U8BIT video_decoder, U32BIT position_in_seconds);

void STB_PVRPlayStop(U8BIT audio_decoder, U8BIT video_decoder);

void STB_PVRPlayEnabled(U8BIT audio_decoder, U8BIT video_decoder, BOOLEAN *video, BOOLEAN *audio);

void STB_PVRPlaySetRetentionLimit(U8BIT audio_decoder, U8BIT video_decoder, U32BIT retention_limit,
   U16BIT rec_date, U8BIT rec_hour, U8BIT rec_min);

void STB_PVRSetRecordStartMode(U8BIT rec_index, E_STB_PVR_START_MODE mode, U32BIT param);

BOOLEAN STB_PVRRecordStart(U16BIT disk_id, U8BIT rec_index, U8BIT *basename,
   U16BIT num_pids, S_PVR_PID_INFO *pid_array);

BOOLEAN STB_PVRRecordPause(U8BIT rec_index);

BOOLEAN STB_PVRRecordResume(U8BIT rec_index);

BOOLEAN STB_PVRRecordChangePids(U8BIT rec_index, U16BIT num_pids, S_PVR_PID_INFO *pids_array);

void STB_PVRRecordStop(U8BIT rec_index);

BOOLEAN STB_PVRIsRecordStarted(U8BIT rec_index);

void STB_PVRRecordEnabled(U8BIT rec_index, BOOLEAN *video, BOOLEAN *audio);

void STB_PVRSetRecordEncryptionKey(U8BIT rec_index, BOOLEAN state, U8BIT *key, U8BIT *iv, U32BIT key_len);

void STB_PVRSetPlaybackDecryptionKey(U8BIT audio_decoder, U8BIT video_decoder, BOOLEAN state,
   U8BIT *key, U8BIT *iv, U32BIT key_len);

void STB_PVRPlayTrickMode(U8BIT audio_decoder, U8BIT video_decoder, E_STB_PVR_PLAY_MODE mode, S16BIT speed);

void STB_PVRSaveFrame(U8BIT audio_decoder, U8BIT video_decoder);

S16BIT STB_PVRGetPlaySpeed(U8BIT audio_decoder, U8BIT video_decoder);

BOOLEAN STB_PVRSetPlaySpeed(U8BIT audio_decoder, U8BIT video_decoder, S16BIT speed);

BOOLEAN STB_PVRIsValidRecording(U16BIT disk_id, U8BIT *basename);

BOOLEAN STB_PVRCanBeUsedForRecording(U16BIT disk_id, U8BIT *basename);

BOOLEAN STB_PVRDeleteRecording(U16BIT disk_id, U8BIT *basename);

BOOLEAN STB_PVRGetRecordingSize(U16BIT disk_id, U8BIT *basename, U32BIT *rec_size_kb);

BOOLEAN STB_PVRGetElapsedTime(U8BIT audio_decoder, U8BIT video_decoder, U8BIT *elapsed_hours,
   U8BIT *elapsed_mins, U8BIT *elapsed_secs);

U8BIT STB_PVRAcquireRecorderIndex(U8BIT tuner, U8BIT demux);

void STB_PVRReleaseRecorderIndex(U8BIT rec_index);

BOOLEAN STB_PVRApplyDescramblerKey(U8BIT rec_index, E_STB_DMX_DESC_TYPE desc_type,
   E_STB_DMX_DESC_KEY_PARITY parity, U8BIT *key, U8BIT *iv);

#endif //  _STBPVRPR_H