mirrors/nxdumptool
1
0
Fork 0
mirror of https://github.com/DarkMatterCore/nxdumptool.git synced 2024-11-09 20:21:45 +00:00
Code Issues Releases Activity
nxdumptool/source/tasks/title_metadata_task.cpp

81 lines
2.8 KiB
C++
Raw Normal View History

Improve directory layout while we still can. The directory layout is partially based on the C++ namespaces we're currently using. Other changes include: * devoptab: move directory into "core". * fatfs: move directory into "core". * GameCardTab: move portions of logic from PopulateList() into their own methods. * GameCardTab: use a macro to generate the properties table. * GameCardTab: use a macro to add ListItem elements. * GameCardTab: update AddApplicationMetadataItems() method to also display the number of DLCs available in the inserted gamecard for each application whenever possible. * Makefile: remove all extra entries from the INCLUDES variable. * nxdt_includes: move HOS version structs into their own header file. * tasks: move code for each individual task into its own file(s). * title: update titleGetGameCardApplicationMetadataEntries() to also count the number of DLCs available in the inserted gamecard for any given base application. * title: reorder gamecard application metadata entries by name before returning the buffer in titleGetGameCardApplicationMetadataEntries().
2024-04-30 22:01:42 +01:00
/*
* title_metadata_task.cpp
*
* Copyright (c) 2020-2024, DarkMatterCore <pabloacurielz@gmail.com>.
*
* This file is part of nxdumptool (https://github.com/DarkMatterCore/nxdumptool).
*
* nxdumptool is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* nxdumptool is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include <tasks/title_metadata_task.hpp>
using namespace brls::i18n::literals; /* For _i18n. */
namespace nxdt::tasks
{
TitleMetadataTask::TitleMetadataTask() : brls::RepeatingTask(REPEATING_TASK_INTERVAL)
{
title: migrate application metadata filtering logic to background thread titleGetApplicationMetadataEntries() and titleGetGameCardApplicationMetadataEntries() will now return dynamically allocated copies of internal pre-filtered / pre-processed arrays, which are generated using the background gamecard thread. This results in less overhead for any potential calls to these functions. Other changes include: * title: rename TitleGameCardApplicationMetadataEntry -> TitleGameCardApplicationMetadata. * title: add `has_patch` field to TitleGameCardApplicationMetadata struct. * title: declare internal TitleApplicationMetadata arrays to hold pre-filtered application metadata. * title: declare internal TitleGameCardApplicationMetadata array to hold pre-processed gamecard application metadata. * title: move filtering logic from titleGetApplicationMetadataEntries() to a new function: titleGenerateFilteredApplicationMetadataPointerArray(). * title: move processing logic from titleGetGameCardApplicationMetadataEntries() to a new function: titleGenerateGameCardApplicationMetadataArray(). * title: rename titleGetPatchVersionString() -> titleGetDisplayVersionString(). * title: add extra debug log messages to some functions. * title: update titleFreeApplicationMetadata() to also free the new internal metadata arrays. * title: update background thread logic in titleGameCardInfoThreadFunc() to also regenerate the pre-filtered application metadata and gamecard application metadata arrays right after a successful call to titleRefreshGameCardTitleInfo(). * title: update titleGetDisplayVersionString() to also support base application titles. * title: simplify string generation logic in titleGenerateGameCardFileName() by using the cached gamecard application metadata array. * GameCardStatusTask: add GetGameCardStatus() method. * GameCardTab: fix callback argument type in class constructor. * GameCardTab: update ProcessGameCardStatus() to block user inputs while processing the new gamecard status. * RootView: add GetGameCardStatus() method. * StatusInfoTask: turn IsInternetConnectionAvailable() into an inline method. * TitleMetadataTask: turn GetApplicationMetadata() into an inline method. * TitleMetadataTask: move debug log messages around. * TitlesTab: update PopulateList() to block user inputs while updating the titles list. * UmsTask: turn GetUmsDevices() into an inline method. * UsbHostTask: turn GetUsbHostSpeed() into an inline method.
2024-05-05 20:42:32 +01:00
LOG_MSG_DEBUG("Title metadata task started.");
Improve directory layout while we still can. The directory layout is partially based on the C++ namespaces we're currently using. Other changes include: * devoptab: move directory into "core". * fatfs: move directory into "core". * GameCardTab: move portions of logic from PopulateList() into their own methods. * GameCardTab: use a macro to generate the properties table. * GameCardTab: use a macro to add ListItem elements. * GameCardTab: update AddApplicationMetadataItems() method to also display the number of DLCs available in the inserted gamecard for each application whenever possible. * Makefile: remove all extra entries from the INCLUDES variable. * nxdt_includes: move HOS version structs into their own header file. * tasks: move code for each individual task into its own file(s). * title: update titleGetGameCardApplicationMetadataEntries() to also count the number of DLCs available in the inserted gamecard for any given base application. * title: reorder gamecard application metadata entries by name before returning the buffer in titleGetGameCardApplicationMetadataEntries().
2024-04-30 22:01:42 +01:00
/* Get system metadata entries. */
TitleMetadataTask: use a struct instead of a vector The struct has been typedef'd as TitleApplicationMetadataInfo. It holds the pointer to the array returned by titleGetApplicationMetadataEntries(), as well as the number of elements available in the array. There's no point in populating a vector when we already have an array we can work with.
2024-05-05 23:41:41 +01:00
this->PopulateApplicationMetadataInfo(true);
Improve directory layout while we still can. The directory layout is partially based on the C++ namespaces we're currently using. Other changes include: * devoptab: move directory into "core". * fatfs: move directory into "core". * GameCardTab: move portions of logic from PopulateList() into their own methods. * GameCardTab: use a macro to generate the properties table. * GameCardTab: use a macro to add ListItem elements. * GameCardTab: update AddApplicationMetadataItems() method to also display the number of DLCs available in the inserted gamecard for each application whenever possible. * Makefile: remove all extra entries from the INCLUDES variable. * nxdt_includes: move HOS version structs into their own header file. * tasks: move code for each individual task into its own file(s). * title: update titleGetGameCardApplicationMetadataEntries() to also count the number of DLCs available in the inserted gamecard for any given base application. * title: reorder gamecard application metadata entries by name before returning the buffer in titleGetGameCardApplicationMetadataEntries().
2024-04-30 22:01:42 +01:00
/* Get user metadata entries. */
TitleMetadataTask: use a struct instead of a vector The struct has been typedef'd as TitleApplicationMetadataInfo. It holds the pointer to the array returned by titleGetApplicationMetadataEntries(), as well as the number of elements available in the array. There's no point in populating a vector when we already have an array we can work with.
2024-05-05 23:41:41 +01:00
this->PopulateApplicationMetadataInfo(false);
Improve directory layout while we still can. The directory layout is partially based on the C++ namespaces we're currently using. Other changes include: * devoptab: move directory into "core". * fatfs: move directory into "core". * GameCardTab: move portions of logic from PopulateList() into their own methods. * GameCardTab: use a macro to generate the properties table. * GameCardTab: use a macro to add ListItem elements. * GameCardTab: update AddApplicationMetadataItems() method to also display the number of DLCs available in the inserted gamecard for each application whenever possible. * Makefile: remove all extra entries from the INCLUDES variable. * nxdt_includes: move HOS version structs into their own header file. * tasks: move code for each individual task into its own file(s). * title: update titleGetGameCardApplicationMetadataEntries() to also count the number of DLCs available in the inserted gamecard for any given base application. * title: reorder gamecard application metadata entries by name before returning the buffer in titleGetGameCardApplicationMetadataEntries().
2024-04-30 22:01:42 +01:00
/* Start task. */
brls::RepeatingTask::start();
}
TitleMetadataTask::~TitleMetadataTask()
{
TitleMetadataTask: use a struct instead of a vector The struct has been typedef'd as TitleApplicationMetadataInfo. It holds the pointer to the array returned by titleGetApplicationMetadataEntries(), as well as the number of elements available in the array. There's no point in populating a vector when we already have an array we can work with.
2024-05-05 23:41:41 +01:00
/* Free application metadata arrays. */
if (this->system_metadata_info.app_metadata) free(this->system_metadata_info.app_metadata);
if (this->user_metadata_info.app_metadata) free(this->user_metadata_info.app_metadata);
Improve directory layout while we still can. The directory layout is partially based on the C++ namespaces we're currently using. Other changes include: * devoptab: move directory into "core". * fatfs: move directory into "core". * GameCardTab: move portions of logic from PopulateList() into their own methods. * GameCardTab: use a macro to generate the properties table. * GameCardTab: use a macro to add ListItem elements. * GameCardTab: update AddApplicationMetadataItems() method to also display the number of DLCs available in the inserted gamecard for each application whenever possible. * Makefile: remove all extra entries from the INCLUDES variable. * nxdt_includes: move HOS version structs into their own header file. * tasks: move code for each individual task into its own file(s). * title: update titleGetGameCardApplicationMetadataEntries() to also count the number of DLCs available in the inserted gamecard for any given base application. * title: reorder gamecard application metadata entries by name before returning the buffer in titleGetGameCardApplicationMetadataEntries().
2024-04-30 22:01:42 +01:00
LOG_MSG_DEBUG("Title metadata task stopped.");
}
void TitleMetadataTask::run(retro_time_t current_time)
{
brls::RepeatingTask::run(current_time);
if (titleIsGameCardInfoUpdated())
{
TitleMetadataTask: use a struct instead of a vector The struct has been typedef'd as TitleApplicationMetadataInfo. It holds the pointer to the array returned by titleGetApplicationMetadataEntries(), as well as the number of elements available in the array. There's no point in populating a vector when we already have an array we can work with.
2024-05-05 23:41:41 +01:00
/* Update user metadata array. */
this->PopulateApplicationMetadataInfo(false);
Improve directory layout while we still can. The directory layout is partially based on the C++ namespaces we're currently using. Other changes include: * devoptab: move directory into "core". * fatfs: move directory into "core". * GameCardTab: move portions of logic from PopulateList() into their own methods. * GameCardTab: use a macro to generate the properties table. * GameCardTab: use a macro to add ListItem elements. * GameCardTab: update AddApplicationMetadataItems() method to also display the number of DLCs available in the inserted gamecard for each application whenever possible. * Makefile: remove all extra entries from the INCLUDES variable. * nxdt_includes: move HOS version structs into their own header file. * tasks: move code for each individual task into its own file(s). * title: update titleGetGameCardApplicationMetadataEntries() to also count the number of DLCs available in the inserted gamecard for any given base application. * title: reorder gamecard application metadata entries by name before returning the buffer in titleGetGameCardApplicationMetadataEntries().
2024-04-30 22:01:42 +01:00
/* Fire task event. */
TitleMetadataTask: use a struct instead of a vector The struct has been typedef'd as TitleApplicationMetadataInfo. It holds the pointer to the array returned by titleGetApplicationMetadataEntries(), as well as the number of elements available in the array. There's no point in populating a vector when we already have an array we can work with.
2024-05-05 23:41:41 +01:00
this->user_title_event.fire(this->user_metadata_info);
Improve directory layout while we still can. The directory layout is partially based on the C++ namespaces we're currently using. Other changes include: * devoptab: move directory into "core". * fatfs: move directory into "core". * GameCardTab: move portions of logic from PopulateList() into their own methods. * GameCardTab: use a macro to generate the properties table. * GameCardTab: use a macro to add ListItem elements. * GameCardTab: update AddApplicationMetadataItems() method to also display the number of DLCs available in the inserted gamecard for each application whenever possible. * Makefile: remove all extra entries from the INCLUDES variable. * nxdt_includes: move HOS version structs into their own header file. * tasks: move code for each individual task into its own file(s). * title: update titleGetGameCardApplicationMetadataEntries() to also count the number of DLCs available in the inserted gamecard for any given base application. * title: reorder gamecard application metadata entries by name before returning the buffer in titleGetGameCardApplicationMetadataEntries().
2024-04-30 22:01:42 +01:00
title: migrate application metadata filtering logic to background thread titleGetApplicationMetadataEntries() and titleGetGameCardApplicationMetadataEntries() will now return dynamically allocated copies of internal pre-filtered / pre-processed arrays, which are generated using the background gamecard thread. This results in less overhead for any potential calls to these functions. Other changes include: * title: rename TitleGameCardApplicationMetadataEntry -> TitleGameCardApplicationMetadata. * title: add `has_patch` field to TitleGameCardApplicationMetadata struct. * title: declare internal TitleApplicationMetadata arrays to hold pre-filtered application metadata. * title: declare internal TitleGameCardApplicationMetadata array to hold pre-processed gamecard application metadata. * title: move filtering logic from titleGetApplicationMetadataEntries() to a new function: titleGenerateFilteredApplicationMetadataPointerArray(). * title: move processing logic from titleGetGameCardApplicationMetadataEntries() to a new function: titleGenerateGameCardApplicationMetadataArray(). * title: rename titleGetPatchVersionString() -> titleGetDisplayVersionString(). * title: add extra debug log messages to some functions. * title: update titleFreeApplicationMetadata() to also free the new internal metadata arrays. * title: update background thread logic in titleGameCardInfoThreadFunc() to also regenerate the pre-filtered application metadata and gamecard application metadata arrays right after a successful call to titleRefreshGameCardTitleInfo(). * title: update titleGetDisplayVersionString() to also support base application titles. * title: simplify string generation logic in titleGenerateGameCardFileName() by using the cached gamecard application metadata array. * GameCardStatusTask: add GetGameCardStatus() method. * GameCardTab: fix callback argument type in class constructor. * GameCardTab: update ProcessGameCardStatus() to block user inputs while processing the new gamecard status. * RootView: add GetGameCardStatus() method. * StatusInfoTask: turn IsInternetConnectionAvailable() into an inline method. * TitleMetadataTask: turn GetApplicationMetadata() into an inline method. * TitleMetadataTask: move debug log messages around. * TitlesTab: update PopulateList() to block user inputs while updating the titles list. * UmsTask: turn GetUmsDevices() into an inline method. * UsbHostTask: turn GetUsbHostSpeed() into an inline method.
2024-05-05 20:42:32 +01:00
//brls::Application::notify("tasks/notifications/user_titles"_i18n);
LOG_MSG_DEBUG("Title info updated.");
}
Improve directory layout while we still can. The directory layout is partially based on the C++ namespaces we're currently using. Other changes include: * devoptab: move directory into "core". * fatfs: move directory into "core". * GameCardTab: move portions of logic from PopulateList() into their own methods. * GameCardTab: use a macro to generate the properties table. * GameCardTab: use a macro to add ListItem elements. * GameCardTab: update AddApplicationMetadataItems() method to also display the number of DLCs available in the inserted gamecard for each application whenever possible. * Makefile: remove all extra entries from the INCLUDES variable. * nxdt_includes: move HOS version structs into their own header file. * tasks: move code for each individual task into its own file(s). * title: update titleGetGameCardApplicationMetadataEntries() to also count the number of DLCs available in the inserted gamecard for any given base application. * title: reorder gamecard application metadata entries by name before returning the buffer in titleGetGameCardApplicationMetadataEntries().
2024-04-30 22:01:42 +01:00
}
TitleMetadataTask: use a struct instead of a vector The struct has been typedef'd as TitleApplicationMetadataInfo. It holds the pointer to the array returned by titleGetApplicationMetadataEntries(), as well as the number of elements available in the array. There's no point in populating a vector when we already have an array we can work with.
2024-05-05 23:41:41 +01:00
void TitleMetadataTask::PopulateApplicationMetadataInfo(bool is_system)
Improve directory layout while we still can. The directory layout is partially based on the C++ namespaces we're currently using. Other changes include: * devoptab: move directory into "core". * fatfs: move directory into "core". * GameCardTab: move portions of logic from PopulateList() into their own methods. * GameCardTab: use a macro to generate the properties table. * GameCardTab: use a macro to add ListItem elements. * GameCardTab: update AddApplicationMetadataItems() method to also display the number of DLCs available in the inserted gamecard for each application whenever possible. * Makefile: remove all extra entries from the INCLUDES variable. * nxdt_includes: move HOS version structs into their own header file. * tasks: move code for each individual task into its own file(s). * title: update titleGetGameCardApplicationMetadataEntries() to also count the number of DLCs available in the inserted gamecard for any given base application. * title: reorder gamecard application metadata entries by name before returning the buffer in titleGetGameCardApplicationMetadataEntries().
2024-04-30 22:01:42 +01:00
{
TitleMetadataTask: use a struct instead of a vector The struct has been typedef'd as TitleApplicationMetadataInfo. It holds the pointer to the array returned by titleGetApplicationMetadataEntries(), as well as the number of elements available in the array. There's no point in populating a vector when we already have an array we can work with.
2024-05-05 23:41:41 +01:00
/* Get reference to output struct. */
TitleApplicationMetadataInfo& info = (is_system ? this->system_metadata_info : this->user_metadata_info);
if (info.app_metadata) free(info.app_metadata);
info.app_metadata_count = 0;
Improve directory layout while we still can. The directory layout is partially based on the C++ namespaces we're currently using. Other changes include: * devoptab: move directory into "core". * fatfs: move directory into "core". * GameCardTab: move portions of logic from PopulateList() into their own methods. * GameCardTab: use a macro to generate the properties table. * GameCardTab: use a macro to add ListItem elements. * GameCardTab: update AddApplicationMetadataItems() method to also display the number of DLCs available in the inserted gamecard for each application whenever possible. * Makefile: remove all extra entries from the INCLUDES variable. * nxdt_includes: move HOS version structs into their own header file. * tasks: move code for each individual task into its own file(s). * title: update titleGetGameCardApplicationMetadataEntries() to also count the number of DLCs available in the inserted gamecard for any given base application. * title: reorder gamecard application metadata entries by name before returning the buffer in titleGetGameCardApplicationMetadataEntries().
2024-04-30 22:01:42 +01:00
/* Get application metadata entries. */
TitleMetadataTask: use a struct instead of a vector The struct has been typedef'd as TitleApplicationMetadataInfo. It holds the pointer to the array returned by titleGetApplicationMetadataEntries(), as well as the number of elements available in the array. There's no point in populating a vector when we already have an array we can work with.
2024-05-05 23:41:41 +01:00
info.app_metadata = titleGetApplicationMetadataEntries(is_system, &(info.app_metadata_count));
Improve directory layout while we still can. The directory layout is partially based on the C++ namespaces we're currently using. Other changes include: * devoptab: move directory into "core". * fatfs: move directory into "core". * GameCardTab: move portions of logic from PopulateList() into their own methods. * GameCardTab: use a macro to generate the properties table. * GameCardTab: use a macro to add ListItem elements. * GameCardTab: update AddApplicationMetadataItems() method to also display the number of DLCs available in the inserted gamecard for each application whenever possible. * Makefile: remove all extra entries from the INCLUDES variable. * nxdt_includes: move HOS version structs into their own header file. * tasks: move code for each individual task into its own file(s). * title: update titleGetGameCardApplicationMetadataEntries() to also count the number of DLCs available in the inserted gamecard for any given base application. * title: reorder gamecard application metadata entries by name before returning the buffer in titleGetGameCardApplicationMetadataEntries().
2024-04-30 22:01:42 +01:00
TitleMetadataTask: use a struct instead of a vector The struct has been typedef'd as TitleApplicationMetadataInfo. It holds the pointer to the array returned by titleGetApplicationMetadataEntries(), as well as the number of elements available in the array. There's no point in populating a vector when we already have an array we can work with.
2024-05-05 23:41:41 +01:00
LOG_MSG_DEBUG("Retrieved %u %s metadata %s.", info.app_metadata_count, is_system ? "system" : "user", info.app_metadata_count == 1 ? "entry" : "entries");
Improve directory layout while we still can. The directory layout is partially based on the C++ namespaces we're currently using. Other changes include: * devoptab: move directory into "core". * fatfs: move directory into "core". * GameCardTab: move portions of logic from PopulateList() into their own methods. * GameCardTab: use a macro to generate the properties table. * GameCardTab: use a macro to add ListItem elements. * GameCardTab: update AddApplicationMetadataItems() method to also display the number of DLCs available in the inserted gamecard for each application whenever possible. * Makefile: remove all extra entries from the INCLUDES variable. * nxdt_includes: move HOS version structs into their own header file. * tasks: move code for each individual task into its own file(s). * title: update titleGetGameCardApplicationMetadataEntries() to also count the number of DLCs available in the inserted gamecard for any given base application. * title: reorder gamecard application metadata entries by name before returning the buffer in titleGetGameCardApplicationMetadataEntries().
2024-04-30 22:01:42 +01:00
}
}
Reference in a new issue Copy permalink