[Meta] Player Comparison Page (#1302)

* Create Players.md * Update Players.md * Rename Players.md to PLAYERS.md * Update PLAYERS.md * Rename PLAYERS.md to Players.md * Update and rename Players.md to players.md * Update players.md * Update players.md final version * Update players.md Actual last one * Update README.md Add player section * Update players.md Make note that transcoding exists. * Home Theater Audio Delays + Subtitle Support Quirks * Update players.md Update to include codecs that are not supported by either video player. * Update players.md HDR Section & Notes * HDR 2x Section -> 1 Section * Disclaimer update * Update players.md HDR disclaimers * Update players.md Requires AV1 for Dolby Vision 10 * Update players.md * Update players.md AV1 disclaimer * HLG notes Finally done! * Update players.md * create Documentation folder --------- Co-authored-by: Ethan Pippin <ethanpippin2343@gmail.com>
2024-11-23 05:59:51 +00:00 · 2024-11-04 16:21:18 -07:00 · 2024-11-04 16:21:18 -07:00 · 83843e2173
commit 83843e2173
parent bcc1b6e733
3 changed files with 144 additions and 1 deletions
--- a/Documentation/contributing.md
+++ b/Documentation/contributing.md
--- a/Documentation/players.md
+++ b/Documentation/players.md
@ -0,0 +1,139 @@
+# Player Differences
+
+Swiftfin offers two player options: Swiftfin (VLCKit) and Native (AVKit). The Swiftfin team recommends using Swiftfin (VLCKit) for optimal compatibility and features, though Native (AVKit) is also available for certain cases that benefit from Apple's native capabilities. All video, audio, and subtitle formats listed are supported for direct playback but may be repackaged based on container support. If transcoding is enabled on your server, any unsupported formats will be converted automatically.
+
+---
+
+## Feature Support
+
+| Feature                 | Swiftfin (VLCKit) | Native (AVKit) |
+|-------------------------|-------------------|----------------|
+| **Framerate Matching**  | ❌                | ✅             |
+| **HDR to SDR Tonemapping** | ✅ [1]         | 🟡 Limited (MP4 only) [2] |
+| **Player Controls**     | - Speed adjustment<br>- Aspect Fill<br>- Chapter Support<br>- Subtitle Support<br>- Audio Track Selection<br>- Customizable UI | - Speed adjustment<br>- Aspect Fill |
+| **Picture-in-Picture**  | ❌                | ✅             |
+| **TLS Support**         | 1.1, 1.2 [3]     | 1.1, 1.2, 1.3 |
+| **[Airplay Audio Output](https://support.apple.com/en-us/102357)** | 🟡 [4] | ✅ |
+
+**Notes**
+
+[1] HDR to SDR Tonemapping on Swiftfin (VLCKit) may have colorspace accuracy variations depending on content and device configuration.
+
+[2] In Native (AVKit), HDR playback works regardless of DirectPlay or MP4 container format. However, HDR to SDR Tonemapping requires DirectPlaying compatible MP4 files and may require Dolby Vision Profiles 5 & 8 for full support.
+
+[3] Swiftfin (VLCKit) does not support TLS 1.3.
+
+[4] Swiftfin (VLCKit) has a [known bug that results in a significant audio delay](https://code.videolan.org/videolan/VLCKit/-/issues/544).
+
+---
+
+## Container Support
+
+| Container | Swiftfin (VLCKit) | Native (AVKit) |
+|-----------|-------------------|----------------|
+| **AVI**   | ✅                | 🟡 Limited support |
+| **FLV**   | ✅                | ❌             |
+| **M4V**   | ✅                | ✅             |
+| **MKV**   | ✅                | ❌             |
+| **MOV**   | ✅                | ✅             |
+| **MP4**   | ✅                | ✅             |
+| **MPEG-TS** | ✅              | 🟡 Limited support |
+| **TS**    | ✅                | 🟡 Limited support |
+| **3G2**   | ✅                | ✅             |
+| **3GP**   | ✅                | ✅             |
+| **WebM**  | ✅                | ❌             |
+
+**Notes**
+
+- Unsupported containers will require transcoding or remuxing to play.
+- AV1 is disabled by default but can be enabled for Native (AVKit) using Custom Device Profiles.
+
+---
+
+## Audio Support
+
+| Audio Codec   | Swiftfin (VLCKit) | Native (AVKit) |
+|---------------|-------------------|----------------|
+| **AAC**       | ✅                | ✅             |
+| **AC3**       | ✅                | ✅             |
+| **ALAC**      | ✅                | ✅             |
+| **AMR NB**    | ✅                | ✅             |
+| **AMR WB**    | ✅                | ❌             |
+| **DTS**       | ✅                | ❌             |
+| **DTS-HD**    | ❌                | ❌             |
+| **EAC3**      | ✅                | ✅             |
+| **FLAC**      | ✅                | ✅             |
+| **MP1**       | ✅                | ❌             |
+| **MP2**       | ✅                | ❌             |
+| **MP3**       | ✅                | ✅             |
+| **MLP**       | ❌                | ❌             |
+| **Nellymoser**| ✅                | ❌             |
+| **Opus**      | ✅                | ❌             |
+| **PCM**       | ✅                | 🟡 Limited support |
+| **Speex**     | ✅                | ❌             |
+| **TrueHD**    | ❌                | ❌             |
+| **Vorbis**    | ✅                | ❌             |
+| **WavPack**   | ✅                | ❌             |
+| **WMA**       | ✅                | ❌             |
+| **WMA Lossless**| ✅              | ❌             |
+| **WMA Pro**   | ✅                | ❌             |
+
+- Audio track selection is not currently supported in Native (AVKit) due to issues with HLS file incompatibilities.
+
+---
+
+## Video Support
+
+| Video Codec | Swiftfin (VLCKit) | Native (AVKit) |
+|-------------|-------------------|----------------|
+| **AV1**     | ✅                | ❌             |
+| **H.264**   | ✅                | ✅             |
+| **H.265**   | ✅                | ✅             |
+| **MPEG-2**  | ✅                | ❌             |
+| **MPEG-4**  | ✅                | ✅             |
+| **VP8**     | ✅                | ❌             |
+| **VP9**     | ✅                | ❌             |
+
+---
+
+## Subtitle Support
+
+| Subtitle Format | Swiftfin (VLCKit) | Native (AVKit) |
+|----------------|-------------------|----------------|
+| **ASS**        | ✅                | ❌             |
+| **CC_DEC**     | ✅                | 🟡             |
+| **DVBSub**     | ✅                | ❌             |
+| **DVDSub**     | ✅                | ❌             |
+| **PGSSub**     | ✅                | ❌             |
+| **SRT**        | ✅                | ❌             |
+| **SSA**        | ✅                | ❌             |
+| **Teletext**   | ✅                | ❌             |
+| **TTML**       | ✅                | 🟡             |
+| **VTT**        | ✅                | 🟡             |
+| **XSub**       | ✅                | ❌             |
+
+**Notes**
+
+- Subtitle track selection is not currently supported in Native (AVKit) due to issues with HLS file incompatibilities.
+
+---
+
+## HDR Support
+
+| Format | Swiftfin (VLCKit) | Native (AVKit) |
+|--------|-------------------|----------------|
+| **Dolby Vision Profile 5** | ❌             | ✅             |
+| **Dolby Vision Profile 8** | ❌             | 🟡 Compatible devices only |
+| **Dolby Vision Profile 10** | ❌            | 🟡 Requires AV1 |
+| **HDR10** | ❌                              | ✅             |
+| **HDR10+** | ❌                             | 🟡 Limited support |
+| **HLG** | ❌                                | ❌             |
+
+**Notes**
+
+- HDR10+ support in Native (AVKit) is limited to certain devices, such as the Apple TV 4K (3rd Generation) and recent iPhones and iPads with compatible hardware.
+- HLG (Hybrid Log-Gamma) support in Native (AVKit) is limited and not currently supported in Swiftin.
+- Dolby Vision Profile 10 requires AV1 to be enabled to work in Native (AVKit).
+- Swiftfin (VLCKit) does not support HDR playback natively. HDR content may play back without the intended high dynamic range effect.
+
+--- 
--- a/README.md
+++ b/README.md
@ -40,7 +40,7 @@ Use the TestFlight version to test new features and bug fixes before being publi

 ## ⚙️ Development

-Thank you for your interest in Swiftfin! Please check out the [Contribution Guidelines](https://github.com/jellyfin/Swiftfin/blob/main/contributing.md) to get started.
+Thank you for your interest in Swiftfin! Please check out the [Contribution Guidelines](https://github.com/jellyfin/Swiftfin/blob/main/Documentation/contributing.md) to get started.

 ## 📚 Translations

@ -51,3 +51,7 @@ Check out our [Weblate instance](https://translate.jellyfin.org/projects/swiftfi
 <a href="https://translate.jellyfin.org/engage/swiftfin/">
 <img src="https://translate.jellyfin.org/widgets/swiftfin/-/multi-auto.svg"/>
 </a>
+
+## 🎬 Player Differences
+
+Swiftfin offers both **Native (AVKit)** and **Swiftfin (VLCKit)** players to provide the best compatibility across Apple devices. To learn more about the capabilities and differences between these players, visit our [Player Differences documentation](https://github.com/jellyfin/Swiftfin/blob/main/Documentation/players.md).