Ogg vorbis support

Author: kunitoki

examples/graphics/source/examples/AudioFileDemo.h

@@ -335,7 +335,9 @@ class AudioFileDemo : public yup::Component
         , saveButton ("Save As")
         , loopButton ("Loop")
     {
-        formatManager.registerDefaultFormats();
+        formatManager.registerDefaultFormats (
+            yup::AudioFormatType::all & ~yup::AudioFormatType::coreAudio);
+
         deviceManager.initialiseWithDefaultDevices (0, 2);
         deviceManager.addAudioCallback (&sourcePlayer);
         sourcePlayer.setSource (&transportSource);
@@ -608,7 +610,7 @@ class AudioFileDemo : public yup::Component
 
     yup::String getAudioFileFilter() const
     {
-        return "*.wav;*.aiff;*.aif;*.flac;*.mp3;*.opus;*.m4a;*.wma";
+        return "*.wav;*.aiff;*.aif;*.flac;*.mp3;*.opus;*.m4a;*.wma;*.ogg";
     }
 
     yup::AudioFormatManager formatManager;

modules/yup_audio_formats/common/yup_AudioFormatManager.cpp

@@ -53,13 +53,15 @@ void AudioFormatManager::registerDefaultFormats (AudioFormatType types)
         registerFormat (std::make_unique<Mp3AudioFormat>());
 #endif
 
+#if YUP_AUDIO_FORMAT_OGG
+    if (hasBitValueSet (types, AudioFormatType::ogg))
+        registerFormat (std::make_unique<OggVorbisAudioFormat>());
+#endif
+
 #if YUP_AUDIO_FORMAT_OPUS
     if (hasBitValueSet (types, AudioFormatType::opus))
         registerFormat (std::make_unique<OpusAudioFormat>());
 #endif
-
-    // TODO: Add other formats like:
-    // registerFormat (std::make_unique<OggVorbisAudioFormat>());
 }
 
 void AudioFormatManager::registerFormat (std::unique_ptr<AudioFormat> format)
