← Back to branch summary

~ubuntu-branches/ubuntu/raring/scummvm/raring

« back to all changes in this revision

Viewing changes to sound/decoders/aiff.h

  • Committer: Bazaar Package Importer
  • Author(s): Moritz Muehlenhoff
  • Date: 2011-05-25 19:02:23 UTC
  • mto: (21.1.2 sid)
  • mto: This revision was merged to the branch mainline in revision 24.
  • Revision ID: james.westby@ubuntu.com-20110525190223-fiqm0oaec714xk31
Tags: upstream-1.3.0
Import upstream version 1.3.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
sound/decoders/aiff.h
1
 
/* ScummVM - Graphic Adventure Engine
2
 
 *
3
 
 * ScummVM is the legal property of its developers, whose names
4
 
 * are too numerous to list here. Please refer to the COPYRIGHT
5
 
 * file distributed with this source distribution.
6
 
 *
7
 
 * This program is free software; you can redistribute it and/or
8
 
 * modify it under the terms of the GNU General Public License
9
 
 * as published by the Free Software Foundation; either version 2
10
 
 * of the License, or (at your option) any later version.
11
 
 
12
 
 * This program is distributed in the hope that it will be useful,
13
 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14
 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15
 
 * GNU General Public License for more details.
16
 
 
17
 
 * You should have received a copy of the GNU General Public License
18
 
 * along with this program; if not, write to the Free Software
19
 
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20
 
 *
21
 
 * $URL: https://scummvm.svn.sourceforge.net/svnroot/scummvm/scummvm/tags/release-1-2-1/sound/decoders/aiff.h $
22
 
 * $Id: aiff.h 49844 2010-06-15 12:33:54Z fingolfin $
23
 
 *
24
 
 */
25
 
 
26
 
/**
27
 
 * @file
28
 
 * Sound decoder used in engines:
29
 
 *  - saga
30
 
 *  - sword1
31
 
 */
32
 
 
33
 
#ifndef SOUND_AIFF_H
34
 
#define SOUND_AIFF_H
35
 
 
36
 
#include "common/scummsys.h"
37
 
#include "common/types.h"
38
 
 
39
 
namespace Common { class SeekableReadStream; }
40
 
 
41
 
namespace Audio {
42
 
 
43
 
class SeekableAudioStream;
44
 
 
45
 
/**
46
 
 * Try to load an AIFF from the given seekable stream. Returns true if
47
 
 * successful. In that case, the stream's seek position will be set to the
48
 
 * start of the audio data, and size, rate and flags contain information
49
 
 * necessary for playback. Currently this function only supports uncompressed
50
 
 * raw PCM data as well as IMA ADPCM.
51
 
 */
52
 
extern bool loadAIFFFromStream(Common::SeekableReadStream &stream, int &size, int &rate, byte &flags);
53
 
 
54
 
/**
55
 
 * Try to load an AIFF from the given seekable stream and create an AudioStream
56
 
 * from that data.
57
 
 *
58
 
 * This function uses loadAIFFFromStream() internally.
59
 
 *
60
 
 * @param stream                        the SeekableReadStream from which to read the AIFF data
61
 
 * @param disposeAfterUse       whether to delete the stream after use
62
 
 * @return      a new SeekableAudioStream, or NULL, if an error occurred
63
 
 */
64
 
SeekableAudioStream *makeAIFFStream(
65
 
        Common::SeekableReadStream *stream,
66
 
        DisposeAfterUse::Flag disposeAfterUse);
67
 
 
68
 
} // End of namespace Audio
69
 
 
70
 
#endif