ogg_file.h

Go to the documentation of this file.

/*
Minetest
Copyright (C) 2022 DS
Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
OpenAL support based on work by:
Copyright (C) 2011 Sebastian 'Bahamada' Rühl
Copyright (C) 2011 Cyriaque 'Cisoun' Skrapits <cysoun@gmail.com>
Copyright (C) 2011 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
 
#pragma once
 
#include "al_helpers.h"
#include <vorbis/vorbisfile.h>
#include <optional>
#include <string>
 
namespace sound {
 
struct OggVorbisBufferSource {
        std::string buf;
        size_t cur_offset = 0;
 
        static size_t read_func(void *ptr, size_t size, size_t nmemb, void *datasource) noexcept;
        static int seek_func(void *datasource, ogg_int64_t offset, int whence) noexcept;
        static int close_func(void *datasource) noexcept;
        static long tell_func(void *datasource) noexcept;
 
        static const ov_callbacks s_ov_callbacks;
};
 
struct OggFileDecodeInfo {
        std::string name_for_logging;
        bool is_stereo;
        ALenum format; // AL_FORMAT_MONO16 or AL_FORMAT_STEREO16
        size_t bytes_per_sample;
        ALsizei freq;
        ALuint length_samples = 0;
        f32 length_seconds = 0.0f;
};
 
struct RAIIOggFile {
        bool m_needs_clear = false;
        OggVorbis_File m_file;
 
        RAIIOggFile() = default;
 
        DISABLE_CLASS_COPY(RAIIOggFile)
 
        ~RAIIOggFile() noexcept
        {
                if (m_needs_clear)
                        ov_clear(&m_file);
        }
 
        OggVorbis_File *get() { return &m_file; }
 
        std::optional<OggFileDecodeInfo> getDecodeInfo(const std::string &filename_for_logging);
 
        RAIIALSoundBuffer loadBuffer(const OggFileDecodeInfo &decode_info, ALuint pcm_start,
                        ALuint pcm_end);
};
 
} // namespace sound