tagparser/matroska/matroskaattachment.h

#ifndef MEDIA_MATROSKAATTACHMENT_H
#define MEDIA_MATROSKAATTACHMENT_H

#include "../abstractattachment.h"

namespace Media {

class EbmlElement;
class MatroskaAttachment;

class TAG_PARSER_EXPORT MatroskaAttachmentMaker
{
    friend class MatroskaAttachment;

public:
    void make(std::ostream &stream) const;
    const MatroskaAttachment &attachment() const;
    uint64 requiredSize() const;
    void bufferCurrentAttachments();

private:
    MatroskaAttachmentMaker(MatroskaAttachment &attachment);

    MatroskaAttachment &m_attachment;
    uint64 m_attachedFileElementSize;
    uint64 m_totalSize;
};

/*!
 * \brief Returns the associated attachment.
 */
inline const MatroskaAttachment &MatroskaAttachmentMaker::attachment() const
{
    return m_attachment;
}

/*!
 * \brief Returns the number of bytes which will be written when making the attachment.
 */
inline uint64 MatroskaAttachmentMaker::requiredSize() const
{
    return m_totalSize;
}

class TAG_PARSER_EXPORT MatroskaAttachment : public AbstractAttachment
{
public:
    MatroskaAttachment();

    void parse(EbmlElement *attachedFileElement);
    MatroskaAttachmentMaker prepareMaking();
    void make(std::ostream &stream);

    EbmlElement *attachedFileElement() const;

private:
    EbmlElement *m_attachedFileElement;

};

/*!
 * \brief Constructs a new Matroska attachment.
 */
inline MatroskaAttachment::MatroskaAttachment() :
    m_attachedFileElement(nullptr)
{}

/*!
 * \brief Returns the "AttachedFile"-element which has been specified when the parse() method has been called.
 */
inline EbmlElement *MatroskaAttachment::attachedFileElement() const
{
    return m_attachedFileElement;
}

/*!
 * \brief Prepares making.
 * \returns Returns a MatroskaAttachmentMaker object which can be used to actually make the attachment.
 * \remarks The attachment must NOT be mutated after making is prepared when it is intended to actually
 *          make the attachment using the make method of the returned object.
 * \throws Throws Media::Failure or a derived exception when a making error occurs.
 *
 * This method might be useful when it is necessary to know the size of the attachment before making it.
 * \sa make()
 */
inline MatroskaAttachmentMaker MatroskaAttachment::prepareMaking()
{
    return MatroskaAttachmentMaker(*this);
}

} // namespace Media

#endif // MEDIA_MATROSKAATTACHMENT_H