sound/vorbis.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  *  - kyra
  30  *  - m4
  31  *  - queen
  32  *  - saga
  33  *  - scumm
  34  *  - sword1
  35  *  - sword2
  36  *  - touche
  37  *  - tucker
  38  */
  39
  40 #ifndef SOUND_VORBIS_H
  41 #define SOUND_VORBIS_H
  42
  43 #include "common/scummsys.h"
  44
  45 #ifdef USE_VORBIS
  46
  47 namespace Common {
  48         class SeekableReadStream;
  49 }
  50
  51 namespace Audio {
  52
  53 class AudioStream;
  54
  55 /**
  56  * Create a new AudioStream from the Ogg Vorbis data in the given stream.
  57  * Allows for looping (which is why we require a SeekableReadStream),
  58  * and specifying only a portion of the data to be played, based
  59  * on time offsets.
  60  *
  61  * @param stream                        the SeekableReadStream from which to read the Ogg Vorbis data
  62  * @param disposeAfterUse       whether to delete the stream after use
  63  * @param startTime                     the (optional) time offset in milliseconds from which to start playback
  64  * @param duration                      the (optional) time in milliseconds specifying how long to play
  65  * @param numLoops                      how often the data shall be looped (0 = infinite)
  66  * @return      a new AudioStream, or NULL, if an error occured
  67  */
  68 AudioStream *makeVorbisStream(
  69         Common::SeekableReadStream *stream,
  70         bool disposeAfterUse,
  71         uint32 startTime = 0,
  72         uint32 duration = 0,
  73         uint numLoops = 1);
  74
  75 } // End of namespace Audio
  76
  77 #endif // #ifdef USE_VORBIS
  78 #endif // #ifndef SOUND_VORBIS_H