stream.h

Go to the documentation of this file.

/* Copyright (C) 2004-2017 Jeremy Faden <jeremy-faden@uiowa.edu>
 *                         Chris Piker <chris-piker@uiowa.edu>
 *
 * This file is part of libdas2, the Core Das2 C Library.
 * 
 * Libdas2 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.
 *
 * Libdas2 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 libdas2; if not, see <http://www.gnu.org/licenses/>. 
 */

#ifndef _das_stream_h_
#define _das_stream_h_

#include <stdbool.h>
#include <das2/packet.h>

#ifdef __cplusplus
extern "C" {
#endif

#define STREAMDESC_CMP_SZ 48
#define STREAMDESC_VER_SZ 48

#define MAX_PKTIDS 100

typedef struct stream_descriptor{
   DasDesc base;

   PktDesc* pktDesc[MAX_PKTIDS];

   /* Common properties */
   char compression[STREAMDESC_CMP_SZ];
   char version[STREAMDESC_VER_SZ];
   bool bDescriptorSent;
     
    void* pUser;  
} StreamDesc;


StreamDesc* new_StreamDesc(void);

StreamDesc* new_StreamDesc_str(DasBuf* pBuf);

StreamDesc* StreamDesc_copy(const StreamDesc* pThis);


void del_StreamDesc(StreamDesc* pThis);

size_t StreamDesc_getNPktDesc(const StreamDesc* pThis);

DasErrCode StreamDesc_addPktDesc(StreamDesc* pThis, PktDesc* pPd, int nPktId);


void StreamDesc_setMonotonic(StreamDesc* pThis, bool isMonotonic );

void StreamDesc_addStdProps(StreamDesc* pThis);

void StreamDesc_addCmdLineProp(StreamDesc* pThis, int argc, char* argv[] );

PktDesc* StreamDesc_createPktDesc(StreamDesc* pThis, DasEncoding* pXEncoder, 
                                  das_units xUnits );

PktDesc* StreamDesc_clonePktDesc(StreamDesc* pThis, const PktDesc* pd);
                                        
PktDesc* StreamDesc_clonePktDescById(
   StreamDesc* pThis, const StreamDesc* pOther, int nPktId
);

bool StreamDesc_isValidId(const StreamDesc* pThis, int nPktId);
                                        
PktDesc* StreamDesc_getPktDesc(const StreamDesc* pThis, int id);

DasErrCode StreamDesc_freePktDesc(StreamDesc* pThis, int nPktId);

int StreamDesc_getOffset(StreamDesc* pThis);

DasErrCode StreamDesc_encode(StreamDesc* pThis, DasBuf* pBuf);

DasDesc* Das2Desc_decode(DasBuf* pBuf);

#ifdef __cplusplus
}
#endif

#endif /* _das_stream_h_ */