---

/root/src/subsynth/syn/Stream/AudioIStream.h

Go to the documentation of this file.

/****************** <SYN heading BEGIN do not edit this line> *****************
 *
 * subsynth - modular audio synthesizer
 * subsynth is (C) Copyright 2001-2002 by Kevin Meinert
 *
 * Original Author: Kevin Meinert
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile: AudioIStream.h,v $
 * Date modified: $Date: 2002/02/16 19:24:16 $
 * Version:       $Revision: 1.15 $
 * -----------------------------------------------------------------
 *
 ****************** <SYN heading END do not edit this line> ******************/
#ifndef SUBSYNTH_INPUT_AUDIO_STREAM
#define SUBSYNTH_INPUT_AUDIO_STREAM

#include "syn/Util/AudioFormat.h"

namespace syn
{
   class AudioIStream
   {
   public:
      virtual ~AudioIStream(){}

      enum Operation {COPY, MUL, ADD, SUB};
   
      // open the stream
      // specify the audio format you would like returned
      // (independant of file attributes)
      virtual bool open( const syn::AudioFormat& fmt, Operation op = COPY ) = 0;

      // read data out of the stream in the format you specified.
      // returns this->gcount(); 
      // samples are in terms of [channels * bytes_per_samp]
      virtual void read( void* data, unsigned int samples ) = 0;
      
      // close the stream...
      virtual bool close() = 0;


      virtual bool isOpen() const = 0;
      virtual void seek( int sampleNum ) {}
      virtual bool eof() const { return true; }
      virtual bool good() const { return false; }
      virtual bool bad() const { return false; }

      virtual const AudioFormat& format() const = 0;

      // returns num samples actually read by the last read()
      // samples are in terms of [channels * bytes_per_samp]
      virtual int gcount() const = 0;
      
   protected:
      Operation mState;
   };
}

#endif

---