summaryrefslogtreecommitdiffabout
path: root/include/midillo/util.h
blob: f9c8430b7a34a0bd498938f331b199b405ce9ee2 (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
#ifndef __MIDILLO_UTIL_H
#define __MIDILLO_UTIL_H

#include <istream>
#include <ostream>

/**
 * @file
 * @brief utilities
 */

namespace midillo {
    using std::istream;
    using std::ostream;

    /**
     * read 32 bits word from the stream
     * @param s input stream
     * @return the data acquired
     */
    unsigned long read32(istream& s);
    /**
     * read 16 bits word from the stream
     * @param s input stream
     * @return the data acquired
     */
    unsigned int read16(istream& s);
    /**
     * read the variable length quantity from the stream
     * @param s input stream
     * @return the data acquired
     */
    unsigned long readVL(istream& s);

    /**
     * write 32 bits word to the stream
     * @param s output stream
     * @param d data to write
     */
    void write32(ostream& s,unsigned long d);
    /**
     * write 16 bits word to the stream
     * @param s output stream
     * @param d data to write
     */
    void write16(ostream& s,unsigned int d);
    /**
     * write the variable length quantity to the stream
     * @param s output stream
     * @param d data to write
     */
    void writeVL(ostream& s,unsigned long d);

    /**
     * calculate the amount of data that would be written by writeVL
     * @param d data that would be written
     * @return the number of bytes
     */
    unsigned long calcVLsize(unsigned long d);

}

#endif /* __MIDILLO_UTIL_H */