Skip to content

Fix CameraView crash when switching camera on Windows and other CameraView enhancements #2634

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
x:TypeArguments="viewModels:CameraViewViewModel"
x:DataType="viewModels:CameraViewViewModel">

<Grid RowDefinitions="200,*,Auto,Auto" ColumnDefinitions="3*,*">
<Grid RowDefinitions="Auto,*,Auto,Auto" ColumnDefinitions="3*,*">
<toolkit:CameraView
x:Name="Camera"
Grid.Column="0" Grid.Row="0" Grid.ColumnSpan="2" Grid.RowSpan="3"
Expand All @@ -36,13 +36,13 @@
</VerticalStackLayout>
</Grid>

<ContentView Grid.Column="1" Grid.Row="0" ZIndex="100" BackgroundColor="#80CCCCCC">
<Grid Grid.Column="1" Grid.Row="0" ZIndex="100" BackgroundColor="#80CCCCCC">
<Image x:Name="image" VerticalOptions="Fill" HorizontalOptions="Fill">
<Image.GestureRecognizers>
<TapGestureRecognizer Tapped="OnImageTapped" />
</Image.GestureRecognizers>
</Image>
</ContentView>
</Grid>

<Grid ColumnDefinitions="Auto,*,Auto" Grid.Column="0" Grid.ColumnSpan="2" Grid.Row="2" ColumnSpacing="10" Margin="10"
BackgroundColor="#00000000">
Expand All @@ -61,6 +61,12 @@

<FlexLayout Margin="5" JustifyContent="SpaceBetween" Wrap="Wrap">

<Picker
Title="Cameras"
ItemsSource="{Binding Cameras}"
ItemDisplayBinding="{Binding Name}"
SelectedItem="{Binding SelectedCamera}" />

<Picker
Title="Flash"
IsVisible="{Binding Path=SelectedCamera.IsFlashSupported, FallbackValue=false}"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ protected override async void OnAppearing()
{
base.OnAppearing();

var cancellationTokenSource = new CancellationTokenSource(TimeSpan.FromSeconds(3));
await BindingContext.RefreshCamerasCommand.ExecuteAsync(cancellationTokenSource.Token);
await BindingContext.InitializeAsync();
}

