Fix typos in comments and string
[openjpeg.git] / src / lib / openjp3d / raw.h
index 55e889da3c22f95f2653a00dc08a7e26b1cb06ad..bd2aa4e8635f65873307ff1571ecb0b270fc2b30 100644 (file)
-/*\r
- * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe\r
- * Copyright (c) 2005, Herve 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 __RAW_H\r
-#define __RAW_H\r
-/**\r
-@file raw.h\r
-@brief Implementation of operations for raw encoding (RAW)\r
-\r
-The functions in RAW.C have for goal to realize the operation of raw encoding linked\r
-with the corresponding mode switch.\r
-*/\r
-\r
-/** @defgroup RAW RAW - Implementation of operations for raw encoding */\r
-/*@{*/\r
-\r
-/**\r
-RAW encoding operations\r
-*/\r
-typedef struct opj_raw {\r
-/** Temporary buffer where bits are coded or decoded */\r
-       unsigned char c;                \r
-/** Number of bits already read or free to write */\r
-       unsigned int ct;                \r
-/** Maximum length to decode */\r
-       unsigned int lenmax;    \r
-/** Length decoded */\r
-       unsigned int len;               \r
-/** Pointer to the current position in the buffer */\r
-       unsigned char *bp;              \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
-} opj_raw_t;\r
-\r
-/** @name Funciones generales */\r
-/*@{*/\r
-/* ----------------------------------------------------------------------- */\r
-/**\r
-Create a new RAW handle \r
-@return Returns a new RAW handle if successful, returns NULL otherwise\r
-*/\r
-opj_raw_t* raw_create(void);\r
-/**\r
-Destroy a previously created RAW handle\r
-@param raw RAW handle to destroy\r
-*/\r
-void raw_destroy(opj_raw_t *raw);\r
-/**\r
-Return the number of bytes written/read since initialisation\r
-@param raw RAW handle to destroy\r
-@return Returns the number of bytes already encoded\r
-*/\r
-int raw_numbytes(opj_raw_t *raw);\r
-/**\r
-Initialize the decoder\r
-@param raw RAW handle\r
-@param bp Pointer to the start of the buffer from which the bytes will be read\r
-@param len Length of the input buffer\r
-*/\r
-void raw_init_dec(opj_raw_t *raw, unsigned char *bp, int len);\r
-/**\r
-Decode a symbol using raw-decoder. Cfr p.506 TAUBMAN\r
-@param raw RAW handle\r
-@return Returns the decoded symbol (0 or 1)\r
-*/\r
-int raw_decode(opj_raw_t *raw);\r
-/* ----------------------------------------------------------------------- */\r
-/*@}*/\r
-\r
-/*@}*/\r
-\r
-#endif /* __RAW_H */\r
+/*
+ * The copyright in this software is being made available under the 2-clauses 
+ * BSD License, included below. This software may be subject to other third 
+ * party and contributor rights, including patent rights, and no such rights
+ * are granted under this license.
+ *
+ * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
+ * Copyright (c) 2005, Herve 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 __RAW_H
+#define __RAW_H
+/**
+@file raw.h
+@brief Implementation of operations for raw encoding (RAW)
+
+The functions in RAW.C have for goal to realize the operation of raw encoding linked
+with the corresponding mode switch.
+*/
+
+/** @defgroup RAW RAW - Implementation of operations for raw encoding */
+/*@{*/
+
+/**
+RAW encoding operations
+*/
+typedef struct opj_raw {
+/** Temporary buffer where bits are coded or decoded */
+       unsigned char c;                
+/** Number of bits already read or free to write */
+       unsigned int ct;                
+/** Maximum length to decode */
+       unsigned int lenmax;    
+/** Length decoded */
+       unsigned int len;               
+/** Pointer to the current position in the buffer */
+       unsigned char *bp;              
+/** Pointer to the start of the buffer */
+       unsigned char *start;   
+/** Pointer to the end of the buffer */
+       unsigned char *end;             
+} opj_raw_t;
+
+/** @name Funciones generales */
+/*@{*/
+/* ----------------------------------------------------------------------- */
+/**
+Create a new RAW handle 
+@return Returns a new RAW handle if successful, returns NULL otherwise
+*/
+opj_raw_t* raw_create(void);
+/**
+Destroy a previously created RAW handle
+@param raw RAW handle to destroy
+*/
+void raw_destroy(opj_raw_t *raw);
+/**
+Return the number of bytes written/read since initialisation
+@param raw RAW handle to destroy
+@return Returns the number of bytes already encoded
+*/
+int raw_numbytes(opj_raw_t *raw);
+/**
+Initialize the decoder
+@param raw RAW handle
+@param bp Pointer to the start of the buffer from which the bytes will be read
+@param len Length of the input buffer
+*/
+void raw_init_dec(opj_raw_t *raw, unsigned char *bp, int len);
+/**
+Decode a symbol using raw-decoder. Cfr p.506 TAUBMAN
+@param raw RAW handle
+@return Returns the decoded symbol (0 or 1)
+*/
+int raw_decode(opj_raw_t *raw);
+/* ----------------------------------------------------------------------- */
+/*@}*/
+
+/*@}*/
+
+#endif /* __RAW_H */