sound/shorten.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 // The code in this file is currently only used in SAGA2 (in the
  27 // SAGA engine), so if that engine isn't enabled, we will skip
  28 // compiling it. If you plan to use this code in another engine,
  29 // you will have to add the proper define check here.
  30 // Also please add the define check at the comment after the
  31 // matching #endif further down this file.
  32 #if defined(ENABLE_SAGA2)
  33
  34 #ifndef SOUND_SHORTEN_H
  35 #define SOUND_SHORTEN_H
  36
  37 #include "common/scummsys.h"
  38
  39 namespace Common { class ReadStream; }
  40
  41 namespace Audio {
  42
  43 class AudioStream;
  44
  45 /**
  46  * Try to load a Shorten file from the given 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.
  50  */
  51 extern byte *loadShortenFromStream(Common::ReadStream &stream, int &size, int &rate, byte &flags);
  52
  53 /**
  54  * Try to load a Shorten file from the given stream and create an AudioStream
  55  * from that data.
  56  *
  57  * This function uses loadShortenFromStream() internally.
  58  */
  59 AudioStream *makeShortenStream(Common::ReadStream &stream);
  60
  61 } // End of namespace Audio
  62
  63 #endif
  64
  65 #endif // defined(ENABLE_SAGA2)
  66
  67