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
136
137
138
139
140
141
142
|
/* $Id: sample.hpp 17979 2009-11-05 22:11:04Z rubidium $ */
/*
* catcodec is a tool to decode/encode the sample catalogue for OpenTTD.
* Copyright (C) 2009 Remko Bijker
*
* 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, version 2.
*
* 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, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
/** @file sample.hpp Interface for Sample reading/writing */
#ifndef SAMPLE_HPP
#define SAMPLE_HPP
#include <vector>
#include "io.hpp"
/**
* Simple in-memory representation of a sample.
*/
class Sample {
private:
uint32_t offset; ///< Offset from the begin of the cat
uint32_t size; ///< The size of the WAV RIFF, i.e. excluding name and filename
string name; ///< The name of the sample
string filename; ///< The filename of the sample
uint16_t num_channels; ///< Number of channels; either 1 or 2
uint32_t sample_rate; ///< Sample rate; either 11025, 22050 or 44100
uint16_t bits_per_sample; ///< Number of bits per sample; either 8 or 16
uint32_t sample_size; ///< The size of the raw data below
uint8_t *sample_data; ///< The actual raw sample data
public:
/**
* Create a new sample by reading data from a file.
* In this case the data comes from a cat file, so for now we only
* read the offset and size from the file.
* @param reader the file to read from
*/
Sample(FileReader &reader);
/**
* Creates a new sample by reading the sample from a given (wav) file.
* @param filename the file to read the sample from
* @param name the name of the sample
*/
Sample(string filename, string name);
/**
* Cleans up our mess.
*/
~Sample();
/**
* Reads a sample from a reader.
* It reads WAV files (if that is the only thing in the file).
* This function has some very strict tests on validity of the input file.
* @param reader place to read the sample from
* @param check_size whether to check that our size makes sense with the size from the sample
*/
void ReadSample(FileReader &reader, bool check_size = true);
/**
* Reads a cat entry from a reader.
* This function has some very strict tests on validity of the input file.
* @param reader place to read the cat entry from
* @param new_format whether this is the old or new format; there are different strictness tests for both cases
*/
void ReadCatEntry(FileReader &reader, bool new_format);
/**
* Write a sample to a writer. If only a sample is written to the
* file it would be a valid WAV file.
* @param writer place to write the sample to
*/
void WriteSample(FileWriter &writer) const;
/**
* Write a cat entry to a writer.
* @param writer place to write the cat entry to
*/
void WriteCatEntry(FileWriter &writer) const;
/**
* Get the name of the sample.
* @return the name of the sample
*/
string GetName() const;
/**
* Get the filename of the sample
* @return the filename of the sample
*/
string GetFilename() const;
/**
* Set the offset from the begin of the cat to this cat entry.
* @param offset the offset.
*/
void SetOffset(uint32_t offset);
/**
* Get the offset for the cat entry that follows us.
* @return the offset for the next cat entry
*/
uint32_t GetNextOffset() const;
/**
* Get the offset from the begin of the cat to this cat entry.
* @return the offset
*/
uint32_t GetOffset() const;
/**
* Get the size of the WAV part of the file.
* @return the size
*/
uint32_t GetSize() const;
};
/** Lets have us a vector of samples */
typedef std::vector<Sample *> Samples;
#endif /* SAMPLE_HPP */
|
