/*
 * --- GSMP-COPYRIGHT-NOTE-BEGIN ---
 * 
 * This copyright note is auto-generated by ./scripts/Create-CopyPatch.
 * Please add additional copyright information _after_ the line containing
 * the GSMP-COPYRIGHT-NOTE-END tag. Otherwise it might get removed by
 * the ./scripts/Create-CopyPatch script. Do not edit this copyright text!
 * 
 * GSMP: pcm/include/BasicFileStream.hh
 * General Sound Manipulation Program is Copyright (C) 2000 - 2004
 *   Valentin Ziegler and René Rebe
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 2. A copy of the GNU General
 * Public License can be found in the file LICENSE.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANT-
 * ABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
 * Public License for more details.
 * 
 * --- GSMP-COPYRIGHT-NOTE-END ---
 */

/* Short Description:
 *   Extended IO-Streaming, according Importer and OggVorbis / MP3
 *   IO-Stream classes.
 */

#ifndef LOWLEVEL___BASICFILESTREAM_HH__
#define LOWLEVEL___BASICFILESTREAM_HH__

#include "Types.hh"
#include "PcmBuffer.hh"
#include "BasicStream.hh"

#include <string>
#include <vector>

namespace GSMP
{
  
  // interface for file streams
  class BasicFileStream
  {
  public:
    
    virtual ~BasicFileStream () {};
    
    /* Control */
    virtual bool Open (const std::string& fname) = 0;
    virtual bool IsOpen () = 0;
    virtual bool Close () = 0;
    
    virtual global_index Size () = 0;
    virtual channel_index Channels () = 0;
    virtual sample_rate Rate () = 0;
    
    /* TODO: more sophisticated Info like:
     * DAM::Properties Properties (FileStreamProperties);
     */
    
    /* Operations */
    virtual local_index Read (local_index size,
			      BasicStream* dest) = 0;
    
    virtual global_index Seek (global_index pos) = 0;
  };

} // end namespace GSMP

#endif // LOWLEVEL__BASICFILESTREAM_HH__