Merge pull request #37 from markjamesm/soundengine-rewrite

Soundengine rewrite to enable cross-platform support.

Author: markjamesm

MusicSharpTests/SoundFlowPlayerTests.cs

@@ -0,0 +1,14 @@
+namespace MusicSharpTests;
+
+public class SoundFlowPlayerTests
+{
+    [Test]
+    public void Play_NullFile()
+    {
+        // arrange
+        var isFileValid = File.Exists("thisisafail.exe");
+
+        // act and assert
+        Assert.That(isFileValid, Is.False);
+    }
+}

MusicSharpTests/WinPlayerTests.cs

@@ -1,25 +1,20 @@
 # MusicSharp
 [![.NET](https://github.com/markjamesm/Baseball-Sharp/actions/workflows/dotnet.yml/badge.svg?branch=master)](https://github.com/markjamesm/MusicSharp/actions) [![C#](https://img.shields.io/badge/Language-CSharp-darkgreen.svg)](https://en.wikipedia.org/wiki/C_Sharp_(programming_language)) [![License](https://img.shields.io/badge/License-GPL-orange.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)
 
-MusicSharp is a cross-platform Terminal User Interface (TUI) music player written in C# (.NET 8) with the goal of being minimalistic and light on resources.
+A cross-platform Terminal User Interface (TUI) music player written in C# (.NET 8) with the goal of being minimalistic and light on resources.
 
-Currently in beta, MusicSharp makes use of the [NAudio](https://github.com/naudio/NAudio) and [Terminal.Gui](https://github.com/migueldeicaza/gui.cs) libraries. A project build log can be [found here](https://markjames.dev/blog/developing-a-cli-music-player-csharp/)
+MusicSharp makes use of the [SoundFlow](https://github.com/LSXPrime/SoundFlow) and [Terminal.Gui](https://github.com/migueldeicaza/gui.cs) libraries.
 
 ## Screenshot
 
 <img src="https://user-images.githubusercontent.com/20845425/99861949-06763200-2b66-11eb-9d5a-9bf2ea5151ee.png" alt="Screenshot of MusicSharp">
 
 ## Features
 
+- Cross-platform support (Windows, Mac, Linux).
 - Play audio files.
-- Load music playlists (M3U)
-- Audio streaming.
-- Lightweight
-
-## Planned
-
-- Save playlists.
-- Cross platform support.
+- Load and play from music playlists (M3U).
+- Streaming support.
 
 ## Installation
 

README.md

@@ -2,19 +2,21 @@
 // Licensed under the GNU GPL v3 License. See LICENSE in the project root for license information.
 // </copyright>
 
+using System;
+using System.IO;
 using MusicSharp.Enums;
 
-namespace MusicSharp.SoundEngines;
+namespace MusicSharp.AudioPlayer;
 
 /// <summary>
 /// Defines the methods an audio player class should implement.
 /// </summary>
-public interface IPlayer
+public interface IPlayer: IDisposable
 {
     /// <summary>
     /// Gets or sets a value indicating whether the audio player is playing.
     /// </summary>
-    ePlayerStatus PlayerStatus { get; set; }
+    EPlayerStatus PlayerStatus { get; set; }
 
     /// <summary>
     /// Gets or sets the last file opened by the player.
@@ -25,19 +27,14 @@ public interface IPlayer
     /// Method to play audio.
     /// </summary>
     /// <param name="path">The filepath of the audio file to play.</param>
-    void OpenFile(string path);
-
-    /// <summary>
-    /// Method to play an audio stream from a URL.
-    /// </summary>
-    /// <param name="streamUrl">The stream URL of the audio file to play.</param>
-    void OpenStream(string streamUrl);
-
+    /// /// <param name="stream">The audio stream.</param>
+    void Play(Stream stream);
+    
     /// <summary>
-    /// Method to pause audio playback.
+    /// Method to play or pause depending on state.
     /// </summary>
     void PlayPause();
-
+    
     /// <summary>
     /// Method to stop audio playback.
     /// </summary>
@@ -53,23 +50,17 @@ public interface IPlayer
     /// </summary>
     void DecreaseVolume();
 
-    /// <summary>
-    /// Play an audio file contained in a playlist.
-    /// </summary>
-    /// <param name="path">The path to the audio file.</param>
-    void PlayFromPlaylist(string path);
-
     /// <summary>
     /// Returns the current playtime of the audioFileReader instance.
     /// </summary>
     /// <returns>The current time played as TimeSpan.</returns>
-    System.TimeSpan CurrentTime();
+    float CurrentTime();
 
     /// <summary>
     /// Returns the total track length in timespan format.
     /// </summary>
     /// <returns>The length of the track in timespan format.</returns>
-    System.TimeSpan TrackLength();
+    float TrackLength();
 
     /// <summary>
     /// Skip ahead in the audio file 5s.

src/SoundEngines/IPlayer.cs renamed to src/AudioPlayer/IPlayer.cs

@@ -0,0 +1,124 @@
+using System;
+using System.IO;
+using MusicSharp.Enums;
+using SoundFlow.Backends.MiniAudio;
+using SoundFlow.Components;
+using SoundFlow.Providers;
+
+namespace MusicSharp.AudioPlayer;
+
+// Cross-platform sound engine that works for all devices which
+//  the .NET platform runs on.
+public sealed class SoundFlowPlayer : IPlayer
+{
+    private readonly MiniAudioEngine _soundEngine;
+    private SoundPlayer _player;
+
+    public EPlayerStatus PlayerStatus { get; set; }
+    public string LastFileOpened { get; set; }
+
+
+    public SoundFlowPlayer(MiniAudioEngine soundEngine)
+    {
+        _soundEngine = soundEngine;
+    }
+
+    public void Play(Stream stream)
+    {
+        if (_player != null)
+        {
+            _player.Stop();
+        }
+
+        _player = new SoundPlayer(new StreamDataProvider(stream));
+
+        // Add the player to the master mixer. This connects the player's output to the audio engine's output.
+        Mixer.Master.AddComponent(_player);
+
+        _player.Play();
+        PlayerStatus = EPlayerStatus.Playing;
+    }
+
+    public void PlayPause()
+    {
+        switch (PlayerStatus)
+        {
+            case EPlayerStatus.Playing:
+                _player.Pause();
+                PlayerStatus = EPlayerStatus.Paused;
+                break;
+            case EPlayerStatus.Paused:
+            case EPlayerStatus.Stopped:
+                _player.Play();
+                PlayerStatus = EPlayerStatus.Playing;
+                break;
+            default:
+                throw new ArgumentOutOfRangeException();
+        }
+    }
+
+    public void Stop()
+    {
+        if (PlayerStatus != EPlayerStatus.Stopped)
+        {
+            _player.Stop();
+            PlayerStatus = EPlayerStatus.Stopped;
+        }
+    }
+
+    public void IncreaseVolume()
+    {
+        // Need to verify what SoundFlow's max volume level is
+        // For now this should be enough based on testing
+        if (_player.Volume < 2.0f)
+        {
+            _player.Volume += .1f;
+        }
+    }
+
+    public void DecreaseVolume()
+    {
+        // Ensure that the volume isn't negative
+        // otherwise the player will crash
+        if (_player.Volume > .1f)
+        {
+            _player.Volume -= .1f;
+        }
+
+        if (_player.Volume <= .1f)
+        {
+            _player.Volume = 0f;
+        }
+    }
+    
+    public void SeekForward()
+    {
+        if (_player.Time < _player.Duration - 5f)
+        {
+            _player.Seek(_player.Time + 5f);
+        }
+    }
+
+    public void SeekBackwards()
+    {
+        if (_player.Time > 5f)
+        {
+            _player.Seek(_player.Time - 5f);
+        }
+    }
+    
+    public float CurrentTime()
+    {
+        return _player.Time;
+    }
+
+    public float TrackLength()
+    {
+        return _player.Duration;
+    }
+
+    public void Dispose()
+    {
+        _soundEngine.Dispose();
+    }
+}

src/AudioPlayer/SoundFlowPlayer.cs

@@ -0,0 +1,7 @@
+namespace MusicSharp.Enums;
+
+public enum EFileType
+{
+    File,
+    Stream
+}

src/Enums/EFileType.cs

@@ -3,9 +3,9 @@
 /// <summary>
 /// The status of the audio player.
 /// </summary>
-public enum ePlayerStatus
+public enum EPlayerStatus
 {
     Playing,
     Paused,
     Stopped
-}
+}

src/Enums/ePlayerStatus.cs renamed to src/Enums/EPlayerStatus.cs

@@ -0,0 +1,26 @@
+using System.IO;
+using System.Net.Http;
+using System.Threading.Tasks;
+
+namespace MusicSharp.Helpers;
+
+public class Converters
+{
+    private readonly HttpClient _httpClient;
+
+    public Converters(HttpClient httpClient)
+    {
+        _httpClient = httpClient;
+    }
+    
+    public static Stream ConvertFileToStream(string path)
+    {
+        return File.OpenRead(path);
+    }
+
+    public async Task<Stream> ConvertUrlToStream(string url)
+    {
+        var stream = await _httpClient.GetStreamAsync(url);
+        return stream;
+    }
+}

src/Helpers/Converters.cs

@@ -3,6 +3,7 @@
 // </copyright>
 
 using System.Collections.Generic;
+using System.Linq;
 using ATL.Playlist;
 
 namespace MusicSharp.Models;
@@ -22,14 +23,9 @@ public static class PlaylistLoader
     /// <param name="userPlaylist">The user specified playlist path.</param>
     public static List<string> LoadPlaylist(string userPlaylist)
     {
-        var filePaths = new List<string>();
         var theReader = PlaylistIOFactory.GetInstance().GetPlaylistIO(userPlaylist);
 
-        foreach (var s in theReader.FilePaths)
-        {
-            filePaths.Add(s);
-        }
-
-        return filePaths;
+        // Fix space formatting as SoundFlow doesn't support encoded spaces
+        return theReader.FilePaths.Select(s => s.Replace("%20", " ")).ToList();
     }
 }

src/Models/PlaylistLoader.cs

@@ -3,9 +3,10 @@
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>net8.0</TargetFramework>
-    <Version>0.4.9</Version>
+    <Version>1.0.0</Version>
     <Authors>Mark-James McDougall</Authors>
     <Company>Mark-James McDougall</Company>
+    <Nullable>enable</Nullable>
     <PackageIcon></PackageIcon>
     <ApplicationIcon>MusicSharp.ico</ApplicationIcon>
   </PropertyGroup>
@@ -19,7 +20,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="NAudio" Version="1.10.0" />
+    <PackageReference Include="SoundFlow" Version="1.0.3" />
     <PackageReference Include="Terminal.Gui" Version="0.90.3" />
     <PackageReference Include="z440.atl.core" Version="3.13.0" />
   </ItemGroup>