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
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* 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; either version 2
* of the License, or (at your option) any later version.
*
* 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
* Sound decoder used in engines:
* - agos
* - lastexpress
* - mohawk
* - saga
* - sci (DK3 ADPCM for Phantasmagoria 2)
* - scumm
* - tinsel
*/
#ifndef AUDIO_ADPCM_H
#define AUDIO_ADPCM_H
#include "common/scummsys.h"
#include "common/types.h"
namespace Common {
class SeekableReadStream;
}
namespace Audio {
class PacketizedAudioStream;
class SeekableAudioStream;
// There are several types of ADPCM encoding, only some are supported here
// For all the different encodings, refer to:
// http://wiki.multimedia.cx/index.php?title=Category:ADPCM_Audio_Codecs
// Usually, if the audio stream we're trying to play has the FourCC header
// string intact, it's easy to discern which encoding is used
enum ADPCMType {
kADPCMOki, // Dialogic/Oki ADPCM (aka VOX)
kADPCMMSIma, // Microsoft IMA ADPCM
kADPCMMS, // Microsoft ADPCM
kADPCMDVI, // Intel DVI IMA ADPCM
kADPCMApple, // Apple QuickTime IMA ADPCM
kADPCMDK3 // Duck DK3 IMA ADPCM
};
/**
* Takes an input stream containing ADPCM compressed sound data and creates
* an RewindableAudioStream from that.
*
* @param stream the SeekableReadStream from which to read the ADPCM data
* @param disposeAfterUse whether to delete the stream after use
* @param size how many bytes to read from the stream (0 = all)
* @param type the compression type used
* @param rate the sampling rate
* @param channels the number of channels
* @param blockAlign block alignment ???
* @return a new RewindableAudioStream, or NULL, if an error occurred
*/
SeekableAudioStream *makeADPCMStream(
Common::SeekableReadStream *stream,
DisposeAfterUse::Flag disposeAfterUse,
uint32 size, ADPCMType type,
int rate,
int channels,
uint32 blockAlign = 0);
/**
* Creates a PacketizedAudioStream that will automatically queue
* packets as individual AudioStreams like returned by makeADPCMStream.
*
* Due to the ADPCM types not necessarily supporting stateless
* streaming, OKI and DVI are not supported by this function
* and will return NULL.
*
* @param type the compression type used
* @param rate the sampling rate
* @param channels the number of channels
* @param blockAlign block alignment ???
* @return The new PacketizedAudioStream or NULL, if the type isn't supported.
*/
PacketizedAudioStream *makePacketizedADPCMStream(
ADPCMType type,
int rate,
int channels,
uint32 blockAlign = 0);
} // End of namespace Audio
#endif
|
