/***************************************************************************
 * libslink.h:
 * 
 * Interface declarations for the SeedLink library (libslink).
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public License
 * as published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License (GNU-LGPL) for more details.  The
 * GNU-LGPL and further information can be found here:
 * http://www.gnu.org/
 *
 * Written by Chad Trabant
 *   ORFEUS/EC-Project MEREDIAN
 *   IRIS Data Management Center
 *
 * modified: 2012.152
 ***************************************************************************/


#ifndef LIBSLINK_H
#define LIBSLINK_H 1

#ifdef __cplusplus
extern "C" {
#endif

#include "slplatform.h"

#define LIBSLINK_VERSION "2.4"
#define LIBSLINK_RELEASE "2012.152"

#define SLRECSIZE           512      /* Default Mini-SEED record size */
#define MAX_HEADER_SIZE     128      /* Max record header size */
#define SLHEADSIZE          8        /* SeedLink header size */
#define SELSIZE             8        /* Maximum selector size */
#define BUFSIZE             8192     /* Size of receiving buffer */
#define SIGNATURE           "SL"     /* SeedLink header signature */
#define INFOSIGNATURE       "SLINFO" /* SeedLink INFO packet signature */
#define MAX_LOG_MSG_LENGTH  200      /* Maximum length of log messages */

/* Return values for sl_collect() and sl_collect_nb() */
#define SLPACKET    1
#define SLTERMINATE 0
#define SLNOPACKET -1

/* SeedLink packet types */
#define SLDATA 0     /* waveform data record */
#define SLDET  1     /* detection record */
#define SLCAL  2     /* calibration record */
#define SLTIM  3     /* timing record */
#define SLMSG  4     /* message record */
#define SLBLK  5     /* general record */
#define SLNUM  6     /* used as the error indicator (same as SLCHA) */
#define SLCHA  6     /* for requesting channel info or detectors */
#define SLINF  7     /* a non-terminating XML formatted message in a miniSEED
			log record, used for INFO responses */
#define SLINFT 8     /* a terminating XML formatted message in a miniSEED log
			record, used for INFO responses */
#define SLKEEP 9     /* an XML formatted message in a miniSEED log
			record, used for keepalive/heartbeat responses */

/* The station and network code used for uni-station mode */
#define UNISTATION  "UNI"
#define UNINETWORK  "XX"

/* SEED structures */

/* Generic struct for head of blockettes */
struct sl_blkt_head_s
{
  uint16_t  blkt_type;
  uint16_t  next_blkt;
} SLP_PACKED;

/* SEED binary time (10 bytes) */
struct sl_btime_s
{
  uint16_t  year;
  uint16_t  day;
  uint8_t   hour;
  uint8_t   min;
  uint8_t   sec;
  uint8_t   unused;
  uint16_t  fract;
} SLP_PACKED;

/* 100 Blockette (12 bytes) */
struct sl_blkt_100_s
{
  uint16_t  blkt_type;
  uint16_t  next_blkt;
  float     sample_rate;
  int8_t    flags;
  uint8_t   reserved[3];
} SLP_PACKED;

/* 1000 Blockette (8 bytes) */
struct sl_blkt_1000_s
{
  uint16_t  blkt_type;
  uint16_t  next_blkt;
  uint8_t   encoding;
  uint8_t   word_swap;
  uint8_t   rec_len;
  uint8_t   reserved;
} SLP_PACKED;

/* 1001 Blockette (8 bytes) */
struct sl_blkt_1001_s
{
  uint16_t  blkt_type;
  uint16_t  next_blkt;
  int8_t    timing_qual;
  int8_t    usec;
  uint8_t   reserved;
  int8_t    frame_cnt;
} SLP_PACKED;

/* Fixed section data of header (48 bytes) */
struct sl_fsdh_s
{
  char        sequence_number[6];
  char        dhq_indicator;
  char        reserved;
  char        station[5];
  char        location[2];
  char        channel[3];
  char        network[2];
  struct sl_btime_s start_time;
  uint16_t    num_samples;
  int16_t     samprate_fact;
  int16_t     samprate_mult;
  uint8_t     act_flags;
  uint8_t     io_flags;
  uint8_t     dq_flags;
  uint8_t     num_blockettes;
  int32_t     time_correct;
  uint16_t    begin_data;
  uint16_t    begin_blockette;
} SLP_PACKED;

/* SeedLink packet, sequence number followed by miniSEED record */
typedef struct slpacket_s
{
  char    slhead[SLHEADSIZE];   /* SeedLink header */
  char    msrecord[SLRECSIZE];  /* Mini-SEED record */
} SLP_PACKED SLpacket;

/* Stream information */
typedef struct slstream_s
{
  char   *net;      	        /* The network code */
  char   *sta;      	        /* The station code */
  char   *selectors;	        /* SeedLink style selectors for this station */
  int     seqnum;	        /* SeedLink sequence number for this station */
  char    timestamp[20];        /* Time stamp of last packet received */
  struct  slstream_s *next;     /* The next station in the chain */
} SLstream;

/* Persistent connection state information */
typedef struct stat_s
{
  char    databuf[BUFSIZE];     /* Data buffer for received packets */
  int     recptr;               /* Receive pointer for databuf */
  int     sendptr;              /* Send pointer for databuf */
  int8_t  expect_info;          /* Do we expect an INFO response? */

  int8_t  netto_trig;           /* Network timeout trigger */
  int8_t  netdly_trig;          /* Network re-connect delay trigger */
  int8_t  keepalive_trig;       /* Send keepalive trigger */

  double  netto_time;           /* Network timeout time stamp */
  double  netdly_time;          /* Network re-connect delay time stamp */
  double  keepalive_time;       /* Keepalive time stamp */

  enum                          /* Connection state */
    {
      SL_DOWN, SL_UP, SL_DATA
    }
  sl_state;

  enum                          /* INFO query state */
    {
      NoQuery, InfoQuery, KeepAliveQuery
    }
  query_mode;
    
} SLstat;

/* Logging parameters */
typedef struct SLlog_s
{
  void (*log_print)();
  const char * logprefix;
  void (*diag_print)();
  const char * errprefix;
  int  verbosity;
} SLlog;

/* SeedLink connection description */
typedef struct slcd_s
{
  SLstream   *streams;		/* Pointer to stream chain (a linked list of structs) */
  char       *sladdr;           /* The host:port of SeedLink server */
  char       *begin_time;	/* Beginning of time window */
  char       *end_time;		/* End of time window */

  int8_t      resume;           /* Boolean flag to control resuming with seq. numbers */
  int8_t      multistation;     /* Boolean flag to indicate multistation mode */
  int8_t      dialup;           /* Boolean flag to indicate dial-up mode */
  int8_t      batchmode;        /* Batch mode (1 - requested, 2 - activated) */
  int8_t      lastpkttime;      /* Boolean flag to control last packet time usage */
  int8_t      terminate;        /* Boolean flag to control connection termination */

  int         keepalive;        /* Interval to send keepalive/heartbeat (secs) */
  int         netto;            /* Network timeout (secs) */
  int         netdly;           /* Network reconnect delay (secs) */

  float       protocol_ver;     /* Version of the SeedLink protocol in use */
  const char *info;             /* INFO level to request */
  int         link;		/* The network socket descriptor */
  SLstat     *stat;             /* Persistent state information */
  SLlog      *log;              /* Logging parameters */
} SLCD;

/* slutils.c */
extern int    sl_collect (SLCD * slconn, SLpacket ** slpack);
extern int    sl_collect_nb (SLCD * slconn, SLpacket ** slpack);
extern int    sl_collect_nb_size (SLCD * slconn, SLpacket ** slpack, int slrecsize);
extern SLCD * sl_newslcd (void);
extern void   sl_freeslcd (SLCD * slconn);
extern int    sl_addstream (SLCD * slconn, const char *net, const char *sta,
			    const char *selectors, int seqnum,
			    const char *timestamp);
extern int    sl_setuniparams (SLCD * slconn, const char *selectors,
			       int seqnum, const char *timestamp);
extern int    sl_request_info (SLCD * slconn, const char * infostr);
extern int    sl_sequence (const SLpacket *);
extern int    sl_packettype (const SLpacket *);
extern void   sl_terminate (SLCD * slconn);

/* config.c */
extern int   sl_read_streamlist (SLCD *slconn, const char *streamfile,
				 const char *defselect);
extern int   sl_parse_streamlist (SLCD *slconn, const char *streamlist,
				  const char *defselect);

/* network.c */
extern int    sl_configlink (SLCD * slconn);
extern int    sl_send_info (SLCD * slconn, const char * info_level,
			    int verbose);
extern int    sl_connect (SLCD * slconn, int sayhello);
extern int    sl_disconnect (SLCD * slconn);
extern int    sl_ping (SLCD * slconn, char *serverid, char *site);
extern int    sl_checksock (int sock, int tosec, int tousec);
extern int    sl_senddata (SLCD * slconn, void *buffer, size_t buflen,
			   const char *ident, void *resp, int resplen);
extern int    sl_recvdata (SLCD * slconn, void *buffer, size_t maxbytes,
			   const char *ident);
extern int    sl_recvresp (SLCD * slconn, void *buffer, size_t maxbytes,
                           const char *command, const char *ident);

/* genutils.c */
extern double sl_dtime (void);
extern int    sl_doy2md (int year, int jday, int *month, int *mday);
extern int    sl_checkversion (const SLCD * slconn, float version);
extern int    sl_checkslcd (const SLCD * slconn);
extern int    sl_readline (int fd, char *buffer, int buflen);

/* logging.c */
extern int    sl_log (int level, int verb, ...);
extern int    sl_log_r (const SLCD * slconn, int level, int verb, ...);
extern int    sl_log_rl (SLlog * log, int level, int verb, ...);
extern void   sl_loginit (int verbosity,
			  void (*log_print)(const char*), const char * logprefix,
			  void (*diag_print)(const char*), const char * errprefix);
extern void   sl_loginit_r (SLCD * slconn, int verbosity,
			    void (*log_print)(const char*), const char * logprefix,
			    void (*diag_print)(const char*), const char * errprefix);
extern SLlog *sl_loginit_rl (SLlog * log, int verbosity,
			     void (*log_print)(const char*), const char * logprefix,
			     void (*diag_print)(const char*), const char * errprefix);

/* statefile.c */
extern int   sl_recoverstate (SLCD *slconn, const char *statefile);
extern int   sl_savestate (SLCD *slconn, const char *statefile);


/* msrecord.c */

/* Unpacking/decompression error flag values */
#define MSD_NOERROR          0        /* No errors */
#define MSD_UNKNOWNFORMAT   -1        /* Unknown data format */
#define MSD_SAMPMISMATCH    -2        /* Num. samples in header is not the number unpacked */
#define MSD_BADSAMPCOUNT    -4        /* Sample count is bad, negative? */
#define MSD_STBADLASTMATCH  -5        /* Steim, last sample does not match */
#define MSD_STBADCOMPFLAG   -6        /* Steim, invalid compression flag(s) */

typedef struct SLMSrecord_s {
  const char            *msrecord;    /* Pointer to original record */
  struct sl_fsdh_s       fsdh;        /* Fixed Section of Data Header */ 
  struct sl_blkt_100_s  *Blkt100;     /* Blockette 100, if present */
  struct sl_blkt_1000_s *Blkt1000;    /* Blockette 1000, if present */
  struct sl_blkt_1001_s *Blkt1001;    /* Blockette 1001, if present */
  int32_t               *datasamples; /* Unpacked 32-bit data samples */
  int32_t                numsamples;  /* Number of unpacked samples */
  int8_t                 unpackerr;   /* Unpacking/decompression error flag */
}
SLMSrecord;

extern SLMSrecord* sl_msr_new (void);
extern void        sl_msr_free (SLMSrecord ** msr);
extern SLMSrecord* sl_msr_parse (SLlog * log, const char * msrecord, SLMSrecord ** msr,
			         int8_t blktflag, int8_t unpackflag);
extern SLMSrecord* sl_msr_parse_size (SLlog * log, const char * msrecord, SLMSrecord ** msr,
				      int8_t blktflag, int8_t unpackflag, int slrecsize);
extern int         sl_msr_print (SLlog * log, SLMSrecord * msr, int details);
extern int         sl_msr_dsamprate (SLMSrecord * msr, double * samprate);
extern double      sl_msr_dnomsamprate (SLMSrecord * msr);
extern double      sl_msr_depochstime (SLMSrecord * msr);


/* strutils.c */

/* For a linked list of strings, as filled by strparse() */
typedef struct SLstrlist_s {
  char               *element;
  struct SLstrlist_s *next;
} SLstrlist;

extern int  sl_strparse(const char *string, const char *delim, SLstrlist **list);
extern int  sl_strncpclean(char *dest, const char *source, int length);

/* gswap.c */

/* Generic byte swapping routines */
extern void   sl_gswap2 ( void *data2 );
extern void   sl_gswap3 ( void *data3 );
extern void   sl_gswap4 ( void *data4 );
extern void   sl_gswap8 ( void *data8 );

/* Generic byte swapping routines for memory aligned quantities */
extern void   sl_gswap2a ( void *data2 );
extern void   sl_gswap4a ( void *data4 );
extern void   sl_gswap8a ( void *data8 );

/* Byte swap macro for the BTime struct */
#define SL_SWAPBTIME(x)   \
  sl_gswap2 (x.year);  \
  sl_gswap2 (x.day);   \
  sl_gswap2 (x.fract);


#ifdef __cplusplus
}
#endif
 
#endif /* LIBSLINK_H */
