segy_api.h

/* segy_api.h */
/* $Id: segy_api.h,v 1.2 2006/10/19 14:57:32 vlad Exp $ */
#ifndef __segy_api_h
#define __segy_api_h


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


struct segy_io_s;
typedef ErrCode (*segy_trans_th_proc)(struct segy_io_s* io,
                      SEGY_TraceHeader* buf);


/***********************************************************************
 * Input/output of SEG-Y file is controlled by this structure:
 ***********************************************************************/
typedef struct segy_io_s
{
  char      *fpath;     
  int       fildes;     
  char      omode;      
  char      media;      
  TextEncoding  text_hdr_enc;   
  ByteOrder bin_data_fmt;   
  int       sample_fmt; 
  int       sample_size;    
  void      *trace_buf; 
  unsigned  trace_size; 
  /***************************************
   * Input operation support (omode='r') *
   ***************************************/
  unsigned  text_hdr_size;  
  unsigned  bin_hdr_size;   
  unsigned  trace_hdr_size; 
  unsigned  file_size;  
  segy_trans_th_proc    in_thdr;
  segy_trans_th_proc    out_thdr;

}   segy_io_t;


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


  ErrCode   segy_init_io (segy_io_t* io);

  ErrCode   segy_init_trace_buffer (segy_io_t* io,
                    const SEGY_BinaryHeader* hdr);

  ErrCode   segy_close (segy_io_t* io);

  unsigned  segy_sample_size (int sample_fmt);


  /********************************
   * Input operations (omode='r') *
   ********************************/

  ErrCode   segy_open_file_read (segy_io_t* io,
                     const char* szFilePath);

  ErrCode   segy_read_reel_text_hdr (segy_io_t* io, char** psTextHdr);

  ErrCode   segy_read_reel_bin_hdr (segy_io_t* io,
                    SEGY_BinaryHeader* hdr);

  ErrCode   segy_read_trace (segy_io_t* io,
                 SEGY_TraceHeader* hdr, void* body);

  ErrCode   segy_in_hdr (segy_io_t* io, SEGY_TraceHeader* hdr);

  ErrCode   segy_in_hdr_vsp (segy_io_t* io, SEGY_TraceHeader* hdr);

  ErrCode   segy_in_body (segy_io_t* io, void* buf);


  /*********************************
   * Output operations (omode='w') *
   *********************************/

  ErrCode   segy_open_file_write (segy_io_t* io,
                      const char* szFilePath);

  ErrCode   segy_write_reel_text_hdr (segy_io_t* io,
                      const char* sTextHdr);

  ErrCode   segy_write_reel_bin_hdr (segy_io_t* io,
                     const SEGY_BinaryHeader* hdr);

  ErrCode   segy_append_trace (segy_io_t* io,
                   const SEGY_TraceHeader* hdr,
                   Real4* body, int nsamples);

  ErrCode   segy_out_hdr (segy_io_t* io, SEGY_TraceHeader* hdr);

  ErrCode   segy_out_hdr_vsp (segy_io_t* io, SEGY_TraceHeader* hdr);

  ErrCode   segy_out_body (segy_io_t* io, Real4* buf,
                   const Real4* body, int nsamples);


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

  ErrCode   segy_eh_template (char* sTextHdr);

  ErrCode   segy_eh_put_integer (char* sTextHdr,
                     int offset,
                     int value);

  ErrCode   segy_eh_put_text (char* sTextHdr,
                  int offset,
                  const char* value);

  ErrCode   segy_eh_put_log (const char* sTextHdr);

  ErrCode   segy_bh_put_log (const SEGY_BinaryHeader* hdr,
                 Logic bImportant);

  ErrCode   segy_th_put_log (const SEGY_TraceHeader* hdr,
                 Logic bImportant, Logic bVSP, Logic bNumbers);

  int       segy_th_value_by_number (const void* hdr,
                     int th_number,
                     AtomType* atype);

  char*     segy_th_word_name (int th_number);


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

#endif /* segy_api.h */