stream.h

Go to the documentation of this file.

/* Copyright (C) 2015-2024 Chris Piker <chris-piker@uiowa.edu>
 * 
 * Adapted from:
 *   Copyright (C) 2006 Jeremy Faden <jeremy-faden@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_stream_h_
#define _das_stream_h_
 
#include <stdbool.h>
#include <das3/packet.h>
#include <das3/dataset.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define STREAM_MODEL_MIXED -1
#define STREAM_MODEL_V2     2
#define STREAM_MODEL_V3     3
 
#define STREAMDESC_CMP_SZ 48
#define STREAMDESC_VER_SZ 48
#define STREAMDESC_TYPE_SZ 48
 
#define MAX_PKTIDS 100
 
 
typedef struct das_stream{
   DasDesc base;
 
   /* TODO: Replace this with a sorted array of structures of the type
 
         {int id, DasDesc* pDesc}
 
      and use sorted insert and binary search to retrieve packet IDs 
      if greater then say 10.  For 10 or less the "small vector" 
      assumption applies and we just an embedded 10-element array 
      and loops.
   */
   DasDesc* descriptors[MAX_PKTIDS];
 
   /* Common properties */
   char compression[STREAMDESC_CMP_SZ];
   char type[STREAMDESC_TYPE_SZ];
   char version[STREAMDESC_VER_SZ];
   bool bDescriptorSent;
 
   /* Reader opt-in: recover an undecodable embedded format (a mime'd blob with no
      registered codec extension) as opaque per-record bytes instead of failing.
      Set from DasIO_embedAsBytes() when the stream descriptor is decoded; the
      dataset parser reads it via DasStream_getEmbedAsBytes(). */
   bool bEmbedAsBytes;
     
    void* pUser;  
} DasStream;
 
#define StreamDesc  DasStream
 
#define DasStream_getEmbedAsBytes(P) ((P)->bEmbedAsBytes)
 
DAS_API DasStream* new_DasStream(void);
 
#define new_StreamDesc new_DasStream
 
DAS_API DasStream* new_DasStream_str(DasBuf* pBuf, int nModel);
 
#define new_StreamDesc_str new_DasStream_str
 
DAS_API char* DasStream_info(const DasStream* pSd, char* sBuf, int nLen);
 
#define StreamDesc_info DasStream_info
 
DAS_API DasStream* DasStream_copy(const DasStream* pThis);
 
#define StreamDesc_copy DasStream_copy
 
DAS_API void del_DasStream(DasStream* pThis);
 
#define del_StreamDesc del_DasStream
 
DAS_API size_t DasStream_getNPktDesc(const DasStream* pThis);
 
#define StreamDesc_getNPktDesc DasStream_getNPktDesc
 
DAS_API DasDesc* DasStream_nextDesc(const DasStream* pThis, int* pPrevPktId);
 
#define StreamDesc_nextPktDesc DasStream_nextDesc
 
DAS_API DasErrCode DasStream_addDesc(DasStream* pThis, DasDesc* pDesc, int nPktId);
 
#define StreamDesc_addPktDesc DasStream_addDesc
 
DAS_API DasErrCode DasStream_shadowPktDesc(DasStream* pThis, DasDesc* pDesc, int nPktId);
 
DAS_API DasErrCode DasStream_takePktDesc(DasStream* pThis, DasDesc* pDesc, int nPktId);
 
DAS_API DasErrCode DasStream_rmDesc(DasStream* pThis, DasDesc* pDesc, int nPktId);
 
#define DasStream_rmPktDesc  DasStream_rmDesc
 
DAS_API void DasStream_setMonotonic(DasStream* pThis, bool isMonotonic );
 
#define StreamDesc_setMonotonic DasStream_setMonotonic
 
DAS_API void DasStream_addStdProps(DasStream* pThis);
 
#define StreamDesc_addStdProps DasStream_addStdProps
 
DAS_API void DasStream_addCmdLineProp(DasStream* pThis, int argc, char* argv[] );
 
#define StreamDesc_addCmdLineProp DasStream_addCmdLineProp
 
DAS_API PktDesc* DasStream_createPktDesc(
   DasStream* pThis, DasEncoding* pXEncoder, das_units xUnits 
);
 
#define StreamDesc_createPktDesc DasStream_createPktDesc
 
 
 
DAS_API PktDesc* DasStream_clonePktDesc(DasStream* pThis, const PktDesc* pd);
 
#define StreamDesc_clonePktDesc DasStream_clonePktDesc
                                        
DAS_API PktDesc* DasStream_clonePktDescById(
   DasStream* pThis, const DasStream* pOther, int nPktId
);
 
#define StreamDesc_clonePktDescById DasStream_clonePktDescById
 
DAS_API bool DasStream_isValidId(const DasStream* pThis, int nPktId);
 
#define StreamDesc_isValidId DasStream_isValidId
                                        
DAS_API PktDesc* DasStream_getPktDesc(const DasStream* pThis, int id);
 
#define StreamDesc_getPktDesc DasStream_getPktDesc
 
DAS_API DasDesc* DasStream_getDesc(const DasStream* pThis, int id);
 
DAS_API int DasStream_getPktId(DasStream* pThis, const DasDesc* pDesc);
 
 
DAS_API DasErrCode DasStream_freeDatDesc(DasStream* pThis, int nPktId);
 
#define StreamDesc_freeDesc DasStream_freeDatDesc
 
DAS_API int DasStream_getOffset(DasStream* pThis);
 
#define StreamDesc_getOffset DasStream_getOffset
 
DAS_API DasErrCode DasStream_encode2(DasStream* pThis, DasBuf* pBuf);
 
#define StreamDesc_encode DasStream_encode2
 
DAS_API DasErrCode DasStream_encode3(DasStream* pThis, DasBuf* pBuf);
 
DAS_API DasDesc* DasDesc_decode(
   DasBuf* pBuf, DasStream* pSd, int nPktId, int nModel
);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* _das_stream_h_ */