@@ -72,20 +74,21 @@ std::unique_ptr<AudioFormatReader> AudioFormatManager::createReaderFor (const Fi
 {
     // Try to open the file
     auto stream = file.createInputStream();
-
     if (stream == nullptr)
         return nullptr;
 
     // Try each format
     for (auto& format : formats)
     {
-        if (format->canHandleFile (file))
-        {
-            stream->setPosition (0);
+        if (! format->canHandleFile (file, AudioFormat::forReading))
+            continue;
 
-            if (auto reader = format->createReaderFor (stream.release()))
-                return reader;
-        }
+        stream->setPosition (0);
+
+        if (auto reader = format->createReaderFor (stream.release()))
+            return reader;
+        else
+            stream = file.createInputStream();
     }
 
     return nullptr;
@@ -94,28 +97,33 @@ std::unique_ptr<AudioFormatReader> AudioFormatManager::createReaderFor (const Fi
 std::unique_ptr<AudioFormatWriter> AudioFormatManager::createWriterFor (const File& file,
                                                                         int sampleRate,
                                                                         int numChannels,
-                                                                        int bitsPerSample)
+                                                                        int bitsPerSample,
+                                                                        const StringPairArray& metadataValues,
+                                                                        int qualityOptionIndex)
 {
     // Try to create the output file
     auto stream = file.createOutputStream();
-
     if (stream == nullptr)
         return nullptr;
 
     // Try each format
     for (auto& format : formats)
     {
-        if (format->canHandleFile (file))
+        if (! format->canHandleFile (file, AudioFormat::forWriting))
+            continue;
+
+        if (auto writer = format->createWriterFor (stream.release(),
+                                                   sampleRate,
+                                                   numChannels,
+                                                   bitsPerSample,
+                                                   metadataValues,
+                                                   qualityOptionIndex))
+        {
+            return writer;
+        }
+        else
         {
-            StringPairArray metadataValues;
-
-            if (auto writer = format->createWriterFor (stream.release(),
-                                                       sampleRate,
-                                                       numChannels,
-                                                       bitsPerSample,
-                                                       metadataValues,
-                                                       0))
-                return writer;
+            stream = file.createOutputStream();
         }
     }
 

modules/yup_audio_formats/common/yup_AudioFormatManager.h

@@ -119,8 +119,7 @@ class YUP_API AudioFormatManager
         should handle it, then attempts to create a reader for that format. The file
         is opened and its header is parsed to extract audio properties.
 
-        @param file The audio file to create a reader for. The file must exist and
-                    be readable.
+        @param file The audio file to create a reader for. The file must exist and be readable.
 
         @returns A unique pointer to an AudioFormatReader if a compatible format
                  was found and the file could be parsed successfully, nullptr otherwise.
@@ -134,11 +133,12 @@ class YUP_API AudioFormatManager
         its extension, then creates a writer configured with the specified audio parameters.
         The format's capabilities are validated against the requested parameters.
 
-        @param file The destination file where audio data will be written. Parent
-                    directories must exist and be writable.
+        @param file The destination file where audio data will be written. Parent directories must exist and be writable.
         @param sampleRate The sample rate for the output audio in Hz (e.g., 44100, 48000).
         @param numChannels The number of audio channels (1 for mono, 2 for stereo, etc.).
         @param bitsPerSample The bit depth for sample encoding (e.g., 16, 24, 32).
+        @param metadataValues The metadata values to write (if supported).
+        @param qualityOptionIndex The quality option index (if supported).
 
         @returns A unique pointer to an AudioFormatWriter if a compatible format was found
                  and supports the specified parameters, nullptr if no suitable format is
@@ -147,7 +147,9 @@ class YUP_API AudioFormatManager
     std::unique_ptr<AudioFormatWriter> createWriterFor (const File& file,
                                                         int sampleRate,
                                                         int numChannels,
-                                                        int bitsPerSample);
+                                                        int bitsPerSample,
+                                                        const StringPairArray& metadataValues = {},
+                                                        int qualityOptionIndex = 0);
 
 private:
     std::vector<std::unique_ptr<AudioFormat>> formats;

modules/yup_audio_formats/format/yup_AudioFormat.cpp

@@ -22,9 +22,9 @@
 namespace yup
 {
 
-bool AudioFormat::canHandleFile (const File& file) const
+bool AudioFormat::canHandleFile (const File& file, Mode handleMode) const
 {
-    auto extensions = getFileExtensions();
+    auto extensions = getFileExtensions (handleMode);
     auto fileExt = file.getFileExtension().toLowerCase();
 
     for (auto& ext : extensions)
@@ -36,4 +36,4 @@ bool AudioFormat::canHandleFile (const File& file) const
     return false;
 }
 
-} // namespace yup
+} // namespace yup

modules/yup_audio_formats/format/yup_AudioFormat.h

@@ -53,6 +53,13 @@ class AudioFormatWriter;
 class YUP_API AudioFormat
 {
 public:
+    /** Mode of operation. */
+    enum Mode
+    {
+        forReading,
+        forWriting
+    };
+
     /** Destructor. */
     virtual ~AudioFormat() = default;
 
@@ -64,21 +71,21 @@ class YUP_API AudioFormat
 
     /** Returns the file extensions associated with this format.
 
-        @returns An array of file extensions (including the dot) that this format can handle
-                 (e.g., {".wav", ".wave"} for WAV format)
+        @returns An array of file extensions (including the dot) that this format can handle (e.g., {".wav", ".wave"} for WAV format)
     */
-    virtual Array<String> getFileExtensions() const = 0;
+    virtual Array<String> getFileExtensions (Mode handleMode) const = 0;
 
     /** Tests whether this format can handle files with the given file extension.
 
         This method provides a convenient way to check if a file can be processed by this format
         based on its extension, without needing to attempt to open the file.
 
         @param file The file to test for compatibility
+        @param handleMode The mode to check for compatibility
 
         @returns true if this format can potentially handle the file, false otherwise
     */
-    virtual bool canHandleFile (const File& file) const;
+    virtual bool canHandleFile (const File& file, Mode handleMode) const;
 
     /** Creates a reader object capable of parsing audio data from the given stream.
 
@@ -168,4 +175,4 @@ class YUP_API AudioFormat
     virtual StringArray getQualityOptions() const { return {}; }
 };
 
-} // namespace yup
+} // namespace yup

modules/yup_audio_formats/formats/yup_AppleCoreAudioFormat.cpp

@@ -1053,20 +1053,27 @@ const String& AppleCoreAudioFormat::getFormatName() const
     return formatName;
 }
 
-Array<String> AppleCoreAudioFormat::getFileExtensions() const
+Array<String> AppleCoreAudioFormat::getFileExtensions (Mode handleMode) const
 {
-    if (streamKind != StreamKind::kNone)
+    if (handleMode == Mode::forReading)
     {
-        const auto extensions = findFileExtensionsForCoreAudioCodec (toAudioFileTypeID (streamKind));
+        if (streamKind != StreamKind::kNone)
+        {
+            const auto extensions = findFileExtensionsForCoreAudioCodec (toAudioFileTypeID (streamKind));
+            if (! extensions.isEmpty())
+                return extensions;
+        }
+
+        const auto extensions = findFileExtensionsForCoreAudioCodecs();
         if (! extensions.isEmpty())
             return extensions;
-    }
 
-    const auto extensions = findFileExtensionsForCoreAudioCodecs();
-    if (! extensions.isEmpty())
-        return extensions;
-
-    return { ".wav", ".aiff", ".aif", ".aifc", ".wav", ".sd2", ".au", ".snd", ".mp4", ".mp3", ".mp2", ".mp1", ".ac3", ".aac", ".m4a", ".m4b", ".caf", ".3gp", ".3g2", ".amr" };
+        return { ".wav", ".aiff", ".aif", ".aifc", ".wav", ".sd2", ".au", ".snd", ".mp4", ".mp3", ".mp2", ".mp1", ".ac3", ".aac", ".m4a", ".m4b", ".caf", ".3gp", ".3g2", ".amr" };
+    }
+    else
+    {
+        return { ".aiff", ".aif", ".aifc", ".sd2", ".au", ".snd", ".mp4", ".mp2", ".mp1", ".ac3", ".aac", ".m4a", ".m4b", ".caf", ".3gp", ".3g2", ".amr" };
+    }
 }
 
 std::unique_ptr<AudioFormatReader> AppleCoreAudioFormat::createReaderFor (InputStream* sourceStream)

modules/yup_audio_formats/formats/yup_AppleCoreAudioFormat.h

@@ -81,7 +81,7 @@ class YUP_API AppleCoreAudioFormat : public AudioFormat
     const String& getFormatName() const override;
 
     /** Returns the file extensions that this format can handle. */
-    Array<String> getFileExtensions() const override;
+    Array<String> getFileExtensions (Mode handleMode) const override;
 
     /** Creates a reader for decoding CoreAudio-supported audio data. */
     std::unique_ptr<AudioFormatReader> createReaderFor (InputStream* sourceStream) override;

modules/yup_audio_formats/formats/yup_FlacAudioFormat.cpp

@@ -529,7 +529,7 @@ const String& FlacAudioFormat::getFormatName() const
     return formatName;
 }
 
-Array<String> FlacAudioFormat::getFileExtensions() const
+Array<String> FlacAudioFormat::getFileExtensions ([[maybe_unused]] Mode handleMode) const
 {
     return { ".flac" };
 }

modules/yup_audio_formats/formats/yup_FlacAudioFormat.h

@@ -47,7 +47,7 @@ class YUP_API FlacAudioFormat : public AudioFormat
     const String& getFormatName() const override;
 
     /** Returns the file extensions that this format can handle. */
-    Array<String> getFileExtensions() const override;
+    Array<String> getFileExtensions (Mode handleMode) const override;
 
     /** Creates a reader for decoding FLAC audio data from the provided stream. */
     std::unique_ptr<AudioFormatReader> createReaderFor (InputStream* sourceStream) override;

modules/yup_audio_formats/formats/yup_Mp3AudioFormat.cpp

@@ -448,7 +448,7 @@ const String& Mp3AudioFormat::getFormatName() const
     return formatName;
 }
 
-Array<String> Mp3AudioFormat::getFileExtensions() const
+Array<String> Mp3AudioFormat::getFileExtensions ([[maybe_unused]] Mode handleMode) const
 {
     return { ".mp3" };
 }