segd_file.h

/* segd_file.h */
/* $Id: segd_file.h,v 1.2 2004/02/03 13:33:24 vlad Exp $ */
#ifndef __segd_file_h
#define __segd_file_h

/***********************************************************************
 *
 * SEG-D digital tape standard (Revisions 0, 1, 2)
 *
 * (C) 2003,2004, Geovers, Ltd.
 *
 ***********************************************************************/

#define SEGD_HdrSize        32
#define SEGD_GH1_Size   SEGD_HdrSize    /* general header #1 size (Rev.0) */
#define SEGD_GH2_Size   SEGD_HdrSize    /* general header #2 size (Rev.1,2) */
#define SEGD_GHN_Size   SEGD_HdrSize    /* general header #N size (Rev.1,2) */
#define SEGD_CS_Size    SEGD_HdrSize    /* channel set header size */
#define SEGD_SS_Size    SEGD_HdrSize    /* sample skew block size */
#define SEGD_XH_Size    SEGD_HdrSize    /* extended and external header size */
#define SEGD_SOS_Size       4   /* start of scan */
#define SEGD_TW_Size        4   /* timing word */
#define SEGD_DTH_Size       20  /* trace header size */
#define SEGD_ETH_Size   SEGD_HdrSize    /* extended trace header block size */

/* Start of scan flags */
#define SEGD_SOS_TWI    (1<<0)  
#define SEGD_SOS_ITB    (1<<1)  
#define SEGD_SOS_DP (1<<2)  
/* Build number from several decimal nibbles */

#define DEC2n(x1,x2)        ((x1)*10+(x2))

#define DEC3n(x1,x2,x3)     (DEC2n(x1,x2)*10+(x3))

#define DEC4n(x1,x2,x3,x4)  (DEC3n(x1,x2,x3)*10+(x4))


#define BCDn(x,d)       (((x)&(0x0f<<(4*(d))))>>(4*(d)))

#define BCDb(x)         (DEC2n(BCDn(x,1),BCDn(x,0)))

#define BCD3b(x1,x2,x3)     (BCDb(x1)*10000+BCDb(x2)*100+BCDb(x3))


/***********************************************************************
 * General header #1
 ***********************************************************************/

/*      Field name          Offset */
#define SEGD_GH1_FILE_NUMBER        0
#define SEGD_GH1_FORMAT_CODE        2
#define SEGD_GH1_GENERAL_CONSTANTS  4
#define SEGD_GH1_YEAR           10
#define SEGD_GH1_GHNUM_DAY      11
#define SEGD_GH1_DAY            12
#define SEGD_GH1_HOUR           13
#define SEGD_GH1_MINUTE         14
#define SEGD_GH1_SECOND         15
#define SEGD_GH1_MANUFACTURER_CODE  16
#define SEGD_GH1_MANUFACTURER_FORMAT    17
#define SEGD_GH1_BYTES_PER_SCAN     18
#define SEGD_GH1_BASE_SCAN_INTERVAL 22
#define SEGD_GH1_POLARITY_SB_EXP    23
#define SEGD_GH1_SCAN_BLOCK     24
#define SEGD_GH1_REC_TYPE_REC_LEN   25
#define SEGD_GH1_RECORD_LENGTH      26
#define SEGD_GH1_SCAN_TYPES     27
#define SEGD_GH1_CHANNEL_SETS       28
#define SEGD_GH1_SKEW_BLOCKS        29
#define SEGD_GH1_EXTENDED_HDR_BLOCKS    30
#define SEGD_GH1_EXTERNAL_HDR_BLOCKS    31


/***********************************************************************
 * General header #2
 ***********************************************************************/

/*      Field name          Offset */
#define SEGD_GH2_FILE_NUMBER        0
#define SEGD_GH2_CHANNEL_SETS       3
#define SEGD_GH2_EXTENDED_HDR_BLOCKS    5
#define SEGD_GH2_EXTERNAL_HDR_BLOCKS    7
#define SEGD_GH2_REVISION_MAJOR     10
#define SEGD_GH2_REVISION_MINOR     11
#define SEGD_GH2_GENERAL_TRAILER_BLOCKS 12
#define SEGD_GH2_RECORD_LENGTH      14
#define SEGD_GH2_GH_BLOCK_NUMBER    18


