aboutsummaryrefslogtreecommitdiff
path: root/engines/glk/frotz/sound_folder.h
blob: 50eef065b112ad2e86253db4d06ee056a0356d82 (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
138
/* 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 GLK_FROTZ_SOUND_FOLDER_H
#define GLK_FROTZ_SOUND_FOLDER_H

#include "glk/frotz/frotz_types.h"
#include "common/archive.h"
#include "common/fs.h"
#include "common/hash-str.h"

namespace Glk {
namespace Frotz {

/**
 * Acts as an interface to an Infocom sound subfolder for the Lurking Horror or
 * Sherlock. Any file which ends with a number and '.snd' will be accessible as
 * 'sound<num>.snd' in the outer Glk layer
 */
class SoundSubfolder : public Common::Archive {
private:
	Common::FSNode _folder;
	Common::StringMap _filenames;
private:
	/**
	 * Constructor
	 */
	SoundSubfolder(const Common::FSNode &folder);
public:
	/**
	 * Checks for a sound subfolder, and if so, instantiates the class for it
	 */
	static void check(const Common::FSNode &gameDir);

	/**
	 * Check if a member with the given name is present in the Archive.
	 * Patterns are not allowed, as this is meant to be a quick File::exists()
	 * replacement.
	 */
	virtual bool hasFile(const Common::String &name) const override;

	/**
	 * Add all members of the Archive to list.
	 * Must only append to list, and not remove elements from it.
	 *
	 * @return the number of names added to list
	 */
	virtual int listMembers(Common::ArchiveMemberList &list) const override;

	/**
	 * Returns a ArchiveMember representation of the given file.
	 */
	virtual const Common::ArchiveMemberPtr getMember(const Common::String &name) const override;

	/**
	 * Create a stream bound to a member with the specified name in the
	 * archive. If no member with this name exists, 0 is returned.
	 * @return the newly created input stream
	 */
	virtual Common::SeekableReadStream *createReadStreamForMember(const Common::String &name) const override;
};

/**
 * Acts as an interface to a Zip file from if-archive for the Lurking Horror or
 * Sherlock. Any file which ends with a number and '.snd' will be accessible as
 * 'sound<num>.snd' in the outer Glk layer
 */
class SoundZip : public Common::Archive {
private:
	Common::Archive *_zip;
	Common::StringMap _filenames;
private:
	/**
	 * Constructor
	 */
	SoundZip(Common::Archive *zip);
public:
	/**
	 * Checks for a sound subfolder, and if so, instantiates the class for it
	 */
	static void check(const Common::FSNode &gameDir, Story story);

	/**
	 * Destructor
	 */
	~SoundZip();

	/**
	 * Check if a member with the given name is present in the Archive.
	 * Patterns are not allowed, as this is meant to be a quick File::exists()
	 * replacement.
	 */
	virtual bool hasFile(const Common::String &name) const override;

	/**
	 * Add all members of the Archive to list.
	 * Must only append to list, and not remove elements from it.
	 *
	 * @return the number of names added to list
	 */
	virtual int listMembers(Common::ArchiveMemberList &list) const override;

	/**
	 * Returns a ArchiveMember representation of the given file.
	 */
	virtual const Common::ArchiveMemberPtr getMember(const Common::String &name) const override;

	/**
	 * Create a stream bound to a member with the specified name in the
	 * archive. If no member with this name exists, 0 is returned.
	 * @return the newly created input stream
	 */
	virtual Common::SeekableReadStream *createReadStreamForMember(const Common::String &name) const override;
};

} // End of namespace Frotz
} // End of namespace Glk

#endif