// https://github.com/dotnet/maui/issues/16697
Expand Down Expand Up @@ -75,7 +74,7 @@ void OnMediaCaptured(object? sender, MediaCapturedEventArgs e)
{
// workaround for https://github.com/dotnet/maui/issues/13858
#if ANDROID
image.Source = ImageSource.FromStream(() => File.OpenRead(imagePath));
image.Source = ImageSource.FromStream(() => File.OpenRead(imagePath));
#else
image.Source = ImageSource.FromFile(imagePath);
#endif
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ public partial class CameraViewViewModel(ICameraProvider cameraProvider) : BaseV
{
readonly ICameraProvider cameraProvider = cameraProvider;

public IReadOnlyList<CameraInfo> Cameras => cameraProvider.AvailableCameras ?? [];
[ObservableProperty]
public partial IReadOnlyList<CameraInfo> Cameras { get; set; }

public CancellationToken Token => CancellationToken.None;

Expand Down Expand Up @@ -42,6 +43,12 @@ public partial class CameraViewViewModel(ICameraProvider cameraProvider) : BaseV
[ObservableProperty]
public partial string ResolutionText { get; set; } = string.Empty;

public async Task InitializeAsync()
{
await cameraProvider.InitializeAsync;
Cameras = cameraProvider.AvailableCameras ?? [];
}

[RelayCommand]
async Task RefreshCameras(CancellationToken token) => await cameraProvider.RefreshAvailableCameras(token);

Expand All @@ -60,6 +67,22 @@ partial void OnSelectedResolutionChanged(Size value)
UpdateResolutionText();
}

partial void OnSelectedCameraChanged(CameraInfo? oldValue, CameraInfo? newValue)
{
UpdateCameraInfoText();
}

void UpdateCameraInfoText()
{
if (SelectedCamera is null)
{
return;
}
CameraNameText = $"{SelectedCamera.Name}";
ZoomRangeText = $"Min Zoom: {SelectedCamera.MinimumZoomFactor}, Max Zoom: {SelectedCamera.MaximumZoomFactor}";
UpdateFlashModeText();
}

void UpdateFlashModeText()
{
if (SelectedCamera is null)
Expand Down
26 changes: 5 additions & 21 deletions src/CommunityToolkit.Maui.Camera/CameraManager.android.cs
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ protected virtual void Dispose(bool disposing)
previewView?.Dispose();
previewView = null;

processCameraProvider?.UnbindAll();
processCameraProvider?.Dispose();
processCameraProvider = null;

Expand Down Expand Up @@ -159,16 +160,6 @@ protected virtual async partial Task PlatformConnectCamera(CancellationToken tok
{
processCameraProvider = (ProcessCameraProvider)(cameraProviderFuture.Get() ?? throw new CameraException($"Unable to retrieve {nameof(ProcessCameraProvider)}"));

if (cameraProvider.AvailableCameras is null)
{
await cameraProvider.RefreshAvailableCameras(token);

if (cameraProvider.AvailableCameras is null)
{
throw new CameraException("Unable to refresh available cameras");
}
}

await StartUseCase(token);

cameraProviderTCS.SetResult();
Expand Down Expand Up @@ -201,22 +192,14 @@ protected async Task StartUseCase(CancellationToken token)
await StartCameraPreview(token);
}

protected virtual async partial Task PlatformStartCameraPreview(CancellationToken token)
protected virtual partial Task PlatformStartCameraPreview(CancellationToken token)
{
if (previewView is null || processCameraProvider is null || cameraPreview is null || imageCapture is null)
{
return;
return Task.CompletedTask;
}

if (cameraView.SelectedCamera is null)
{
if (cameraProvider.AvailableCameras is null)
{
await cameraProvider.RefreshAvailableCameras(token);
}

cameraView.SelectedCamera = cameraProvider.AvailableCameras?.FirstOrDefault() ?? throw new CameraException("No camera available on device");
}
cameraView.SelectedCamera ??= cameraProvider.AvailableCameras?.FirstOrDefault() ?? throw new CameraException("No camera available on device");

var cameraSelector = cameraView.SelectedCamera.CameraSelector ?? throw new CameraException($"Unable to retrieve {nameof(CameraSelector)}");

Expand All @@ -232,6 +215,7 @@ protected virtual async partial Task PlatformStartCameraPreview(CancellationToke

IsInitialized = true;
OnLoaded.Invoke();
return Task.CompletedTask;
}

protected virtual partial void PlatformStopCameraPreview()
Expand Down
31 changes: 6 additions & 25 deletions src/CommunityToolkit.Maui.Camera/CameraManager.macios.cs
Original file line number Diff line number Diff line change
Expand Up @@ -78,24 +78,18 @@
captureDevice.UnlockForConfiguration();
}

public async partial ValueTask UpdateCaptureResolution(Size resolution, CancellationToken token)
public partial ValueTask UpdateCaptureResolution(Size resolution, CancellationToken token)
{
if (captureDevice is null)
if (captureDevice is null || cameraView.SelectedCamera is null)
{
return;
return ValueTask.CompletedTask;
}

captureDevice.LockForConfiguration(out NSError? error);
if (error is not null)
{
Trace.WriteLine(error);
return;
}

if (cameraView.SelectedCamera is null)
{
await cameraProvider.RefreshAvailableCameras(token);
cameraView.SelectedCamera = cameraProvider.AvailableCameras?.FirstOrDefault() ?? throw new CameraException("No camera available on device");
return ValueTask.CompletedTask;
}

var filteredFormatList = cameraView.SelectedCamera.SupportedFormats.Where(f =>
Expand All @@ -117,20 +111,11 @@
}

captureDevice.UnlockForConfiguration();
return ValueTask.CompletedTask;
}

protected virtual async partial Task PlatformConnectCamera(CancellationToken token)
{
if (cameraProvider.AvailableCameras is null)
{
await cameraProvider.RefreshAvailableCameras(token);

if (cameraProvider.AvailableCameras is null)
{
throw new CameraException("Unable to refresh cameras");
}
}

await PlatformStartCameraPreview(token);
}

Expand All @@ -149,11 +134,7 @@
input.Dispose();
}

if (cameraView.SelectedCamera is null)
{
await cameraProvider.RefreshAvailableCameras(token);
cameraView.SelectedCamera = cameraProvider.AvailableCameras?.FirstOrDefault() ?? throw new CameraException("No camera available on device");
}
cameraView.SelectedCamera ??= cameraProvider.AvailableCameras?.FirstOrDefault() ?? throw new CameraException("No camera available on device");

captureDevice = cameraView.SelectedCamera.CaptureDevice ?? throw new CameraException($"No Camera found");
captureInput = new AVCaptureDeviceInput(captureDevice, out _);
Expand Down Expand Up @@ -204,7 +185,7 @@
var photoOutputConnection = photoOutput.ConnectionFromMediaType(avMediaTypeVideo);
if (photoOutputConnection is not null)
{
photoOutputConnection.VideoOrientation = videoOrientation;

Check warning on line 188 in src/CommunityToolkit.Maui.Camera/CameraManager.macios.cs

View workflow job for this annotation

GitHub Actions / Build Sample App using Latest .NET SDK (macos-15)

This call site is reachable on: 'iOS' 15.0 and later, 'maccatalyst' 15.0 and later. 'AVCaptureConnection.VideoOrientation' is obsoleted on: 'ios' 17.0 and later (Use VideoRotationAngle instead.), 'maccatalyst' 17.0 and later (Use VideoRotationAngle instead.). (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1422)
}
}

Expand Down Expand Up @@ -271,7 +252,7 @@
IEnumerable<UIScene> scenes = UIApplication.SharedApplication.ConnectedScenes;
var interfaceOrientation = scenes.FirstOrDefault() is UIWindowScene windowScene
? windowScene.InterfaceOrientation
: UIApplication.SharedApplication.StatusBarOrientation;

Check warning on line 255 in src/CommunityToolkit.Maui.Camera/CameraManager.macios.cs

View workflow job for this annotation

GitHub Actions / Build Sample App using Latest .NET SDK (macos-15)

This call site is reachable on: 'iOS' 15.0 and later, 'maccatalyst' 15.0 and later. 'UIApplication.StatusBarOrientation' is obsoleted on: 'ios' 9.0 and later, 'maccatalyst' 9.0 and later. (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1422)

return interfaceOrientation switch
{
Expand Down Expand Up @@ -347,7 +328,7 @@
{
if (PreviewLayer.Connection is not null)
{
PreviewLayer.Connection.VideoOrientation = videoOrientation;

Check warning on line 331 in src/CommunityToolkit.Maui.Camera/CameraManager.macios.cs

View workflow job for this annotation

GitHub Actions / Build Sample App using Latest .NET SDK (macos-15)

This call site is reachable on: 'iOS' 15.0 and later, 'maccatalyst' 15.0 and later. 'AVCaptureConnection.VideoOrientation' is obsoleted on: 'ios' 17.0 and later (Use VideoRotationAngle instead.), 'maccatalyst' 17.0 and later (Use VideoRotationAngle instead.). (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1422)
}
}
}
Expand Down
33 changes: 9 additions & 24 deletions src/CommunityToolkit.Maui.Camera/CameraManager.windows.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
using System.Runtime.Versioning;
using CommunityToolkit.Maui.Core.Primitives;
using CommunityToolkit.Maui.Extensions;
using Microsoft.Maui.Controls.PlatformConfiguration;
using Microsoft.UI.Xaml.Controls;
using Windows.Media.Capture;
using Windows.Media.Capture.Frames;
Expand Down Expand Up @@ -121,16 +120,6 @@ protected virtual void Dispose(bool disposing)

protected virtual async partial Task PlatformConnectCamera(CancellationToken token)
{
if (cameraProvider.AvailableCameras is null)
{
await cameraProvider.RefreshAvailableCameras(token);

if (cameraProvider.AvailableCameras is null)
{
throw new CameraException("Unable to refresh cameras");
}
}

await StartCameraPreview(token);
}

Expand All @@ -141,13 +130,9 @@ protected virtual async partial Task PlatformStartCameraPreview(CancellationToke
return;
}

mediaCapture = new MediaCapture();
cameraView.SelectedCamera ??= cameraProvider.AvailableCameras?.FirstOrDefault() ?? throw new CameraException("No camera available on device");

if (cameraView.SelectedCamera is null)
{
await cameraProvider.RefreshAvailableCameras(token);
cameraView.SelectedCamera = cameraProvider.AvailableCameras?.FirstOrDefault() ?? throw new CameraException("No camera available on device");
}
mediaCapture = new MediaCapture();

await mediaCapture.InitializeCameraForCameraView(cameraView.SelectedCamera.DeviceId, token);

Expand Down Expand Up @@ -182,22 +167,22 @@ protected virtual partial void PlatformStopCameraPreview()

protected async Task PlatformUpdateResolution(Size resolution, CancellationToken token)
{
if (!IsInitialized || mediaCapture is null)
if (!IsInitialized || mediaCapture is null || cameraView.SelectedCamera is null)
{
return;
}

if (cameraView.SelectedCamera is null)
if (mediaCapture.VideoDeviceController.Id != cameraView.SelectedCamera.DeviceId)
{
await cameraProvider.RefreshAvailableCameras(token);
cameraView.SelectedCamera = cameraProvider.AvailableCameras?.FirstOrDefault() ?? throw new CameraException("No camera available on device");
return;
}

var filteredPropertiesList = cameraView.SelectedCamera.ImageEncodingProperties.Where(p => p.Width <= resolution.Width && p.Height <= resolution.Height).ToList();

filteredPropertiesList = filteredPropertiesList.Count is not 0
? filteredPropertiesList
: [.. cameraView.SelectedCamera.ImageEncodingProperties.OrderByDescending(p => p.Width * p.Height)];
if (filteredPropertiesList.Count is 0)
{
filteredPropertiesList = [.. cameraView.SelectedCamera.ImageEncodingProperties.OrderByDescending(p => p.Width * p.Height)];
}

if (filteredPropertiesList.Count is not 0)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
}

/// <inheritdoc/>
public void Dispose()

Check warning on line 63 in src/CommunityToolkit.Maui.Camera/Handlers/CameraViewHandler.shared.cs

View workflow job for this annotation

GitHub Actions / Build Sample App using Latest .NET SDK (windows-latest)

'CameraViewHandler.Dispose()' hides inherited member 'ViewHandler<ICameraView, View>.Dispose()'. Use the new keyword if hiding was intended.
{
Dispose(true);
GC.SuppressFinalize(this);
Expand Down Expand Up @@ -90,9 +90,20 @@
{
base.ConnectHandler(platformView);

await (cameraManager?.ArePermissionsGranted() ?? Task.CompletedTask);
await (cameraManager?.ConnectCamera(CancellationToken.None) ?? Task.CompletedTask);
await cameraProvider.RefreshAvailableCameras(CancellationToken.None);
if (cameraManager is null)
{
throw new CameraException("CameraManager is null");
}

if (await cameraManager.ArePermissionsGranted() is false)
{
throw new PermissionException("Camera permissions not granted");
}

await cameraProvider.InitializeAsync;
VirtualView.SelectedCamera ??= cameraProvider.AvailableCameras?.FirstOrDefault() ?? throw new CameraException("No camera available on device");

await cameraManager.ConnectCamera(CancellationToken.None);
}

/// <inheritdoc/>
Expand All @@ -106,7 +117,7 @@
/// Releases the unmanaged resources used by the <see cref="CameraViewHandler"/> and optionally releases the managed resources.
/// </summary>
/// <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
protected virtual void Dispose(bool disposing)

Check warning on line 120 in src/CommunityToolkit.Maui.Camera/Handlers/CameraViewHandler.shared.cs

View workflow job for this annotation

GitHub Actions / Build Sample App using Latest .NET SDK (windows-latest)

'CameraViewHandler.Dispose(bool)' hides inherited member 'ViewHandler<ICameraView, View>.Dispose(bool)'. To make the current member override that implementation, add the override keyword. Otherwise add the new keyword.
{
if (disposing)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,24 @@ public interface ICameraProvider
/// Cameras available on device
/// </summary>
/// <remarks>
/// List is initialized using <see cref="RefreshAvailableCameras(CancellationToken)"/>
/// List is initialized using <see cref="InitializeAsync"/>, and can be refreshed using <see cref="RefreshAvailableCameras(CancellationToken)"/>
/// </remarks>
IReadOnlyList<CameraInfo>? AvailableCameras { get; }

/// <summary>
/// Assigns <see cref="AvailableCameras"/> with the cameras available on device
/// Refreshes <see cref="AvailableCameras"/> with the cameras available on device
/// </summary>
/// <remarks>
/// Only call this method when the available cameras on device has been updated, as the list is automatically initialized with <see cref="InitializeAsync"/>
/// </remarks>
/// <param name="token"></param>
/// <returns></returns>
[MemberNotNull(nameof(AvailableCameras))]
ValueTask RefreshAvailableCameras(CancellationToken token);

/// <summary>
/// The <see cref="Task"/> to initialize the available cameras list. This task is automatically started when the <see cref="ICameraProvider"/> is created.
/// </summary>
Task InitializeAsync { get; }

}
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,13 @@ partial class CameraProvider : ICameraProvider

/// <inheritdoc/>
public partial ValueTask RefreshAvailableCameras(CancellationToken token);
}

public CameraProvider()
{
InitializeAsync = RefreshAvailableCameras(CancellationToken.None).AsTask();
}

/// <inheritdoc/>
public Task InitializeAsync { get; init; }

}
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ public async partial ValueTask RefreshAvailableCameras(CancellationToken token)
var deviceInfoCollection = await DeviceInformation.FindAllAsync(DeviceClass.VideoCapture).AsTask(token);
var mediaFrameSourceGroup = await MediaFrameSourceGroup.FindAllAsync().AsTask(token);
var videoCaptureSourceGroup = mediaFrameSourceGroup.Where(sourceGroup => deviceInfoCollection.Any(deviceInfo => deviceInfo.Id == sourceGroup.Id)).ToList();
var mediaCapture = new MediaCapture();

var availableCameras = new List<CameraInfo>();

foreach (var sourceGroup in videoCaptureSourceGroup)
{
var mediaCapture = new MediaCapture();
await mediaCapture.InitializeCameraForCameraView(sourceGroup.Id, token);

CameraPosition position = CameraPosition.Unknown;
Expand Down Expand Up @@ -63,6 +63,8 @@ public async partial ValueTask RefreshAvailableCameras(CancellationToken token)
imageEncodingPropertiesList);

availableCameras.Add(cameraInfo);

mediaCapture.Dispose();
}

AvailableCameras = availableCameras;
Expand Down
Loading
Loading