ARCoreCameraSubsystem.cs
24.4 KB
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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
using System;
using System.Collections.Generic;
using System.Runtime.InteropServices;
using AOT;
using Unity.Collections;
using UnityEngine.Scripting;
using UnityEngine.XR.ARSubsystems;
namespace UnityEngine.XR.ARCore
{
/// <summary>
/// The ARCore implementation of the
/// [`XRCameraSubsystem`](xref:UnityEngine.XR.ARSubsystems.XRCameraSubsystem).
/// Do not create this directly. Use the
/// [`SubsystemManager`](xref:UnityEngine.SubsystemManager)
/// instead.
/// </summary>
[Preserve]
public sealed class ARCoreCameraSubsystem : XRCameraSubsystem
{
/// <summary>
/// The identifying name for the camera-providing implementation.
/// </summary>
/// <value>
/// The identifying name for the camera-providing implementation.
/// </value>
const string k_SubsystemId = "ARCore-Camera";
/// <summary>
/// The name for the shader for rendering the camera texture.
/// </summary>
/// <value>
/// The name for the shader for rendering the camera texture.
/// </value>
const string k_DefaultBackgroundShaderName = "Unlit/ARCoreBackground";
enum CameraConfigurationResult
{
/// <summary>
/// Setting the camera configuration was successful.
/// </summary>
Success = 0,
/// <summary>
/// The given camera configuration was not valid to be set by the provider.
/// </summary>
InvalidCameraConfiguration = 1,
/// <summary>
/// The provider session was invalid.
/// </summary>
InvalidSession = 2,
/// <summary>
/// An error occurred because the user did not dispose of all <c>XRCpuImage</c> and did not allow all
/// asynchronous conversion jobs complete before changing the camera configuration.
/// </summary>
ErrorImagesNotDisposed = 3,
}
/// <summary>
/// The name for the background shader based on the current render pipeline.
/// </summary>
/// <value>
/// The name for the background shader based on the current render pipeline. Or, <c>null</c> if the current
/// render pipeline is incompatible with the set of shaders.
/// </value>
/// <remarks>
/// The value for the <c>GraphicsSettings.currentRenderPipeline</c> is not expected to change within the lifetime
/// of the application.
/// </remarks>
public static string backgroundShaderName => k_DefaultBackgroundShaderName;
/// <summary>
/// Create and register the camera subsystem descriptor to advertise a providing implementation for camera
/// functionality.
/// </summary>
[RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.SubsystemRegistration)]
static void Register()
{
if (!Api.platformAndroid || !Api.loaderPresent)
return;
var cameraSubsystemCinfo = new XRCameraSubsystemCinfo
{
id = k_SubsystemId,
#if UNITY_2020_2_OR_NEWER
providerType = typeof(ARCoreCameraSubsystem.ARCoreProvider),
subsystemTypeOverride = typeof(ARCoreCameraSubsystem),
#else
implementationType = typeof(ARCoreCameraSubsystem),
#endif
supportsAverageBrightness = true,
supportsAverageColorTemperature = false,
supportsColorCorrection = true,
supportsDisplayMatrix = true,
supportsProjectionMatrix = true,
supportsTimestamp = true,
supportsCameraConfigurations = true,
supportsCameraImage = true,
supportsAverageIntensityInLumens = false,
supportsFocusModes = true,
supportsFaceTrackingAmbientIntensityLightEstimation = true,
supportsFaceTrackingHDRLightEstimation = false,
supportsWorldTrackingAmbientIntensityLightEstimation = true,
supportsWorldTrackingHDRLightEstimation = true,
supportsCameraGrain = false,
};
if (!XRCameraSubsystem.Register(cameraSubsystemCinfo))
{
Debug.LogError($"Failed to register the {k_SubsystemId} subsystem.");
}
}
/// <summary>
/// Invoked from native code just before this subsystem calls
/// [ArSession_getSupportedCameraConfigsWithFilter](https://developers.google.com/ar/reference/c/group/ar-session#arsession_getsupportedcameraconfigswithfilter).
/// </summary>
/// <remarks>
/// This allows you to customize the
/// [ArCameraConfigFilter](https://developers.google.com/ar/reference/c/group/ar-camera-config-filter)
/// passed to
/// [ArSession_getSupportedCameraConfigsWithFilter](https://developers.google.com/ar/reference/c/group/ar-session#arsession_getsupportedcameraconfigswithfilter).
///
/// Do not destroy the <see cref="ARCoreBeforeGetCameraConfigurationEventArgs.filter"/> object in this
/// callback. Doing so is undefined behavior and may crash.
///
/// The filter pointer to by <see cref="ARCoreBeforeGetCameraConfigurationEventArgs.filter"/> is only guaranteed
/// to exist for the duration of this callback. Accessing it from outside this callback is undefined behavior.
/// </remarks>
public event Action<ARCoreBeforeGetCameraConfigurationEventArgs> beforeGetCameraConfiguration
{
add => ((ARCoreProvider)provider).beforeGetCameraConfiguration += value;
remove => ((ARCoreProvider)provider).beforeGetCameraConfiguration -= value;
}
#if !UNITY_2020_2_OR_NEWER
/// <summary>
/// Creates an instance of the ARCore-specific camera provider. This provides camera services for ARCore.
/// </summary>
/// <returns>Returns a new instance of
/// [XRCameraSubsystem.Provider](xref:UnityEngine.XR.ARSubsystems.XRCameraSubsystem.Provider)
/// specific to ARCore.</returns>
protected override Provider CreateProvider() => new ARCoreProvider();
#endif
/// <summary>
/// Provides the camera functionality for the ARCore implementation.
/// </summary>
class ARCoreProvider : Provider
{
/// <summary>
/// The shader property name for the main texture of the camera video frame.
/// </summary>
/// <value>
/// The shader property name for the main texture of the camera video frame.
/// </value>
const string k_MainTexPropertyName = "_MainTex";
/// <summary>
/// The name of the camera permission for Android.
/// </summary>
/// <value>
/// The name of the camera permission for Android.
/// </value>
const string k_CameraPermissionName = "android.permission.CAMERA";
/// <summary>
/// The shader property name identifier for the main texture of the camera video frame.
/// </summary>
/// <value>
/// The shader property name identifier for the main texture of the camera video frame.
/// </value>
static readonly int k_MainTexPropertyNameId = Shader.PropertyToID(k_MainTexPropertyName);
/// <summary>
/// Get the material used by <c>XRCameraSubsystem</c> to render the camera texture.
/// </summary>
/// <returns>
/// The material to render the camera texture.
/// </returns>
public override Material cameraMaterial => m_CameraMaterial;
Material m_CameraMaterial;
/// <summary>
/// Determine whether camera permission has been granted.
/// </summary>
/// <returns>
/// <c>true</c> if camera permission has been granted for this app. Otherwise, <c>false</c>.
/// </returns>
public override bool permissionGranted => ARCorePermissionManager.IsPermissionGranted(k_CameraPermissionName);
public override bool invertCulling => NativeApi.UnityARCore_Camera_ShouldInvertCulling();
public override XRCpuImage.Api cpuImageApi => ARCoreCpuImageApi.instance;
static Action<IntPtr, ArSession, ArCameraConfigFilter> s_OnBeforeGetCameraConfigurationDelegate = OnBeforeGetCameraConfiguration;
GCHandle m_GCHandle;
/// <summary>
/// Construct the camera functionality provider for ARCore.
/// </summary>
public ARCoreProvider()
{
NativeApi.UnityARCore_Camera_Construct(k_MainTexPropertyNameId);
m_CameraMaterial = CreateCameraMaterial(ARCoreCameraSubsystem.backgroundShaderName);
m_GCHandle = GCHandle.Alloc(this);
}
/// <summary>
/// Get the camera facing direction.
/// </summary>
public override Feature currentCamera => NativeApi.GetCurrentFacingDirection();
/// <summary>
/// Get the currently active camera or set the requested camera
/// </summary>
public override Feature requestedCamera
{
get => Api.GetRequestedFeatures();
set
{
Api.SetFeatureRequested(Feature.AnyCamera, false);
Api.SetFeatureRequested(value, true);
}
}
/// <summary>
/// Start the camera functionality.
/// </summary>
public override void Start() => NativeApi.UnityARCore_Camera_Start();
/// <summary>
/// Stop the camera functionality.
/// </summary>
public override void Stop() => NativeApi.UnityARCore_Camera_Stop();
/// <summary>
/// Destroy any resources required for the camera functionality.
/// </summary>
public override void Destroy()
{
NativeApi.UnityARCore_Camera_Destruct();
if (m_GCHandle.IsAllocated)
{
m_GCHandle.Free();
}
m_GCHandle = default;
}
/// <summary>
/// Get the camera frame for the subsystem.
/// </summary>
/// <param name="cameraParams">The current Unity <c>Camera</c> parameters.</param>
/// <param name="cameraFrame">The current camera frame returned by the method.</param>
/// <returns>
/// <c>true</c> if the method successfully got a frame. Otherwise, <c>false</c>.
/// </returns>
public override bool TryGetFrame(XRCameraParams cameraParams, out XRCameraFrame cameraFrame)
{
return NativeApi.UnityARCore_Camera_TryGetFrame(cameraParams, out cameraFrame);
}
/// <summary>
/// Get or set the focus mode for the camera.
/// </summary>
public override bool autoFocusRequested
{
get => Api.GetRequestedFeatures().All(Feature.AutoFocus);
set => Api.SetFeatureRequested(Feature.AutoFocus, value);
}
/// <summary>
/// Get the actual auto focus state
/// </summary>
public override bool autoFocusEnabled => NativeApi.GetAutoFocusEnabled();
/// <summary>
/// Called on the render thread by background rendering code immediately before the background
/// is rendered.
/// For ARCore this is required in order to submit the GL commands for waiting on the fence
/// created on the main thread after calling ArPresto_Update().
/// </summary>
/// <param name="id">Platform-specific data.</param>
public override void OnBeforeBackgroundRender(int id)
{
NativeApi.UnityARCore_Camera_GetFenceWaitHandler(id);
}
/// <summary>
/// Get or set the light estimation mode.
/// </summary>
public override Feature requestedLightEstimation
{
get => Api.GetRequestedFeatures();
set
{
Api.SetFeatureRequested(Feature.AnyLightEstimation, false);
Api.SetFeatureRequested(value, true);
}
}
/// <summary>
/// Get the light estimation features currently enabled
/// </summary>
public override Feature currentLightEstimation => NativeApi.GetCurrentLightEstimation();
/// <summary>
/// Get the camera intrinsics information.
/// </summary>
/// <param name="cameraIntrinsics">The camera intrinsics information returned from the method.</param>
/// <returns>
/// <c>true</c> if the method successfully gets the camera intrinsics information. Otherwise, <c>false</c>.
/// </returns>
public override bool TryGetIntrinsics(out XRCameraIntrinsics cameraIntrinsics) => NativeApi.UnityARCore_Camera_TryGetIntrinsics(out cameraIntrinsics);
/// <summary>
/// Queries the supported camera configurations.
/// </summary>
/// <param name="defaultCameraConfiguration">A default value used to fill the returned array before copying
/// in real values. This ensures future additions to this struct are backwards compatible.</param>
/// <param name="allocator">The allocation strategy to use for the returned data.</param>
/// <returns>
/// The supported camera configurations.
/// </returns>
public override NativeArray<XRCameraConfiguration> GetConfigurations(XRCameraConfiguration defaultCameraConfiguration,
Allocator allocator)
{
IntPtr configurations = NativeApi.UnityARCore_Camera_AcquireConfigurations(out int configurationsCount,
out int configurationSize);
try
{
unsafe
{
return NativeCopyUtility.PtrToNativeArrayWithDefault(defaultCameraConfiguration,
(void*)configurations,
configurationSize, configurationsCount,
allocator);
}
}
finally
{
NativeApi.UnityARCore_Camera_ReleaseConfigurations(configurations);
}
}
/// <summary>
/// The current camera configuration.
/// </summary>
/// <value>
/// The current camera configuration if it exists. Otherwise, <c>null</c>.
/// </value>
/// <exception cref="System.ArgumentException">Thrown when setting the current configuration if the given
/// configuration is not a valid, supported camera configuration.</exception>
/// <exception cref="System.InvalidOperationException">Thrown when setting the current configuration if the
/// implementation is unable to set the current camera configuration for various reasons such as:
/// <list type="bullet">
/// <item><description>ARCore session is invalid</description></item>
/// <item><description>Captured <c>XRCpuImage</c> have not been disposed</description></item>
/// </list>
/// </exception>
/// <seealso cref="TryAcquireLatestCpuImage"/>
public override XRCameraConfiguration? currentConfiguration
{
get
{
if (TryGetCurrentConfiguration(out XRCameraConfiguration cameraConfiguration))
{
return cameraConfiguration;
}
return null;
}
set
{
// Assert that the camera configuration is not null.
// The XRCameraSubsystem should have already checked this.
Debug.Assert(value != null, "Cannot set the current camera configuration to null");
switch (NativeApi.UnityARCore_Camera_TrySetCurrentConfiguration((XRCameraConfiguration)value))
{
case CameraConfigurationResult.Success:
break;
case CameraConfigurationResult.InvalidCameraConfiguration:
throw new ArgumentException("Camera configuration does not exist in the available "
+ "configurations", "value");
case CameraConfigurationResult.InvalidSession:
throw new InvalidOperationException("Cannot set camera configuration because the ARCore "
+ "session is not valid");
case CameraConfigurationResult.ErrorImagesNotDisposed:
throw new InvalidOperationException("Cannot set camera configuration because you have not "
+ "disposed of all XRCpuImage and allowed all "
+ "asynchronous conversion jobs to complete");
default:
throw new InvalidOperationException("cannot set camera configuration for ARCore");
}
}
}
/// <summary>
/// Gets the texture descriptors associated with the camera image.
/// </summary>
/// <returns>The texture descriptors.</returns>
/// <param name="defaultDescriptor">Default descriptor.</param>
/// <param name="allocator">Allocator.</param>
public override unsafe NativeArray<XRTextureDescriptor> GetTextureDescriptors(
XRTextureDescriptor defaultDescriptor,
Allocator allocator)
{
int length, elementSize;
var textureDescriptors = NativeApi.UnityARCore_Camera_AcquireTextureDescriptors(
out length, out elementSize);
try
{
return NativeCopyUtility.PtrToNativeArrayWithDefault(
defaultDescriptor,
textureDescriptors, elementSize, length, allocator);
}
finally
{
NativeApi.UnityARCore_Camera_ReleaseTextureDescriptors(textureDescriptors);
}
}
/// <summary>
/// Query for the latest native camera image.
/// </summary>
/// <param name="cameraImageCinfo">The metadata required to construct a <see cref="XRCpuImage"/></param>
/// <returns>
/// <c>true</c> if the camera image is acquired. Otherwise, <c>false</c>.
/// </returns>
public override bool TryAcquireLatestCpuImage(out XRCpuImage.Cinfo cameraImageCinfo)
=> ARCoreCpuImageApi.TryAcquireLatestImage(ARCoreCpuImageApi.ImageType.Camera, out cameraImageCinfo);
event Action<ARCoreBeforeGetCameraConfigurationEventArgs> m_BeforeGetCameraConfiguration;
internal event Action<ARCoreBeforeGetCameraConfigurationEventArgs> beforeGetCameraConfiguration
{
add
{
m_BeforeGetCameraConfiguration += value;
NativeApi.SetOnBeforeGetCameraConfigurationCallback(s_OnBeforeGetCameraConfigurationDelegate, (IntPtr)m_GCHandle);
}
remove
{
m_BeforeGetCameraConfiguration -= value;
if (m_BeforeGetCameraConfiguration == null)
{
NativeApi.SetOnBeforeGetCameraConfigurationCallback(null, IntPtr.Zero);
}
}
}
[MonoPInvokeCallback(typeof(Action<IntPtr, ArSession, ArCameraConfigFilter>))]
static void OnBeforeGetCameraConfiguration(IntPtr providerHandle, ArSession session, ArCameraConfigFilter filter)
{
if (GCHandle.FromIntPtr(providerHandle).Target is ARCoreProvider provider)
{
provider.m_BeforeGetCameraConfiguration?.Invoke(new ARCoreBeforeGetCameraConfigurationEventArgs
{
session = session,
filter = filter
});
}
}
}
internal static bool TryGetCurrentConfiguration(out XRCameraConfiguration configuration) => NativeApi.UnityARCore_Camera_TryGetCurrentConfiguration(out configuration);
/// <summary>
/// Container to wrap the native ARCore camera APIs.
/// </summary>
static class NativeApi
{
[DllImport("UnityARCore", EntryPoint = "UnityARCore_Camera_SetOnBeforeGetCameraConfigurationCallback")]
public static extern void SetOnBeforeGetCameraConfigurationCallback(
Action<IntPtr, ArSession, ArCameraConfigFilter> OnBeforeGetCameraConfigFilterDelegate, IntPtr providerHandle);
[DllImport("UnityARCore")]
public static extern void UnityARCore_Camera_Construct(int mainTexPropertyNameId);
[DllImport("UnityARCore")]
public static extern void UnityARCore_Camera_Destruct();
[DllImport("UnityARCore")]
public static extern void UnityARCore_Camera_Start();
[DllImport("UnityARCore")]
public static extern void UnityARCore_Camera_Stop();
[DllImport("UnityARCore")]
public static extern bool UnityARCore_Camera_TryGetFrame(XRCameraParams cameraParams,
out XRCameraFrame cameraFrame);
[DllImport("UnityARCore", EntryPoint="UnityARCore_Camera_GetAutoFocusEnabled")]
public static extern bool GetAutoFocusEnabled();
[DllImport("UnityARCore", EntryPoint="UnityARCore_Camera_GetCurrentLightEstimation")]
public static extern Feature GetCurrentLightEstimation();
[DllImport("UnityARCore")]
public static extern bool UnityARCore_Camera_TryGetIntrinsics(out XRCameraIntrinsics cameraIntrinsics);
[DllImport("UnityARCore")]
public static extern IntPtr UnityARCore_Camera_AcquireConfigurations(out int configurationsCount,
out int configurationSize);
[DllImport("UnityARCore")]
public static extern void UnityARCore_Camera_ReleaseConfigurations(IntPtr configurations);
[DllImport("UnityARCore")]
public static extern bool UnityARCore_Camera_TryGetCurrentConfiguration(out XRCameraConfiguration cameraConfiguration);
[DllImport("UnityARCore")]
public static extern CameraConfigurationResult UnityARCore_Camera_TrySetCurrentConfiguration(XRCameraConfiguration cameraConfiguration);
[DllImport("UnityARCore")]
public static extern unsafe void* UnityARCore_Camera_AcquireTextureDescriptors(
out int length, out int elementSize);
[DllImport("UnityARCore")]
public static extern unsafe void UnityARCore_Camera_ReleaseTextureDescriptors(
void* descriptors);
[DllImport("UnityARCore")]
public static extern bool UnityARCore_Camera_ShouldInvertCulling();
[DllImport("UnityARCore", EntryPoint="UnityARCore_Camera_GetCurrentFacingDirection")]
public static extern Feature GetCurrentFacingDirection();
[DllImport("UnityARCore")]
public static extern void UnityARCore_Camera_GetFenceWaitHandler(int unused);
}
}
}