]> Creatis software - gdcm.git/blobdiff - src/gdcmopenjpeg/libopenjpeg/bio.h
(Try to) fix troubles with WIN32 vs _WIN32 at compile time
[gdcm.git] / src / gdcmopenjpeg / libopenjpeg / bio.h
index ecffff28d2c9ecf24858a8d1f28b47b7e1ec87b8..e64bf06234cfc6ad8e3218390813eff9d5ec6586 100644 (file)
-/*\r
- * Copyright (c) 2001-2003, David Janssens\r
- * Copyright (c) 2002-2003, Yannick Verschueren\r
- * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe\r
- * Copyright (c) 2005, HervĂ© Drolon, FreeImage Team\r
- * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium\r
- * All rights reserved.\r
- *\r
- * Redistribution and use in source and binary forms, with or without\r
- * modification, are permitted provided that the following conditions\r
- * are met:\r
- * 1. Redistributions of source code must retain the above copyright\r
- *    notice, this list of conditions and the following disclaimer.\r
- * 2. Redistributions in binary form must reproduce the above copyright\r
- *    notice, this list of conditions and the following disclaimer in the\r
- *    documentation and/or other materials provided with the distribution.\r
- *\r
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'\r
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
- * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE\r
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\r
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF\r
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\r
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
- * POSSIBILITY OF SUCH DAMAGE.\r
- */\r
-\r
-#ifndef __BIO_H\r
-#define __BIO_H\r
-/** \r
-@file bio.h\r
-@brief Implementation of an individual bit input-output (BIO)\r
-\r
-The functions in BIO.C have for goal to realize an individual bit input - output.\r
-*/\r
-\r
-/** @defgroup BIO BIO - Individual bit input-output stream */\r
-/*@{*/\r
-\r
-/**\r
-Individual bit input-output stream (BIO)\r
-*/\r
-typedef struct opj_bio {\r
-  /** pointer to the start of the buffer */\r
-  unsigned char *start;\r
-  /** pointer to the end of the buffer */\r
-  unsigned char *end;\r
-  /** pointer to the present position in the buffer */\r
-  unsigned char *bp;\r
-  /** temporary place where each byte is read or written */\r
-  unsigned int buf;\r
-  /** coder : number of bits free to write. decoder : number of bits read */\r
-  int ct;\r
-} opj_bio_t;\r
-\r
-/** @name Exported functions */\r
-/*@{*/\r
-/* ----------------------------------------------------------------------- */\r
-/**\r
-Create a new BIO handle \r
-@return Returns a new BIO handle if successful, returns NULL otherwise\r
-*/\r
-opj_bio_t* bio_create();\r
-/**\r
-Destroy a previously created BIO handle\r
-@param bio BIO handle to destroy\r
-*/\r
-void bio_destroy(opj_bio_t *bio);\r
-/**\r
-Number of bytes written.\r
-@param bio BIO handle\r
-@return Returns the number of bytes written\r
-*/\r
-int bio_numbytes(opj_bio_t *bio);\r
-/**\r
-Init encoder\r
-@param bio BIO handle\r
-@param bp Output buffer\r
-@param len Output buffer length \r
-*/\r
-void bio_init_enc(opj_bio_t *bio, unsigned char *bp, int len);\r
-/**\r
-Init decoder\r
-@param bio BIO handle\r
-@param bp Input buffer\r
-@param len Input buffer length \r
-*/\r
-void bio_init_dec(opj_bio_t *bio, unsigned char *bp, int len);\r
-/**\r
-Write bits\r
-@param bio BIO handle\r
-@param v Value of bits\r
-@param n Number of bits to write\r
-*/\r
-void bio_write(opj_bio_t *bio, int v, int n);\r
-/**\r
-Read bits\r
-@param bio BIO handle\r
-@param n Number of bits to read \r
-@return Returns the corresponding read number\r
-*/\r
-int bio_read(opj_bio_t *bio, int n);\r
-/**\r
-Flush bits\r
-@param bio BIO handle\r
-@return Returns 1 if successful, returns 0 otherwise\r
-*/\r
-int bio_flush(opj_bio_t *bio);\r
-/**\r
-Passes the ending bits (coming from flushing)\r
-@param bio BIO handle\r
-@return Returns 1 if successful, returns 0 otherwise\r
-*/\r
-int bio_inalign(opj_bio_t *bio);\r
-/* ----------------------------------------------------------------------- */\r
-/*@}*/\r
-\r
-/*@}*/\r
-\r
-#endif /* __BIO_H */\r
-\r
+/*
+ * Copyright (c) 2001-2003, David Janssens
+ * Copyright (c) 2002-2003, Yannick Verschueren
+ * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
+ * Copyright (c) 2005, HervĂ© Drolon, FreeImage Team
+ * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
+ * 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.
+ *
+ * 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 THE COPYRIGHT OWNER 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 __BIO_H
+#define __BIO_H
+/** 
+@file bio.h
+@brief Implementation of an individual bit input-output (BIO)
+
+The functions in BIO.C have for goal to realize an individual bit input - output.
+*/
+
+/** @defgroup BIO BIO - Individual bit input-output stream */
+/*@{*/
+
+/**
+Individual bit input-output stream (BIO)
+*/
+typedef struct opj_bio {
+  /** pointer to the start of the buffer */
+  unsigned char *start;
+  /** pointer to the end of the buffer */
+  unsigned char *end;
+  /** pointer to the present position in the buffer */
+  unsigned char *bp;
+  /** temporary place where each byte is read or written */
+  unsigned int buf;
+  /** coder : number of bits free to write. decoder : number of bits read */
+  int ct;
+} opj_bio_t;
+
+/** @name Exported functions */
+/*@{*/
+/* ----------------------------------------------------------------------- */
+/**
+Create a new BIO handle 
+@return Returns a new BIO handle if successful, returns NULL otherwise
+*/
+opj_bio_t* bio_create();
+/**
+Destroy a previously created BIO handle
+@param bio BIO handle to destroy
+*/
+void bio_destroy(opj_bio_t *bio);
+/**
+Number of bytes written.
+@param bio BIO handle
+@return Returns the number of bytes written
+*/
+int bio_numbytes(opj_bio_t *bio);
+/**
+Init encoder
+@param bio BIO handle
+@param bp Output buffer
+@param len Output buffer length 
+*/
+void bio_init_enc(opj_bio_t *bio, unsigned char *bp, int len);
+/**
+Init decoder
+@param bio BIO handle
+@param bp Input buffer
+@param len Input buffer length 
+*/
+void bio_init_dec(opj_bio_t *bio, unsigned char *bp, int len);
+/**
+Write bits
+@param bio BIO handle
+@param v Value of bits
+@param n Number of bits to write
+*/
+void bio_write(opj_bio_t *bio, int v, int n);
+/**
+Read bits
+@param bio BIO handle
+@param n Number of bits to read 
+@return Returns the corresponding read number
+*/
+int bio_read(opj_bio_t *bio, int n);
+/**
+Flush bits
+@param bio BIO handle
+@return Returns 1 if successful, returns 0 otherwise
+*/
+int bio_flush(opj_bio_t *bio);
+/**
+Passes the ending bits (coming from flushing)
+@param bio BIO handle
+@return Returns 1 if successful, returns 0 otherwise
+*/
+int bio_inalign(opj_bio_t *bio);
+/* ----------------------------------------------------------------------- */
+/*@}*/
+
+/*@}*/
+
+#endif /* __BIO_H */
+