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