From 4add1621fbf9145957f2eff9565b95c58d596f74 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 25 Sep 2016 12:12:15 +0200 Subject: [PATCH] WavAudioImporter: reflect new features in plugin documentation. --- src/MagnumPlugins/WavAudioImporter/WavImporter.cpp | 4 ++-- src/MagnumPlugins/WavAudioImporter/WavImporter.h | 13 ++++++++++--- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/src/MagnumPlugins/WavAudioImporter/WavImporter.cpp b/src/MagnumPlugins/WavAudioImporter/WavImporter.cpp index 0fd132f70..eae5a8649 100644 --- a/src/MagnumPlugins/WavAudioImporter/WavImporter.cpp +++ b/src/MagnumPlugins/WavAudioImporter/WavImporter.cpp @@ -153,7 +153,7 @@ void WavImporter::doOpenData(Containers::ArrayView data) { return; } - /* Check ALAW format */ + /* Check A-Law format */ } else if(formatChunk->audioFormat == WavAudioFormat::ALaw) { if(formatChunk->numChannels == 1) _format = Buffer::Format::MonoALaw; @@ -166,7 +166,7 @@ void WavImporter::doOpenData(Containers::ArrayView data) { return; } - /* Check MULAW format */ + /* Check μ-Law format */ } else if(formatChunk->audioFormat == WavAudioFormat::MuLaw) { if(formatChunk->numChannels == 1) _format = Buffer::Format::MonoMuLaw; diff --git a/src/MagnumPlugins/WavAudioImporter/WavImporter.h b/src/MagnumPlugins/WavAudioImporter/WavImporter.h index aecd6f726..c8d145a95 100644 --- a/src/MagnumPlugins/WavAudioImporter/WavImporter.h +++ b/src/MagnumPlugins/WavAudioImporter/WavImporter.h @@ -53,9 +53,16 @@ namespace Magnum { namespace Audio { /** @brief WAV importer plugin -Supports mono and stereo PCM files with 8 or 16 bits per channel. The files are -imported with @ref Buffer::Format::Mono8, @ref Buffer::Format::Mono16, -@ref Buffer::Format::Stereo8 or @ref Buffer::Format::Stereo16, respectively. +Supports mono and stereo files of the following formats: + +- 8 bit per channel PCM, imported as @ref Buffer::Format::Mono8 and @ref Buffer::Format::Stereo8 +- 16 bit per channel PCM, imported as @ref Buffer::Format::Mono16 and @ref Buffer::Format::Stereo16 +- 32-bit IEEE Float, imported as @ref Buffer::Format::MonoFloat / @ref Buffer::Format::StereoFloat +- 64-bit IEEE Float, imported as @ref Buffer::Format::MonoDouble / @ref Buffer::Format::StereoDouble +- A-Law, imported as @ref Buffer::Format::MonoALaw / @ref Buffer::Format::StereoALaw +- μ-Law, imported as @ref Buffer::Format::MonoMuLaw / @ref Buffer::Format::StereoMuLaw + +Multi-channel formats are not supported. This plugin is built if `WITH_WAVAUDIOIMPORTER` is enabled when building Magnum. To use dynamic plugin, you need to load `WavAudioImporter` plugin