Readme doc package

.github/workflows/ci.yml

@@ -33,17 +33,17 @@ jobs:
           patchBinary
           cd ios-arm64_i386_x86_64-simulator/MobileVLCKit.framework
           patchBinary
-          mkdir -p $GITHUB_WORKSPACE/build/ios-device
-          mkdir -p $GITHUB_WORKSPACE/build/ios-simulator
-          mv ios-arm64_armv7_armv7s/DynamicMobileVLCKit.framework $GITHUB_WORKSPACE/build/ios-device
-          mv ios-arm64_i386_x86_64-simulator/DynamicMobileVLCKit.framework $GITHUB_WORKSPACE/build/ios-simulator
+          mkdir -p $GITHUB_WORKSPACE/iOS/ios-device
+          mkdir -p $GITHUB_WORKSPACE/iOS/ios-simulator
+          mv ios-arm64_armv7_armv7s/DynamicMobileVLCKit.framework $GITHUB_WORKSPACE/iOS/ios-device
+          mv ios-arm64_i386_x86_64-simulator/DynamicMobileVLCKit.framework $GITHUB_WORKSPACE/iOS/ios-simulator
       - name: Setup NuGet
         uses: nuget/setup-nuget@v1
         with:
           nuget-version: '5.x'
       - name: Create LibVLC iOS NuGet package
         run: |
-          nuget pack VideoLAN.LibVLC.iOS.nuspec
+          nuget pack iOS/VideoLAN.LibVLC.iOS.nuspec
       - name: Upload build
         uses: actions/upload-artifact@v2
         with:
@@ -103,9 +103,9 @@ jobs:
       - name: Create NuGet folders
         shell: bash
         run: |
-          mkdir -p build/win10-arm/native
-          mkdir -p build/win10-x64/native
-          mkdir -p build/win10-x86/native
+          mkdir -p UWP/win10-arm/native
+          mkdir -p UWP/win10-x64/native
+          mkdir -p UWP/win10-x86/native
       - name: Download and extract UWP builds
         env:
             VLC_VERSION: 3.0.16
@@ -124,30 +124,30 @@ jobs:
           7z x x64.zip -ox64 -y
           7z x x64/vlc/win64-uwp/vlc-$VLC_VERSION-win64.7z -ox64/vlc/win64-uwp -y
 
-          mv arm/vlc/winarm-uwp/vlc-$VLC_VERSION/lua build/win10-arm/native
-          mv arm/vlc/winarm-uwp/vlc-$VLC_VERSION/plugins build/win10-arm/native
-          mv libvlc-uwp-access-build-arm/libaccess_winrt_plugin.dll build/win10-arm/native/plugins/access
-          mv arm/vlc/winarm-uwp/vlc-$VLC_VERSION/sdk build/win10-arm/native
-          mv arm/vlc/winarm-uwp/vlc-$VLC_VERSION/libvlc.dll build/win10-arm/native
-          mv arm/vlc/winarm-uwp/vlc-$VLC_VERSION/libvlccore.dll build/win10-arm/native
+          mv arm/vlc/winarm-uwp/vlc-$VLC_VERSION/lua UWP/win10-arm/native
+          mv arm/vlc/winarm-uwp/vlc-$VLC_VERSION/plugins UWP/win10-arm/native
+          mv libvlc-uwp-access-build-arm/libaccess_winrt_plugin.dll UWP/win10-arm/native/plugins/access
+          mv arm/vlc/winarm-uwp/vlc-$VLC_VERSION/sdk UWP/win10-arm/native
+          mv arm/vlc/winarm-uwp/vlc-$VLC_VERSION/libvlc.dll UWP/win10-arm/native
+          mv arm/vlc/winarm-uwp/vlc-$VLC_VERSION/libvlccore.dll UWP/win10-arm/native
 
