src/lib/openjpip/codestream_manager.h

   1 /*
   2  * $Id$
   3  *
   4  * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
   5  * Copyright (c) 2002-2014, Professor Benoit Macq
   6  * Copyright (c) 2010-2011, Kaori Hagihara
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  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.
  17  *
  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.
  29  */
  30
  31 #ifndef     CODESTREAM_MANAGER_H_
  32 # define    CODESTREAM_MANAGER_H_
  33
  34 #include "byte_manager.h"
  35
  36 /** codestream parameters*/
  37 typedef struct codestream_param {
  38     int fd;         /**< file descriptor*/
  39     OPJ_OFF_T offset; /**< byte position of DBox (Box Contents) in the file*/
  40     Byte8_t length; /**< content length*/
  41 } codestream_param_t;
  42
  43
  44 /**
  45  * set codestream parameters from inputs
  46  *
  47  * @param[in] fd     file descriptor
  48  * @param[in] offset offset in the file
  49  * @param[in] length codestream length
  50  * @return           structure of generated codestream parameters
  51  */
  52 codestream_param_t set_codestream(int fd, OPJ_OFF_T offset, OPJ_SIZE_T length);
  53
  54
  55 /**
  56  * fetch Codestream bytes of data in file stream
  57  *
  58  * @param[in] cs     codestream pointer
  59  * @param[in] offset start Byte position in codestream
  60  * @param[in] size   Byte length
  61  * @return           pointer to the fetched data
  62  */
  63 Byte_t * fetch_codestreambytes(codestream_param_t *cs, OPJ_OFF_T offset,
  64                                OPJ_SIZE_T size);
  65
  66 /**
  67  * fetch Codestream 1-byte Byte code in file stream
  68  *
  69  * @param[in] cs     codestream pointer
  70  * @param[in] offset start Byte position in codestream
  71  * @return           fetched code
  72  */
  73 Byte_t fetch_codestream1byte(codestream_param_t *cs, OPJ_OFF_T offset);
  74
  75 /**
  76  * fetch Codestream 2-byte big endian Byte codes in file stream
  77  *
  78  * @param[in] cs     codestream pointer
  79  * @param[in] offset start Byte position in codestream
  80  * @return           fetched code
  81  */
  82 Byte2_t fetch_codestream2bytebigendian(codestream_param_t *cs,
  83                                        OPJ_OFF_T offset);
  84
  85 /**
  86  * fetch Codestream 4-byte big endian Byte codes in file stream
  87  *
  88  * @param[in] cs     codestream pointer
  89  * @param[in] offset start Byte position in codestream
  90  * @return           fetched code
  91  */
  92 Byte4_t fetch_codestream4bytebigendian(codestream_param_t *cs,
  93                                        OPJ_OFF_T offset);
  94
  95
  96 /**
  97  * print codestream parameters
  98  *
  99  * @param[in] cs codestream
 100  */
 101 void print_codestream(codestream_param_t cs);
 102
 103
 104 #endif      /* !CODESTREAM_MANAGER_H_ */