file.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Multimedia.
 *
 * StormByte-Multimedia original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte-Multimedia source in this
 * file. Third-party components — including FFmpeg and embedded trained data —
 * remain under their own licenses and are not covered by the commercial grant.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * StormByte-Multimedia is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with StormByte-Multimedia. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#include <StormByte/multimedia/visibility.h>
 
#include <optional>
#include <string>
 
namespace StormByte::Multimedia {
    class File;
}
 
namespace StormByte::Multimedia::Detail {
    class Probe;
}
 
namespace StormByte::Multimedia::Metadata {
    class STORMBYTE_MULTIMEDIA_PUBLIC File {
        public:
            File(const File&) = default;
 
            File(File&&) noexcept = default;
 
            ~File() = default;
 
            File& operator=(const File&) = default;
 
            File& operator=(File&&) noexcept = default;
 
            const std::optional<std::string>& Title() const noexcept;
 
            const std::optional<std::string>& Artist() const noexcept;
 
            const std::optional<std::string>& Album() const noexcept;
 
            const std::optional<std::string>& AlbumArtist() const noexcept;
 
            const std::optional<std::string>& Composer() const noexcept;
 
            const std::optional<std::string>& Genre() const noexcept;
 
            const std::optional<std::string>& Comment() const noexcept;
 
            const std::optional<std::string>& Copyright() const noexcept;
 
            const std::optional<std::string>& Encoder() const noexcept;
 
            const std::optional<std::string>& Date() const noexcept;
 
            std::optional<unsigned> Track() const noexcept;
 
            std::optional<unsigned> Disc() const noexcept;
 
        private:
            friend class StormByte::Multimedia::File;
            friend class StormByte::Multimedia::Detail::Probe;
 
            std::optional<std::string> m_title;         
            std::optional<std::string> m_artist;        
            std::optional<std::string> m_album;         
            std::optional<std::string> m_albumArtist;   
            std::optional<std::string> m_composer;      
            std::optional<std::string> m_genre;         
            std::optional<std::string> m_comment;       
            std::optional<std::string> m_copyright;     
            std::optional<std::string> m_encoder;       
            std::optional<std::string> m_date;          
            std::optional<unsigned> m_track;            
            std::optional<unsigned> m_disc;             
 
            File() noexcept = default;
 
            void Title(std::string title) noexcept;
 
            void Artist(std::string artist) noexcept;
 
            void Album(std::string album) noexcept;
 
            void AlbumArtist(std::string albumArtist) noexcept;
 
            void Composer(std::string composer) noexcept;
 
            void Genre(std::string genre) noexcept;
 
            void Comment(std::string comment) noexcept;
 
            void Copyright(std::string copyright) noexcept;
 
            void Encoder(std::string encoder) noexcept;
 
            void Date(std::string date) noexcept;
 
            void Track(unsigned track) noexcept;
 
            void Disc(unsigned disc) noexcept;
    };
}