codec.h

Go to the documentation of this file.

/* Copyright (C) 2024  Chris Piker <chris-piker@uiowa.edu>
 *
 * This file is part of das2C, the Core Das2 C Library.
 * 
 * das2C is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * das2C 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 Lesser General Public License for
 * more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 2.1 along with das2C; if not, see <http://www.gnu.org/licenses/>. 
 */
 
#ifndef _das_codec_h_
#define _das_codec_h_
 
#include <stdint.h>
 
#include <das2/value.h>
#include <das2/array.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Not public, only here because used in a macro */
#define DASENC_VALID    0x0001 
 
typedef struct das_codec {
 
   bool bResLossWarn; /* If true, the resolution loss warning has already been emitted */
 
   uint32_t uProc; /* Internal processing flags setup on the call to _init */
 
   int nAryValSz;  /* The size of each array value in internal buffer */
 
   int16_t nBufValSz;  /* Width of a single value in the external buffer */
 
   das_val_type vtBuf; /* The value type in the external buffer */
 
   DasAry* pAry;  /* The array for which values are encoded/decoded */
 
   ubyte cSep;   /* Split strings on this byte value, in addition to null */
 
   uint32_t uMaxString; /* If we are storing fixed strings, this is set */
 
   das_units timeUnits; /* If ascii times are to be stored as an integral type
                           this is needed */
 
   char* pOverflow;  /* If the size of a variable length value breaks */
   size_t uOverflow; /* the small vector assumption, extra space is here */
 
} DasCodec;
 
 
#define DasCodec_isValid(pCd) (((pCd)->uProc & DASENC_VALID)==(DASENC_VALID))
 
DAS_API DasErrCode DasCodec_init(
   DasCodec* pThis, DasAry* pAry, const char* sSemantic, const char* sEncType,
   int16_t uSzEach, ubyte cSep, das_units epoch
);
 
DAS_API int DasCodec_decode(
   DasCodec* pThis, const ubyte* pBuf, int nBufLen, int nExpect, int* pValsRead
);
 
DAS_API void DasCodec_deInit(DasCodec* pThis);
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* _das_codec_h_ */