pvr_general.h

/*
 *  Copyright (C) 2005-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */
 
#ifndef C_API_ADDONINSTANCE_PVR_GENERAL_H
#define C_API_ADDONINSTANCE_PVR_GENERAL_H
 
#include "../inputstream/stream_constants.h"
#include "pvr_defines.h"
 
#include <stdbool.h>
#include <stdint.h>
 
//¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
// "C" Definitions group 1 - General PVR
#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */
 
  //============================================================================
  typedef enum PVR_ERROR
  {
    PVR_ERROR_NO_ERROR = 0,
 
    PVR_ERROR_UNKNOWN = -1,
 
    PVR_ERROR_NOT_IMPLEMENTED = -2,
 
    PVR_ERROR_SERVER_ERROR = -3,
 
    PVR_ERROR_SERVER_TIMEOUT = -4,
 
    PVR_ERROR_REJECTED = -5,
 
    PVR_ERROR_ALREADY_PRESENT = -6,
 
    PVR_ERROR_INVALID_PARAMETERS = -7,
 
    PVR_ERROR_RECORDING_RUNNING = -8,
 
    PVR_ERROR_FAILED = -9,
  } PVR_ERROR;
  //----------------------------------------------------------------------------
 
  //============================================================================
  typedef enum PVR_CONNECTION_STATE
  {
    PVR_CONNECTION_STATE_UNKNOWN = 0,
 
    PVR_CONNECTION_STATE_SERVER_UNREACHABLE = 1,
 
    PVR_CONNECTION_STATE_SERVER_MISMATCH = 2,
 
    PVR_CONNECTION_STATE_VERSION_MISMATCH = 3,
 
    PVR_CONNECTION_STATE_ACCESS_DENIED = 4,
 
    PVR_CONNECTION_STATE_CONNECTED = 5,
 
    PVR_CONNECTION_STATE_DISCONNECTED = 6,
 
    PVR_CONNECTION_STATE_CONNECTING = 7,
  } PVR_CONNECTION_STATE;
  //----------------------------------------------------------------------------
 
  //============================================================================
  typedef enum PVR_SOURCE
  {
    DEFAULT = 0,
 
    PVR_SOURCE_EPG_AS_LIVE = 1,
  } PVR_SOURCE;
  //----------------------------------------------------------------------------
 
  //============================================================================
  typedef enum PVR_SETTING_READONLY_CONDITION
  {
    PVR_SETTING_READONLY_CONDITION_NONE = 0,
 
    PVR_SETTING_READONLY_CONDITION_TIMER_DISABLED = (1 << 0),
 
    PVR_SETTING_READONLY_CONDITION_TIMER_SCHEDULED = (1 << 1),
 
    PVR_SETTING_READONLY_CONDITION_TIMER_RECORDING = (1 << 2),
 
    PVR_SETTING_READONLY_CONDITION_TIMER_COMPLETED = (1 << 3),
 
  } PVR_SETTING_READONLY_CONDITION;
  //----------------------------------------------------------------------------
 
  //============================================================================
  typedef enum PVR_SETTING_TYPE
  {
    INTEGER = 0,
 
    STRING = 1,
 
  } PVR_SETTING_TYPE;
  //----------------------------------------------------------------------------
 
  //============================================================================
 
#define PVR_STREAM_PROPERTY_STREAMURL "streamurl"
 
#define PVR_STREAM_PROPERTY_INPUTSTREAM STREAM_PROPERTY_INPUTSTREAM
 
#define PVR_STREAM_PROPERTY_INPUTSTREAM_PLAYER STREAM_PROPERTY_INPUTSTREAM_PLAYER
 
#define PVR_STREAM_PROPERTY_INPUTSTREAM_INSTANCE_ID STREAM_PROPERTY_INPUTSTREAM_INSTANCE_ID
 
#define PVR_STREAM_PROPERTY_MIMETYPE "mimetype"
 
#define PVR_STREAM_PROPERTY_ISREALTIMESTREAM STREAM_PROPERTY_ISREALTIMESTREAM
 
#define PVR_STREAM_PROPERTY_EPGPLAYBACKASLIVE "epgplaybackaslive"
 
#define PVR_STREAM_PROPERTY_LIVEPLAYBACKASEPG "liveplaybackasepg"
 
#define PVR_STREAM_PROPERTY_VALUE_INPUTSTREAMFFMPEG STREAM_PROPERTY_VALUE_INPUTSTREAMFFMPEG
 
  //-----------------------------------------------------------------------------
 
  typedef struct PVR_ADDON_CAPABILITIES
  {
    bool bSupportsEPG;
    bool bSupportsEPGEdl;
    bool bSupportsTV;
    bool bSupportsRadio;
    bool bSupportsRecordings;
    bool bSupportsRecordingsUndelete;
    bool bSupportsTimers;
    bool bSupportsChannelGroups;
    bool bSupportsChannelScan;
    bool bSupportsChannelSettings;
    bool bHandlesInputStream;
    bool bHandlesDemuxing;
    bool bSupportsRecordingPlayCount;
    bool bSupportsLastPlayedPosition;
    bool bSupportsRecordingEdl;
    bool bSupportsRecordingsRename;
    bool bSupportsRecordingsLifetimeChange;
    bool bSupportsDescrambleInfo;
    bool bSupportsAsyncEPGTransfer;
    bool bSupportsRecordingSize;
    bool bSupportsProviders;
    bool bSupportsRecordingsDelete;
    bool bSupportsMultipleRecordedStreams;
 
    unsigned int iRecordingsLifetimesSize;
    struct PVR_ATTRIBUTE_INT_VALUE* recordingsLifetimeValues;
  } PVR_ADDON_CAPABILITIES;
 
  typedef struct PVR_INT_SETTING_DEFINITION
  {
    unsigned int iValuesSize;
    struct PVR_ATTRIBUTE_INT_VALUE* values;
    int iDefaultValue;
    int iMinValue;
    int iStep;
    int iMaxValue;
  } PVR_INT_SETTING_DEFINITION;
 
  typedef struct PVR_STRING_SETTING_DEFINITION
  {
    unsigned int iValuesSize;
    struct PVR_ATTRIBUTE_STRING_VALUE* values;
    const char* strDefaultValue;
    bool bAllowEmptyValue;
  } PVR_STRING_SETTING_DEFINITION;
 
  typedef struct PVR_SETTING_DEFINITION
  {
    unsigned int iId;
    const char* strName;
    enum PVR_SETTING_TYPE eType;
    uint64_t iReadonlyConditions;
    struct PVR_INT_SETTING_DEFINITION* intSettingDefinition;
    struct PVR_STRING_SETTING_DEFINITION* stringSettingDefinition;
  } PVR_SETTING_DEFINITION;
 
  typedef struct PVR_SETTING_KEY_VALUE_PAIR
  {
    unsigned int iKey;
    enum PVR_SETTING_TYPE eType;
    int iValue;
    const char* strValue;
  } PVR_SETTING_KEY_VALUE_PAIR;
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* !C_API_ADDONINSTANCE_PVR_GENERAL_H */