aboutsummaryrefslogtreecommitdiff
path: root/Source/NVIDIAGfeSDK/Private/GfeSDKHighlights.cpp
blob: b008b6ed5e289efadfc6820acd82a03bea6975f1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
/* Copyright (c) 2017, NVIDIA CORPORATION.  All rights reserved.
*
* NVIDIA CORPORATION and its licensors retain all intellectual property
* and proprietary rights in and to this software, related documentation
* and any modifications thereto.  Any use, reproduction, disclosure or
* distribution of this software and related documentation without an express
* license agreement from NVIDIA CORPORATION is strictly prohibited.
*/
#include "GfeSDKHighlights.h"
#include "NVIDIAGfeSDKPrivatePCH.h"

#define VALIDATE_MODULE_HIGHLIGHTS()                                           \
    if (!GFEHandle && Callback)                                    \
    {                                                               \
        Callback(GfeSDK::NVGSDK_ERR_MODULE_NOT_LOADED, Context);    \
        return;                                                     \
    }

#define VALIDATE_MODULE_HIGHLIGHTS_SPECIALIZED()                                       \
    if (!GFEHandle && Callback)                                            \
    {                                                                       \
        Callback(GfeSDK::NVGSDK_ERR_MODULE_NOT_LOADED, nullptr, Context);   \
        return;                                                             \
    }

struct LocaleStringPair
{
	std::string localeCode;
	std::string localizedString;
};

struct LocaleHighlightsList
{
	std::vector<LocaleStringPair> Strings;
	std::vector<GfeSDK::NVGSDK_LocalizedPair> Pairs;
};

FGfeSDKHighlights::FGfeSDKHighlights(GfeSDK::NVGSDK_HANDLE* Handle) :
    GFEHandle(Handle)
{}

FGfeSDKHighlights::~FGfeSDKHighlights()
{}

void FGfeSDKHighlights::ConfigureAsync(FGfeSDKHighlightConfigParams const& Params, GfeSDK::NVGSDK_EmptyCallback Callback, void* Context)
{	
    VALIDATE_MODULE_HIGHLIGHTS();

	std::string UTF8DefaultLocale = TCHAR_TO_UTF8(*Params.DefaultLocale);
	GfeSDK::NVGSDK_HighlightConfigParams cParams;
	memset(&cParams, 0, sizeof(cParams));
	cParams.defaultLocale = UTF8DefaultLocale.c_str();

	// Temporary storages for structure elements required by ConfigureAsync function
	std::vector<GfeSDK::NVGSDK_Highlight> Highlights(Params.HighlightDefinitions.Num());
	// TCHAR_TO_UTF8 shares internal buffer, so its results need to be assigned by copy, not pointer.
	std::vector <std::string> id(Params.HighlightDefinitions.Num()); // Workaround for usage of TCHAR_TO_UTF8.
	std::vector<LocaleHighlightsList> LocaleStringPairs(Params.HighlightDefinitions.Num());

    for (int32 i=0; i<Params.HighlightDefinitions.Num(); i++)
    {
		GfeSDK::NVGSDK_Highlight def;
        
		const FGfeSDKHighlightDefinition& ueDef(Params.HighlightDefinitions[i]);
		id[i] = TCHAR_TO_UTF8(*ueDef.Id);
		def.id = id[i].c_str();
		def.highlightTags = TranslateBitfieldEnum(kHighlightTypeUnrealToSdk, ueDef.HighlightTags);
		def.significance = TranslateBitfieldEnum(kHighlightSignificanceUnrealToSdk, ueDef.Significance);
		def.userInterest = ueDef.UserDefaultInterest;

		LocaleStringPairs[i].Pairs.resize(ueDef.NameTranslationTable.Num());
		LocaleStringPairs[i].Strings.resize(ueDef.NameTranslationTable.Num());

		int32 s = 0;
		for (auto& Entry : ueDef.NameTranslationTable)
        {			
			LocaleStringPairs[i].Strings[s].localeCode = TCHAR_TO_UTF8(*Entry.Key);
			LocaleStringPairs[i].Strings[s].localizedString = TCHAR_TO_UTF8(*Entry.Value);

			LocaleStringPairs[i].Pairs[s].localeCode = LocaleStringPairs[i].Strings[s].localeCode.c_str();
			LocaleStringPairs[i].Pairs[s].localizedString = LocaleStringPairs[i].Strings[s].localizedString.c_str();
			s++;
        }
		
		def.nameTable = LocaleStringPairs[i].Pairs.data();
		def.nameTableSize = LocaleStringPairs[i].Pairs.size();

		Highlights[i] = def;
    }
	cParams.highlightDefinitionTable = Highlights.data();
	cParams.highlightTableSize = Highlights.size();
	GfeSDK::NVGSDK_Highlights_ConfigureAsync(GFEHandle, &cParams, Callback, Context);
}