/***********************************************************************
 * General header #N
 ***********************************************************************/

/*      Field name          Offset */
#define SEGD_GHN_SRC_LINE_NUM_CARD  3
#define SEGD_GHN_SRC_LINE_NUM_FRAC  6
#define SEGD_GHN_SRC_POINT_NUM_CARD 8
#define SEGD_GHN_SRC_POINT_NUM_FRAC 11
#define SEGD_GHN_SRC_POINT_INDEX    13
#define SEGD_GHN_PHASE_CONTROL      14
#define SEGD_GHN_VIBRATOR_TYPE      15
#define SEGD_GHN_PHASE_ANGLE        16
#define SEGD_GHN_GH_BLOCK_NUMBER    18
#define SEGD_GHN_SRC_SET_NUMBER     19


/***********************************************************************
 * Channel set description header
 ***********************************************************************/

/*      Field name          Offset */
#define SEGD_CS_SCAN_TYPE_NUMBER    0
#define SEGD_CS_CHANNEL_SET_NUMBER  1
#define SEGD_CS_CHANNEL_SET_START_TIME  2
#define SEGD_CS_CHANNEL_SET_END_TIME    4
#define SEGD_CS_DESCALE_MULTIPLIER  6
#define SEGD_CS_NUMBER_OF_CHANNELS  8
#define SEGD_CS_CHANNEL_TYPE        10
#define SEGD_CS_SAMPLES_PER_CHAN_GAIN   11
#define SEGD_CS_ALIAS_FILTER_FREQ   12
#define SEGD_CS_ALIAS_FILTER_SLOPE  14
#define SEGD_CS_LOW_CUT_FILTER      16
#define SEGD_CS_LOW_CUT_FILTER_SLOPE    18
#define SEGD_CS_1ST_NOTCH_FILTER    20
#define SEGD_CS_2ND_NOTCH_FILTER    22
#define SEGD_CS_3RD_NOTCH_FILTER    24
#define SEGD_CS_EXTENDED_CS_NUMBER  26
#define SEGD_CS_EXTENDED_HDR_FLAG   28
#define SEGD_CS_VERTICAL_STACK      29
#define SEGD_CS_STREAMER_CABLE_NUMBER   30
#define SEGD_CS_ARRAY_FORMING       31


/***********************************************************************
 * Demux trace header
 ***********************************************************************/

/*      Field name          Offset */
#define SEGD_DTH_FILE_NUMBER        0
#define SEGD_DTH_SCAN_TYPE_NUMBER   2
#define SEGD_DTH_CHANNEL_SET_NUMBER 3
#define SEGD_DTH_TRACE_NUMBER       4
#define SEGD_DTH_FIRST_TIMING_WORD  6
#define SEGD_DTH_TRACE_HDR_EXTENSIONS   9
#define SEGD_DTH_SAMPLE_SKEW        10
#define SEGD_DTH_TRACE_EDIT     11
#define SEGD_DTH_TIME_BREAK_WINDOW  12
#define SEGD_DTH_EXT_CHANNEL_SET_NUMBER 15
#define SEGD_DTH_EXT_FILE_NUMBER    17

/***********************************************************************
 * Demux trace header extension
 ***********************************************************************/

/*      Field name          Offset */
#define SEGD_ETH_RECEIVER_LINE_NUMBER   0
#define SEGD_ETH_RECEIVER_POINT_NUMBER  3
#define SEGD_ETH_RECEIVER_POINT_INDEX   6
#define SEGD_ETH_NUMBER_OF_SAMPLES  7


