godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Modify Importing audio samples to be in pair with 4.4 documentation

Browse Source
This commit is contained in:
DeeJayLSP
2025-07-06 11:44:49 -03:00
parent a5cf10abce
commit 5de74e9b35
1 changed files with 43 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
tutorials/assets_pipeline/importing_audio_samples.rst
View File

@@ -10,16 +10,15 @@ Godot provides 3 options to import your audio data: WAV, Ogg Vorbis and MP3.
Each format has different advantages: Each format has different advantages:
- WAV files use raw data or light compression (IMA-ADPCM or QOA). Currently - WAV files use raw data or light compression (IMA ADPCM or Quite OK Audio). Currently
they can only be imported in raw format, but Godot allows compression after they can only be imported in raw format, but Godot allows compression after import.
import. They are lightweight to play back on the CPU (hundreds of simultaneous They are lightweight to play back on the CPU (hundreds of simultaneous voices
voices in this format are fine). The downside is that they take up a lot of disk space. in this format are fine). The downside is that they take up a lot of disk space.
- Ogg Vorbis files use a stronger compression that results in much - Ogg Vorbis files use a stronger compression that results in much smaller file
smaller file size, but require significantly more processing power to size, but require significantly more processing power to play back.
play back. - MP3 files use better compression than WAV with IMA ADPCM or Quite OK Audio, but
- MP3 files use better compression than WAV with IMA-ADPCM or QOA, but worse worse than Ogg Vorbis. This means that an MP3 file with roughly equal quality
than Ogg Vorbis. This means that an MP3 file with roughly equal quality to to Ogg Vorbis will be significantly larger. On the bright side, MP3 requires
Ogg Vorbis will be significantly larger. On the bright side, MP3 requires
less CPU usage to play back compared to Ogg Vorbis. less CPU usage to play back compared to Ogg Vorbis.
.. note:: .. note::
@@ -30,23 +29,23 @@ Each format has different advantages:
Here is a comparative chart representing the file size of 1 second of audio with Here is a comparative chart representing the file size of 1 second of audio with
each format: each format:
+-----------------------------+-------------------+ +------------------------------+-------------------+
| Format | 1 second of audio | | Format | 1 second of audio |
+=============================+===================+ +==============================+===================+
| WAV 24-bit, 96 kHz, stereo | 576 KB | | WAV 24-bit, 96 kHz, stereo | 576 KB |
+-----------------------------+-------------------+ +------------------------------+-------------------+
| WAV 16-bit, 44 kHz, mono | 88 KB | | WAV 16-bit, 44 kHz, mono | 88 KB |
+-----------------------------+-------------------+ +------------------------------+-------------------+
| WAV IMA-ADPCM, 44 kHz, mono | 22 KB | | WAV IMA ADPCM, 44 kHz, mono | 22 KB |
+-----------------------------+-------------------+ +------------------------------+-------------------+
| WAV QOA, 44 kHz, mono | 17 KB | | Quite OK Audio, 44 kHz, mono | 17 KB |
+-----------------------------+-------------------+ +------------------------------+-------------------+
| MP3 192 Kb/s, stereo | 24 KB | | MP3 192 Kb/s, stereo | 24 KB |
+-----------------------------+-------------------+ +------------------------------+-------------------+
| Ogg Vorbis 128 Kb/s, stereo | 16 KB | | Ogg Vorbis 128 Kb/s, stereo | 16 KB |
+-----------------------------+-------------------+ +------------------------------+-------------------+
| Ogg Vorbis 96 Kb/s, stereo | 12 KB | | Ogg Vorbis 96 Kb/s, stereo | 12 KB |
+-----------------------------+-------------------+ +------------------------------+-------------------+
Note that the MP3 and Ogg Vorbis figures can vary depending on the encoding Note that the MP3 and Ogg Vorbis figures can vary depending on the encoding
type. The above figures use :abbr:`CBR (Constant Bit Rate)` encoding for type. The above figures use :abbr:`CBR (Constant Bit Rate)` encoding for
@@ -125,8 +124,8 @@ saving to a waveform, which increases their size unnecessarily and add latency
to the moment they are played back. to the moment they are played back.
Enabling **Trim** will automatically trim the beginning and end of the audio if Enabling **Trim** will automatically trim the beginning and end of the audio if
it's lower than -50 dB *after* normalization (see **Edit > Normalize** below). A it's lower than -50 dB *after* normalization (see **Edit > Normalize** below).
fade-in/fade-out period of 500 samples is also used during trimming to avoid A fade-in/fade-out period of 500 samples is also used during trimming to avoid
audible pops. audible pops.
Edit > Normalize Edit > Normalize
@@ -143,13 +142,15 @@ Unlike Ogg Vorbis and MP3, WAV files can contain metadata to indicate whether
they're looping (in addition to loop points). By default, Godot will follow this they're looping (in addition to loop points). By default, Godot will follow this
metadata, but you can choose to apply a specific loop mode: metadata, but you can choose to apply a specific loop mode:
- **Detect from WAV:** Uses loop information from the WAV metadata.
- **Disabled:** Don't loop audio, even if metadata indicates the file should be - **Disabled:** Don't loop audio, even if metadata indicates the file should be
played back looping. played back looping.
- **Forward:** Standard audio looping. - **Forward:** Standard audio looping. Plays the audio forward from the beginning
- **Ping-Pong:** Play audio forward until it's done playing, then play it to the loop end, then returns to the loop beginning and repeats.
backward and repeat. This is similar to mirrored texture repeat, but for - **Ping-Pong:** Plays the audio forward until the loop end, then backwards to
audio. the loop beginning, repeating this cycle.
- **Backward:** Play audio in reverse and loop back to the end when done playing. - **Backward:** Plays the audio backwards from the loop end to the loop beginning,
then repeats.
When choosing one of the **Forward**, **Ping-Pong** or **Backward** loop modes, When choosing one of the **Forward**, **Ping-Pong** or **Backward** loop modes,
loop points can also be defined to make only a specific part of the sound loop. loop points can also be defined to make only a specific part of the sound loop.
@@ -166,12 +167,12 @@ the end of the audio file if set to ``-1``.
Compress > Mode Compress > Mode
--------------- ---------------
Three compression modes can be chosen from for WAV files: **Disabled** (default), Three compression modes can be chosen from for WAV files: **PCM (Uncompressed)**,
**RAM (Ima-ADPCM)**, or **QOA (Quite OK Audio)**. **RAM (Ima-ADPCM)** reduces **IMA ADPCM**, or **Quite OK Audio** (default). **IMA ADPCM** reduces file size
file size and memory usage a little, at the cost of decreasing quality in an and memory usage a little, at the cost of decreasing quality in an audible manner.
audible manner. **QOA (Quite OK Audio)** reduces file size a bit more than **Quite OK Audio** reduces file size a bit more than **IMA ADPCM** and the quality
**RAM (Ima-ADPCM)** and the quality decrease is much less noticeable, at the decrease is much less noticeable, at the cost of slightly higher CPU usage (still
cost of higher CPU usage (still much lower than MP3). much lower than MP3).
Ogg Vorbis and MP3 don't decrease quality as much and can provide greater file Ogg Vorbis and MP3 don't decrease quality as much and can provide greater file
size reductions, at the cost of higher CPU usage during playback. This higher size reductions, at the cost of higher CPU usage during playback. This higher
@@ -265,8 +266,8 @@ music tracks).
.. note:: .. note::
Unlike WAV files, Ogg Vorbis and MP3 only support a "loop begin" loop point, Unlike WAV files, Ogg Vorbis and MP3 only support a "loop begin" loop point,
not a "loop end" point. Looping can also be only be standard forward not a "loop end" point. Looping can also be only be standard forward looping,
looping, not ping-pong or backward. not ping-pong or backward.
.. _doc_importing_audio_samples_best_practices: .. _doc_importing_audio_samples_best_practices: