intern/audaspace/FX/AUD_SuperposeReader.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_SuperposeReader.h
  28  *  \ingroup audfx
  29  */
  30
  31
  32 #ifndef AUD_SUPERPOSEREADER
  33 #define AUD_SUPERPOSEREADER
  34
  35 #include "AUD_IReader.h"
  36 #include "AUD_Buffer.h"
  37
  38 /**
  39  * This reader plays two readers with the same specs sequently.
  40  */
  41 class AUD_SuperposeReader : public AUD_IReader
  42 {
  43 private:
  44         /**
  45          * The first reader.
  46          */
  47         AUD_IReader* m_reader1;
  48
  49         /**
  50          * The second reader.
  51          */
  52         AUD_IReader* m_reader2;
  53
  54         /**
  55          * The playback buffer for the intersecting part.
  56          */
  57         AUD_Buffer m_buffer;
  58
  59         // hide copy constructor and operator=
  60         AUD_SuperposeReader(const AUD_SuperposeReader&);
  61         AUD_SuperposeReader& operator=(const AUD_SuperposeReader&);
  62
  63 public:
  64         /**
  65          * Creates a new superpose reader.
  66          * \param reader1 The first reader to read from.
  67          * \param reader2 The second reader to read from.
  68          * \exception AUD_Exception Thrown if the specs from the readers differ.
  69          */
  70         AUD_SuperposeReader(AUD_IReader* reader1, AUD_IReader* reader2);
  71
  72         /**
  73          * Destroys the reader.
  74          */
  75         virtual ~AUD_SuperposeReader();
  76
  77         virtual bool isSeekable() const;
  78         virtual void seek(int position);
  79         virtual int getLength() const;
  80         virtual int getPosition() const;
  81         virtual AUD_Specs getSpecs() const;
  82         virtual void read(int & length, sample_t* & buffer);
  83 };
  84
  85 #endif //AUD_SUPERPOSEREADER