/*
 * ÁÛÕÔãîéÐï ãáÛÞÒÝÞ-ÞÑàÐÑÐâëÒÐÕÜÐï çÐáâì ÔÕÙáâÒØâÕÛìÝÐ âÞÛìÚÞ ÕáÛØ
 * ÔÐÝÝëÙ äÐÙÛ ßÞÔÚÛîçÕÝ ½µ Ø× ßàÞÓàÐÜÜë âàÐÝáäÞàÜÐæØØ (áÜÞâàØ ft).
 */
#ifndef _filetrans_

#include <mix/Types.h>

typedef enum
{
  /* Multiplexed formats */
  SEGD_FC_0015 = 0x0015,    /* 20 bits, binary multiplexed */
  SEGD_FC_0022 = 0x0022,    /* 8 bits, quaternary */
  SEGD_FC_0042 = 0x0042,    /* 8 bits, hexadecimal */
  SEGD_FC_0024 = 0x0024,    /* 16 bits, quaternary */
  SEGD_FC_0044 = 0x0044,    /* 16 bits, hexadecimal */
  SEGD_FC_0036 = 0x0036,    /* 24 bits, 2's compliment integer */
  SEGD_FC_0038 = 0x0038,    /* 32 bits, 2's compliment integer */
  SEGD_FC_0048 = 0x0048,    /* 32 bits, hexadecimal */
  SEGD_FC_0058 = 0x0058,    /* 32 bits, IEEE */
  /* Demultiplexed formats */
  SEGD_FC_8015 = 0x8015,        /* 20 bits, binary demultiplexed */
  SEGD_FC_8022 = 0x8022,        /* 8 bits, quaternary */
  SEGD_FC_8042 = 0x8042,        /* 8 bits, hexadecimal */
  SEGD_FC_8024 = 0x8024,        /* 16 bits, quaternary */
  SEGD_FC_8044 = 0x8044,        /* 16 bits, hexadecimal */
  SEGD_FC_8036 = 0x8036,        /* 24 bits, 2's compliment integer */
  SEGD_FC_8038 = 0x8038,        /* 32 bits, 2's compliment integer */
  SEGD_FC_8048 = 0x8048,        /* 32 bits, hexadecimal */
  SEGD_FC_8058 = 0x8058         /* 32 bits, IEEE */

}   SEGD_FormatCode;

typedef enum
{
  SEGD_RT_TestRecord = 2,
  SEGD_RT_ParallelChannelTest = 4,
  SEGD_RT_DirectChannelTest = 6,
  SEGD_RT_NormalRecord = 9,
  SEGD_RT_Other = 1

}   SEGD_RecordType;

typedef enum
{
  SEGD_VT_NotRecorded = 0,
  SEGD_VT_PWaveVibrator = 1,
  SEGD_VT_SWaveVibrator = 2,
  SEGD_VT_MarineVibrator = 3,

}   SEGD_VibratorType;

typedef enum
{
  SEGD_CT_Other = 7,
  SEGD_CT_ExternalData = 6,
  SEGD_CT_TimeCounter = 5,
  SEGD_CT_WaterBreak = 4,
  SEGD_CT_UpHole = 3,
  SEGD_CT_TimeBreak = 2,
  SEGD_CT_Seis = 1,
  SEGD_CT_Unused = 0,
  SEGD_CT_SignatureUnfiltered = 8,
  SEGD_CT_SignatureFiltered = 9,
  SEGD_CT_AuxiliaryDataTrailer = 12

}   SEGD_ChannelType;

typedef enum
{
  SEGD_GC_Undefined = 0,
  SEGD_GC_IndividualAGC = 1,
  SEGD_GC_GangedAGC = 2,
  SEGD_GC_FixedGain = 3,
  SEGD_GC_ProgrammedGain = 4,
  SEGD_GC_BinaryGainControl = 8,
  SEGD_GC_IFPGainControl = 9

}   SEGD_GainControl;

typedef enum
{
  SEGD_TE_NoEditApplied = 0,    
  SEGD_TE_DeadZeroChannels = 1, 
  SEGD_TE_ZeroedChannels = 2    
}   SEGD_TraceEdit;