void FGfeSDKHighlights::GetUserSettingsAsync(GfeSDK::NVGSDK_Highlights_GetUserSettingsCallback Callback, void* Context) const
{
    VALIDATE_MODULE_HIGHLIGHTS_SPECIALIZED();
	GfeSDK::NVGSDK_Highlights_GetUserSettingsAsync(GFEHandle, Callback, Context);
}

void FGfeSDKHighlights::OpenGroupAsync(FGfeSDKHighlightOpenGroupParams const& Params, GfeSDK::NVGSDK_EmptyCallback Callback, void* Context)
{
    VALIDATE_MODULE_HIGHLIGHTS();

	LocaleHighlightsList LocaleHighlights;
	LocaleHighlights.Pairs.resize(Params.GroupDescriptionTranslationTable.Num());
	LocaleHighlights.Strings.resize(Params.GroupDescriptionTranslationTable.Num());

	GfeSDK::NVGSDK_HighlightOpenGroupParams params;
	memset(&params, 0, sizeof(params));

	const std::string groupId(TCHAR_TO_UTF8(*Params.GroupId));
	params.groupId = groupId.c_str();

	int32 s = 0;
    for (auto& Entry : Params.GroupDescriptionTranslationTable)
    {
		LocaleHighlights.Strings[s].localeCode = TCHAR_TO_UTF8(*Entry.Key);
		LocaleHighlights.Strings[s].localizedString = TCHAR_TO_UTF8(*Entry.Value);
		LocaleHighlights.Pairs[s].localeCode = LocaleHighlights.Strings[s].localeCode.c_str();
		LocaleHighlights.Pairs[s].localizedString = LocaleHighlights.Strings[s].localizedString.c_str();
		s++;
    }

	params.groupDescriptionTable = LocaleHighlights.Pairs.data();
	params.groupDescriptionTableSize = LocaleHighlights.Pairs.size();

	GfeSDK::NVGSDK_Highlights_OpenGroupAsync(GFEHandle, &params, Callback, Context);
}

void FGfeSDKHighlights::CloseGroupAsync(FGfeSDKHighlightCloseGroupParams const& Params, GfeSDK::NVGSDK_EmptyCallback Callback, void* Context)
{
    VALIDATE_MODULE_HIGHLIGHTS();

	GfeSDK::NVGSDK_HighlightCloseGroupParams params;
	memset(&params, 0, sizeof(params));

	std::string ID = TCHAR_TO_UTF8(*Params.GroupId);
	params.groupId = ID.c_str();
	params.destroyHighlights = Params.DestroyHighlights;

	GfeSDK::NVGSDK_Highlights_CloseGroupAsync(GFEHandle, &params, Callback, Context);
}

void FGfeSDKHighlights::SetScreenshotHighlightAsync(FGfeSDKHighlightScreenshotParams const& Params, GfeSDK::NVGSDK_EmptyCallback Callback, void* Context)
{
    VALIDATE_MODULE_HIGHLIGHTS();
	std::string gID = TCHAR_TO_UTF8(*Params.GroupId);
	std::string hID = TCHAR_TO_UTF8(*Params.HighlightId);

	GfeSDK::NVGSDK_ScreenshotHighlightParams params;
	memset(&params, 0, sizeof(params));

    params.groupId = gID.c_str();
    params.highlightId = hID.c_str();

	GfeSDK::NVGSDK_Highlights_SetScreenshotHighlightAsync(GFEHandle, &params, Callback, Context);
}

void FGfeSDKHighlights::SetVideoHighlightAsync(FGfeSDKHighlightVideoParams const& Params, GfeSDK::NVGSDK_EmptyCallback Callback, void* Context)
{
    VALIDATE_MODULE_HIGHLIGHTS();
	GfeSDK::NVGSDK_VideoHighlightParams cParams;
	memset(&cParams, 0, sizeof(cParams));

	std::string gID = TCHAR_TO_UTF8(*Params.GroupId);
	std::string hID = TCHAR_TO_UTF8(*Params.HighlightId);

	cParams.groupId = gID.c_str();
	cParams.highlightId = hID.c_str();
	cParams.endDelta = Params.EndDelta;
	cParams.startDelta = Params.StartDelta;

	GfeSDK::NVGSDK_Highlights_SetVideoHighlightAsync(GFEHandle, &cParams, Callback, Context);
}

