IFileTypes.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.
 */

#pragma once

#include <stdint.h>

namespace XFILE
{

/* indicate that caller can handle truncated reads, where function returns before entire buffer has been filled */
  static const unsigned int READ_TRUNCATED = 0x01;

/* indicate that that caller support read in the minimum defined chunk size, this disables internal cache then */
  static const unsigned int READ_CHUNKED = 0x02;

/* use cache to access this file */
  static const unsigned int READ_CACHED = 0x04;

/* open without caching. regardless to file type. */
  static const unsigned int READ_NO_CACHE = 0x08;

/* calculate bitrate for file while reading */
  static const unsigned int READ_BITRATE = 0x10;

/* indicate to the caller we will seek between multiple streams in the file frequently */
  static const unsigned int READ_MULTI_STREAM = 0x20;

/* indicate to the caller file is audio and/or video (and e.g. may grow) */
  static const unsigned int READ_AUDIO_VIDEO = 0x40;

/* indicate that caller will do write operations before reading  */
  static const unsigned int READ_AFTER_WRITE = 0x80;

/* indicate that caller want to reopen a file if its already open  */
  static const unsigned int READ_REOPEN = 0x100;

struct SNativeIoControl
{
  unsigned long int   request;
  void*               param;
};

struct SCacheStatus
{
  uint64_t maxforward; 
  uint64_t forward; 
  uint32_t maxrate; 
  uint32_t currate; 
  uint32_t lowrate; 
};

enum CACHE_BUFFER_MODES
{
  CACHE_BUFFER_MODE_INTERNET = 0,
  CACHE_BUFFER_MODE_ALL = 1,
  CACHE_BUFFER_MODE_TRUE_INTERNET = 2,
  CACHE_BUFFER_MODE_NONE = 3,
  CACHE_BUFFER_MODE_NETWORK = 4,
};

typedef enum {
  IOCTRL_NATIVE        = 1,  
  IOCTRL_SEEK_POSSIBLE = 2,  
  IOCTRL_CACHE_STATUS  = 3,  
  IOCTRL_CACHE_SETRATE = 4,  
  IOCTRL_SET_CACHE     = 8,  
  IOCTRL_SET_RETRY     = 16, 
} EIoControl;

enum CURLOPTIONTYPE
{
  CURL_OPTION_OPTION,     
  CURL_OPTION_PROTOCOL,   
  CURL_OPTION_CREDENTIALS,
  CURL_OPTION_HEADER      
};

enum FileProperty
{
  FILE_PROPERTY_RESPONSE_PROTOCOL,          
  FILE_PROPERTY_RESPONSE_HEADER,            
  FILE_PROPERTY_CONTENT_TYPE,               
  FILE_PROPERTY_CONTENT_CHARSET,            
  FILE_PROPERTY_MIME_TYPE,                  
  FILE_PROPERTY_EFFECTIVE_URL               
};

class IFileCallback
{
public:
  virtual bool OnFileCallback(void* pContext, int ipercent, float avgSpeed) = 0;
  virtual ~IFileCallback() = default;
};
}