/***********************************************************************
 * SEG-D structures description
 ***********************************************************************/

typedef struct
{
  int   file_number;
  SEGD_FormatCode   format_code;    
  int   general_constants[12];  
  int   gh_number;      
  int   year;           
  int   day;            
  int   hour;
  int   minute;
  int   second;
  int   manufacturer_code;
  int   manufacturer_format;
  int   bytes_per_scan;
  float base_scan_interval; 
  int   polarity;       
  int   scan_per_block;     
  SEGD_RecordType   record_type;
  float record_length;      
  int   scan_types;     
  int   channel_sets;       
  int   skew_blocks;        
  int   extended_hdr_blocks;    
  int   external_hdr_blocks;    
}   SEGD_GeneralHeader1;

typedef struct
{
  int   file_number;        
  int   channel_sets;       
  int   extended_hdr_blocks;    
  int   external_hdr_blocks;    
  int   revision_major;
  int   revision_minor;
  int   general_trailer_blocks; 
  int   record_length;      
  int   gh_block_number;    
}   SEGD_GeneralHeader2;

typedef struct
{
  int   src_line_num_card;  
  int   src_line_num_frac;  
  int   src_point_num_card; 
  int   src_point_num_frac; 
  int   src_point_index;    
  int   phase_control;      
  SEGD_VibratorType vibrator_type;  
  int   phase_angle;        
  int   gh_block_number;    
  int   src_set_number;     
}   SEGD_GeneralHeaderN;

typedef struct
{
  int   scan_type_number;   
  int   channel_set_number;
  int   channel_set_start_time; 
  int   channel_set_end_time;   
  float descale_multiplier;
  int   number_of_channels;
  SEGD_ChannelType  channel_type;
  int   subscan_number;     
  SEGD_GainControl  gain_control;
  int   alias_filter_freq;
  int   alias_filter_slope;
  int   low_cut_filter;
  int   low_cut_filter_slope;
  int   notch_filter_1st;
  int   notch_filter_2nd;
  int   notch_filter_3rd;
  int   extended_hdr_flag;
  int   vertical_stack;
  int   streamer_cable_number;
  int   array_forming;

}   SEGD_ChannelSet;


typedef struct
{
  int           cs_n;   
  SEGD_ChannelSet   *cs;    
  int           ss_n;   
  unsigned char     *ss;    
  int           samples;
}   SEGD_ScanType;


typedef struct
{
  int   file_number;
  int   scan_type_number;
  int   channel_set_number;
  int   trace_number;
  float time;           
  float time_break;     
  int   trace_hdr_ext;      
  float skew;           
  SEGD_TraceEdit    trace_edit; 
}   SEGD_DemuxTraceHeader;


typedef struct
{
  int   receiver_line_number;
  int   receiver_point_number;
  int   receiver_point_index;
  int   number_of_samples;

}   SEGD_ExtTraceHeader;


/* Just for KeyLabelItem definition */
#include <mix/misc.h>

#ifndef __segd_file_vars

extern KeyLabelItem SEGD_FormatCode_Labels[];
extern unsigned     SEGD_FormatCode_Labels_n;
extern KeyLabelItem SEGD_RecordType_Labels[];
extern unsigned     SEGD_RecordType_Labels_n;
extern KeyLabelItem SEGD_VibratorType_Labels[];
extern unsigned     SEGD_VibratorType_Labels_n;
extern KeyLabelItem SEGD_ChannelType_Labels[];
extern unsigned     SEGD_ChannelType_Labels_n;
extern KeyLabelItem SEGD_GainControl_Labels[];
extern unsigned     SEGD_GainControl_Labels_n;
extern KeyLabelItem SEGD_ManCodes[];
extern unsigned     SEGD_ManCodes_n;
extern KeyLabelItem SEGD_TraceEdit_Labels[];
extern unsigned     SEGD_TraceEdit_Labels_n;

#endif /* __segd_file_vars */

#endif


#endif /* segd_file.h */