documentation/3.0.0/SoundStream_8hpp_source.html

//

// SFML - Simple and Fast Multimedia Library

// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)

//

// This software is provided 'as-is', without any express or implied warranty.

// In no event will the authors be held liable for any damages arising from the use of this software.

//

// Permission is granted to anyone to use this software for any purpose,

// including commercial applications, and to alter it and redistribute it freely,

// subject to the following restrictions:

//

// 1. The origin of this software must not be misrepresented;

//    you must not claim that you wrote the original software.

//    If you use this software in a product, an acknowledgment

//    in the product documentation would be appreciated but is not required.

//

// 2. Altered source versions must be plainly marked as such,

//    and must not be misrepresented as being the original software.

//

// 3. This notice may not be removed or altered from any source distribution.

//


#pragma once


// Headers

#include <SFML/Audio/Export.hpp>


#include <SFML/Audio/SoundChannel.hpp>

#include <SFML/Audio/SoundSource.hpp>


#include <SFML/System/Time.hpp>


#include <memory>

#include <optional>

#include <vector>


#include <cstddef>

#include <cstdint>


namespace sf

{


class SFML_AUDIO_API SoundStream : public SoundSource

{

public:


    struct Chunk

    {

        const std::int16_t* samples{};

        std::size_t         sampleCount{};

    };


    ~SoundStream() override;


    SoundStream(SoundStream&&) noexcept;


    SoundStream& operator=(SoundStream&&) noexcept;


    void play() override;


    void pause() override;


    void stop() override;


    [[nodiscard]] unsigned int getChannelCount() const;


    [[nodiscard]] unsigned int getSampleRate() const;


    [[nodiscard]] std::vector<SoundChannel> getChannelMap() const;


    [[nodiscard]] Status getStatus() const override;


    void setPlayingOffset(Time timeOffset);


    [[nodiscard]] Time getPlayingOffset() const;


    void setLooping(bool loop);


    [[nodiscard]] bool isLooping() const;


    void setEffectProcessor(EffectProcessor effectProcessor) override;


protected:

    SoundStream();


    void initialize(unsigned int channelCount, unsigned int sampleRate, const std::vector<SoundChannel>& channelMap);


    [[nodiscard]] virtual bool onGetData(Chunk& data) = 0;


    virtual void onSeek(Time timeOffset) = 0;


    virtual std::optional<std::uint64_t> onLoop();


private:

    [[nodiscard]] void* getSound() const override;


    // Member data

    struct Impl;

    std::unique_ptr<Impl> m_impl;

};


} // namespace sf


Export.hpp

SFML_AUDIO_API
#define SFML_AUDIO_API
Definition Audio/Export.hpp:42

SoundChannel.hpp

SoundSource.hpp

Time.hpp

sf::SoundSource::SoundSource
SoundSource(const SoundSource &)=default
Copy constructor.

sf::SoundSource::EffectProcessor
std::function< void(const float *inputFrames, unsigned int &inputFrameCount, float *outputFrames, unsigned int &outputFrameCount, unsigned int frameChannelCount)> EffectProcessor
Callable that is provided with sound data for processing.
Definition SoundSource.hpp:154

sf::SoundSource::Status
Status
Enumeration of the sound source states.
Definition SoundSource.hpp:55

sf::SoundStream::setLooping
void setLooping(bool loop)
Set whether or not the stream should loop after reaching the end.

sf::SoundStream::getChannelMap
std::vector< SoundChannel > getChannelMap() const
Get the map of position in sample frame to sound channel.

sf::SoundStream::SoundStream
SoundStream(SoundStream &&) noexcept
Move constructor.

sf::SoundStream::getChannelCount
unsigned int getChannelCount() const
Return the number of channels of the stream.

sf::SoundStream::pause
void pause() override
Pause the audio stream.

sf::SoundStream::initialize
void initialize(unsigned int channelCount, unsigned int sampleRate, const std::vector< SoundChannel > &channelMap)
Define the audio stream parameters.

sf::SoundStream::isLooping
bool isLooping() const
Tell whether or not the stream is in loop mode.

sf::SoundStream::getStatus
Status getStatus() const override
Get the current status of the stream (stopped, paused, playing)

sf::SoundStream::setEffectProcessor
void setEffectProcessor(EffectProcessor effectProcessor) override
Set the effect processor to be applied to the sound.

sf::SoundStream::stop
void stop() override
Stop playing the audio stream.

sf::SoundStream::getSampleRate
unsigned int getSampleRate() const
Get the stream sample rate of the stream.

sf::SoundStream::onSeek
virtual void onSeek(Time timeOffset)=0
Change the current playing position in the stream source.

sf::SoundStream::onGetData
virtual bool onGetData(Chunk &data)=0
Request a new chunk of audio samples from the stream source.

sf::SoundStream::onLoop
virtual std::optional< std::uint64_t > onLoop()
Change the current playing position in the stream source to the beginning of the loop.

sf::SoundStream::~SoundStream
~SoundStream() override
Destructor.

sf::SoundStream::getPlayingOffset
Time getPlayingOffset() const
Get the current playing position of the stream.

sf::SoundStream::play
void play() override
Start or resume playing the audio stream.

sf::SoundStream::setPlayingOffset
void setPlayingOffset(Time timeOffset)
Change the current playing position of the stream.

sf::Time
Represents a time value.
Definition Time.hpp:42

sf::SoundChannel
SoundChannel
Types of sound channels that can be read/written from sound buffers/files.
Definition SoundChannel.hpp:42

sf
Definition AudioResource.hpp:36

sf::SoundStream::Chunk
Structure defining a chunk of audio data to stream.
Definition SoundStream.hpp:59

sf::SoundStream::Chunk::samples
const std::int16_t * samples
Pointer to the audio samples.
Definition SoundStream.hpp:60

sf::SoundStream::Chunk::sampleCount
std::size_t sampleCount
Number of samples pointed by Samples.
Definition SoundStream.hpp:61