v2 "processors"

.github/workflows/release.yml

@@ -2,7 +2,7 @@ name: Release
 
 on:
   release:
-    types: [ created ]
+    types: [ published ]
 
 permissions:
   contents: write
@@ -11,53 +11,24 @@ jobs:
 
   release:
     runs-on: ubuntu-latest
-
-    env:
-      ReferenceUrl: https://exmod-team.github.io/SL-References/Dev.zip
-      ReferencePath: ${{ github.workspace }}/References
-
     steps:
 
-      - uses: actions/checkout@v4
-
-      - name: Set Up .NET
-        uses: actions/setup-dotnet@v4.0.1
-        with:
-          dotnet-version: 9.0.x
-
-      - name: Download References
-        run: |
-          wget -O "References.zip" ${{ env.ReferenceUrl }}
-          unzip -d ${{ env.ReferencePath }} "References.zip"
+      - uses: actions/checkout@v6
 
-      - name: Rename Assembly-CSharp
-        working-directory: ${{ env.ReferencePath }}
-        run: mv Assembly-CSharp-Publicized.dll Assembly-CSharp.dll
+      - uses: Axwabo/scpsl-references-downloader@v1
 
       - name: Build
-        run: dotnet build -c:Release -o Output
+        run: dotnet build -c Release -o Out
 
       - name: Create Bundle
-        working-directory: Output
-        run: |
-          mkdir SecretLabNAudio
-          mkdir SecretLabNAudio/bin
-          mkdir SecretLabNAudio/LICENSES
-
-          mv SecretLabNAudio.dll SecretLabNAudio/bin
-          ls | grep -E "^(NAudio|NLayer|NVorbis)" | xargs -I {0} mv {0} SecretLabNAudio/bin
-
-          cp -r ../THIRD_PARTY_LICENSES SecretLabNAudio/LICENSES
-          cp ../LICENSE SecretLabNAudio/LICENSES/SecretLabNAudio.txt
-
-          cd SecretLabNAudio
-          zip -r ../SecretLabNAudio.zip .
+        working-directory: Out
+        run: ${{ github.workspace }}/bundle.sh
 
       - name: Upload Assets
         uses: softprops/action-gh-release@v2
         with:
-          files: Output/SecretLabNAudio*.dll,Output/SecretLabNAudio*.xml,Output/SecretLabNAudio.zip
+          files: Out/SecretLabNAudio*.dll,Out/SecretLabNAudio*.xml,Out/SecretLabNAudio.zip
 
       - name: Push to NuGet
-        working-directory: Output
+        working-directory: Out
         run: dotnet nuget push SecretLabNAudio.*.nupkg -k ${{ secrets.NUGET_API_KEY }} -s https://api.nuget.org/v3/index.json

Directory.Build.props

@@ -2,10 +2,11 @@
     <PropertyGroup>
         <TargetFramework>net48</TargetFramework>
         <Nullable>enable</Nullable>
-        <LangVersion>13</LangVersion>
+        <LangVersion>14</LangVersion>
         <PlatformTarget>x64</PlatformTarget>
         <DisableImplicitFrameworkReferences>true</DisableImplicitFrameworkReferences>
-        <Version>1.0.2</Version>
+        <Version>2.0.0</Version>
+        <PackageVersion>2.0.0-alpha5</PackageVersion>
     </PropertyGroup>
 
     <ItemGroup>
@@ -14,24 +15,26 @@
     </ItemGroup>
 
     <ItemGroup>
-        <Reference Include="mscorlib" Private="false" />
-        <Reference Include="System" Private="false" />
-        <Reference Include="System.Core" Private="false" />
-        <Reference Include="System.Data" Private="false" />
+        <Reference Include="mscorlib" />
+        <Reference Include="System" />
+        <Reference Include="System.Core" />
+        <Reference Include="System.Data" />
     </ItemGroup>
 
     <ItemGroup>
-        <Reference Include="Assembly-CSharp" Private="false" />
-        <Reference Include="Mirror" Private="false" />
-        <Reference Include="UnityEngine.CoreModule" Private="false" />
+        <Reference Include="Assembly-CSharp" />
+        <Reference Include="Mirror" />
+        <Reference Include="UnityEngine.CoreModule" />
     </ItemGroup>
 
     <ItemGroup>
         <Using Include="System" />
