aboutsummaryrefslogtreecommitdiff
path: root/engines/titanic/sound/wave_file.h
blob: 4158d64683c4166044348f8269fad963b992c65b (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
136
137
/* 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.
 *
 */

#ifndef TITANIC_WAVE_FILE_H
#define TITANIC_WAVE_FILE_H

#include "audio/audiostream.h"
#include "audio/mixer.h"
#include "titanic/sound/audio_buffer.h"
#include "titanic/support/string.h"
#include "titanic/true_talk/dialogue_file.h"

namespace Titanic {

enum LoadMode { LOADMODE_AUDIO_BUFFER = 1, LOADMODE_SCUMMVM = 2 };

class QSoundManager;

class CWaveFile {
private:
	byte *_waveData;
	int _waveSize;
	int _dataSize;
	QSoundManager *_soundManager;
	Audio::SeekableAudioStream *_audioStream;
	Audio::SoundHandle _soundHandle;
private:
	/**
	 * Handles setup of fields shared by the constructors
	 */
	void setup();

	/**
	 * Gets passed the raw data for the wave file
	 */
	void load(byte *data, uint size);
public:
	Audio::Mixer::SoundType _soundType;

	LoadMode _loadMode;
	int _field4;
	int _field14;
	CAudioBuffer *_audioBuffer;
	DisposeAfterUse::Flag _disposeAudioBuffer;
	int _channel;
public:
	CWaveFile();
	CWaveFile(QSoundManager *owner);
	~CWaveFile();

	/**
	 * Returns the duration of the wave file
	 * @returns	Total ticks. Not really sure how ticks
	 * map to real time
	 */
	uint getDurationTicks() const;

	/**
	 * Return the size of the wave file
	 */
	uint size() const { return _dataSize; }

	/**
	 * Returns a ScummVM Audio Stream for playback purposes
	 */
	Audio::SeekableAudioStream *audioStream();

	/**
	 * Tries to load the specified wave file sound
	 */
	bool loadSound(const CString &name);

	/**
	 * Tries to load speech from a specified dialogue file
	 */
	bool loadSpeech(CDialogueFile *dialogueFile, int speechIndex);

	/**
	 * Tries to load the specified music wave file
	 */
	bool loadMusic(const CString &name);

	/**
	 * Tries to load the specified audio buffer
	 */
	bool loadMusic(CAudioBuffer *buffer, DisposeAfterUse::Flag disposeAfterUse);

	/**
	 * Returns true if the wave file has data loaded
	 */
	bool isLoaded() const {
		return _audioStream != nullptr || _waveData != nullptr;
	}

	/**
	 * Return the frequency of the loaded wave file
	 */
	uint getFrequency();

	/**
	 * Resets the music stream
	 */
	void reset();

	/**
	 * Lock sound data for access
	 */
	const byte *lock();

	/**
	 * Unlock sound data after a prior call to lock
	 */
	void unlock(const byte *ptr);
};

} // End of namespace Titanic

#endif /* TITANIC_WAVE_FILE_H */