bitparser.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015, 2016, 2017, 2018 Rafael Antoniello
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of copyright holders nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef SPUTIL_SRC_BITPARSER_H_
#define SPUTIL_SRC_BITPARSER_H_

#include <sys/types.h>
#include <inttypes.h>
#include "mem_utils.h"

/* **** Definitions **** */

#define LITTLEENDIAN

typedef struct bitparser_ctx_s {
    WORD_T *buf;
    size_t buf_size;
    WORD_T bcnt;
    WORD_T word0;
    WORD_T word1;
    WORD_T top;
} bitparser_ctx_t;

/* **** Prototypes **** */

bitparser_ctx_t* bitparser_open(void *buf, size_t buf_size);

void bitparser_close(bitparser_ctx_t **ref_bitparser_ctx);

void bitparser_flush(bitparser_ctx_t* bitparser_ctx, size_t n);

WORD_T bitparser_get(bitparser_ctx_t* bitparser_ctx, size_t n);

WORD_T bitparser_show(bitparser_ctx_t* bitparser_ctx, size_t n);

void* bitparser_copy_bytes(bitparser_ctx_t* bitparser_ctx, size_t cnt);

void bitparser_align_2byte(bitparser_ctx_t* bitparser_ctx);

#endif /* SPUTIL_SRC_BITPARSER_H_ */