325 lines
14 KiB
C++
325 lines
14 KiB
C++
// Copyright (c) 2012-2023 Wojciech Figat. All rights reserved.
|
|
|
|
#if PLATFORM_TOOLS_IOS
|
|
|
|
#include "iOSPlatformTools.h"
|
|
#include "Engine/Platform/File.h"
|
|
#include "Engine/Platform/FileSystem.h"
|
|
#include "Engine/Platform/iOS/iOSPlatformSettings.h"
|
|
#include "Engine/Core/Config/GameSettings.h"
|
|
#include "Engine/Core/Config/BuildSettings.h"
|
|
#include "Engine/Graphics/Textures/TextureData.h"
|
|
#include "Engine/Graphics/PixelFormatExtensions.h"
|
|
#include "Engine/Content/Content.h"
|
|
#include "Engine/Content/JsonAsset.h"
|
|
#include "Engine/Engine/Globals.h"
|
|
#include "Editor/Editor.h"
|
|
#include "Editor/ProjectInfo.h"
|
|
#include "Editor/Cooker/GameCooker.h"
|
|
#include "Editor/Utilities/EditorUtilities.h"
|
|
#include <ThirdParty/pugixml/pugixml.hpp>
|
|
using namespace pugi;
|
|
|
|
IMPLEMENT_SETTINGS_GETTER(iOSPlatformSettings, iOSPlatform);
|
|
|
|
namespace
|
|
{
|
|
String GetAppName()
|
|
{
|
|
const auto gameSettings = GameSettings::Get();
|
|
String productName = gameSettings->ProductName;
|
|
productName.Replace(TEXT(" "), TEXT(""));
|
|
productName.Replace(TEXT("."), TEXT(""));
|
|
productName.Replace(TEXT("-"), TEXT(""));
|
|
return productName;
|
|
}
|
|
}
|
|
|
|
const Char* iOSPlatformTools::GetDisplayName() const
|
|
{
|
|
return TEXT("iOS");
|
|
}
|
|
|
|
const Char* iOSPlatformTools::GetName() const
|
|
{
|
|
return TEXT("iOS");
|
|
}
|
|
|
|
PlatformType iOSPlatformTools::GetPlatform() const
|
|
{
|
|
return PlatformType::iOS;
|
|
}
|
|
|
|
ArchitectureType iOSPlatformTools::GetArchitecture() const
|
|
{
|
|
return ArchitectureType::ARM64;
|
|
}
|
|
|
|
DotNetAOTModes iOSPlatformTools::UseAOT() const
|
|
{
|
|
return DotNetAOTModes::MonoAOTDynamic;
|
|
}
|
|
|
|
PixelFormat iOSPlatformTools::GetTextureFormat(CookingData& data, TextureBase* texture, PixelFormat format)
|
|
{
|
|
// TODO: add ETC compression support for iOS
|
|
// TODO: add ASTC compression support for iOS
|
|
|
|
if (PixelFormatExtensions::IsCompressedBC(format))
|
|
{
|
|
switch (format)
|
|
{
|
|
case PixelFormat::BC1_Typeless:
|
|
case PixelFormat::BC2_Typeless:
|
|
case PixelFormat::BC3_Typeless:
|
|
return PixelFormat::R8G8B8A8_Typeless;
|
|
case PixelFormat::BC1_UNorm:
|
|
case PixelFormat::BC2_UNorm:
|
|
case PixelFormat::BC3_UNorm:
|
|
return PixelFormat::R8G8B8A8_UNorm;
|
|
case PixelFormat::BC1_UNorm_sRGB:
|
|
case PixelFormat::BC2_UNorm_sRGB:
|
|
case PixelFormat::BC3_UNorm_sRGB:
|
|
return PixelFormat::R8G8B8A8_UNorm_sRGB;
|
|
case PixelFormat::BC4_Typeless:
|
|
return PixelFormat::R8_Typeless;
|
|
case PixelFormat::BC4_UNorm:
|
|
return PixelFormat::R8_UNorm;
|
|
case PixelFormat::BC4_SNorm:
|
|
return PixelFormat::R8_SNorm;
|
|
case PixelFormat::BC5_Typeless:
|
|
return PixelFormat::R16G16_Typeless;
|
|
case PixelFormat::BC5_UNorm:
|
|
return PixelFormat::R16G16_UNorm;
|
|
case PixelFormat::BC5_SNorm:
|
|
return PixelFormat::R16G16_SNorm;
|
|
case PixelFormat::BC7_Typeless:
|
|
case PixelFormat::BC6H_Typeless:
|
|
return PixelFormat::R16G16B16A16_Typeless;
|
|
case PixelFormat::BC7_UNorm:
|
|
case PixelFormat::BC6H_Uf16:
|
|
case PixelFormat::BC6H_Sf16:
|
|
return PixelFormat::R16G16B16A16_Float;
|
|
case PixelFormat::BC7_UNorm_sRGB:
|
|
return PixelFormat::R16G16B16A16_UNorm;
|
|
default:
|
|
return format;
|
|
}
|
|
}
|
|
|
|
return format;
|
|
}
|
|
|
|
bool iOSPlatformTools::IsNativeCodeFile(CookingData& data, const String& file)
|
|
{
|
|
String extension = FileSystem::GetExtension(file);
|
|
return extension.IsEmpty() || extension == TEXT("dylib");
|
|
}
|
|
|
|
void iOSPlatformTools::OnBuildStarted(CookingData& data)
|
|
{
|
|
// Adjust the cooking output folders for packaging app
|
|
const auto appName = GetAppName();
|
|
String contents = String(TEXT("/Payload/")) / appName + TEXT(".app/");
|
|
data.DataOutputPath /= contents;
|
|
data.NativeCodeOutputPath /= contents;
|
|
data.ManagedCodeOutputPath /= contents;
|
|
|
|
PlatformTools::OnBuildStarted(data);
|
|
}
|
|
|
|
bool iOSPlatformTools::OnPostProcess(CookingData& data)
|
|
{
|
|
const auto gameSettings = GameSettings::Get();
|
|
const auto platformSettings = iOSPlatformSettings::Get();
|
|
const auto platformDataPath = data.GetPlatformBinariesRoot();
|
|
const auto projectVersion = Editor::Project->Version.ToString();
|
|
const auto appName = GetAppName();
|
|
|
|
// Setup package name (eg. com.company.project)
|
|
String appIdentifier = platformSettings->AppIdentifier;
|
|
{
|
|
String productName = gameSettings->ProductName;
|
|
productName.Replace(TEXT(" "), TEXT(""));
|
|
productName.Replace(TEXT("."), TEXT(""));
|
|
productName.Replace(TEXT("-"), TEXT(""));
|
|
String companyName = gameSettings->CompanyName;
|
|
companyName.Replace(TEXT(" "), TEXT(""));
|
|
companyName.Replace(TEXT("."), TEXT(""));
|
|
companyName.Replace(TEXT("-"), TEXT(""));
|
|
appIdentifier.Replace(TEXT("${PROJECT_NAME}"), *productName, StringSearchCase::IgnoreCase);
|
|
appIdentifier.Replace(TEXT("${COMPANY_NAME}"), *companyName, StringSearchCase::IgnoreCase);
|
|
appIdentifier = appIdentifier.ToLower();
|
|
for (int32 i = 0; i < appIdentifier.Length(); i++)
|
|
{
|
|
const auto c = appIdentifier[i];
|
|
if (c != '_' && c != '.' && !StringUtils::IsAlnum(c))
|
|
{
|
|
LOG(Error, "Apple app identifier \'{0}\' contains invalid character. Only letters, numbers, dots and underscore characters are allowed.", appIdentifier);
|
|
return true;
|
|
}
|
|
}
|
|
if (appIdentifier.IsEmpty())
|
|
{
|
|
LOG(Error, "Apple app identifier is empty.", appIdentifier);
|
|
return true;
|
|
}
|
|
}
|
|
|
|
// Find executable
|
|
String executableName;
|
|
{
|
|
Array<String> files;
|
|
FileSystem::DirectoryGetFiles(files, data.NativeCodeOutputPath, TEXT("*"), DirectorySearchOption::TopDirectoryOnly);
|
|
for (auto& file : files)
|
|
{
|
|
if (FileSystem::GetExtension(file).IsEmpty())
|
|
{
|
|
executableName = StringUtils::GetFileName(file);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Deploy app icon
|
|
TextureData iconData;
|
|
if (!EditorUtilities::GetApplicationImage(platformSettings->OverrideIcon, iconData))
|
|
{
|
|
String tmpFolderPath = data.DataOutputPath / TEXT("icon.iconset");
|
|
if (!FileSystem::DirectoryExists(tmpFolderPath))
|
|
FileSystem::CreateDirectory(tmpFolderPath);
|
|
String srcIconPath = tmpFolderPath / TEXT("icon_1024x1024.png");
|
|
if (EditorUtilities::ExportApplicationImage(iconData, 1024, 1024, PixelFormat::R8G8B8A8_UNorm, srcIconPath))
|
|
{
|
|
LOG(Error, "Failed to export application icon.");
|
|
return true;
|
|
}
|
|
bool failed = Platform::RunProcess(TEXT("sips -z 16 16 icon_1024x1024.png --out icon_16x16.png"), tmpFolderPath);
|
|
failed |= Platform::RunProcess(TEXT("sips -z 32 32 icon_1024x1024.png --out icon_16x16@2x.png"), tmpFolderPath);
|
|
failed |= Platform::RunProcess(TEXT("sips -z 32 32 icon_1024x1024.png --out icon_32x32.png"), tmpFolderPath);
|
|
failed |= Platform::RunProcess(TEXT("sips -z 64 64 icon_1024x1024.png --out icon_32x32@2x.png"), tmpFolderPath);
|
|
failed |= Platform::RunProcess(TEXT("sips -z 128 128 icon_1024x1024.png --out icon_128x128.png"), tmpFolderPath);
|
|
failed |= Platform::RunProcess(TEXT("sips -z 256 256 icon_1024x1024.png --out icon_128x128@2x.png"), tmpFolderPath);
|
|
failed |= Platform::RunProcess(TEXT("sips -z 256 256 icon_1024x1024.png --out icon_256x256.png"), tmpFolderPath);
|
|
failed |= Platform::RunProcess(TEXT("sips -z 512 512 icon_1024x1024.png --out icon_256x256@2x.png"), tmpFolderPath);
|
|
failed |= Platform::RunProcess(TEXT("sips -z 512 512 icon_1024x1024.png --out icon_512x512.png"), tmpFolderPath);
|
|
failed |= Platform::RunProcess(TEXT("sips -z 1024 1024 icon_1024x1024.png --out icon_512x512@2x.png"), tmpFolderPath);
|
|
failed |= Platform::RunProcess(TEXT("iconutil -c icns icon.iconset"), data.DataOutputPath);
|
|
if (failed)
|
|
{
|
|
LOG(Error, "Failed to export application icon.");
|
|
return true;
|
|
}
|
|
FileSystem::DeleteDirectory(tmpFolderPath);
|
|
String iTunesArtworkPath = data.OriginalOutputPath / TEXT("iTunesArtwork.png");
|
|
if (EditorUtilities::ExportApplicationImage(iconData, 512, 512, PixelFormat::R8G8B8A8_UNorm, iTunesArtworkPath))
|
|
{
|
|
LOG(Error, "Failed to export application icon.");
|
|
return true;
|
|
}
|
|
FileSystem::MoveFile(data.OriginalOutputPath / TEXT("iTunesArtwork"), iTunesArtworkPath, true);
|
|
}
|
|
|
|
// Create PkgInfo file
|
|
const String pkgInfoPath = data.DataOutputPath / TEXT("PkgInfo");
|
|
File::WriteAllText(pkgInfoPath, TEXT("APPL???"), Encoding::ANSI);
|
|
|
|
// Create Info.plist file with package description
|
|
const String plistPath = data.DataOutputPath / TEXT("Info.plist");
|
|
{
|
|
xml_document doc;
|
|
xml_node plist = doc.child_or_append(PUGIXML_TEXT("plist"));
|
|
plist.append_attribute(PUGIXML_TEXT("version")).set_value(PUGIXML_TEXT("1.0"));
|
|
xml_node dict = plist.child_or_append(PUGIXML_TEXT("dict"));
|
|
|
|
dict.append_child(PUGIXML_TEXT("key")).set_child_value(PUGIXML_TEXT("LSRequiresIPhoneOS"));
|
|
dict.append_child(PUGIXML_TEXT("true"));
|
|
|
|
dict.append_child(PUGIXML_TEXT("key")).set_child_value(PUGIXML_TEXT("UIStatusBarHidden"));
|
|
dict.append_child(PUGIXML_TEXT("true"));
|
|
|
|
dict.append_child(PUGIXML_TEXT("key")).set_child_value(PUGIXML_TEXT("UIRequiresFullScreen"));
|
|
dict.append_child(PUGIXML_TEXT("true"));
|
|
|
|
dict.append_child(PUGIXML_TEXT("key")).set_child_value(PUGIXML_TEXT("UIViewControllerBasedStatusBarAppearance"));
|
|
dict.append_child(PUGIXML_TEXT("false"));
|
|
|
|
dict.append_child(PUGIXML_TEXT("key")).set_child_value(PUGIXML_TEXT("CFBundleIcons"));
|
|
dict.append_child(PUGIXML_TEXT("dict"));
|
|
|
|
#define ADD_ENTRY(key, value) \
|
|
dict.append_child(PUGIXML_TEXT("key")).set_child_value(PUGIXML_TEXT(key)); \
|
|
dict.append_child(PUGIXML_TEXT("string")).set_child_value(PUGIXML_TEXT(value))
|
|
#define ADD_ENTRY_STR(key, value) \
|
|
dict.append_child(PUGIXML_TEXT("key")).set_child_value(PUGIXML_TEXT(key)); \
|
|
{ std::u16string valueStr(value.GetText()); \
|
|
dict.append_child(PUGIXML_TEXT("string")).set_child_value(pugi::string_t(valueStr.begin(), valueStr.end()).c_str()); }
|
|
|
|
ADD_ENTRY("CFBundleDevelopmentRegion", "English");
|
|
ADD_ENTRY("CFBundlePackageType", "APPL");
|
|
ADD_ENTRY("CFBundleSignature", "????");
|
|
ADD_ENTRY("LSApplicationCategoryType", "public.app-category.games");
|
|
ADD_ENTRY("CFBundleInfoDictionaryVersion", "6.0");
|
|
ADD_ENTRY("CFBundleIconFile", "icon.icns");
|
|
ADD_ENTRY("MinimumOSVersion", "14.0");
|
|
ADD_ENTRY_STR("CFBundleExecutable", executableName);
|
|
ADD_ENTRY_STR("CFBundleIdentifier", appIdentifier);
|
|
ADD_ENTRY_STR("CFBundleName", appName); // TODO: limit to 15 chars max
|
|
ADD_ENTRY_STR("CFBundleDisplayName", gameSettings->ProductName);
|
|
ADD_ENTRY_STR("CFBundleGetInfoString", gameSettings->ProductName);
|
|
ADD_ENTRY_STR("CFBundleVersion", projectVersion);
|
|
ADD_ENTRY_STR("CFBundleShortVersionString", projectVersion);
|
|
ADD_ENTRY_STR("NSHumanReadableCopyright", gameSettings->CopyrightNotice);
|
|
|
|
dict.append_child(PUGIXML_TEXT("key")).set_child_value(PUGIXML_TEXT("UIRequiredDeviceCapabilities"));
|
|
xml_node UIRequiredDeviceCapabilities = dict.append_child(PUGIXML_TEXT("array"));
|
|
UIRequiredDeviceCapabilities.append_child(PUGIXML_TEXT("string")).set_child_value(PUGIXML_TEXT("arm64"));
|
|
UIRequiredDeviceCapabilities.append_child(PUGIXML_TEXT("string")).set_child_value(PUGIXML_TEXT("metal"));
|
|
|
|
dict.append_child(PUGIXML_TEXT("key")).set_child_value(PUGIXML_TEXT("UISupportedInterfaceOrientations"));
|
|
xml_node UISupportedInterfaceOrientations = dict.append_child(PUGIXML_TEXT("array"));
|
|
UISupportedInterfaceOrientations.append_child(PUGIXML_TEXT("string")).set_child_value(PUGIXML_TEXT("UIInterfaceOrientationPortrait"));
|
|
UISupportedInterfaceOrientations.append_child(PUGIXML_TEXT("string")).set_child_value(PUGIXML_TEXT("UIInterfaceOrientationLandscapeLeft"));
|
|
UISupportedInterfaceOrientations.append_child(PUGIXML_TEXT("string")).set_child_value(PUGIXML_TEXT("UIInterfaceOrientationLandscapeRight"));
|
|
|
|
dict.append_child(PUGIXML_TEXT("key")).set_child_value(PUGIXML_TEXT("CFBundleSupportedPlatforms"));
|
|
xml_node CFBundleSupportedPlatforms = dict.append_child(PUGIXML_TEXT("array"));
|
|
CFBundleSupportedPlatforms.append_child(PUGIXML_TEXT("string")).set_child_value(PUGIXML_TEXT("iPhoneOS"));
|
|
|
|
#undef ADD_ENTRY
|
|
#undef ADD_ENTRY_STR
|
|
|
|
if (!doc.save_file(*StringAnsi(plistPath)))
|
|
{
|
|
LOG(Error, "Failed to save {0}", plistPath);
|
|
return true;
|
|
}
|
|
}
|
|
|
|
// TODO: expose event to inject custom post-processing before app packaging (eg. third-party plugins)
|
|
|
|
// Run code signing for Apple platform
|
|
if (EditorUtilities::CodeSignApple(data.DataOutputPath, GetPlatform(), *platformSettings))
|
|
return true;
|
|
|
|
// Package application
|
|
const auto buildSettings = BuildSettings::Get();
|
|
if (buildSettings->SkipPackaging)
|
|
return false;
|
|
GameCooker::PackageFiles();
|
|
LOG(Info, "Building app package...");
|
|
const String ipaPath = data.OriginalOutputPath / appName + TEXT(".ipa");
|
|
const String ipaCommand = String::Format(TEXT("zip -r -X {0}.ipa Payload iTunesArtwork"), appName);
|
|
const int32 result = Platform::RunProcess(ipaCommand, data.OriginalOutputPath);
|
|
if (result != 0)
|
|
{
|
|
data.Error(String::Format(TEXT("Failed to package app (result code: {0}). See log for more info."), result));
|
|
return true;
|
|
}
|
|
LOG(Info, "Output application package: {0} (size: {1} MB)", ipaPath, FileSystem::GetFileSize(ipaPath) / 1024 / 1024);
|
|
|
|
return false;
|
|
}
|
|
|
|
#endif
|