+        <Using Include="System.Collections.Generic" />
+        <Using Include="System.Diagnostics.CodeAnalysis" />
+        <Using Include="System.IO" />
         <Using Include="LabApi.Features.Wrappers" />
         <Using Include="Mirror" />
         <Using Include="NAudio.Wave" />
-        <Using Include="SecretLabNAudio.Core.Extensions" />
         <Using Include="UnityEngine" />
         <Using Include="UnityEngine.Object" Alias="Object" />
     </ItemGroup>

Directory.Build.targets

@@ -1,21 +1,22 @@
 <Project>
-    <Import Project="ReferencePath.props.user" Condition="Exists('ReferencePath.props.user')"/>
+    <Import Project="ReferencePath.props.user" Condition="Exists('ReferencePath.props.user')" />
     <PropertyGroup>
         <ReferencePath Condition="$(ReferencePath) == ''">$(SL_REFERENCES)</ReferencePath>
         <AssemblySearchPaths>$(ReferencePath);$(AssemblySearchPaths)</AssemblySearchPaths>
     </PropertyGroup>
-    
+
     <Target Name="NotifyIncompleteSetup" BeforeTargets="PrepareForBuild" Condition="$(ReferencePath) == ''">
         <PropertyGroup>
-            <Template>
-&lt;Project&gt;
-    &lt;PropertyGroup&gt;
-        &lt;ReferencePath&gt;&lt;/ReferencePath&gt;
-    &lt;/PropertyGroup&gt;
-&lt;/Project&gt;
-            </Template>
+            <Props>$(MSBuildThisFileDirectory)ReferencePath.props.user</Props>
+            <Template><![CDATA[
+<Project>
+    <PropertyGroup>
+        <ReferencePath></ReferencePath>
+    </PropertyGroup>
+</Project>
+            ]]></Template>
         </PropertyGroup>
-        <WriteLinesToFile File="$(MSBuildThisFileDirectory)ReferencePath.props.user" Lines="$(Template)" Condition="!Exists('$(MSBuildThisFileDirectory)ReferencePath.props.user')" />
+        <WriteLinesToFile File="$(Props)" Lines="$(Template)" Condition="!Exists($(Props))" />
         <Error Text="The ReferencePath property is not specified! Make sure to set the property in the ReferencePath.props.user file." />
     </Target>
 </Project>

Directory.Packages.props

@@ -5,7 +5,7 @@
 
     <ItemGroup>
         <PackageVersion Include="NAudio.Core" Version="2.2.1" />
-        <PackageVersion Include="Northwood.LabAPI" Version="1.1.3" />
+        <PackageVersion Include="Northwood.LabAPI" Version="1.1.5" />
 
         <PackageVersion Include="NAudio.Wasapi" Version="2.2.1" />
 

README.md

