MP4Frame.h

/* MP4Frame.h */
 
/* Copyright (C) 2011-2024 Michael Lugmair (Lucio Carreras)
 *
 * This file is part of sayonara player
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 
 * This program 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 General Public License for more details.
 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef SAYONARA_ABSTRACT_MP4_FRAME_H
#define SAYONARA_ABSTRACT_MP4_FRAME_H
 
#include "Utils/Tagging/AbstractFrame.h"
#include "Utils/Algorithm.h"
 
#include <QString>
 
#include <taglib/tag.h>
#include <taglib/tstringlist.h>
#include <taglib/mp4tag.h>
#include <taglib/tpropertymap.h>
 
#include <algorithm>
#include <optional>
 
namespace MP4
{
    bool isFrameAvailable(TagLib::MP4::Tag* tag, const QByteArray& key, const QByteArray& propertyMapKey);
    TagLib::MP4::ItemMap::ConstIterator findKey(const QByteArray& key, const TagLib::MP4::ItemMap& itemMap);
    void eraseAllFromTag(TagLib::MP4::Tag* tag, const QString& key);
 
    template<typename Model_t>
    class MP4Frame :
        protected Tagging::AbstractFrame<TagLib::MP4::Tag>
    {
        protected:
            virtual std::optional<Model_t> mapItemToData(const TagLib::MP4::Item& item) const = 0;
            virtual std::optional<TagLib::MP4::Item> mapDataToItem(const Model_t& model) = 0;
 
        public:
            MP4Frame(TagLib::MP4::Tag* tag, const QByteArray& identifier) :
                Tagging::AbstractFrame<TagLib::MP4::Tag>(tag, identifier) {}
 
            ~MP4Frame() override = default;
 
            bool read(Model_t& data) const
            {
                if(tag())
                {
                    if(const auto maybeData = findDataInItemMap(); maybeData.has_value())
                    {
                        data = maybeData.value();
                        return true;
                    }
 
                    if(const auto maybeData = findDataInPropertyMap(); maybeData.has_value())
                    {
                        data = maybeData.value();
                        return true;
                    }
                }
 
                return false;
            }
 
            bool write(const Model_t& data)
            {
                if(!tag())
                {
                    return false;
                }
 
                eraseAllFromTag(tag(), key());
 
                const auto item = mapDataToItem(data);
                if(item.has_value() && item.value().isValid())
                {
                    tag()->setItem(tagKey(), *item);
                }
 
                return item.has_value();
            }
 
            [[nodiscard]] bool isFrameAvailable() const
            {
                return MP4::isFrameAvailable(tag(), key(), propertyMapKey());
            }
 
        private:
            std::optional<Model_t> findDataInItemMap() const
            {
                const auto& itemMap = tag()->itemMap();
 
                if(const auto it = findKey(key(), itemMap); (it != itemMap.end() && it->second.isValid()))
                {
                    const auto optionalData = mapItemToData(it->second);
                    if(optionalData.has_value())
                    {
                        return optionalData;
                    }
                }
 
                return std::nullopt;
            }
 
            virtual std::optional<Model_t> findDataInPropertyMap() const { return std::nullopt; };
 
            [[nodiscard]] virtual QByteArray propertyMapKey() const { return {}; };
    };
}
 
#endif // SAYONARA_ABSTRACT_MP4_FRAME_H