AudioObject.h

Go to the documentation of this file.

// File: AudioObject.h
// Description: Audio system using FMOD with all declarations needed for basic audio playback
// Author(s): Marcelo Escamilla (marcelo.escamilla@digipen.edu)
// 2025 / 09 / 29
// (C) Digipen 2025
//   ____   __                  __  __
// /\__  _\/\ \                /\ \/\ \
// \/_/\ \/\ \ \___      __    \ \ \_\ \    ___   __  __    ____     __
//    \ \ \ \ \  _ `\  /'__`\   \ \  _  \  / __`\/\ \/\ \  /',__\  /'__`\
//     \ \ \ \ \ \ \ \/\  __/    \ \ \ \ \/\ \L\ \ \ \_\ \/\__, `\/\  __/
//      \ \_\ \ \_\ \_\ \____\    \ \_\ \_\ \____/\ \____/\/\____/\ \____\
//       \/_/  \/_/\/_/\/____/     \/_/\/_/\/___/  \/___/  \/___/  \/____/
 
#pragma once
 
#include <FMOD/fmod.h>
#include <FMOD/fmod.hpp>
#include "Framework/Component.h"
 
using Stream = sys::Json; // replace with whatever stream we are using

enum class AudioType
{
    None,
    Music,
    SFX,
    UI
};

class AudioObject
{
 
public:
    AudioObject();

    AudioObject(const char* name, bool loopable, AudioType _channelType);
 
 
    // The rule of five is needed to make this work properly so these are needed here
    // Keisha mentioned that the rule of five is having the copy, assignment, move, move assignment, and destructor
    // Copy constructor changed a bit to properly copy the sound object
    AudioObject(const AudioObject& other);
    // Copy assignment operator implemented properly
    auto operator=(const AudioObject& other) -> AudioObject&;
    // Move constructor is needing to be implemented properly
    AudioObject(AudioObject&& other) noexcept;
    // Move assignment operator needing to be implemented properly
    auto operator=(AudioObject&& other) noexcept -> AudioObject&;

    ~AudioObject();

    auto play() -> void;

    auto pause(bool pause) -> void;

    auto stop() -> void;

    auto setVolume(float vol) -> void;

    auto setPitch(float pit) -> void;

    auto getIsPlaying() const -> bool;

    auto getIsPaused() const -> bool;

    auto getVolume() const -> float;

    auto getPitch() const -> float;

    auto getAudioHandler() -> AudioObject*;

    auto name() const -> const std::string&;

    auto loadFile(const std::string& fileName, bool loopable) -> void;
 
    auto load(Stream& stream) -> void;
    auto save(Stream& stream) const -> void;
 
    friend auto to_json(json& j, const AudioObject& a) -> void;
    friend auto from_json(const json& j, AudioObject& a) -> void;
 
private:
    FMOD::Sound* sound;
    FMOD::Channel* channel;
    bool isPlaying;
    bool isPaused;
    float volume;
    float pitch;
    std::string filePath;
    bool isLoopable;
    std::string _name;
    AudioType channelType;
};