@@ -7,6 +7,9 @@ This library has a number of open-source dependencies. See [Attributions](ATTRIB
 > [!NOTE]
 > SecretLabNAudio is not sponsored nor endorsed by NAudio.
 
+> [!IMPORTANT]
+> If you're still using v1, [migrate to v2](https://github.com/Axwabo/SecretLabNAudio/wiki/Migration-Guide)
+
 # Features
 
 [Watch the demo](https://youtu.be/6btaXm3BU8s)
@@ -25,15 +28,16 @@ This library has a number of open-source dependencies. See [Attributions](ATTRIB
 
 > [!TIP]
 > Check the [wiki](https://github.com/Axwabo/SecretLabNAudio/wiki) for more information.
+> See [this page](https://github.com/Axwabo/SecretLabNAudio/wiki/Examples) for examples.
 
 # Installation
 
 ## Single-File
 
 1. Download the `SecretLabNAudio.zip` file from the [releases page](https://github.com/Axwabo/SecretLabNAudio/releases)
 2. Extract `bin/SecretLabNAudio.dll` from the archive into the **global plugins** directory
-    - Linux: `.config/SCP Secret Laboratory/LabAPI/plugins/global/`
-    - Windows: `%appdata%/SCP Secret Laboratory/LabAPI/plugins/global/`
+   - Linux: `~/.config/SCP Secret Laboratory/LabAPI/plugins/global/`
+   - Windows: `%appdata%/SCP Secret Laboratory/LabAPI/plugins/global/`
 3. Restart the server
 
 > [!IMPORTANT]
@@ -43,23 +47,30 @@ This library has a number of open-source dependencies. See [Attributions](ATTRIB
 ## Modular
 
 1. Download the `SecretLabNAudio.Core.dll` file from the [releases page](https://github.com/Axwabo/SecretLabNAudio/releases)
-2. Place the file in the **dependencies** directory
-    - Linux: `.config/SCP Secret Laboratory/LabAPI/dependencies/<port>/`
-    - Windows: `%appdata%/SCP Secret Laboratory/LabAPI/dependencies/<port>/`
-3. Download the `SecretLabNAudio.zip` file from the releases page
-4. Extract the necessary files from the `bin/` directory of the archive as **dependencies**
-    - `NAudio.Core.dll` is **always required**
-    - `NLayer` and `NLayer.NAudioSpport.dll` for `.mp3` support (optional)
-    - `NAudio.Vorbis.dll` and `NVorbis.dll` for `.ogg` support (optional)
-    - `NAudio.Wasapi.dll` for Media Foundation support (optional, WIndows-only)
-5. Optionally download the necessary **plugin(s)** from the releases page
-    - `SecretLabNAudio.NLayer.dll` for `.mp3` support
-    - `SecretLabNAudio.NVorbis.dll` for `.ogg` support
-    - `SecretLabNAudio.MediaFoundation.dll` for Media Foundation support (Windows-only)
-6. Place the downloaded plugin(s) into the **plugins** directory
-    - Linux: `.config/SCP Secret Laboratory/LabAPI/plugins/<port>/`
-    - Windows: `%appdata%/SCP Secret Laboratory/LabAPI/plugins/<port>/`
-7. Restart the server
+2. Download the `SecretLabNAudio.zip` file from the releases page
+3. Extract the necessary DLLs from the `bin/` directory
+   - See the [table below](#modules) for what you need
+   - Place dependencies into the **dependencies** directory
+     - Linux: `~/.config/SCP Secret Laboratory/LabAPI/dependencies/<port>/`
+     - Windows: `%appdata%/SCP Secret Laboratory/LabAPI/dependencies/<port>/`
+   - Place plugins into the **plugins** directory
+     - Linux: `~/.config/SCP Secret Laboratory/LabAPI/plugins/<port>/`
+     - Windows: `%appdata%/SCP Secret Laboratory/LabAPI/plugins/<port>/`
+4. Restart the server
+
+### Modules
+
+To support reading from some file formats, install the modules you need.
+
+| Usage        | Plugin                             | Dependencies                                  |
+|--------------|------------------------------------|-----------------------------------------------|
+| **required** | (none)                             | `SecretLabNAudio.Core` `NAudio.Core`          |
+| mp3          | `SecretLabNAudio.NLayer`           | `NLayer` `NLayer.NAudioSupport`               |
+| ogg          | `SecretLabNAudio.NVorbis`          | `NVorbis` `NAudio.Vorbis` `System.ValueTuple` |
+| most formats | `SecretLabNAudio.MediaFoundation`* | `NAudio.Wasapi`*                              |
+
+> [!NOTE]
+> *MediaFoundation is only available on Windows.
 
 ## Development
 

SecretLabNAudio.Core/AudioPlayer.Create.cs

@@ -1,4 +1,6 @@
-namespace SecretLabNAudio.Core;
+using SecretLabNAudio.Core.Extensions;
+
+namespace SecretLabNAudio.Core;
 
 public partial class AudioPlayer
 {

SecretLabNAudio.Core/AudioPlayer.Format.cs

@@ -23,14 +23,7 @@ public partial class AudioPlayer
 
     /// <summary>Checks if the given provider is not compatible with <see cref="AudioPlayer"/>s.</summary>
     /// <param name="provider">The provider to check. Null values are skipped.</param>
-    /// <exception cref="ArgumentException">
-    /// Thrown when the given sample provider is not null and does not match the following criteria:
-    /// <para>
-    /// Encoding = <see cref="WaveFormatEncoding.IeeeFloat"/><br/>
-    /// Sample Rate = <see cref="SampleRate"/><br/>
-    /// Channels = <see cref="Channels"/>
-    /// </para>
-    /// </exception>
+    /// <include file='XmlDocs/Providers.xml' path='doc/Format/exception'/>
     public static void ThrowIfIncompatible(ISampleProvider? provider)
     {
         if (provider is {WaveFormat: not {SampleRate: SampleRate, Channels: Channels, Encoding: WaveFormatEncoding.IeeeFloat}})