cdrom-device.hh

Go to the documentation of this file.

/*
 
MIT License
 
Copyright (c) 2022 PCSX-Redux authors
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
 
#pragma once
 
#include <EASTL/fixed_vector.h>
#include <EASTL/functional.h>
#include <stdint.h>
 
#include <concepts>
#include <coroutine>
#include <cstdint>
#include <type_traits>
 
#include "psyqo/cdrom-commandbuffer.hh"
#include "psyqo/cdrom.hh"
#include "psyqo/msf.hh"
#include "psyqo/task.hh"
 
namespace psyqo {
 
class GPU;
 
namespace Concepts {
 
template <typename T, typename = void>
struct CDRomDeviceStateEnumHasIdle : std::false_type {};
 
template <typename T>
struct CDRomDeviceStateEnumHasIdle<T, std::enable_if_t<T::IDLE == T(0)>> : std::true_type {};
 
template <typename T>
concept IsCDRomDeviceStateEnum =
    std::is_enum_v<T> && std::is_same_v<uint8_t, std::underlying_type_t<T>> && CDRomDeviceStateEnumHasIdle<T>::value;
 
}  // namespace Concepts
 
class CDRomDevice final : public CDRom {
  public:
    typedef eastl::fixed_vector<uint8_t, 16, false> Response;
    struct PlaybackLocation {
        MSF relative;
        MSF absolute;
        unsigned track;
        unsigned index;
    };
 
    struct ResetAwaiter {
        ResetAwaiter(CDRomDevice &device) : m_device(device) {}
        bool await_ready() const { return false; }
        template <typename U>
        void await_suspend(std::coroutine_handle<U> handle) {
            m_device.reset([handle, this](bool result) {
                m_result = result;
                handle.resume();
            });
        }
        bool await_resume() { return m_result; }
 
      private:
        CDRomDevice &m_device;
        bool m_result;
    };
 
    struct GetTOCSizeAwaiter {
        GetTOCSizeAwaiter(CDRomDevice &device) : m_device(device) {}
        bool await_ready() const { return false; }
        template <typename U>
        void await_suspend(std::coroutine_handle<U> handle) {
            m_device.getTOCSize(&m_result, [handle, this](bool success) {
                m_success = success;
                handle.resume();
            });
        }
        unsigned await_resume() { return m_success ? m_result : 0; }
 
      private:
        CDRomDevice &m_device;
        unsigned m_result;
        bool m_success;
    };
 
    struct ReadTOCAwaiter {
        ReadTOCAwaiter(CDRomDevice &device, MSF *toc, unsigned size) : m_device(device), m_toc(toc), m_size(size) {}
        bool await_ready() const { return false; }
        template <typename U>
        void await_suspend(std::coroutine_handle<U> handle) {
            m_device.readTOC(m_toc, m_size, [handle, this](bool result) {
                m_result = result;
                handle.resume();
            });
        }
        bool await_resume() { return m_result; }
 
      private:
        CDRomDevice &m_device;
        MSF *m_toc;
        unsigned m_size;
        bool m_result;
    };
 
    struct MuteAwaiter {
        MuteAwaiter(CDRomDevice &device) : m_device(device) {}
        bool await_ready() const { return false; }
        template <typename U>
        void await_suspend(std::coroutine_handle<U> handle) {
            m_device.mute([handle, this](bool result) {
                m_result = result;
                handle.resume();
            });
        }
        bool await_resume() { return m_result; }
 
      private:
        CDRomDevice &m_device;
        bool m_result;
    };
 
    struct UnmuteAwaiter {
        UnmuteAwaiter(CDRomDevice &device) : m_device(device) {}
        bool await_ready() const { return false; }
        template <typename U>
        void await_suspend(std::coroutine_handle<U> handle) {
            m_device.unmute([handle, this](bool result) {
                m_result = result;
                handle.resume();
            });
        }
        bool await_resume() { return m_result; }
 
      private:
        CDRomDevice &m_device;
        bool m_result;
    };
 
    struct GetPlaybackLocationAwaiter {
        GetPlaybackLocationAwaiter(CDRomDevice &device) : m_device(device) {}
        bool await_ready() const { return false; }
        template <typename U>
        void await_suspend(std::coroutine_handle<U> handle) {
            m_device.getPlaybackLocation([handle, this](PlaybackLocation *location) {
                m_location = location;
                handle.resume();
            });
        }
        PlaybackLocation *await_resume() { return m_location; }
 
      private:
        CDRomDevice &m_device;
        PlaybackLocation *m_location;
    };
 
  private:
    struct ActionBase {
        const char *name() const { return m_name; }
 
      protected:
        ActionBase(const char *const name) : m_name(name) {}
        virtual ~ActionBase() = default;
 
        virtual bool dataReady(const Response &response);
        virtual bool complete(const Response &response);
        virtual bool acknowledge(const Response &response);
        virtual bool end(const Response &response);
 
        void setCallback(eastl::function<void(bool)> &&callback);
        void queueCallbackFromISR(bool success);
        void setSuccess(bool success);
        // This isn't really a great way to do this, but it's the best I can come up with
        // that doesn't involve friending a bunch of classes.
        PlaybackLocation *getPendingLocationPtr() const;
        void queueGetLocationCallback(bool success = true);
 
        friend class CDRomDevice;
        CDRomDevice *m_device = nullptr;
        const char *const m_name = nullptr;
    };
 
  public:
    virtual ~CDRomDevice();
 
    void prepare();
 
    void reset(eastl::function<void(bool)> &&callback);
    TaskQueue::Task scheduleReset();
    bool resetBlocking(GPU &);
    ResetAwaiter reset() { return {*this}; }
 
    void readSectors(uint32_t sector, uint32_t count, void *buffer, eastl::function<void(bool)> &&callback) override;
    bool readSectorsBlocking(uint32_t sector, uint32_t count, void *buffer, GPU &);
 
    void getTOCSize(unsigned *size, eastl::function<void(bool)> &&callback);
    TaskQueue::Task scheduleGetTOCSize(unsigned *size);
    unsigned getTOCSizeBlocking(GPU &);
    GetTOCSizeAwaiter getTOCSize() { return {*this}; }
 
    void readTOC(MSF *toc, unsigned size, eastl::function<void(bool)> &&callback);
    TaskQueue::Task scheduleReadTOC(MSF *toc, unsigned size);
    bool readTOCBlocking(MSF *toc, unsigned size, GPU &);
    ReadTOCAwaiter readTOC(MSF *toc, unsigned size) { return {*this, toc, size}; }
 
    void mute(eastl::function<void(bool)> &&callback);
    TaskQueue::Task scheduleMute();
    void muteBlocking(GPU &);
    MuteAwaiter mute() { return MuteAwaiter(*this); }
 
    void unmute(eastl::function<void(bool)> &&callback);
    TaskQueue::Task scheduleUnmute();
    void unmuteBlocking(GPU &);
    UnmuteAwaiter unmute() { return {*this}; }
 
    void playCDDATrack(MSF start, eastl::function<void(bool)> &&callback);
    void playCDDATrack(unsigned track, eastl::function<void(bool)> &&callback);
    void playCDDADisc(MSF start, eastl::function<void(bool)> &&callback);
    void playCDDADisc(unsigned track, eastl::function<void(bool)> &&callback);
    void resumeCDDA(eastl::function<void(bool)> &&callback);
 
    void pauseCDDA();
 
    void stopCDDA();
 
    void getPlaybackLocation(PlaybackLocation *location, eastl::function<void(PlaybackLocation *)> &&callback);
    void getPlaybackLocation(eastl::function<void(PlaybackLocation *)> &&callback);
    TaskQueue::Task scheduleGetPlaybackLocation(PlaybackLocation *location);
    GetPlaybackLocationAwaiter getPlaybackLocation() { return {*this}; }
 
    void setVolume(uint8_t leftToLeft, uint8_t rightToLeft, uint8_t leftToRight, uint8_t rightToRight);
 
    void test(const psyqo::Hardware::CDRom::CDRomCommandBuffer &commandBuffer, eastl::function<void(bool)> &&callback);
    TaskQueue::Task scheduleTest(const psyqo::Hardware::CDRom::CDRomCommandBuffer &commandBuffer);
    void testBlocking(GPU &, const psyqo::Hardware::CDRom::CDRomCommandBuffer &commandBuffer);
 
    template <Concepts::IsCDRomDeviceStateEnum S>
    class Action : public ActionBase {
      protected:
        Action(const char *const name) : ActionBase(name) {}
        void registerMe(CDRomDevice *device) {
            device->switchAction(this);
            m_device = device;
        }
 
        void setState(S state) { m_device->m_state = static_cast<uint8_t>(state); }
        S getState() const { return static_cast<S>(m_device->m_state); }
    };
 
    [[nodiscard]] bool isIdle() const { return m_state == 0; }
 
  private:
    void switchAction(ActionBase *action);
    void irq();
    void actionComplete();
 
    friend class ActionBase;
 
    eastl::function<void(bool)> m_callback;
    eastl::function<void(PlaybackLocation *)> m_locationCallback;
    PlaybackLocation m_locationStorage;
    PlaybackLocation *m_locationPtr = nullptr;
    uint32_t m_event = 0;
    ActionBase *m_action = nullptr;
    uint8_t m_state = 0;
    bool m_success = false;
    bool m_blocking = false;
    bool m_pendingGetLocation = false;
 
    struct BlockingAction {
        BlockingAction(CDRomDevice *, GPU &);
        ~BlockingAction();
 
      private:
        CDRomDevice *m_device;
        GPU &m_gpu;
    };
 
    struct MaskedIRQ {
        MaskedIRQ();
        ~MaskedIRQ();
    };
};
 
}  // namespace psyqo