w3c / w3c/webcodecs

Misleading/incorrect statement in Opus codec registration

Open
#853 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
1.3k
Forks
194
Avg merge
1d 13h
Merged PRs (30d)
3

Description

The Opus codec registration states the following:
image

The conclusion I draw from this is that when description is set, the bitstream is in the 'ogg' format. However, this is not necessarily the case. description may still be provided even if the format is 'opus', and the 'ogg' format may not even be supported even if description is being set.

Here's a repro link: https://jsfiddle.net/7d1fLmbz/4/
I'm on Chrome Version 131.0.6778.86 on Windows 11.

I think what the registration is meaning to say is that each user agent is free to set description if they want, it's just when they set it it needs to be an Identification Header. It's very useful that it does this and I make use of this description field myself. However, the presence of description cannot be used to conclude whether the format is 'opus' or 'ogg'.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Opus codec registration text referenced in the issue and compare its wording with the linked JSFiddle reproduction. Revise the statement so that providing description is not presented as evidence of an Ogg or Opus format, then verify that the clarification matches the WebCodecs API behavior.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.