Add support for local files and package resources to MediaElement

samples/CommunityToolkit.Maui.Sample/Pages/Views/MediaElement/MediaElementPage.xaml

@@ -31,7 +31,7 @@
                 x:Name="MediaElement"
                 ShouldAutoPlay="True"
                 Source="{x:Static constants:StreamingVideoUrls.BuckBunny}"
-                MetadataArtworkUrl="https://lh3.googleusercontent.com/pw/AP1GczNRrebWCJvfdIau1EbsyyYiwAfwHS0JXjbioXvHqEwYIIdCzuLodQCZmA57GADIo5iB3yMMx3t_vsefbfoHwSg0jfUjIXaI83xpiih6d-oT7qD_slR0VgNtfAwJhDBU09kS5V2T5ZML-WWZn8IrjD4J-g=w1792-h1024-s-no-gm"
+                MetadataArtworkSource="https://lh3.googleusercontent.com/pw/AP1GczNRrebWCJvfdIau1EbsyyYiwAfwHS0JXjbioXvHqEwYIIdCzuLodQCZmA57GADIo5iB3yMMx3t_vsefbfoHwSg0jfUjIXaI83xpiih6d-oT7qD_slR0VgNtfAwJhDBU09kS5V2T5ZML-WWZn8IrjD4J-g=w1792-h1024-s-no-gm"
                 MetadataTitle="Big Buck Bunny"
                 MetadataArtist="Blender Foundation"
                 MediaEnded="OnMediaEnded"

samples/CommunityToolkit.Maui.Sample/Pages/Views/MediaElement/MediaElementPage.xaml.cs

@@ -15,7 +15,7 @@ public partial class MediaElementPage : BasePage<MediaElementViewModel>
 	const string loadLocalResource = "Load Local Resource";
 	const string resetSource = "Reset Source to null";
 	const string loadMusic = "Load Music";
-
+	const string loadFromFile = "Load from File";
 	const string botImageUrl = "https://lh3.googleusercontent.com/pw/AP1GczNRrebWCJvfdIau1EbsyyYiwAfwHS0JXjbioXvHqEwYIIdCzuLodQCZmA57GADIo5iB3yMMx3t_vsefbfoHwSg0jfUjIXaI83xpiih6d-oT7qD_slR0VgNtfAwJhDBU09kS5V2T5ZML-WWZn8IrjD4J-g=w1792-h1024-s-no-gm";
 	const string hlsStreamTestUrl = "https://mtoczko.github.io/hls-test-streams/test-gap/playlist.m3u8";
 	const string hal9000AudioUrl = "https://github.com/prof3ssorSt3v3/media-sample-files/raw/master/hal-9000.mp3";
@@ -166,7 +166,7 @@ await DisplayAlertAsync("Error Loading URL Source", "No value was found to load
 	async void ChangeSourceClicked(object? sender, EventArgs? e)
 	{
 		var result = await DisplayActionSheetAsync("Choose a source", "Cancel", null,
-			loadOnlineMp4, loadHls, loadLocalResource, resetSource, loadMusic);
+			loadOnlineMp4, loadHls, loadLocalResource, resetSource, loadMusic, loadFromFile);
 
 		MediaElement.Stop();
 		MediaElement.Source = null;
@@ -175,28 +175,28 @@ async void ChangeSourceClicked(object? sender, EventArgs? e)
 		{
 			case loadOnlineMp4:
 				MediaElement.MetadataTitle = "Big Buck Bunny";
-				MediaElement.MetadataArtworkUrl = botImageUrl;
+				MediaElement.MetadataArtworkSource = botImageUrl;
 				MediaElement.MetadataArtist = "Big Buck Bunny Album";
 				MediaElement.Source =
 					MediaSource.FromUri(StreamingVideoUrls.BuckBunny);
 				return;
 
 			case loadHls:
 				MediaElement.MetadataArtist = "HLS Album";
-				MediaElement.MetadataArtworkUrl = botImageUrl;
+				MediaElement.MetadataArtworkSource = botImageUrl;
 				MediaElement.MetadataTitle = "HLS Title";
 				MediaElement.Source = MediaSource.FromUri(hlsStreamTestUrl);
 				return;
 
 			case resetSource:
-				MediaElement.MetadataArtworkUrl = string.Empty;
+				MediaElement.MetadataArtworkSource = null;
 				MediaElement.MetadataTitle = string.Empty;
 				MediaElement.MetadataArtist = string.Empty;
 				MediaElement.Source = null;
 				return;
 
 			case loadLocalResource:
-				MediaElement.MetadataArtworkUrl = botImageUrl;
+				MediaElement.MetadataArtworkSource = MediaSource.FromResource("robot.jpg");
 				MediaElement.MetadataTitle = "Local Resource Title";
 				MediaElement.MetadataArtist = "Local Resource Album";
 
@@ -218,9 +218,32 @@ async void ChangeSourceClicked(object? sender, EventArgs? e)
 			case loadMusic:
 				MediaElement.MetadataTitle = "HAL 9000";
 				MediaElement.MetadataArtist = "HAL 9000 Album";
-				MediaElement.MetadataArtworkUrl = botImageUrl;
+				MediaElement.MetadataArtworkSource = botImageUrl;
 				MediaElement.Source = MediaSource.FromUri(hal9000AudioUrl);
 				return;
+			case loadFromFile:
+				var fileResult = await PickAndShow(new PickOptions
+				{
+					FileTypes = FilePickerFileType.Images,
+					PickerTitle = "Please select an image file"
+				});
+				if (fileResult is not null)
+				{
+					MediaElement.MetadataArtworkSource = MediaSource.FromFile(fileResult.FullPath);
+				}
+				MediaElement.MetadataTitle = "Downloaded file";
+				MediaElement.MetadataArtist = "From File Album";
+
+				fileResult = await PickAndShow(new PickOptions
+				{
+					FileTypes = FilePickerFileType.Videos,
+					PickerTitle = "Please select a video file"
+				});
+				if (fileResult is not null) 
+				{
+					MediaElement.Source = MediaSource.FromFile(fileResult.FullPath);
+				}
+				return;
 		}
 	}
 