-          mv x86/vlc/win32-uwp/vlc-$VLC_VERSION/lua build/win10-x86/native
-          mv x86/vlc/win32-uwp/vlc-$VLC_VERSION/plugins build/win10-x86/native
-          mv libvlc-uwp-access-build-x86/libaccess_winrt_plugin.dll build/win10-x86/native/plugins/access
-          mv x86/vlc/win32-uwp/vlc-$VLC_VERSION/sdk build/win10-x86/native
-          mv x86/vlc/win32-uwp/vlc-$VLC_VERSION/libvlc.dll build/win10-x86/native
-          mv x86/vlc/win32-uwp/vlc-$VLC_VERSION/libvlccore.dll build/win10-x86/native
+          mv x86/vlc/win32-uwp/vlc-$VLC_VERSION/lua UWP/win10-x86/native
+          mv x86/vlc/win32-uwp/vlc-$VLC_VERSION/plugins UWP/win10-x86/native
+          mv libvlc-uwp-access-build-x86/libaccess_winrt_plugin.dll UWP/win10-x86/native/plugins/access
+          mv x86/vlc/win32-uwp/vlc-$VLC_VERSION/sdk UWP/win10-x86/native
+          mv x86/vlc/win32-uwp/vlc-$VLC_VERSION/libvlc.dll UWP/win10-x86/native
+          mv x86/vlc/win32-uwp/vlc-$VLC_VERSION/libvlccore.dll UWP/win10-x86/native
 
-          mv x64/vlc/win64-uwp/vlc-$VLC_VERSION/lua build/win10-x64/native
-          mv x64/vlc/win64-uwp/vlc-$VLC_VERSION/plugins build/win10-x64/native
-          mv libvlc-uwp-access-build-x64/libaccess_winrt_plugin.dll build/win10-x64/native/plugins/access
-          mv x64/vlc/win64-uwp/vlc-$VLC_VERSION/sdk build/win10-x64/native
-          mv x64/vlc/win64-uwp/vlc-$VLC_VERSION/libvlc.dll build/win10-x64/native
-          mv x64/vlc/win64-uwp/vlc-$VLC_VERSION/libvlccore.dll build/win10-x64/native
+          mv x64/vlc/win64-uwp/vlc-$VLC_VERSION/lua UWP/win10-x64/native
+          mv x64/vlc/win64-uwp/vlc-$VLC_VERSION/plugins UWP/win10-x64/native
+          mv libvlc-uwp-access-build-x64/libaccess_winrt_plugin.dll UWP/win10-x64/native/plugins/access
+          mv x64/vlc/win64-uwp/vlc-$VLC_VERSION/sdk UWP/win10-x64/native
+          mv x64/vlc/win64-uwp/vlc-$VLC_VERSION/libvlc.dll UWP/win10-x64/native
+          mv x64/vlc/win64-uwp/vlc-$VLC_VERSION/libvlccore.dll UWP/win10-x64/native
       - name: Package NuGet
         shell: bash
         run: |
-          mono nuget.exe pack VideoLAN.LibVLC.UWP.nuspec
+          mono nuget.exe pack UWP/VideoLAN.LibVLC.UWP.nuspec
       - name: Upload NuGet package
         uses: actions/upload-artifact@v2
         with:

Android/README.md

