11#include "../AddonBase.h"
12#include "../c-api/addon-instance/game.h"
55 for (
unsigned int i = 0; i < layout.digital_button_count; ++i)
57 for (
unsigned int i = 0; i < layout.analog_button_count; ++i)
59 for (
unsigned int i = 0; i < layout.analog_stick_count; ++i)
61 for (
unsigned int i = 0; i < layout.accelerometer_count; ++i)
63 for (
unsigned int i = 0; i < layout.key_count; ++i)
64 keys.emplace_back(layout.keys[i]);
65 for (
unsigned int i = 0; i < layout.rel_pointer_count; ++i)
67 for (
unsigned int i = 0; i < layout.abs_pointer_count; ++i)
69 for (
unsigned int i = 0; i < layout.motor_count; ++i)
70 motors.emplace_back(layout.motors[i]);
95 std::vector<std::string>
keys;
163 if (CPrivateBase::m_interface->globalSingleInstance !=
nullptr)
165 throw std::logic_error(
166 "kodi::addon::CInstanceGame: Cannot create more than one game instance!");
168 SetAddonStruct(CPrivateBase::m_interface->firstKodiInstance);
169 CPrivateBase::m_interface->globalSingleInstance =
this;
202 for (
unsigned int i = 0; i < m_instanceData->props->proxy_dll_count; ++i)
204 if (m_instanceData->props->proxy_dll_paths[i] !=
nullptr)
205 paths.emplace_back(m_instanceData->props->proxy_dll_paths[i]);
207 return !paths.empty();
226 for (
unsigned int i = 0; i < m_instanceData->props->resource_directory_count; ++i)
228 if (m_instanceData->props->resource_directories[i] !=
nullptr)
229 dirs.emplace_back(m_instanceData->props->resource_directories[i]);
231 return !dirs.empty();
258 bool SupportsVFS()
const {
return m_instanceData->props->supports_vfs; }
273 for (
unsigned int i = 0; i < m_instanceData->props->extension_count; ++i)
275 if (m_instanceData->props->extensions[i] !=
nullptr)
276 extensions.emplace_back(m_instanceData->props->extensions[i]);
278 return !extensions.empty();
407 void CloseGame(
void) { m_instanceData->toKodi->CloseGame(m_instanceData->toKodi->kodiInstance); }
434 return m_instanceData->toKodi->GetPlaybackSpeed(m_instanceData->toKodi->kodiInstance);
451 m_instanceData->toKodi->SetGameTiming(m_instanceData->toKodi->kodiInstance, &timingInfo);
490 if (!CPrivateBase::m_interface->globalSingleInstance)
500 *
static_cast<CInstanceGame*
>(CPrivateBase::m_interface->globalSingleInstance)
501 ->m_instanceData->toKodi;
502 m_handle = cb.OpenStream(cb.kodiInstance, &properties);
505 const KODI_GAME_STREAM_HANDLE handle = m_handle;
506 const bool started = cb.
StartStream(cb.kodiInstance, handle);
507 if (m_handle != handle)
512 return m_handle !=
nullptr;
524 if (!m_handle || !CPrivateBase::m_interface->globalSingleInstance)
528 *
static_cast<CInstanceGame*
>(CPrivateBase::m_interface->globalSingleInstance)
529 ->m_instanceData->toKodi;
530 const KODI_GAME_STREAM_HANDLE handle = m_handle;
531 cb.CloseStream(cb.kodiInstance, handle);
532 if (m_handle == handle)
553 if (!m_handle || !CPrivateBase::m_interface->globalSingleInstance)
557 *
static_cast<CInstanceGame*
>(CPrivateBase::m_interface->globalSingleInstance)
558 ->m_instanceData->toKodi;
559 return cb.GetStreamBuffer(cb.kodiInstance, m_handle, width, height, &buffer);
577 if (!m_handle || !CPrivateBase::m_interface->globalSingleInstance)
581 *
static_cast<CInstanceGame*
>(CPrivateBase::m_interface->globalSingleInstance)
582 ->m_instanceData->toKodi;
583 cb.AddStreamData(cb.kodiInstance, m_handle, &packet);
597 if (!m_handle || !CPrivateBase::m_interface->globalSingleInstance)
601 *
static_cast<CInstanceGame*
>(CPrivateBase::m_interface->globalSingleInstance)
602 ->m_instanceData->toKodi;
603 cb.ReleaseStreamBuffer(cb.kodiInstance, m_handle, &buffer);
615 bool IsOpen()
const {
return m_handle !=
nullptr; }
619 KODI_GAME_STREAM_HANDLE m_handle =
nullptr;
654 return m_instanceData->toKodi->EnableHardwareRendering(m_instanceData->toKodi->kodiInstance,
691 return m_instanceData->toKodi->HwGetProcAddress(m_instanceData->toKodi->kodiInstance, sym);
761 virtual bool HasFeature(
const std::string& controller_id,
const std::string& feature_name)
798 const std::vector<kodi::addon::GameControllerLayout>& controllers)
811 virtual bool EnableKeyboard(
bool enable,
const std::string& controller_id) {
return false; }
822 virtual bool EnableMouse(
bool enable,
const std::string& controller_id) {
return false; }
870 const std::string& port_address,
871 const std::string& controller_id)
901 return m_instanceData->toKodi->InputEvent(m_instanceData->toKodi->kodiInstance, &event);
1073 const std::string& token)
1115 const std::string& memAddrExpression)
1133 const std::function<
void(
const std::string& achievementUrl,
unsigned int cheevoId)>& callback)
1150 m_instanceData->toKodi->RCOnGameLoaded(m_instanceData->toKodi->kodiInstance, &data);
1165 m_instanceData->toKodi->RCOnAchievementTriggered(m_instanceData->toKodi->kodiInstance, &data);
1181 m_instanceData->toKodi->RCOnGameCompleted(m_instanceData->toKodi->kodiInstance, title.c_str(),
1197 m_instanceData->toKodi->RCOnRichPresenceUpdated(m_instanceData->toKodi->kodiInstance,
1198 evaluation.c_str());
1213 m_instanceData->toKodi->RCOnLoginResult(m_instanceData->toKodi->kodiInstance, &data);
1231 m_instanceData->toKodi->RCOnAchievementProgress(m_instanceData->toKodi->kodiInstance,
1232 progress.empty() ?
nullptr : progress.data(),
1233 static_cast<unsigned int>(progress.size()));
1249 m_instanceData->toKodi->RCOnServerError(m_instanceData->toKodi->kodiInstance, message.c_str(),
1268 m_instanceData->toKodi->RCOnConnectionChanged(m_instanceData->toKodi->kodiInstance, connected);
1284 m_instanceData->toKodi->RCOnChallengeIndicator(m_instanceData->toKodi->kodiInstance, &data,
1300 m_instanceData->toKodi->RCOnAchievementProgressUpdate(m_instanceData->toKodi->kodiInstance,
1316 m_instanceData->toKodi->RCOnLeaderboardStarted(m_instanceData->toKodi->kodiInstance, &data);
1331 m_instanceData->toKodi->RCOnLeaderboardFailed(m_instanceData->toKodi->kodiInstance, &data);
1349 m_instanceData->toKodi->RCOnLeaderboardSubmitted(m_instanceData->toKodi->kodiInstance, &data);
1364 m_instanceData->toKodi->RCOnLeaderboardTrackerUpdate(m_instanceData->toKodi->kodiInstance,
1380 m_instanceData->toKodi->RCOnLeaderboardScoreboard(m_instanceData->toKodi->kodiInstance, &data);
1394 void RCOnReset() { m_instanceData->toKodi->RCOnReset(m_instanceData->toKodi->kodiInstance); }
1408 m_instanceData->toKodi->RCOnSubsetCompleted(m_instanceData->toKodi->kodiInstance,
1432 m_instanceData->toKodi->RCOnAchievementProgressShow(m_instanceData->toKodi->kodiInstance,
1435 m_instanceData->toKodi->RCOnAchievementProgressHide(m_instanceData->toKodi->kodiInstance,
1456 m_instanceData->toKodi->RCOnLeaderboardTrackerShow(m_instanceData->toKodi->kodiInstance,
1459 m_instanceData->toKodi->RCOnLeaderboardTrackerHide(m_instanceData->toKodi->kodiInstance,
1618 instance->hdl =
this;
1620 instance->game->toAddon->LoadGame = ADDON_LoadGame;
1621 instance->game->toAddon->LoadGameSpecial = ADDON_LoadGameSpecial;
1622 instance->game->toAddon->LoadStandalone = ADDON_LoadStandalone;
1623 instance->game->toAddon->UnloadGame = ADDON_UnloadGame;
1624 instance->game->toAddon->GetGameTiming = ADDON_GetGameTiming;
1625 instance->game->toAddon->GetRegion = ADDON_GetRegion;
1626 instance->game->toAddon->RequiresGameLoop = ADDON_RequiresGameLoop;
1627 instance->game->toAddon->RunFrame = ADDON_RunFrame;
1628 instance->game->toAddon->Reset = ADDON_Reset;
1630 instance->game->toAddon->HwContextReset = ADDON_HwContextReset;
1631 instance->game->toAddon->HwContextDestroy = ADDON_HwContextDestroy;
1633 instance->game->toAddon->AudioAvailable = ADDON_AudioAvailable;
1635 instance->game->toAddon->HasFeature = ADDON_HasFeature;
1636 instance->game->toAddon->GetTopology = ADDON_GetTopology;
1637 instance->game->toAddon->FreeTopology = ADDON_FreeTopology;
1638 instance->game->toAddon->SetControllerLayouts = ADDON_SetControllerLayouts;
1639 instance->game->toAddon->EnableKeyboard = ADDON_EnableKeyboard;
1640 instance->game->toAddon->EnableMouse = ADDON_EnableMouse;
1641 instance->game->toAddon->ConnectController = ADDON_ConnectController;
1642 instance->game->toAddon->InputEvent = ADDON_InputEvent;
1644 instance->game->toAddon->SerializeSize = ADDON_SerializeSize;
1645 instance->game->toAddon->Serialize = ADDON_Serialize;
1646 instance->game->toAddon->Deserialize = ADDON_Deserialize;
1647 instance->game->toAddon->AchievementStateSize = ADDON_AchievementStateSize;
1648 instance->game->toAddon->SerializeAchievements = ADDON_SerializeAchievements;
1649 instance->game->toAddon->DeserializeAchievements = ADDON_DeserializeAchievements;
1651 instance->game->toAddon->CheatReset = ADDON_CheatReset;
1652 instance->game->toAddon->GetMemory = ADDON_GetMemory;
1653 instance->game->toAddon->SetCheat = ADDON_SetCheat;
1655 instance->game->toAddon->SetRetroAchievementsCredentials =
1656 ADDON_SetRetroAchievementsCredentials;
1657 instance->game->toAddon->RCSetHardcoreEnabled = ADDON_RCSetHardcoreEnabled;
1658 instance->game->toAddon->RCSetEncoreModeEnabled = ADDON_RCSetEncoreModeEnabled;
1659 instance->game->toAddon->ActivateAchievement = ADDON_ActivateAchievement;
1660 instance->game->toAddon->GetCheevoUrlId = ADDON_GetCheevoUrlId;
1662 instance->game->toAddon->GetEjectState = ADDON_GetEjectState;
1663 instance->game->toAddon->SetEjectState = ADDON_SetEjectState;
1664 instance->game->toAddon->GetImageIndex = ADDON_GetImageIndex;
1665 instance->game->toAddon->SetImageIndex = ADDON_SetImageIndex;
1666 instance->game->toAddon->GetImageCount = ADDON_GetImageCount;
1667 instance->game->toAddon->AddImageIndex = ADDON_AddImageIndex;
1668 instance->game->toAddon->ReplaceImageIndex = ADDON_ReplaceImageIndex;
1669 instance->game->toAddon->RemoveImageIndex = ADDON_RemoveImageIndex;
1670 instance->game->toAddon->SetInitialImage = ADDON_SetInitialImage;
1671 instance->game->toAddon->GetImagePath = ADDON_GetImagePath;
1672 instance->game->toAddon->GetImageLabel = ADDON_GetImageLabel;
1674 instance->game->toAddon->FreeString = ADDON_FreeString;
1676 m_instanceData = instance->game;
1677 m_instanceData->toAddon->addonInstance =
this;
1684 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->LoadGame(url);
1692 std::vector<std::string> urlList;
1693 for (
size_t i = 0; i < urlCount; ++i)
1695 if (urls[i] !=
nullptr)
1696 urlList.emplace_back(urls[i]);
1699 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1700 ->LoadGameSpecial(type, urlList);
1705 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->LoadStandalone();
1710 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->UnloadGame();
1716 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1717 ->GetGameTiming(*timing_info);
1722 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->
GetRegion();
1727 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->RequiresGameLoop();
1732 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->RunFrame();
1737 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->Reset();
1744 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->HwContextReset();
1749 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->HwContextDestroy();
1756 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->AudioAvailable();
1762 const char* controller_id,
1763 const char* feature_name)
1765 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1766 ->HasFeature(controller_id, feature_name);
1771 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->GetTopology();
1777 static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->FreeTopology(topology);
1782 unsigned int controller_count)
1784 if (controllers ==
nullptr)
1787 std::vector<GameControllerLayout> controllerList;
1788 controllerList.reserve(controller_count);
1789 for (
unsigned int i = 0; i < controller_count; ++i)
1790 controllerList.emplace_back(controllers[i]);
1792 static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1793 ->SetControllerLayouts(controllerList);
1798 const char* controller_id)
1800 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1801 ->EnableKeyboard(enable, controller_id);
1806 const char* controller_id)
1808 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1809 ->EnableMouse(enable, controller_id);
1814 const char* port_address,
1815 const char* controller_id)
1817 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1818 ->ConnectController(connect, port_address, controller_id);
1824 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->InputEvent(*event);
1831 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->SerializeSize();
1838 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->Serialize(data, size);
1842 const uint8_t* data,
1845 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->Deserialize(data, size);
1850 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->AchievementStateSize();
1857 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1858 ->SerializeAchievements(data, size);
1862 const uint8_t* data,
1865 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1866 ->DeserializeAchievements(data, size);
1873 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->CheatReset();
1881 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1882 ->GetMemory(type, *data, *size);
1890 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1891 ->SetCheat(index, enabled, code);
1895 const char* username,
1898 if (username ==
nullptr || token ==
nullptr)
1901 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1902 ->SetRetroAchievementsCredentials(username, token);
1908 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1909 ->RCSetHardcoreEnabled(enabled);
1915 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1916 ->RCSetEncoreModeEnabled(enabled);
1920 unsigned int cheevoId,
1921 const char* memAddrExpression)
1923 if (memAddrExpression ==
nullptr)
1926 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1927 ->ActivateAchievement(cheevoId, memAddrExpression);
1931 void(__cdecl* callback)(
const void* context,
1932 const char* achievementUrl,
1933 unsigned int cheevoId),
1934 const void* context)
1936 if (callback ==
nullptr)
1939 const auto cppCallback =
1940 [callback, context](
const std::string& achievementUrl,
unsigned int cheevoId)
1941 { callback(context, achievementUrl.c_str(), cheevoId); };
1943 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1944 ->GetCheevoUrlId(cppCallback);
1949 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->GetEjectState();
1954 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->SetEjectState(ejected);
1959 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->GetImageIndex();
1963 unsigned int imageIndex)
1965 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->SetImageIndex(imageIndex);
1970 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->GetImageCount();
1975 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->AddImageIndex();
1979 unsigned int imageIndex,
1980 const char* filePath)
1982 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1983 ->ReplaceImageIndex(imageIndex, filePath ? filePath :
"");
1987 unsigned int imageIndex)
1989 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1990 ->RemoveImageIndex(imageIndex);
1994 unsigned int imageIndex,
1995 const char* filePath)
1997 return static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)
1998 ->SetInitialImage(imageIndex, filePath ? filePath :
"");
2002 unsigned int imageIndex)
2004 std::string cppPath =
2005 static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->GetImagePath(imageIndex);
2006 if (cppPath.empty())
2009 char* path =
new char[cppPath.size() + 1];
2010 std::copy(cppPath.begin(), cppPath.end(), path);
2011 path[cppPath.size()] =
'\0';
2016 unsigned int imageIndex)
2018 std::string cppLabel =
2019 static_cast<CInstanceGame*
>(instance->toAddon->addonInstance)->GetImageLabel(imageIndex);
2020 if (cppLabel.empty())
2023 char* label =
new char[cppLabel.size() + 1];
2024 std::copy(cppLabel.begin(), cppLabel.end(), label);
2025 label[cppLabel.size()] =
'\0';
Definition AddonBase.h:566
Definition AddonBase.h:502
@ ADDON_LOG_INFO
1 : To include information messages in the log file.
Definition addon_base.h:188
virtual GAME_ERROR AudioAvailable()
Tell the client the frontend is ready for audio.
Definition Game.h:726
CInstanceGame()
Game class constructor.
Definition Game.h:161
std::string GameClientDllPath() const
Callback to Kodi Function The path of the game client being loaded.
Definition Game.h:187
bool ProxyDllPaths(std::vector< std::string > &paths)
Callback to Kodi Function Paths to proxy DLLs used to load the game client.
Definition Game.h:200
bool ResourceDirectories(std::vector< std::string > &dirs)
Callback to Kodi Function The "system" directories of the frontend.
Definition Game.h:224
std::string ProfileDirectory() const
Callback to Kodi Function The writable directory of the frontend.
Definition Game.h:247
bool SupportsVFS() const
Callback to Kodi Function The value of the <supports_vfs> property from addon.xml.
Definition Game.h:258
~CInstanceGame() override=default
Destructor.
bool Extensions(std::vector< std::string > &extensions)
Callback to Kodi Function The extensions in the <extensions> property from addon.xml.
Definition Game.h:271
void RCOnLeaderboardScoreboard(const game_rc_leaderboard_scoreboard &data)
Callback to Kodi Function Tell Kodi where a submitted attempt placed
Definition Game.h:1378
void RCOnSubsetCompleted(const std::string &title)
Callback to Kodi Function Notify Kodi that every achievement of a subset has been earned
Definition Game.h:1406
void RCOnLeaderboardSubmitted(const game_rc_leaderboard &data)
Callback to Kodi Function Notify Kodi that a leaderboard value has been sent to the server
Definition Game.h:1347
virtual GAME_ERROR ActivateAchievement(unsigned int cheevoId, const std::string &memAddrExpression)
Activate an achievement.
Definition Game.h:1114
void RCOnRichPresenceUpdated(const std::string &evaluation)
Callback to Kodi Function Publish the current rich presence evaluation to Kodi
Definition Game.h:1195
void RCOnLeaderboardTracker(const game_rc_leaderboard_tracker &data, bool show)
Callback to Kodi Function Show, update or hide the live value of an attempt in progress
Definition Game.h:1453
void RCOnChallengeIndicator(const game_rc_achievement_challenge &data, bool show)
Callback to Kodi Function Show or hide the indicator for an achievement the player is attempting
Definition Game.h:1282
virtual GAME_ERROR RCSetEncoreModeEnabled(bool enabled)
Set whether already-earned achievements can be earned again.
Definition Game.h:1103
void RCOnLeaderboardFailed(const game_rc_leaderboard &data)
Callback to Kodi Function Notify Kodi that an attempt at a leaderboard has been abandoned
Definition Game.h:1329
void RCOnServerError(const std::string &message, const std::string &api)
Callback to Kodi Function Report an error returned by the RetroAchievements server
Definition Game.h:1247
void RCOnAchievementProgress(const std::vector< game_rc_achievement_progress > &progress)
Callback to Kodi Function Publish progress towards the game's measured achievements
Definition Game.h:1229
void RCOnReset()
Callback to Kodi Function Ask the frontend to reset the game
Definition Game.h:1394
void RCOnGameLoaded(const game_rc_game_loaded &data)
Callback to Kodi Function Notify Kodi that a game has been identified by the achievement runtime
Definition Game.h:1148
void RCOnLoginResult(const game_rc_login_result &data)
Callback to Kodi Function Notify Kodi of the outcome of a login attempt
Definition Game.h:1211
void RCOnAchievementProgressIndicator(const game_rc_achievement_progress_indicator &data, bool show)
Callback to Kodi Function Show, update or hide how far along a measured achievement is
Definition Game.h:1428
virtual GAME_ERROR SetRetroAchievementsCredentials(const std::string &username, const std::string &token)
Set the credentials of the RetroAchievements user.
Definition Game.h:1072
void RCOnLeaderboardTrackerUpdate(const game_rc_leaderboard_tracker &data)
Callback to Kodi Function Give Kodi a new value for an attempt already on screen
Definition Game.h:1362
void RCOnAchievementProgressUpdate(const game_rc_achievement_progress_indicator &data)
Callback to Kodi Function Give Kodi a new value for a measured achievement already on screen
Definition Game.h:1298
void RCOnConnectionChanged(bool connected)
Callback to Kodi Function Report a change in connectivity to the RetroAchievements server
Definition Game.h:1266
void RCOnLeaderboardStarted(const game_rc_leaderboard &data)
Callback to Kodi Function Notify Kodi that an attempt at a leaderboard has begun
Definition Game.h:1314
virtual GAME_ERROR RCSetHardcoreEnabled(bool enabled)
Set whether achievements are earned in hardcore mode.
Definition Game.h:1091
void RCOnGameCompleted(const std::string &title, bool hardcore)
Callback to Kodi Function Notify Kodi that every achievement of the game has been earned
Definition Game.h:1179
virtual GAME_ERROR GetCheevoUrlId(const std::function< void(const std::string &achievementUrl, unsigned int cheevoId)> &callback)
Get triggered achievement URL and ID pairs.
Definition Game.h:1132
void RCOnAchievementTriggered(const game_rc_achievement_triggered &data)
Callback to Kodi Function Notify Kodi that the player has earned an achievement
Definition Game.h:1163
virtual GAME_ERROR CheatReset()
Reset the cheat system.
Definition Game.h:1033
virtual GAME_ERROR GetMemory(GAME_MEMORY type, uint8_t *&data, size_t &size)
Get a region of memory.
Definition Game.h:1045
virtual GAME_ERROR SetCheat(unsigned int index, bool enabled, const std::string &code)
Set a cheat code.
Definition Game.h:1060
Game system timing.
Definition game.h:1178
GAME_REGION
Game region definition
Definition game.h:623
SPECIAL_GAME_TYPE
Special game types passed into game_load_game_special().
Definition game.h:641
GAME_MEMORY
Game Memory
Definition game.h:660
@ GAME_REGION_UNKNOWN
Game region unknown.
Definition game.h:625
void(* game_proc_address_t)(void)
Hardware framebuffer process function address
Definition game.h:463
Hardware rendering properties
Definition game.h:338
**Payload of AddonToKodiFuncTable_Game::RCOnChallengeIndicator**
Definition game.h:1444
Payload of the achievement progress indicator callbacks
Definition game.h:1466
**Payload of AddonToKodiFuncTable_Game::RCOnAchievementTriggered**
Definition game.h:1289
**Payload of AddonToKodiFuncTable_Game::RCOnGameLoaded**
Definition game.h:1267
Payload of the leaderboard attempt callbacks
Definition game.h:1374
**Payload of AddonToKodiFuncTable_Game::RCOnLeaderboardScoreboard**
Definition game.h:1399
Payload of the leaderboard tracker callbacks
Definition game.h:1425
**Payload of AddonToKodiFuncTable_Game::RCOnLoginResult**
Definition game.h:1314
GAME_STREAM_TYPE type
The stream type.
Definition game.h:542
@ GAME_STREAM_HW_FRAMEBUFFER
Hardware framebuffer.
Definition game.h:526
Stream buffers for hardware rendering and zero-copy support
Definition game.h:565
Stream packet and ephemeral metadata
Definition game.h:588
Immutable stream metadata
Definition game.h:540
GAME_ERROR
Game add-on error codes
Definition game.h:29
@ GAME_ERROR_INVALID_PARAMETERS
The parameters of the called method are invalid for this operation.
Definition game.h:43
@ GAME_ERROR_NOT_IMPLEMENTED
The method called by the frontend is not implemented.
Definition game.h:37
virtual GAME_ERROR SetImageIndex(unsigned int imageIndex)
Inserts the disk image at the given index.
Definition Game.h:1527
virtual unsigned int GetImageCount()
Gets the number of available disk images.
Definition Game.h:1535
virtual std::string GetImageLabel(unsigned int imageIndex)
Gets a user-friendly label for a disk image.
Definition Game.h:1610
virtual GAME_ERROR ReplaceImageIndex(unsigned int imageIndex, const std::string &filePath)
Replaces the disk image at the given index.
Definition Game.h:1557
virtual GAME_ERROR RemoveImageIndex(unsigned int imageIndex)
Removes the disk image at the given index.
Definition Game.h:1572
virtual std::string GetImagePath(unsigned int imageIndex)
Gets the full path of a disk image.
Definition Game.h:1600
virtual unsigned int GetImageIndex()
Gets the index of the currently inserted disk image.
Definition Game.h:1515
virtual GAME_ERROR SetInitialImage(unsigned int imageIndex, const std::string &filePath)
Sets which image should be initially inserted on load.
Definition Game.h:1587
virtual GAME_ERROR SetEjectState(bool ejected)
Opens or closes the virtual disk tray.
Definition Game.h:1506
virtual GAME_ERROR AddImageIndex()
Adds a new disk image slot.
Definition Game.h:1544
virtual bool GetEjectState()
Returns whether the virtual disk tray is currently ejected.
Definition Game.h:1493
virtual GAME_ERROR HwContextDestroy()
Called before the context is destroyed.
Definition Game.h:678
virtual GAME_ERROR HwContextReset()
Invalidates the current HW context and reinitializes GPU resources.
Definition Game.h:668
bool EnableHardwareRendering(const game_hw_rendering_properties &properties)
Callback to Kodi Function Enable hardware rendering functionality
Definition Game.h:652
game_proc_address_t HwGetProcAddress(const char *sym)
Callback to Kodi Function Get a symbol from the hardware context
Definition Game.h:689
bool IsOpen() const
Check if the stream opened correctly, e.g. after calling the constructor.
Definition Game.h:615
void ReleaseBuffer(game_stream_buffer &buffer)
Free an allocated buffer.
Definition Game.h:595
void Close()
Free the specified stream.
Definition Game.h:522
bool GetBuffer(unsigned int width, unsigned int height, game_stream_buffer &buffer)
Get a buffer for zero-copy stream data.
Definition Game.h:551
void AddData(const game_stream_packet &packet)
Add a data packet to a stream.
Definition Game.h:575
bool Open(const game_stream_properties &properties)
Create a stream for gameplay data.
Definition Game.h:488
virtual GAME_ERROR LoadGameSpecial(SPECIAL_GAME_TYPE type, const std::vector< std::string > &urls)
Load a game that requires multiple files.
Definition Game.h:324
virtual GAME_ERROR UnloadGame()
Unload the current game.
Definition Game.h:350
void SetGameTiming(const game_system_timing &timingInfo)
Callback to Kodi Function Update the video and audio timing of the running game
Definition Game.h:449
virtual GAME_ERROR GetGameTiming(game_system_timing &timing_info)
Get timing information about the loaded game.
Definition Game.h:360
virtual GAME_ERROR RunFrame()
Run a single frame for add-ons that use a game loop.
Definition Game.h:390
virtual bool RequiresGameLoop()
Return true if the client requires the frontend to provide a game loop.
Definition Game.h:382
virtual GAME_ERROR Reset()
Reset the current game.
Definition Game.h:398
virtual GAME_ERROR LoadStandalone()
Begin playing without a game file.
Definition Game.h:340
double GetPlaybackSpeed()
Callback to Kodi Function Get the speed the game is being played back at
Definition Game.h:432
void CloseGame(void)
Callback to Kodi Function Requests the frontend to stop the current game
Definition Game.h:407
virtual GAME_ERROR LoadGame(const std::string &url)
Load a game.
Definition Game.h:313
virtual GAME_REGION GetRegion()
Get region of the loaded game.
Definition Game.h:371
virtual size_t AchievementStateSize()
How many bytes the achievement runtime's state needs right now.
Definition Game.h:967
virtual GAME_ERROR SerializeAchievements(uint8_t *data, size_t size)
Write the achievement runtime's state.
Definition Game.h:979
virtual GAME_ERROR DeserializeAchievements(const uint8_t *data, size_t size)
Restore achievement state written by SerializeAchievements()
Definition Game.h:1001
virtual GAME_ERROR Deserialize(const uint8_t *data, size_t size)
Deserialize the game from the given state.
Definition Game.h:952
virtual GAME_ERROR Serialize(uint8_t *data, size_t size)
Serialize the state of the game.
Definition Game.h:941
virtual size_t SerializeSize()
Get the number of bytes required to serialize the game.
Definition Game.h:930
void ATTR_DLL_LOCAL Log(const ADDON_LOG loglevel, const char *format,...)
Add a message to Kodi's log.
Definition AddonBase.h:1939
std::string ATTR_DLL_LOCAL GetRegion(const std::string &id)
Returns your regions setting as a string for the specified id.
Definition General.h:331
Game instance.
Definition game.h:1711
Game callbacks.
Definition game.h:1566
bool(* StartStream)(KODI_HANDLE, KODI_GAME_STREAM_HANDLE)
Reset a prepared hardware stream after installing its returned handle.
Definition game.h:1630
Definition addon_base.h:269
Internal used structure to have stored C API data above and available for everything below.
Definition AddonBase.h:73