void FGfeSDKHighlights::OpenSummaryAsync(FGfeSDKHighlightSummaryParams const& Params, GfeSDK::NVGSDK_EmptyCallback Callback, void* Context)
{
    VALIDATE_MODULE_HIGHLIGHTS();
	GfeSDK::NVGSDK_SummaryParams cParams;
	memset(&cParams, 0, sizeof(cParams));

	std::vector<GfeSDK::NVGSDK_GroupView> cGroupViews(Params.GroupViews.Num());
	std::vector<std::string> StringCache(Params.GroupViews.Num());

	for (size_t i = 0; i < cGroupViews.size(); i++)
	{
		StringCache[i] = TCHAR_TO_UTF8(*Params.GroupViews[i].GroupId);
		cGroupViews[i].groupId = StringCache[i].c_str();
		cGroupViews[i].tagsFilter = TranslateBitfieldEnum(kHighlightTypeUnrealToSdk, Params.GroupViews[i].TagsFilter);
		cGroupViews[i].significanceFilter = TranslateBitfieldEnum(kHighlightSignificanceUnrealToSdk, Params.GroupViews[i].SignificanceFilter);
	}
	cParams.groupSummaryTable = cGroupViews.data();
	cParams.groupSummaryTableSize = cGroupViews.size();

	GfeSDK::NVGSDK_Highlights_OpenSummaryAsync(GFEHandle, &cParams, Callback, Context);
}

void FGfeSDKHighlights::GetNumberOfHighlightsAsync(FGfeSDKHighlightGroupView const& GroupView, GfeSDK::NVGSDK_Highlights_GetNumberOfHighlightsCallback Callback, void* Context)
{
    VALIDATE_MODULE_HIGHLIGHTS_SPECIALIZED();
    GfeSDK::NVGSDK_GroupView groupView;
	memset(&groupView, 0, sizeof(groupView));

	std::string gID = TCHAR_TO_UTF8(*GroupView.GroupId);
	groupView.groupId = gID.c_str();
    groupView.tagsFilter = TranslateBitfieldEnum(kHighlightTypeUnrealToSdk, GroupView.TagsFilter);
    groupView.significanceFilter = TranslateBitfieldEnum(kHighlightSignificanceUnrealToSdk, GroupView.SignificanceFilter);

	GfeSDK::NVGSDK_Highlights_GetNumberOfHighlightsAsync(GFEHandle, &groupView, Callback, Context);
}

struct SNumHighlightsInfo
{
	volatile bool  Ready;
	int32 NumberOfHighlights;

	SNumHighlightsInfo():
		Ready(false),
		NumberOfHighlights(0)
	{}
};

void __stdcall OnGetNumberOfHighlightsCallbackBlocking(GfeSDK::NVGSDK_RetCode rt, GfeSDK::NVGSDK_Highlights_NumberOfHighlights const* NumberOfHighlights, void* context)
{
	SNumHighlightsInfo* NCB = static_cast<SNumHighlightsInfo*>(context);
	if (NCB)
	{
		NCB->NumberOfHighlights = NumberOfHighlights->numberOfHighlights;
		NCB->Ready = true;
	}
}

int32 FGfeSDKHighlights::GetNumberOfHighlights(FGfeSDKHighlightGroupView const& GroupView)
{
	SNumHighlightsInfo NCB;	
	GetNumberOfHighlightsAsync(GroupView, &OnGetNumberOfHighlightsCallbackBlocking, &NCB);
	int32 IterationCounter = 0;
	// Polling cycle (not sure if this is correct for UE4, if we need a blocking function)
	// Wait for 10 seconds and return 0 if time is up
	while (!NCB.Ready && (IterationCounter < 1000))
	{
		Poll();
		FPlatformProcess::Sleep(0.001f);
		IterationCounter++;
	}
	return NCB.NumberOfHighlights;
}

void FGfeSDKHighlights::Poll()
{
	if (GFEHandle)
		GfeSDK::NVGSDK_Poll(GFEHandle);
}