diff spandsp-0.0.6pre17/src/spandsp/bitstream.h @ 4:26cd8f1ef0b1

import spandsp-0.0.6pre17
author Peter Meerwald <pmeerw@cosy.sbg.ac.at>
date Fri, 25 Jun 2010 15:50:58 +0200
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/spandsp-0.0.6pre17/src/spandsp/bitstream.h	Fri Jun 25 15:50:58 2010 +0200
@@ -0,0 +1,81 @@
+/*
+ * SpanDSP - a series of DSP components for telephony
+ *
+ * bitstream.h - Bitstream composition and decomposition routines.
+ *
+ * Written by Steve Underwood <steveu@coppice.org>
+ *
+ * Copyright (C) 2006 Steve Underwood
+ *
+ * All rights reserved.
+ *
+ * This program 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.
+ *
+ * This program 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 along with this program; if not, write to the Free Software
+ * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ *
+ * $Id: bitstream.h,v 1.14.4.1 2009/12/28 12:20:47 steveu Exp $
+ */
+
+/*! \file */
+
+#if !defined(_SPANDSP_BITSTREAM_H_)
+#define _SPANDSP_BITSTREAM_H_
+
+/*! \page bitstream_page Bitstream composition and decomposition
+\section bitstream_page_sec_1 What does it do?
+
+\section bitstream_page_sec_2 How does it work?
+*/
+
+/*! Bitstream handler state */
+typedef struct bitstream_state_s bitstream_state_t;
+
+#if defined(__cplusplus)
+extern "C"
+{
+#endif
+
+/*! \brief Put a chunk of bits into the output buffer.
+    \param s A pointer to the bitstream context.
+    \param c A pointer to the bitstream output buffer.
+    \param value The value to be pushed into the output buffer.
+    \param bits The number of bits of value to be pushed. 1 to 25 bits is valid. */
+SPAN_DECLARE(void) bitstream_put(bitstream_state_t *s, uint8_t **c, uint32_t value, int bits);
+
+/*! \brief Get a chunk of bits from the input buffer.
+    \param s A pointer to the bitstream context.
+    \param c A pointer to the bitstream input buffer.
+    \param bits The number of bits of value to be grabbed. 1 to 25 bits is valid.
+    \return The value retrieved from the input buffer. */
+SPAN_DECLARE(uint32_t) bitstream_get(bitstream_state_t *s, const uint8_t **c, int bits);
+
+/*! \brief Flush any residual bit to the output buffer.
+    \param s A pointer to the bitstream context.
+    \param c A pointer to the bitstream output buffer. */
+SPAN_DECLARE(void) bitstream_flush(bitstream_state_t *s, uint8_t **c);
+
+/*! \brief Initialise a bitstream context.
+    \param s A pointer to the bitstream context.
+    \param lsb_first TRUE if the bit stream is LSB first, else its MSB first.
+    \return A pointer to the bitstream context. */
+SPAN_DECLARE(bitstream_state_t *) bitstream_init(bitstream_state_t *s, int direction);
+
+SPAN_DECLARE(int) bitstream_release(bitstream_state_t *s);
+
+SPAN_DECLARE(int) bitstream_free(bitstream_state_t *s);
+
+#if defined(__cplusplus)
+}
+#endif
+
+#endif
+/*- End of file ------------------------------------------------------------*/

Repositories maintained by Peter Meerwald, pmeerw@pmeerw.net.