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 #include "Resource.h"
  26 #include "DataStream.h"
  27
  28 /**
  29  * Base Class for sound plugins
  30  */
  31 class GEM_EXPORT SoundMgr : public Resource {
  32 public:
  33         static const TypeID ID;
  34 public:
  35         SoundMgr(void);
  36         virtual ~SoundMgr(void);
  37         /**
  38          * Read up to cnt samples into memory
  39          *
  40          * @param[out] memory Array to hold samples read.
  41          * @param[in] cnt number of samples to read.
  42          * @returns Number of samples read.
  43          */
  44         virtual int read_samples( short* memory, int cnt ) = 0 ;
  45         int get_channels() const
  46         {
  47                 return channels;
  48         }
  49         int get_samplerate() const
  50         {
  51                 return samplerate;
  52         }
  53         int get_length() const
  54         {
  55                 return samples;
  56         } // returns the total samples count
  57 protected:
  58         int samples; // total count of sound samples
  59         int channels;
  60         int samplerate;
  61 };
  62
  63 #endif