stnd_io.h

/* stnd_io.h */
/* $Id: stnd_io.h,v 1.2 2001/04/02 13:34:24 vlad Exp $ */
#ifndef __stnd_io_h
#define __stnd_io_h

#include <mix/ErrCodes.h>
#include <mix/trans.h>
#include <mix/stnd_file.h>


/***********************************************************************
 * Input/output of VSP-PC file is controlled by this structure:
 ***********************************************************************/
typedef struct
{
  char      *fpath;     /* file path or device name */
  int       fildes;     /* file handle */
  char      omode;      /* operating mode: 'r' - read, 'w' - write */

  /* read operating mode only */
  int       filesize;   /* size of file */
  int       fhsize;     /* size of file header (bytes) */
  int       thsize;     /* size of trace header (bytes) */
  int       trsize;     /* size of trace body (bytes) */
  int       nsamples;   /* number of sample in trace */
  AtomType  format;     /* sample's format */
  void      *trconv;    /* trace body conversion buffer */

}   stnd_io_t;


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


/******************************
 * Input/output               *
 ******************************/

/* Open VSP-PC file for writing. */
ErrCode     stnd_open_file_write (stnd_io_t* io,
                      const char* szFilePath);

/* Open VSP-PC file for reading. */
ErrCode     stnd_open_file_read (stnd_io_t* io,
                     const char* szFilePath);

/* Close VSP-PC file. */
ErrCode     stnd_close (stnd_io_t* io);

/* Write trace file header. */
ErrCode     stnd_write_file_hdr (stnd_io_t* io,
                     const STND_FileHeader* hdr);

/* Write trace header. */
ErrCode     stnd_write_trace_hdr (stnd_io_t* io,
                      const STND_TraceHeader* hdr);

/* Write trace body. */
ErrCode     stnd_write_trace_body (stnd_io_t* io,
                       Real4* body,
                       int nsamples);

/* Read trace file header. */
ErrCode     stnd_read_file_hdr (stnd_io_t* io,
                    STND_FileHeader* hdr);

/* Read trace header. */
ErrCode     stnd_read_trace_hdr (stnd_io_t* io,
                     STND_TraceHeader* hdr);

/* Read trace body. */
ErrCode     stnd_read_trace_body (stnd_io_t* io,
                      Real4* body);


/******************************
 *   Input/Ouput buffer to    *
 *  C structure conversion.   *
 ******************************/

/* Copy trace header from structure to file I/O buffer. */
ErrCode     stnd_copy_th2io (void* buf,
                 const STND_TraceHeader_blocks* th);

/* Copy file header from structure to file I/O buffer. */
ErrCode     stnd_copy_fh2io (void* buf,
                 const STND_FileHeader_blocks* fh);

/* Copy trace header from file I/O buffer to structure. */
ErrCode     stnd_copy_io2th (const void* buf,
                 STND_TraceHeader_blocks* th);

/* Copy file header from file I/O buffer to structure. */
ErrCode     stnd_copy_io2fh (const void* buf,
                 STND_FileHeader_blocks* fh);


/******************************
 * ASCII supposed operations  *
 ******************************/

/* Initialize file header header by template. */
ErrCode     stnd_fh_template (STND_FileHeader* hdr);

/* Print to log file header. */
ErrCode     stnd_fh_put_log (const STND_FileHeader* hdr,
                 Logic bImportant);

/* Print to log trace header. */
ErrCode     stnd_th_put_log (const STND_TraceHeader* hdr,
                 Logic bImportant);

#ifdef __cplusplus
};
#endif /* __cplusplus */


#endif /* stnd_io.h */