gemrb/core/SoundMgr.h

   1 /* GemRB - Infinity Engine Emulator
   2  * Copyright (C) 2003 The GemRB Project
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  *
  19  */
  20
  21 #ifndef SOUNDMGR_H
  22 #define SOUNDMGR_H
  23
  24 #include "ie_types.h"
  25
  26 #include "DataStream.h"
  27 #include "Resource.h"
  28
  29 /**
  30  * Base Class for sound plugins
  31  */
  32 class GEM_EXPORT SoundMgr : public Resource {
  33 public:
  34         static const TypeID ID;
  35 public:
  36         SoundMgr(void);
  37         virtual ~SoundMgr(void);
  38         /**
  39          * Read up to cnt samples into memory
  40          *
  41          * @param[out] memory Array to hold samples read.
  42          * @param[in] cnt number of samples to read.
  43          * @returns Number of samples read.
  44          */
  45         virtual int read_samples( short* memory, int cnt ) = 0 ;
  46         int get_channels() const
  47         {
  48                 return channels;
  49         }
  50         int get_samplerate() const
  51         {
  52                 return samplerate;
  53         }
  54         int get_length() const
  55         {
  56                 return samples;
  57         } // returns the total samples count
  58 protected:
  59         int samples; // total count of sound samples
  60         int channels;
  61         int samplerate;
  62 };
  63
  64 #endif