summaryrefslogtreecommitdiffstats
path: root/src/VBox/Main/include/EBMLWriter.h
blob: eda3f4b1dfba1f86c24eb5f605abfab2faa07f98 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/* $Id: EBMLWriter.h $ */
/** @file
 * EBMLWriter.h - EBML writer.
 */

/*
 * Copyright (C) 2013-2023 Oracle and/or its affiliates.
 *
 * This file is part of VirtualBox base platform packages, as
 * available from https://www.virtualbox.org.
 *
 * 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, in version 3 of the
 * License.
 *
 * 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 <https://www.gnu.org/licenses>.
 *
 * SPDX-License-Identifier: GPL-3.0-only
 */

#ifndef MAIN_INCLUDED_EBMLWriter_h
#define MAIN_INCLUDED_EBMLWriter_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif

#include <stack>

#include <iprt/critsect.h>
#include <iprt/file.h>

#include <VBox/com/string.h>


/** No flags set. */
#define VBOX_EBMLWRITER_FLAG_NONE               0
/** The file handle was inherited. */
#define VBOX_EBMLWRITER_FLAG_HANDLE_INHERITED   RT_BIT(0)

class EBMLWriter
{
public:
    typedef uint32_t EbmlClassId;

private:

    struct EbmlSubElement
    {
        uint64_t offset;
        EbmlClassId classId;
        EbmlSubElement(uint64_t offs, EbmlClassId cid) : offset(offs), classId(cid) {}
    };

    /** Stack of EBML sub elements. */
    std::stack<EbmlSubElement> m_Elements;
    /** The file's handle. */
    RTFILE                     m_hFile;
    /** The file's name (path). */
    com::Utf8Str               m_strFile;
    /** Flags. */
    uint32_t                   m_fFlags;

public:

    EBMLWriter(void)
        : m_hFile(NIL_RTFILE)
        , m_fFlags(VBOX_EBMLWRITER_FLAG_NONE) { }

    virtual ~EBMLWriter(void) { close(); }

public:

    int createEx(const char *a_pszFile, PRTFILE phFile);

    int create(const char *a_pszFile, uint64_t fOpen);

    void close(void);

    /** Returns the file name. */
    const com::Utf8Str& getFileName(void) { return m_strFile; }

    /** Returns file size. */
    uint64_t getFileSize(void) { return RTFileTell(m_hFile); }

    /** Get reference to file descriptor */
    inline const RTFILE &getFile(void) { return m_hFile; }

    /** Returns available space on storage. */
    uint64_t getAvailableSpace(void);

    /**
     * Returns whether the file is open or not.
     *
     * @returns True if open, false if not.
     */
    bool isOpen(void) { return RTFileIsValid(m_hFile); }

public:

    EBMLWriter &subStart(EbmlClassId classId);

    EBMLWriter &subEnd(EbmlClassId classId);

    EBMLWriter &serializeString(EbmlClassId classId, const char *str);

    EBMLWriter &serializeUnsignedInteger(EbmlClassId classId, uint64_t parm, size_t size = 0);

    EBMLWriter &serializeFloat(EbmlClassId classId, float value);

    EBMLWriter &serializeData(EbmlClassId classId, const void *pvData, size_t cbData);

    int write(const void *data, size_t size);

    void writeUnsignedInteger(uint64_t value, size_t size = sizeof(uint64_t));

    void writeClassId(EbmlClassId parm);

    void writeSize(uint64_t parm);

    static inline size_t getSizeOfUInt(uint64_t arg);

private:

    void operator=(const EBMLWriter &);
};

#endif /* !MAIN_INCLUDED_EBMLWriter_h */