ISavestate.h

/*
 *  Copyright (C) 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 "SavestateTypes.h"

#include <stdint.h>
#include <string>
#include <vector>

extern "C"
{
#include <libavutil/pixfmt.h>
}

class CDateTime;

namespace KODI
{
namespace RETRO
{
class ISavestate
{
public:
  virtual ~ISavestate() = default;

  virtual void Reset() = 0;

  virtual bool Serialize(const uint8_t*& data, size_t& size) const = 0;


  virtual SAVE_TYPE Type() const = 0;

  virtual uint8_t Slot() const = 0;

  virtual std::string Label() const = 0;

  virtual std::string Caption() const = 0;

  virtual CDateTime Created() const = 0;


  virtual std::string GameFileName() const = 0;


  virtual uint64_t TimestampFrames() const = 0;

  virtual double TimestampWallClock() const = 0;


  virtual std::string GameClientID() const = 0;

  virtual std::string GameClientVersion() const = 0;


  virtual AVPixelFormat GetPixelFormat() const = 0;

  virtual unsigned int GetNominalWidth() const = 0;

  virtual unsigned int GetNominalHeight() const = 0;

  virtual unsigned int GetMaxWidth() const = 0;

  virtual unsigned int GetMaxHeight() const = 0;

  virtual float GetPixelAspectRatio() const = 0;


  virtual const uint8_t* GetVideoData() const = 0;

  virtual size_t GetVideoSize() const = 0;

  virtual unsigned int GetVideoWidth() const = 0;

  virtual unsigned int GetVideoHeight() const = 0;

  virtual unsigned int GetRotationDegCCW() const = 0;


  virtual const uint8_t* GetMemoryData() const = 0;

  virtual size_t GetMemorySize() const = 0;

  virtual void SetType(SAVE_TYPE type) = 0;
  virtual void SetSlot(uint8_t slot) = 0;
  virtual void SetLabel(const std::string& label) = 0;
  virtual void SetCaption(const std::string& caption) = 0;
  virtual void SetCreated(const CDateTime& createdUTC) = 0;
  virtual void SetGameFileName(const std::string& gameFileName) = 0;
  virtual void SetTimestampFrames(uint64_t timestampFrames) = 0;
  virtual void SetTimestampWallClock(double timestampWallClock) = 0;
  virtual void SetGameClientID(const std::string& gameClient) = 0;
  virtual void SetGameClientVersion(const std::string& gameClient) = 0;
  virtual void SetPixelFormat(AVPixelFormat pixelFormat) = 0;
  virtual void SetNominalWidth(unsigned int nominalWidth) = 0;
  virtual void SetNominalHeight(unsigned int nominalHeight) = 0;
  virtual void SetMaxWidth(unsigned int maxWidth) = 0;
  virtual void SetMaxHeight(unsigned int maxHeight) = 0;
  virtual void SetPixelAspectRatio(float pixelAspectRatio) = 0;
  virtual uint8_t* GetVideoBuffer(size_t size) = 0;
  virtual void SetVideoWidth(unsigned int videoWidth) = 0;
  virtual void SetVideoHeight(unsigned int videoHeight) = 0;
  virtual void SetRotationDegCCW(unsigned int rotationCCW) = 0;
  virtual uint8_t* GetMemoryBuffer(size_t size) = 0;
  virtual void Finalize() = 0;

  virtual bool Deserialize(std::vector<uint8_t> data) = 0;
};
} // namespace RETRO
} // namespace KODI