@@ -278,7 +301,7 @@ async void DisplayPopup(object? sender, EventArgs? e)
 			HeightRequest = 400,
 			AndroidViewType = AndroidViewType.SurfaceView,
 			Source = source,
-			MetadataArtworkUrl = botImageUrl,
+			MetadataArtworkSource = botImageUrl,
 			ShouldAutoPlay = true,
 			ShouldShowPlaybackControls = true,
 		};
@@ -288,4 +311,20 @@ async void DisplayPopup(object? sender, EventArgs? e)
 		popupMediaElement.Stop();
 		popupMediaElement.Source = null;
 	}
+
+	async Task<FileResult?> PickAndShow(PickOptions options)
+	{
+		try
+		{
+			var result = await FilePicker.Default.PickAsync(options);
+			return result;
+		}
+		catch (Exception ex)
+		{
+			// The user canceled or something went wrong
+			logger.LogError(ex, "Error picking file");
+		}
+
+		return null;
+	}
 }

src/CommunityToolkit.Maui.MediaElement/Interfaces/IMediaElement.shared.cs

@@ -18,6 +18,11 @@ public interface IMediaElement : IView, IAsynchronousMediaElementHandler
 	/// </summary>
 	event EventHandler<MediaPositionChangedEventArgs> PositionChanged;
 
+	/// <summary>
+	/// Gets or sets the artwork Image source.
+	/// </summary>
+	MediaSource? MetadataArtworkSource { get; set; }
+
 	/// <summary>
 	/// Gets the media aspect ratio.
 	/// </summary>
@@ -106,11 +111,6 @@ public interface IMediaElement : IView, IAsynchronousMediaElementHandler
 	/// </summary>
 	string MetadataArtist { get; set; }
 
-	/// <summary>
-	/// Gets or sets the artwork Image Url.
-	/// </summary>
-	string MetadataArtworkUrl { get; set; }
-
 	/// <summary>
 	/// Occurs when the media has ended playing successfully.
 	/// </summary>

src/CommunityToolkit.Maui.MediaElement/MediaElement.shared.cs

@@ -117,9 +117,9 @@ public partial class MediaElement : View, IMediaElement, IDisposable
 	public static readonly BindableProperty MetadataArtistProperty = BindableProperty.Create(nameof(MetadataArtist), typeof(string), typeof(MediaElement), MediaElementDefaults.MetadataArtist);
 
 	/// <summary>
-	/// Bindable property for the <see cref="MetadataArtworkUrl"/> property.
+	/// Bindable property for the <see cref="MetadataArtworkSource"/> property.
 	/// </summary>
-	public static readonly BindableProperty MetadataArtworkUrlProperty = BindableProperty.Create(nameof(MetadataArtworkUrl), typeof(string), typeof(MediaElement), MediaElementDefaults.MetadataArtworkUrl);
+	public static readonly BindableProperty MetadataArtworkSourceProperty = BindableProperty.Create(nameof(MetadataArtworkSource), typeof(MediaSource), typeof(MediaElement), MediaElementDefaults.MetadataArtworkSource);
 
 	readonly WeakEventManager eventManager = new();
 	readonly SemaphoreSlim seekToSemaphoreSlim = new(1, 1);
