sound/wave.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$
  22  * $Id$
  23  *
  24  */
  25
  26 /**
  27  * Sound decoder used in engines:
  28  *  - agos
  29  *  - gob
  30  *  - saga
  31  *  - scumm
  32  *  - sword1
  33  *  - sword2
  34  *  - tucker
  35  */
  36
  37 #ifndef SOUND_WAVE_H
  38 #define SOUND_WAVE_H
  39
  40 #include "common/scummsys.h"
  41
  42 namespace Common { class SeekableReadStream; }
  43
  44 namespace Audio {
  45
  46 class AudioStream;
  47
  48 /**
  49  * Try to load a WAVE from the given seekable stream. Returns true if
  50  * successful. In that case, the stream's seek position will be set to the
  51  * start of the audio data, and size, rate and flags contain information
  52  * necessary for playback. Currently this function supports uncompressed
  53  * raw PCM data, MS IMA ADPCM and MS ADPCM (uses makeADPCMStream internally).
  54  */
  55 extern bool loadWAVFromStream(
  56         Common::SeekableReadStream &stream,
  57         int &size,
  58         int &rate,
  59         byte &flags,
  60         uint16 *wavType = 0,
  61         int *blockAlign = 0);
  62
  63 /**
  64  * Try to load a WAVE from the given seekable stream and create an AudioStream
  65  * from that data. Currently this function supports uncompressed
  66  * raw PCM data, MS IMA ADPCM and MS ADPCM (uses makeADPCMStream internally).
  67  *
  68  * This function uses loadWAVFromStream() internally.
  69  *
  70  * @param stream                        the SeekableReadStream from which to read the WAVE data
  71  * @param disposeAfterUse       whether to delete the stream after use
  72  * @return      a new AudioStream, or NULL, if an error occured
  73  */
  74 AudioStream *makeWAVStream(
  75         Common::SeekableReadStream *stream,
  76         bool disposeAfterUse = false);
  77
  78 } // End of namespace Audio
  79
  80 #endif