openjpeg/src/lib/openjp2/raw.h

101 lines
3.4 KiB
C
Raw Normal View History

2003-11-27 11:10:17 +01:00
/*
2007-01-15 10:55:40 +01:00
* Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
* Copyright (c) 2002-2007, Professor Benoit Macq
* Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
* Copyright (c) 2005, Herve Drolon, FreeImage Team
2003-11-27 11:10:17 +01:00
* 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.
2004-02-13 10:47:40 +01:00
*/
2003-11-27 11:10:17 +01:00
#ifndef __RAW_H
#define __RAW_H
/**
@file raw.h
@brief Implementation of operations for raw encoding (RAW)
2004-02-13 10:47:40 +01:00
The functions in RAW.C have for goal to realize the operation of raw encoding linked
with the corresponding mode switch.
*/
2003-11-27 11:10:17 +01:00
/** @defgroup RAW RAW - Implementation of operations for raw encoding */
/*@{*/
2003-11-27 11:10:17 +01:00
/**
RAW encoding operations
*/
typedef struct opj_raw {
2005-12-08 10:38:47 +01:00
/** temporary buffer where bits are coded or decoded */
OPJ_BYTE c;
2005-12-08 10:38:47 +01:00
/** number of bits already read or free to write */
OPJ_UINT32 ct;
2005-12-08 10:38:47 +01:00
/** maximum length to decode */
OPJ_UINT32 lenmax;
2005-12-08 10:38:47 +01:00
/** length decoded */
OPJ_UINT32 len;
2005-12-08 10:38:47 +01:00
/** pointer to the current position in the buffer */
OPJ_BYTE *bp;
2005-12-08 10:38:47 +01:00
/** pointer to the start of the buffer */
OPJ_BYTE *start;
2005-12-08 10:38:47 +01:00
/** pointer to the end of the buffer */
OPJ_BYTE *end;
} opj_raw_t;
/** @name Exported functions */
/*@{*/
/* ----------------------------------------------------------------------- */
/**
Create a new RAW handle
@return Returns a new RAW handle if successful, returns NULL otherwise
*/
opj_raw_t* opj_raw_create(void);
/**
Destroy a previously created RAW handle
@param raw RAW handle to destroy
*/
void opj_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
*/
OPJ_UINT32 opj_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 opj_raw_init_dec(opj_raw_t *raw, OPJ_BYTE *bp, OPJ_UINT32 len);
/**
Decode a symbol using raw-decoder. Cfr p.506 TAUBMAN
@param raw RAW handle
@return Returns the decoded symbol (0 or 1)
*/
OPJ_UINT32 opj_raw_decode(opj_raw_t *raw);
/* ----------------------------------------------------------------------- */
/*@}*/
/*@}*/
2003-11-27 11:10:17 +01:00
#endif /* __RAW_H */