Skip to content

File DiskFile.h

File List > Amplitude > IO > DiskFile.h

Go to the documentation of this file

// Copyright (c) 2021-present Sparky Studios. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#ifndef _AM_IO_DISK_FILE_H
#define _AM_IO_DISK_FILE_H

#include <SparkyStudios/Audio/Amplitude/IO/File.h>

#include <filesystem>

namespace SparkyStudios::Audio::Amplitude
{
    class AM_API_PUBLIC DiskFile : public File
    {
    public:
        DiskFile();

        explicit DiskFile(AmFileHandle fp);

        explicit DiskFile(
            const std::filesystem::path& fileName, eFileOpenMode mode = eFileOpenMode_Read, eFileOpenKind kind = eFileOpenKind_Binary);

        ~DiskFile() override;

        [[nodiscard]] AmOsString GetPath() const override;

        [[nodiscard]] bool Eof() const override;

        AmSize Read(AmUInt8Buffer dst, AmSize bytes) const override;

        AmSize Write(AmConstUInt8Buffer src, AmSize bytes) override;

        [[nodiscard]] AmSize Length() const override;

        void Seek(AmInt64 offset, eFileSeekOrigin origin) override;

        [[nodiscard]] AmSize Position() const override;

        [[nodiscard]] AmVoidPtr GetPtr() const override;

        [[nodiscard]] bool IsValid() const override;

        void Close() override;

        AmResult Open(
            const std::filesystem::path& filePath, eFileOpenMode mode = eFileOpenMode_Read, eFileOpenKind kind = eFileOpenKind_Binary);

    private:
        std::filesystem::path m_filePath;
        AmFileHandle m_fileHandle;
    };
} // namespace SparkyStudios::Audio::Amplitude

#endif // _AM_IO_DISK_FILE_H