2 * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
3 * Copyright (c) 2002-2007, Professor Benoit Macq
4 * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
5 * Copyright (c) 2005, Herve Drolon, FreeImage Team
6 * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
35 @brief Implementation of operations for raw encoding (RAW)
37 The functions in RAW.C have for goal to realize the operation of raw encoding linked
38 with the corresponding mode switch.
41 /** @defgroup RAW RAW - Implementation of operations for raw encoding */
45 RAW encoding operations
47 typedef struct opj_raw {
48 /** temporary buffer where bits are coded or decoded */
50 /** number of bits already read or free to write */
52 /** maximum length to decode */
56 /** pointer to the current position in the buffer */
58 /** pointer to the start of the buffer */
60 /** pointer to the end of the buffer */
64 /** @name Exported functions */
66 /* ----------------------------------------------------------------------- */
68 Create a new RAW handle
69 @return Returns a new RAW handle if successful, returns NULL otherwise
71 opj_raw_t* raw_create(void);
73 Destroy a previously created RAW handle
74 @param raw RAW handle to destroy
76 void raw_destroy(opj_raw_t *raw);
78 Return the number of bytes written/read since initialisation
79 @param raw RAW handle to destroy
80 @return Returns the number of bytes already encoded
82 OPJ_UINT32 raw_numbytes(opj_raw_t *raw);
84 Initialize the decoder
86 @param bp Pointer to the start of the buffer from which the bytes will be read
87 @param len Length of the input buffer
89 void raw_init_dec(opj_raw_t *raw, OPJ_BYTE *bp, OPJ_UINT32 len);
91 Decode a symbol using raw-decoder. Cfr p.506 TAUBMAN
93 @return Returns the decoded symbol (0 or 1)
95 OPJ_UINT32 raw_decode(opj_raw_t *raw);
96 /* ----------------------------------------------------------------------- */