aboutsummaryrefslogtreecommitdiff
path: root/audio/decoders/quicktime.h
blob: 9f6c6c20e0fc26da9e288e0274b5da1578444674 (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
/* 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.
 *
 * $URL$
 * $Id$
 *
 */

/**
 * @file
 * Sound decoder used in engines:
 *  - groovie
 *  - mohawk
 *  - sci
 */

#ifndef AUDIO_QUICKTIME_H
#define AUDIO_QUICKTIME_H

#include "common/scummsys.h"
#include "common/types.h"

namespace Common {
	class SeekableReadStream;
	class String;
}

namespace Audio {

class SeekableAudioStream;

/**
 * Try to load a QuickTime sound file from the given file name and create a SeekableAudioStream
 * from that data.
 *
 * @param filename          the filename of the file from which to read the data
 * @return  a new SeekableAudioStream, or NULL, if an error occurred
 */
SeekableAudioStream *makeQuickTimeStream(const Common::String &filename);

/**
 * Try to load a QuickTime sound file from the given seekable stream and create a SeekableAudioStream
 * from that data.
 *
 * @param stream            the SeekableReadStream from which to read the data
 * @param disposeAfterUse   whether to delete the stream after use
 * @return  a new SeekableAudioStream, or NULL, if an error occurred
 */
SeekableAudioStream *makeQuickTimeStream(Common::SeekableReadStream *stream, DisposeAfterUse::Flag disposeAfterUse = DisposeAfterUse::YES);

} // End of namespace Audio

#endif