Version

menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.9.8628 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.

Vorbis Encoder Parameters

In the Vorbis Encoder Parameters dialog you can define properties for Vorbis audio files. The Vorbis encoder is a perceptual audio codec that maintains a specified constant quality while varying the bitrate. In most cases, using the default mode results in the most consistent quality for the bits used.

[Note]Note

The Vorbis format supported by Audiokinetic has been optimized for interactive media and gaming platforms. It does not follow the standard Ogg/Vorbis file format. Do not expect media players or other standard Ogg/Vorbis tools to be able to read those streams properly.

In certain circumstances where you need to manage the bitrate closely, you can define the bitrate settings. This has been implemented using a bitrate reservoir that maintains the bitrate within the range that you specify by banking bits, using the average rate as a set-point. In many cases this can result in reduced quality. This option should be reserved for particular situations when it is essential to manage the bitrate closely.

In addition, if you plan to use the Vorbis encoder, you will need to enable the seek table to use the Play from elapsed time virtual voice behavior.

[Note]Note

When remote connected, the Source Editor's Play Cursor will only work on a Vorbis encoded source if the latter is converted with a seek table.

By default, the seek table option is turned off to save disk space. Be sure to turn this setting on when selecting either of the virtual voice behaviors; otherwise, the sound will not play when either of these virtual voice behaviors is used.

Interface Element

Description

Quality Factor

A decimal float value for the quality setting of the compressed file where -2 is intended as an ultra-low setting in which low bitrate is much more important than quality consistency and 0.0 is intended to produce consistent results at all times.

A higher quality setting translates into:

  • More disk space required

  • Better audio quality

  • Consistent results at all times

The Vorbis variable rate codec will keep the encoding quality value that you specify constant while varying the bitrate. A high compression rate can result in reduced quality. To achieve a higher quality, and therefore a lower compression rate, select a value close to the top range.

Default value: +4
Range: -2 to +10

The Vorbis decoder will take approximately 24 KB of the lower engine memory for each stereo file encoded in a quality setting less than 0.

Managed Bitrate

Enables the functionality for managing the average as well as the minimum and maximum bitrates per channel.

Although the Vorbis codec is natively variable bitrate codec, it includes infrastructure for 'managing' the bitrate of streams by setting minimum and maximum usage constraints, as well as functionality for nudging a stream toward a desired average value. These features should only be used when there is a requirement to limit bitrate in some way, such as guaranteeing certain bandwidth limitations for file streaming. Although the difference is usually slight, managed bitrate modes will always produce output inferior to variable bitrate encodings (given equal bitrate usage).

[Note]Note

Note that setting overly or impossibly tight bitrate management requirements can affect output quality dramatically for the worse.

Average bitrate (kbps per channel)

The value of the average bitrate that will be used by the bitrate reservoir as a set-point for tracking the bitrate in the encoder.

Default value: 64
Range: 16 to 240
Units: kbps per channel

Min bitrate (kbps per channel)

The minimum bitrate per channel encoded.

Default value: 64
Range: 16 to 240
Units: kbps per channel

The Vorbis codec supports limited ranges of valid bitrate settings depending on the sample rate of the file to encode. For more information about the valid ranges, consult the Valid Vorbis Bitrate Settings.

Max bitrate (kbps per channel)

The maximum bitrate per encoded channel.

Default value: 64
Range: 16 to 240
Units: kbps per channel

The Vorbis codec supports limited ranges of valid bitrate settings depending on the sample rate of the file to encode. For more information about the valid ranges, consult the Valid Vorbis Bitrate Settings.

Advanced Settings

Enables the functionality for managing the reservoir settings.

This functionality should only be used by users with expertise in encoding.

Bit reservoir time

The minimum/maximum bitrate constraints that will be used in the bit tracking reservoir. The reservoir averages out localized surges and dips in bitrates by managing the frame size and banking bits within the range defined for this setting.

Default value: 2
Range: 0 to 10
Units: seconds

Reservoir bias factor

The setting that determines how the reservoir will manage banking of bits - a higher setting results in the reservoir hoarding bits so that there are many to draw on should the bitrate go down. A lower setting results in storing less bits to deal with bitrate changes.

Default value: 0.1
Range: 0 to 1

Average track slew time

The transition time before the reservoir tracker will respond to defined minimum and maximum bitrate times.

Default value: 1.5
Range: 0 to 10
Units: seconds

Seek table granularity (sample frames)

The settings that determine how many seek locations or key frames will be used in the audio file. The seek table is normally used for virtual voice sounds that use the Play from elapsed time option. The lower the settings, the closer the sound will be to the accurate elapsed time for the sound.

Default: 16,384
Range: 1,024 to 32,768
Units: PCM frames (each frame is 1/sample frequency)

Closes the Vorbis Encoder Parameters dialog and saves your settings.

Closes the Vorbis Encoder Parameters dialog without saving your settings.


Valid Vorbis Bitrate Settings

Bitrate management is implemented using a bit-reservoir algorithm. The encoder has a fixed-size reservoir used as a 'savings account' in encoding. When a frame is smaller than the target rate, the unused bits go into the reservoir so that they may be used by future frames. When a frame is larger than target bitrate, it draws 'banked' bits out of the reservoir. Encoding is managed so that the reservoir never goes negative (when a maximum bitrate is specified) or fills beyond a fixed limit (when a minimum bitrate is specified). An 'average bitrate' request is used as the set-point in a long-range bitrate tracker which adjusts the encoder's aggressiveness up or down depending on whether or not frames are coming in larger or smaller than the requested average point.

The Vorbis codec supports limited ranges of valid bitrate settings depending on the sample rate of the file to encode. If the bitrate specified (average, minimum, and maximum) are outside the valid ranges for the file to encode, the values will be clamped to the nearest value within the valid range and a warning will be displayed in the conversion dialog specifying the actual bitrate used for encoding. Refer to the table below to determine valid bitrates for given sample rates.

Sample (Hz)

Mono Min (kbps)

Mono Max (kbps)

Stereo Min (kbps / channel)

Stereo Max (kbps / channel)

8,000     

8         

42         

5         

32         

10,000     

14         

50         

8         

44         

12,000     

14         

50         

8         

44         

14,000     

14         

50         

8         

44         

16,000     

16         

100         

10         

86         

18,000     

16         

100         

10         

86         

20,000     

22         

90         

14         

86         

22,050     

22         

90         

14         

86         

24,000     

22         

90         

14         

86         

28,000     

24         

190         

14         

190         

32,000     

24         

190         

14         

190         

36,000     

24         

190         

14         

190         

44,100     

26         

240         

16         

250         

48,000     

26         

240         

16         

250         


Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise