Skip to content

Define the player formats every server must produce #323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
maximmaxim345 wants to merge 3 commits into
base: main
Choose a base branch
from
+2 −2
Draft

Define the player formats every server must produce #323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2c50d0b
docs: define the player formats every server must serve
maximmaxim345 Oct 20, 2026
f7ab0b9
docs: require all three fields of the guaranteed entry to match
maximmaxim345 Oct 20, 2026
d4087e4
docs: allow servers to support other player formats
maximmaxim345 Oct 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1228,7 +1228,7 @@ The `player@v1_support` object in [`client/hello`](#client--server-clienthello)
- `bit_depth`: integer - bit depth for this format (e.g., 16, 24); meaningful for `pcm` and `flac` only, ignored for `opus`
- `buffer_capacity`: integer - maximum total size in bytes of outstanding audio chunks, as defined in [Player Buffer Accounting](#player-buffer-accounting)

Servers MUST support the `flac` and `pcm` codecs and MAY support `opus`. Players MUST list either `flac` or `pcm` and MAY list both as entries in `supported_formats`, so that every server can serve them, and MAY list `opus` in addition. Players are not told which codecs a server supports; the server selects only among the formats it can produce, as described below.
Servers MUST support the `flac` and `pcm` codecs at every combination of a `bit_depth` of 16 or 24, 1 or 2 `channels`, and a `sample_rate` of 44100 or 48000, and MAY support other formats, including `opus`. Players MUST list at least one `flac` or `pcm` entry in one of these combinations in `supported_formats`, so that every server can serve them, and MAY list other entries, including `opus`, in addition. Players are not told which codecs a server supports; the server selects only among the formats it can produce, as described below.

**Note:** Opus is covered by third-party patents. Implementers that ship `opus` in a commercial product are responsible for any license fees that apply; the patent pool does not target open-source software distributed independently from a hardware device.

Expand Down
2 changes: 1 addition & 1 deletion roles/player/v1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The `player@v1_support` object in [`client/hello`](../../messaging.md#client--se
- `bit_depth`: integer - bit depth for this format (e.g., 16, 24); meaningful for `pcm` and `flac` only, ignored for `opus`
- `buffer_capacity`: integer - maximum total size in bytes of outstanding audio chunks, as defined in [Player Buffer Accounting](#player-buffer-accounting)

Servers MUST support the `flac` and `pcm` codecs and MAY support `opus`. Players MUST list either `flac` or `pcm` and MAY list both as entries in `supported_formats`, so that every server can serve them, and MAY list `opus` in addition. Players are not told which codecs a server supports; the server selects only among the formats it can produce, as described below.
Servers MUST support the `flac` and `pcm` codecs at every combination of a `bit_depth` of 16 or 24, 1 or 2 `channels`, and a `sample_rate` of 44100 or 48000, and MAY support other formats, including `opus`. Players MUST list at least one `flac` or `pcm` entry in one of these combinations in `supported_formats`, so that every server can serve them, and MAY list other entries, including `opus`, in addition. Players are not told which codecs a server supports; the server selects only among the formats it can produce, as described below.

**Note:** Opus is covered by third-party patents. Implementers that ship `opus` in a commercial product are responsible for any license fees that apply; the patent pool does not target open-source software distributed independently from a hardware device.

Expand Down
Loading