vorbiscommentfield.h

Go to the documentation of this file.

#ifndef TAG_PARSER_VORBISCOMMENTFIELD_H
#define TAG_PARSER_VORBISCOMMENTFIELD_H
 
#include "../generictagfield.h"
 
#include <c++utilities/misc/flagenumclass.h>
 
namespace CppUtilities {
class BinaryReader;
class BinaryWriter;
} // namespace CppUtilities
 
namespace TagParser {

enum class VorbisCommentFlags : std::uint8_t {
    None = 0x0, 
    NoSignature = 0x1, 
    NoFramingByte = 0x2, 
    NoCovers = 0x4, 
    ConvertTotalFields = 0x8, 
};
 
} // namespace TagParser
 
CPP_UTILITIES_MARK_FLAG_ENUM_CLASS(TagParser, TagParser::VorbisCommentFlags)
 
namespace TagParser {
 
class VorbisCommentField;
class Diagnostics;

template <> class TAG_PARSER_EXPORT TagFieldTraits<VorbisCommentField> {
public:
    using IdentifierType = std::string;
    using TypeInfoType = std::uint32_t;
};
 
class OggIterator;
 
class TAG_PARSER_EXPORT VorbisCommentField : public TagField<VorbisCommentField> {
    friend class TagField<VorbisCommentField>;
 
public:
    VorbisCommentField();
    VorbisCommentField(const IdentifierType &id, const TagValue &value);
 
    void parse(OggIterator &iterator, Diagnostics &diag);
    void parse(OggIterator &iterator, std::uint64_t &maxSize, Diagnostics &diag);
    void parse(std::istream &stream, std::uint64_t &maxSize, Diagnostics &diag);
    bool make(CppUtilities::BinaryWriter &writer, VorbisCommentFlags flags, Diagnostics &diag);
    bool isAdditionalTypeInfoUsed() const;
    bool supportsNestedFields() const;
 
    static typename std::string fieldIdFromString(std::string_view idString);
    static std::string fieldIdToString(const std::string &id);
 
private:
    template <class StreamType> void internalParse(StreamType &stream, std::uint64_t &maxSize, Diagnostics &diag);
};

inline bool VorbisCommentField::isAdditionalTypeInfoUsed() const
{
    return false;
}

inline bool VorbisCommentField::supportsNestedFields() const
{
    return false;
}

inline std::string VorbisCommentField::fieldIdFromString(std::string_view idString)
{
    return std::string(idString);
}

inline std::string VorbisCommentField::fieldIdToString(const std::string &id)
{
    return id;
}
 
} // namespace TagParser
 
#endif // TAG_PARSER_VORBISCOMMENTFIELD_H