diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /support/dktools/dk4rld.h |
Initial commit
Diffstat (limited to 'support/dktools/dk4rld.h')
-rw-r--r-- | support/dktools/dk4rld.h | 154 |
1 files changed, 154 insertions, 0 deletions
diff --git a/support/dktools/dk4rld.h b/support/dktools/dk4rld.h new file mode 100644 index 0000000000..32167f9583 --- /dev/null +++ b/support/dktools/dk4rld.h @@ -0,0 +1,154 @@ +/* + WARNING: This file was generated by dkct. + Changes you make here will be lost if dkct is run again! + You should modify the original source and run dkct on it. + Original source: dk4rld.ctr +*/ + +/* +Copyright (C) 2015-2017, Dirk Krause + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. +* Redistributions in binary form must reproduce the above opyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. +* Neither the name of the author nor the names of contributors may be used + to endorse or promote products derived from this software without specific + prior written permission. + +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 DK4RLD_H_INCLUDED +/** Avoid multiple inclusions. */ +#define DK4RLD_H_INCLUDED 1 + + +#line 9 "dk4rld.ctr" + +/** @file dk4rld.h Run-length decoder. + +Use dk4rld_init() to initialize the decoder before feeding data to it. + +Feed the encoded data into the decoder byte by byte, use the +dk4rld_add() function. +If the function returns DK4_EDSTM_ACCEPT, the input was successfully stored +into the internal data structures, not need for further action. +If the function returns DK4_EDSTM_FINISHED, an output secquence was +completed, either a run or a literal byte sequence. Use dk4rld_output() +to retrieve output data. +If the dk4rld_add function returns DK4_EDSTM_STOP, an end of data +(EOD) marker was found; do not feed further bytes into the decoder. + +After feeding all input bytes into the decoder, use dk4rld_finish() to check +syntax. If the function returns DK4_EDSTM_ERROR, the input data stream +was not properly run-length encoded. +*/ + +#include "dk4error.h" + +/** Run length decoder. +*/ +typedef struct { + unsigned char ob[128]; /**< Output buffer. */ + size_t oused; /**< Number of used bytes in ob. */ + size_t ll; /**< Number of expected bytes. */ + int st; /**< Current state. */ +} dk4_rl_dec_t; + + +#ifdef __cplusplus +extern "C" { +#endif + +/** Initialize decoder. + @param dec Decoder to initialize. + @param erp Error report, may be NULL. + + Error codes: + - DK4_E_INVALID_ARGUMENTS if enc is NULL. +*/ +void +dk4rld_init(dk4_rl_dec_t *dec, dk4_er_t *erp); + +/** Add one encoded byte to decoder. + @param dec Decoder. + @param inbyte Byte to process. + @param erp Error report, may be NULL. + @return Action to take, one from: + - DK4_EDSTM_ACCEPT<br> + if the byte was successfully added + to the internal data structures, no further action necessary. + - DK4_EDSTM_FINISHED<br> + if output is available, use dk4rld_output() to retrieve output. + - DK4_EDSTM_STOP<br> + if an EOD marker was detected. Do not feed further bytes + to the decoder. + - DK4_EDSTM_ERROR<br> + if an error occured. + + Error codes: + - DK4_E_INVALID_ARGUMENTS if enc is NULL. +*/ +int +dk4rld_add(dk4_rl_dec_t *dec, unsigned char inbyte, dk4_er_t *erp); + +/** Finish decoding. + @param dec Decoder. + @param erp Error report, may be NULL. + @return Action to take, one from: + - DK4_EDSTM_ACCEPT<br> + if no remaining data is stored in the decoder, no further + action necessary. + - DK4_EDSTM_FINISHED<br> + if output is available, use dk4rld_output() to retrieve output. + - DK4_EDSTM_ERROR<br> + if an error occured. + + Error codes: + - DK4_E_INVALID_ARGUMENTS<br> + if enc is NULL. + - DK4_E_SYNTAX<br> + if data indicated by the run-length byte or literally-length + byte is missing. +*/ +int +dk4rld_finish(dk4_rl_dec_t *dec, dk4_er_t *erp); + +/** Retrieve decoder output. + @param dptr Address of pointer to set to decoder output, + should be initialized to NULL. + @param szptr Address of variable to receive buffer size, + should be initialized to 0. + @param dec Decoder. + @param erp Error report, may be NULL. + @return 1 if data is available, 0 otherwise. + + Error codes: + - DK4_E_INVALID_ARGUMENTS if enc is NULL. +*/ +int +dk4rld_output( + const unsigned char **dptr, size_t *szptr, dk4_rl_dec_t *dec, dk4_er_t *erp +); + +#ifdef __cplusplus +} +#endif + + +#endif |