@@ -0,0 +1,42 @@
+# LibVLC for Android
+
+As it is native code, you will need to use a wrapper library such as [LibVLCSharp](https://code.videolan.org/videolan/LibVLCSharp) to use it from .NET.
+
+## What is libvlc?
+
+`libvlc` is the multimedia framework powering the VLC applications. It is fully opensource, so other apps use it too.
+
+**API documentation**: https://www.videolan.org/developers/vlc/doc/doxygen/html/group__libvlc.html
+
+it contains all modules, data structures and functions documentation to understand how to use the `libvlc` C API.
+
+The **source** is in the main VLC repository: https://github.com/videolan/vlc
+
+`libvlc` is *modularized* into hundreds of plugins, which may be loaded at runtime. This architecture provides great flexibility to developers (both VLC devs and devs consuming the library). The unified, complete and (somewhat) high level `libvlc` C API allows a wide range of operations, such as:
+
+- Play every media file formats, every codec and every streaming protocols
+- Run on every platform, from desktop (Windows, Linux, Mac) to mobile (Android, iOS) and TVs
+- Hardware and efficient decoding on every platform, up to 8K
+- Network browsing for distant filesystems (SMB, FTP, SFTP, NFS...) and servers (UPnP, DLNA)
+- Playback of Audio CD, DVD and Bluray with menu navigation
+- Support for HDR, including tonemapping for SDR streams
+- Audio passthrough with SPDIF and HDMI, including for Audio HD codecs, like DD+, TrueHD or DTS-HD
+- Support for video and audio filters
+- Support for 360 video and 3D audio playback, including Ambisonics
+- Able to cast and stream to distant renderers, like Chromecast and UPnP renderers.
+
+Full list of the new 3.0 features can be found here: https://www.videolan.org/vlc/releases/3.0.0.html
+
+```cmd
+dotnet add package VideoLAN.LibVLC.Android
+```
+
+[![NuGet Stats](https://img.shields.io/nuget/v/VideoLAN.LibVLC.Android.svg)](https://www.nuget.org/packages/VideoLAN.LibVLC.Android)
+[![NuGet Stats](https://img.shields.io/nuget/dt/VideoLAN.LibVLC.Android.svg)](https://www.nuget.org/packages/VideoLAN.LibVLC.Android)
+
+## Supported CPU architectures
+
+- armeabi-v7a
+- arm64-v8a
+- x86
+- x86_64

VideoLAN.LibVLC.Android.nuspec → Android/VideoLAN.LibVLC.Android.nuspec

@@ -14,18 +14,20 @@ As it is native code, you will need to use a wrapper library such as LibVLCSharp
     <projectUrl>https://code.videolan.org/videolan/libvlc-nuget</projectUrl>
     <license type="expression">LGPL-2.1-or-later</license>
     <icon>icon.png</icon>
+    <readme>README.md</readme>
     <releaseNotes>https://code.videolan.org/videolan/vlc/blob/master/NEWS</releaseNotes>
   </metadata>
   <files>
-    <file src="build\VideoLAN.LibVLC.Android.targets" target="build\VideoLAN.LibVLC.Android.targets"/>
-    <file src="build\android-armv7\libvlc.so" target="build\android-armv7\libvlc.so"/>
-    <file src="build\android-armv7\libc++_shared.so" target="build\android-armv7\libc++_shared.so"/>
-    <file src="build\android-armv8\libvlc.so" target="build\android-armv8\libvlc.so"/>
-    <file src="build\android-armv8\libc++_shared.so" target="build\android-armv8\libc++_shared.so"/>
-    <file src="build\android-x86\libvlc.so" target="build\android-x86\libvlc.so"/>
-    <file src="build\android-x86\libc++_shared.so" target="build\android-x86\libc++_shared.so"/>
-    <file src="build\android-x86_64\libvlc.so" target="build\android-x86_64\libvlc.so"/>
-    <file src="build\android-x86_64\libc++_shared.so" target="build\android-x86_64\libc++_shared.so"/>
-    <file src="icon.png" target="" />
+    <file src="VideoLAN.LibVLC.Android.targets" target="VideoLAN.LibVLC.Android.targets"/>
+    <file src="android-armv7\libvlc.so" target="android-armv7\libvlc.so"/>
+    <file src="android-armv7\libc++_shared.so" target="android-armv7\libc++_shared.so"/>
+    <file src="android-armv8\libvlc.so" target="android-armv8\libvlc.so"/>
+    <file src="android-armv8\libc++_shared.so" target="android-armv8\libc++_shared.so"/>
+    <file src="android-x86\libvlc.so" target="android-x86\libvlc.so"/>
+    <file src="android-x86\libc++_shared.so" target="android-x86\libc++_shared.so"/>
+    <file src="android-x86_64\libvlc.so" target="android-x86_64\libvlc.so"/>
+    <file src="android-x86_64\libc++_shared.so" target="android-x86_64\libc++_shared.so"/>
+    <file src="..\icon.png" target="" />
+    <file src="README.md" target="" />
   </files>
 </package>

UWP/README.md

@@ -0,0 +1,41 @@
+# LibVLC for UWP
+
+As it is native code, you will need to use a wrapper library such as [LibVLCSharp](https://code.videolan.org/videolan/LibVLCSharp) to use it from .NET.
+
+## What is libvlc?
+
+`libvlc` is the multimedia framework powering the VLC applications. It is fully opensource, so other apps use it too.
+
+**API documentation**: https://www.videolan.org/developers/vlc/doc/doxygen/html/group__libvlc.html
+
+it contains all modules, data structures and functions documentation to understand how to use the `libvlc` C API.
+
+The **source** is in the main VLC repository: https://github.com/videolan/vlc
+
+`libvlc` is *modularized* into hundreds of plugins, which may be loaded at runtime. This architecture provides great flexibility to developers (both VLC devs and devs consuming the library). The unified, complete and (somewhat) high level `libvlc` C API allows a wide range of operations, such as:
+
+- Play every media file formats, every codec and every streaming protocols
+- Run on every platform, from desktop (Windows, Linux, Mac) to mobile (Android, iOS) and TVs
+- Hardware and efficient decoding on every platform, up to 8K
+- Network browsing for distant filesystems (SMB, FTP, SFTP, NFS...) and servers (UPnP, DLNA)
+- Playback of Audio CD, DVD and Bluray with menu navigation
+- Support for HDR, including tonemapping for SDR streams
+- Audio passthrough with SPDIF and HDMI, including for Audio HD codecs, like DD+, TrueHD or DTS-HD
+- Support for video and audio filters
+- Support for 360 video and 3D audio playback, including Ambisonics
+- Able to cast and stream to distant renderers, like Chromecast and UPnP renderers.
+
+Full list of the new 3.0 features can be found here: https://www.videolan.org/vlc/releases/3.0.0.html
+
+```cmd
+dotnet add package VideoLAN.LibVLC.UWP
+```
+
+[![NuGet Stats](https://img.shields.io/nuget/v/VideoLAN.LibVLC.UWP.svg)](https://www.nuget.org/packages/VideoLAN.LibVLC.UWP)
+[![NuGet Stats](https://img.shields.io/nuget/dt/VideoLAN.LibVLC.UWP.svg)](https://www.nuget.org/packages/VideoLAN.LibVLC.UWP)
+
+## Supported CPU architectures
+
+- i386
+- x86_64
+- ARMv7

VideoLAN.LibVLC.UWP.nuspec → UWP/VideoLAN.LibVLC.UWP.nuspec

@@ -20,10 +20,11 @@ Use this LibVLC build for Windows Universal projects (UAP) on Windows 10 Desktop
   </metadata>
   <files>
     <!-- https://code.videolan.org/videolan/vlc/-/commit/c900a2183f8988f32e60afdcae3aa398387295f1 -->
-    <file src="build\VideoLAN.LibVLC.UWP.targets" target="build\VideoLAN.LibVLC.UWP.targets"/>
-    <file src="build\win10-x86\native\**" target="build\win10-x86"/>
-    <file src="build\win10-x64\native\**" target="build\win10-x64"/>
-    <file src="build\win10-arm\native\**" target="build\win10-arm"/>
-    <file src="icon.png" target="" />
+    <file src="VideoLAN.LibVLC.UWP.targets" target="VideoLAN.LibVLC.UWP.targets"/>
+    <file src="win10-x86\native\**" target="runtimes\win10-x86\native"/>
+    <file src="win10-x64\native\**" target="runtimes\win10-x64\native"/>
+    <file src="win10-arm\native\**" target="runtimes\win10-arm\native"/>
+    <file src="..\icon.png" target="" />
+    <file src="README.md" target="" />
   </files>
 </package>

build/VideoLAN.LibVLC.UWP.targets → UWP/VideoLAN.LibVLC.UWP.targets

@@ -31,39 +31,39 @@
     <!-- x64 -->
     <ItemGroup Condition="'$(VlcUWPX64Enabled)' == 'true'">
       <!-- Expand selectors and compute absolute paths for include, exclude and MainLibraries -->
-      <VlcUWPX64IncludeFilesFullPath Include="$([MSBuild]::Unescape($(MSBuildThisFileDirectory)..\build\win10-x64\%(VlcUWPX64IncludeFiles.Identity)))" />
-      <VlcUWPX64ExcludeFilesFullPath Include="$([MSBuild]::Unescape($(MSBuildThisFileDirectory)..\build\win10-x64\%(VlcUWPX64ExcludeFiles.Identity)))" 
+      <VlcUWPX64IncludeFilesFullPath Include="$([MSBuild]::Unescape($(MSBuildThisFileDirectory)..\runtimes\win10-x64\native\%(VlcUWPX64IncludeFiles.Identity)))" />
+      <VlcUWPX64ExcludeFilesFullPath Include="$([MSBuild]::Unescape($(MSBuildThisFileDirectory)..\runtimes\win10-x64\native\%(VlcUWPX64ExcludeFiles.Identity)))" 
         Condition="'%(VlcUWPX64ExcludeFiles.Identity)'!=''" />
 
       <!-- We have gathered all the full path of what should be copied and what should be skipped, let's include that as Content that gets copied -->
       <Content Include="@(VlcUWPX64IncludeFilesFullPath)" Exclude="@(VlcUWPX64ExcludeFilesFullPath)">
-        <Link>$([MSBuild]::MakeRelative($(MSBuildThisFileDirectory)..\build\win10-x64\, %(FullPath)))</Link>
+        <Link>$([MSBuild]::MakeRelative($(MSBuildThisFileDirectory)..\runtimes\win10-x64\native\, %(FullPath)))</Link>
         <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
       </Content>
     </ItemGroup>
 
     <!-- x86 -->
     <ItemGroup Condition="'$(VlcUWPX86Enabled)' == 'true'">
       <!-- Expand selectors and compute absolute paths for include, exclude and MainLibraries -->
-      <VlcUWPX86IncludeFilesFullPath Include="$([MSBuild]::Unescape($(MSBuildThisFileDirectory)..\build\win10-x86\%(VlcUWPX86IncludeFiles.Identity)))" />
-      <VlcUWPX86ExcludeFilesFullPath Include="$([MSBuild]::Unescape($(MSBuildThisFileDirectory)..\build\win10-x86\%(VlcUWPX86ExcludeFiles.Identity)))" Condition="'%(VlcWindowsX86ExcludeFiles.Identity)'!=''" />
+      <VlcUWPX86IncludeFilesFullPath Include="$([MSBuild]::Unescape($(MSBuildThisFileDirectory)..\runtimes\win10-x86\native\%(VlcUWPX86IncludeFiles.Identity)))" />
+      <VlcUWPX86ExcludeFilesFullPath Include="$([MSBuild]::Unescape($(MSBuildThisFileDirectory)..\runtimes\win10-x86\native\%(VlcUWPX86ExcludeFiles.Identity)))" Condition="'%(VlcWindowsX86ExcludeFiles.Identity)'!=''" />
 
       <!-- We have gathered all the full path of what should be copied and what should be skipped, let's include that as Content that gets copied -->
       <Content Include="@(VlcUWPX86IncludeFilesFullPath)" Exclude="@(VlcUWPX86ExcludeFilesFullPath)">
-        <Link>$([MSBuild]::MakeRelative($(MSBuildThisFileDirectory)..\build\win10-x86\, %(FullPath)))</Link>
+        <Link>$([MSBuild]::MakeRelative($(MSBuildThisFileDirectory)..\runtimes\win10-x86\native\, %(FullPath)))</Link>
         <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
       </Content>
     </ItemGroup>
 
      <!-- ARM -->
     <ItemGroup Condition="'$(VlcUWPARMEnabled)' == 'true'">
       <!-- Expand selectors and compute absolute paths for include, exclude and MainLibraries -->
-      <VlcUWPARMIncludeFilesFullPath Include="$([MSBuild]::Unescape($(MSBuildThisFileDirectory)..\build\win10-arm\%(VlcUWPARMIncludeFiles.Identity)))" />
-      <VlcUWPARMExcludeFilesFullPath Include="$([MSBuild]::Unescape($(MSBuildThisFileDirectory)..\build\win10-arm\%(VlcUWPARMExcludeFiles.Identity)))" Condition="'%(VlcWindowsARMExcludeFiles.Identity)'!=''" />
+      <VlcUWPARMIncludeFilesFullPath Include="$([MSBuild]::Unescape($(MSBuildThisFileDirectory)..\runtimes\win10-arm\native\%(VlcUWPARMIncludeFiles.Identity)))" />
+      <VlcUWPARMExcludeFilesFullPath Include="$([MSBuild]::Unescape($(MSBuildThisFileDirectory)..\runtimes\win10-arm\native\%(VlcUWPARMExcludeFiles.Identity)))" Condition="'%(VlcWindowsARMExcludeFiles.Identity)'!=''" />
 
       <!-- We have gathered all the full path of what should be copied and what should be skipped, let's include that as Content that gets copied -->
       <Content Include="@(VlcUWPARMIncludeFilesFullPath)" Exclude="@(VlcUWPARMExcludeFilesFullPath)">
-        <Link>$([MSBuild]::MakeRelative($(MSBuildThisFileDirectory)..\build\win10-arm\, %(FullPath)))</Link>
+        <Link>$([MSBuild]::MakeRelative($(MSBuildThisFileDirectory)..\runtimes\win10-arm\native\, %(FullPath)))</Link>
         <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
       </Content>
     </ItemGroup>

Windows/README.md

@@ -0,0 +1,43 @@
+# LibVLC for Windows
+
+As it is native code, you will need to use a wrapper library such as [LibVLCSharp](https://code.videolan.org/videolan/LibVLCSharp) to use it from .NET.
+
+_note: If you are looking to target modern Windows (UWP, Xbox, etc.), the NuGet you want is [VideoLAN.LibVLC.UWP](https://www.nuget.org/packages/VideoLAN.LibVLC.UWP) instead._
+
+## What is libvlc?
+
+`libvlc` is the multimedia framework powering the VLC applications. It is fully opensource, so other apps use it too.
+
+**API documentation**: https://www.videolan.org/developers/vlc/doc/doxygen/html/group__libvlc.html
+
+it contains all modules, data structures and functions documentation to understand how to use the `libvlc` C API.
+
+The **source** is in the main VLC repository: https://github.com/videolan/vlc
+
+`libvlc` is *modularized* into hundreds of plugins, which may be loaded at runtime. This architecture provides great flexibility to developers (both VLC devs and devs consuming the library). The unified, complete and (somewhat) high level `libvlc` C API allows a wide range of operations, such as:
+
+- Play every media file formats, every codec and every streaming protocols
+- Run on every platform, from desktop (Windows, Linux, Mac) to mobile (Android, iOS) and TVs
+- Hardware and efficient decoding on every platform, up to 8K
+- Network browsing for distant filesystems (SMB, FTP, SFTP, NFS...) and servers (UPnP, DLNA)
+- Playback of Audio CD, DVD and Bluray with menu navigation
+- Support for HDR, including tonemapping for SDR streams
+- Audio passthrough with SPDIF and HDMI, including for Audio HD codecs, like DD+, TrueHD or DTS-HD
+- Support for video and audio filters
+- Support for 360 video and 3D audio playback, including Ambisonics
+- Able to cast and stream to distant renderers, like Chromecast and UPnP renderers.
+
+Full list of the new 3.0 features can be found here: https://www.videolan.org/vlc/releases/3.0.0.html
+
+```cmd
+dotnet add package VideoLAN.LibVLC.Windows
+```
+
+[![NuGet Stats](https://img.shields.io/nuget/v/VideoLAN.LibVLC.Windows.svg)](https://www.nuget.org/packages/VideoLAN.LibVLC.Windows)
+[![NuGet Stats](https://img.shields.io/nuget/dt/VideoLAN.LibVLC.Windows.svg)](https://www.nuget.org/packages/VideoLAN.LibVLC.Windows)
+
+## Supported CPU architectures
+
+- x64
+- x86
+- ARM32

VideoLAN.LibVLC.Windows.nuspec → Windows/VideoLAN.LibVLC.Windows.nuspec

@@ -17,9 +17,10 @@ As it is native code, you will need to use a wrapper library such as LibVLCSharp
     <releaseNotes>https://code.videolan.org/videolan/vlc/blob/master/NEWS</releaseNotes>
   </metadata>
   <files>
-    <file src="build\VideoLAN.LibVLC.Windows.targets" target="build\VideoLAN.LibVLC.Windows.targets"/>
-    <file src="build\win7-x64\native\**" target="build\x64"/>
-    <file src="build\win7-x86\native\**" target="build\x86"/>
-    <file src="icon.png" target="" />
+    <file src="VideoLAN.LibVLC.Windows.targets" target="VideoLAN.LibVLC.Windows.targets"/>
+    <file src="win7-x64\native\**" target="x64"/>
+    <file src="win7-x86\native\**" target="x86"/>
+    <file src="..\icon.png" target="" />
+    <file src="README.md" target="" />
   </files>
 </package>