speaker.hpp

Go to the documentation of this file.

/*
  Wizard Engine
  Copyright (C) 2023-2024 Zana Domán
 
  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.
*/
 
#ifndef WIZARD_ENGINE_SPEAKER_HPP
#define WIZARD_ENGINE_SPEAKER_HPP
 
#include <wizard_engine/assets.hpp>
#include <wizard_engine/component.hpp>
#include <wizard_engine/export.hpp>
 
namespace wze {
class speaker final : public component {
  private:
    static std::vector<speaker*> _instances;
    int32_t _channel;
    std::shared_ptr<wze::sound> _sound;
    float _range;
    bool _auto_panning;
    float _x;
    float _y;
    float _z;
    bool _spatial;
    float _x_offset;
    float _y_offset;
    bool _attach_x;
    bool _attach_y;
    bool _x_angle_lock;
    bool _y_angle_lock;
 
    void set_angle(float _) final;
 
    [[nodiscard]] float angle_offset() const final;
 
    [[nodiscard]] bool attach_angle() const final;
 
  public:
#ifdef __WIZARD_ENGINE_INTERNAL__
    [[nodiscard]] static std::vector<speaker*> const& instances();
#endif /* __WIZARD_ENGINE_INTERNAL__ */
 
    [[nodiscard]] std::shared_ptr<wze::sound> const& sound() const;
 
    void set_sound(std::shared_ptr<wze::sound> const& sound);
 
    [[nodiscard]] int8_t volume() const;
 
    void set_volume(int8_t volume);
 
    [[nodiscard]] float range() const;
 
    void set_range(float range);
 
    [[nodiscard]] bool auto_panning() const;
 
    void set_auto_panning(bool auto_panning);
 
    [[nodiscard]] float x() const;
 
    void set_x(float x) final;
 
    [[nodiscard]] float y() const;
 
    void set_y(float y) final;
 
    [[nodiscard]] float z() const;
 
    void set_z(float z);
 
    [[nodiscard]] bool spatial() const;
 
    void set_spatial(bool spatial);
 
    [[nodiscard]] float x_offset() const final;
 
    void set_x_offset(float x_offset);
 
    [[nodiscard]] float y_offset() const final;
 
    void set_y_offset(float y_offset);
 
    [[nodiscard]] bool attach_x() const final;
 
    void set_attach_x(bool attach_x);
 
    [[nodiscard]] bool attach_y() const final;
 
    void set_attach_y(bool attach_y);
 
    [[nodiscard]] bool x_angle_lock() const final;
 
    void set_x_angle_lock(bool x_angle_lock);
 
    [[nodiscard]] bool y_angle_lock() const final;
 
    void set_y_angle_lock(bool y_angle_lock);
 
    [[nodiscard]] bool playing() const;
 
    [[nodiscard]] bool paused() const;
 
    explicit speaker(std::shared_ptr<wze::sound> const& sound = {},
                     int8_t volume = std::numeric_limits<int8_t>::max(),
                     float range = std::numeric_limits<int16_t>::max(),
                     bool auto_panning = false, float x = 0, float y = 0,
                     float z = 0, bool spatial = false, float x_offset = 0,
                     float y_offset = 0, bool attach_x = true,
                     bool attach_y = true, bool x_angle_lock = true,
                     bool y_angle_lock = true);
 
    speaker(speaker const& other);
 
    speaker(speaker&& other) noexcept(false);
 
    ~speaker() final;
 
    speaker& operator=(speaker const& other);
 
    speaker& operator=(speaker&& other) noexcept(false);
 
    void play(uint16_t fade_in = 0, uint16_t loops = 0);
 
    void pause();
 
    void resume();
 
    void stop(uint16_t fade_out = 0);
 
    void align_panning();
};
} /* namespace wze */
 
#endif /* WIZARD_ENGINE_SPEAKER_HPP */