File.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2002 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// dspsr/Kernel/Classes/dsp/File.h
 
 
#ifndef __File_h
#define __File_h
 
#include "dsp/Seekable.h"
#include "Registry.h"
 
namespace dsp {
 
 
  class File : public Seekable
  {
    friend class SerialFiles;
    friend class Multiplex;
    friend class HoleyFile;
    friend class RingBuffer;
    
  public:
    
 
    static File* create (const char* filename);
 
    static File* create (const std::string& filename)
    { return create (filename.c_str()); }
 
    File (const char* name);
    
    virtual ~File ();
 
 
    virtual bool is_valid (const char* filename) const = 0;
 
    virtual void open (const char* filename);
 
    void open (const std::string& filename) 
    { open (filename.c_str()); }
 
    virtual void close ();
 
    virtual void reopen ();
 
    std::string get_filename () const { return current_filename; }
    std::string get_current_filename() const { return current_filename; }
 
    virtual std::string get_data_filename () const;
 
    int get_header_bytes() const{ return header_bytes; }
 
    virtual bool contiguous (const File* that) const;
 
    typedef Registry::List<File> Register;
 
  protected:
    
 
    virtual void open_file (const char* filename) = 0;  
 
 
    virtual int64_t fstat_file_ndat(uint64_t tailer_bytes=0);
 
    virtual int64_t pad_bytes(unsigned char* buffer, int64_t bytes);
 
    
    int fd;
    
    int header_bytes;
 
 
    std::string current_filename;
 
    void * host_buffer = nullptr;
 
    uint64_t host_buffer_size = 0;
 
 
    virtual int64_t load_bytes (unsigned char* buffer, uint64_t nbytes);
 
    virtual int64_t load_bytes_device (unsigned char* buffer, uint64_t bytes, void * device_handle);
    
 
    virtual int64_t seek_bytes (uint64_t bytes);
    
    virtual void set_total_samples ();
 
    virtual void open_fd (const std::string& filename);
 
    static Register& get_register();
 
  private:
 
    void init();
 
 
  };
 
}
 
#endif // !defined(__File_h)