Skip to content

Add OpusEncoderConfig.[signal/application] #777

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

Merged
merged 3 commits into from
Mar 19, 2024
Merged

Add OpusEncoderConfig.[signal/application] #777

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
586ec1b
Add OpusEncoderConfig.[signal/application]
tguilbert-google Mar 5, 2024
275965b
secion -> section
aboba Mar 5, 2024
a1ea7d2
Remove references to Object RTC draft
tguilbert-google Mar 6, 2024
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
70 changes: 70 additions & 0 deletions opus_codec_registration.src.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@
<xmp>
dictionary OpusEncoderConfig {
OpusBitstreamFormat format = "opus";
OpusSignal signal = "auto";
OpusApplication application = "audio";
Copy link
Member Author

@tguilbert-google tguilbert-google Mar 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no default in libopus for OPUS_SET_APPLICATION (unlike the default of "auto" for OPUS_SET_SIGNAL). I think "audio" is the most generic/least surprising as a default.

[EnforceRange] unsigned long long frameDuration = 20000;
[EnforceRange] unsigned long complexity;
[EnforceRange] unsigned long packetlossperc = 0;
Expand All @@ -139,6 +141,14 @@
Configures the format of output {{EncodedAudioChunk}}s. See
{{OpusBitstreamFormat}}.
</dd>
<dt><dfn dict-member for=OpusEncoderConfig>signal</dfn></dt>
<dd>
Specificies the type of audio signal being encoded. See {{OpusSignal}}.
</dd>
<dt><dfn dict-member for=OpusEncoderConfig>application</dfn></dt>
<dd>
Specificies the encoder's intended application. See {{OpusApplication}}.
</dd>
<dt><dfn dict-member for=OpusEncoderConfig>frameDuration</dfn></dt>
<dd>
Configures the frame duration, in microseconds, of output {{EncodedAudioChunk}}s.
Expand Down Expand Up @@ -197,6 +207,66 @@
</dd>
</dl>

OpusSignal {#opus-signal}
------------------------------------------
<pre class='idl'>
<xmp>
enum OpusSignal {
"auto",
"music",
"voice",
};
</xmp>
</pre>

The {{OpusSignal}} indicates the default value for the type of signal being encoded.

<dl>
<dt><dfn enum-value for=OpusSignal>auto</dfn></dt>
<dd>
The audio signal is not specified to be of a particular type.
</dd>
<dt><dfn enum-value for=OpusSignal>music</dfn></dt>
<dd>
The audio signal is music.
</dd>
<dt><dfn enum-value for=OpusSignal>voice</dfn></dt>
<dd>
The audio signal is voice or speech.
</dd>
</dl>

OpusApplication {#opus-application}
------------------------------------------
<pre class='idl'>
<xmp>
enum OpusApplication {
"voip",
"audio",
"lowdelay",
};
</xmp>
</pre>

The {{OpusApplication}} indicates the default value for the encoder's intended
application.

<dl>
<dt><dfn enum-value for=OpusApplication>voip</dfn></dt>
<dd>
Process signal for improved speech intelligibility.
</dd>
<dt><dfn enum-value for=OpusApplication>audio</dfn></dt>
<dd>
Favor faithfulness to the original input.
</dd>
<dt><dfn enum-value for=OpusApplication>lowdelay</dfn></dt>
<dd>
Configure the minimum possible coding delay by disabling certain modes of
operation.
</dd>
</dl>

Privacy Considerations {#privacy-considerations}
==========================================================================

Expand Down