intern/audaspace/FX/AUD_EffectReader.h

   1 /*
   2  * $Id$
   3  *
   4  * ***** BEGIN GPL LICENSE BLOCK *****
   5  *
   6  * Copyright 2009-2011 Jörg Hermann Müller
   7  *
   8  * This file is part of AudaSpace.
   9  *
  10  * Audaspace is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * AudaSpace is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with Audaspace; if not, write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  23  *
  24  * ***** END GPL LICENSE BLOCK *****
  25  */
  26
  27 /** \file audaspace/FX/AUD_EffectReader.h
  28  *  \ingroup audfx
  29  */
  30
  31
  32 #ifndef AUD_EFFECTREADER
  33 #define AUD_EFFECTREADER
  34
  35 #include "AUD_IReader.h"
  36
  37 /**
  38  * This reader is a base class for all effect readers that take one other reader
  39  * as input.
  40  */
  41 class AUD_EffectReader : public AUD_IReader
  42 {
  43 private:
  44         // hide copy constructor and operator=
  45         AUD_EffectReader(const AUD_EffectReader&);
  46         AUD_EffectReader& operator=(const AUD_EffectReader&);
  47
  48 protected:
  49         /**
  50          * The reader to read from.
  51          */
  52         AUD_IReader* m_reader;
  53
  54 public:
  55         /**
  56          * Creates a new effect reader.
  57          * \param reader The reader to read from.
  58          */
  59         AUD_EffectReader(AUD_IReader* reader);
  60
  61         /**
  62          * Destroys the reader.
  63          */
  64         virtual ~AUD_EffectReader();
  65
  66         virtual bool isSeekable() const;
  67         virtual void seek(int position);
  68         virtual int getLength() const;
  69         virtual int getPosition() const;
  70         virtual AUD_Specs getSpecs() const;
  71         virtual void read(int & length, sample_t* & buffer);
  72 };
  73
  74 #endif //AUD_EFFECTREADER