@@ -333,14 +333,14 @@ public string MetadataArtist
 	}
 
 	/// <summary>
-	/// Gets or sets the <see cref="MetadataArtworkUrl"/> of the media.
+	/// Gets or sets the <see cref="MetadataArtworkSource"/> of the media.
 	/// </summary>
-	public string MetadataArtworkUrl
+	[TypeConverter(typeof(MediaSourceConverter))]
+	public MediaSource? MetadataArtworkSource
 	{
-		get => (string)GetValue(MetadataArtworkUrlProperty);
-		set => SetValue(MetadataArtworkUrlProperty, value);
+		get => (MediaSource?)GetValue(MetadataArtworkSourceProperty);
+		set => SetValue(MetadataArtworkSourceProperty, value);
 	}
-
 	/// <summary>
 	/// Gets or sets the <see cref="Volume"/> of the media.
 	/// </summary>
@@ -577,7 +577,6 @@ void ClearTimer()
 		timer.Stop();
 		timer = null;
 	}
-
 	void OnSourceChanged(object? sender, EventArgs eventArgs)
 	{
 		OnPropertyChanged(SourceProperty.PropertyName);

src/CommunityToolkit.Maui.MediaElement/Primitives/MediaElementDefaults.shared.cs

@@ -1,3 +1,5 @@
+using CommunityToolkit.Maui.Views;
+
 namespace CommunityToolkit.Maui.Core;
 
 static class MediaElementDefaults
@@ -26,7 +28,7 @@ static class MediaElementDefaults
 
 	public const string MetadataArtist = "";
 
-	public const string MetadataArtworkUrl = "";
+	public static MediaSource? MetadataArtworkSource => null;
 
 	public const MediaElementState CurrentState = MediaElementState.None;
 

src/CommunityToolkit.Maui.MediaElement/Primitives/Metadata.macios.cs

@@ -1,4 +1,5 @@
 using AVFoundation;
+using CommunityToolkit.Maui.Views;
 using CoreMedia;
 using Foundation;
 using MediaPlayer;
@@ -69,42 +70,33 @@ public Metadata(PlatformMediaElement player)
 	/// </summary>
 	/// <param name="playerItem"></param>
 	/// <param name="mediaElement"></param>
-	public void SetMetadata(AVPlayerItem? playerItem, IMediaElement? mediaElement)
+	/// <param name="cancellationToken"></param>
+	public async Task SetMetadata(AVPlayerItem? playerItem, IMediaElement? mediaElement, CancellationToken cancellationToken = default)
 	{
 		if (mediaElement is null)
 		{
-			Metadata.ClearNowPlaying();
 			return;
 		}
+		ClearNowPlaying();
+		var artwork = await MetadataArtworkMediaSource(mediaElement.MetadataArtworkSource, cancellationToken).ConfigureAwait(false);
 
-		var url = mediaElement.MetadataArtworkUrl;
-
+		if (artwork is UIImage image)
+		{
+			NowPlayingInfo.Artwork = new(boundsSize: new(320, 240), requestHandler: _ => image);
+		}
+		else
+		{
+			NowPlayingInfo.Artwork = new(boundsSize: new(0, 0), requestHandler: _ => defaultUIImage);
+		}
 		NowPlayingInfo.Title = mediaElement.MetadataTitle;
 		NowPlayingInfo.Artist = mediaElement.MetadataArtist;
 		NowPlayingInfo.PlaybackDuration = playerItem?.Duration.Seconds ?? 0;
 		NowPlayingInfo.IsLiveStream = false;
 		NowPlayingInfo.PlaybackRate = mediaElement.Speed;
 		NowPlayingInfo.ElapsedPlaybackTime = playerItem?.CurrentTime.Seconds ?? 0;
-		NowPlayingInfo.Artwork = new(boundsSize: new(320, 240), requestHandler: _ => GetImage(url));
 		MPNowPlayingInfoCenter.DefaultCenter.NowPlaying = NowPlayingInfo;
 	}
 
-	static UIImage GetImage(string imageUri)
-	{
-		try
-		{
-			if (imageUri.StartsWith(Uri.UriSchemeHttp, StringComparison.OrdinalIgnoreCase))
-			{
-				return UIImage.LoadFromData(NSData.FromUrl(new NSUrl(imageUri))) ?? defaultUIImage;
-			}
-			return defaultUIImage;
-		}
-		catch
-		{
-			return defaultUIImage;
-		}
-	}
-
 	MPRemoteCommandHandlerStatus SeekCommand(MPRemoteCommandEvent? commandEvent)
 	{
 		if (commandEvent is not MPChangePlaybackPositionCommandEvent eventArgs)
@@ -181,4 +173,111 @@ MPRemoteCommandHandlerStatus ToggleCommand(MPRemoteCommandEvent? commandEvent)
 
 		return MPRemoteCommandHandlerStatus.Success;
 	}
+
+	public static async Task<UIImage?> MetadataArtworkMediaSource(MediaSource? artworkUrl, CancellationToken cancellationToken = default)
+	{
+		switch(artworkUrl)
+		{
+			case UriMediaSource uriMediaSource:
+				var uri = uriMediaSource.Uri;
+				return GetBitmapFromUrl(uri?.AbsoluteUri);
+			case FileMediaSource fileMediaSource:
+				var uriFile = fileMediaSource.Path;
+				return await GetBitmapFromFile(uriFile, cancellationToken).ConfigureAwait(false);
+			case ResourceMediaSource resourceMediaSource:
+				var path = resourceMediaSource.Path;
+				return await GetBitmapFromResource(path, cancellationToken).ConfigureAwait(false);
+			case null:
+				return null;
+		}
+		return null;
+	}
+
+	static async Task<UIImage?> GetBitmapFromFile(string? resource, CancellationToken cancellationToken = default)
+	{
+		if (string.IsNullOrEmpty(resource))
+		{
+			System.Diagnostics.Trace.WriteLine("Metadata artwork file path is null or empty.");
+			return null;
+		}
+		if (!File.Exists(resource))
+		{
+			System.Diagnostics.Trace.WriteLine($"Metadata artwork file not found: '{resource}'.");
+			return null;
+		}
+		try
+		{
+			using var fileStream = File.OpenRead(resource);
+			using var memoryStream = new MemoryStream();
+			await fileStream.CopyToAsync(memoryStream, cancellationToken).ConfigureAwait(false);
+			memoryStream.Position = 0;
+			NSData temp = NSData.FromStream(memoryStream) ?? new NSData();
+			return UIImage.LoadFromData(temp);
+		}
+		catch (IOException ex)
+		{
+			System.Diagnostics.Trace.WriteLine($"Error reading metadata artwork file '{resource}': {ex}");
+			return null;
+		}
+		catch (UnauthorizedAccessException ex)
+		{
+			System.Diagnostics.Trace.WriteLine($"Access denied reading metadata artwork file '{resource}': {ex}");
+			return null;
+		}
+	}
+
+	static UIImage? GetBitmapFromUrl(string? resource)
+	{
+		if (string.IsNullOrEmpty(resource))
+		{
+			return null;
+		}
+
+		try
+		{
+			var nsUrl = new NSUrl(resource);
+			NSData? data = NSData.FromUrl(nsUrl);
+			if (data is null)
+			{
+				System.Diagnostics.Trace.WriteLine($"Failed to load metadata artwork from URL: '{resource}' - NSData.FromUrl returned null.");
+				return null;
+			}
+
+			UIImage? image = UIImage.LoadFromData(data);
+			if (image is null)
+			{
+				System.Diagnostics.Trace.WriteLine($"Failed to create UIImage from URL: '{resource}' - UIImage.LoadFromData returned null.");
+			}
+
+			return image;
+		}
+		catch (Exception ex)
+		{
+			System.Diagnostics.Trace.WriteLine($"Error loading metadata artwork from URL '{resource}': {ex}");
+			return null;
+		}
+	}
+	static async Task<UIImage?> GetBitmapFromResource(string? resource, CancellationToken cancellationToken = default)
+	{
+		if (string.IsNullOrWhiteSpace(resource))
+		{
+			return null;
+		}
+		using var inputStream = await FileSystem.OpenAppPackageFileAsync(resource).ConfigureAwait(false);
+		using var memoryStream = new MemoryStream();
+		if (inputStream is null)
+		{
+			System.Diagnostics.Trace.WriteLine($"Failed to open app package file: '{resource}' - stream is null.");
+			return null;
+		}
+		await inputStream.CopyToAsync(memoryStream, cancellationToken).ConfigureAwait(false);
+		memoryStream.Position = 0;
+		NSData? nsdata = NSData.FromStream(memoryStream);
+		if (nsdata is null)
+		{
+			System.Diagnostics.Trace.TraceInformation($"NSData create from stream: {nsdata} is null.");
+			return null;
+		}
+		return UIImage.LoadFromData(nsdata);
+	}
 }