src/lib/openjpip/mhixbox_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     MHIXBOX_MANAGER_H_
  32 # define    MHIXBOX_MANAGER_H_
  33
  34 #include "byte_manager.h"
  35 #include "box_manager.h"
  36
  37 /** Marker index parameters*/
  38 typedef struct markeridx_param {
  39     Byte2_t code;                 /**< marker code*/
  40     Byte2_t num_remain;           /**< remaining number of the same marker index segments listed immediately*/
  41     OPJ_OFF_T offset;               /**< offset relative to the start of the*/
  42     /**codestream ( including the length*/
  43     /**parameter but not the marker itself)*/
  44     Byte2_t length;               /**< marker segment length*/
  45     struct markeridx_param *next; /**< pointer to the next markeridx*/
  46 } markeridx_param_t;
  47
  48
  49
  50 /** header index table box parameters*/
  51 /** I.3.2.4.3 Header Index Table box*/
  52 typedef struct mhixbox_param {
  53     Byte8_t tlen;             /**< length ( total length of the main*/
  54     /**header or of the first tile-part header)*/
  55     markeridx_param_t *first; /**< first marker index pointer of the list*/
  56 } mhixbox_param_t;
  57
  58
  59
  60 /**
  61  * generate mhix box
  62  *
  63  * @param[in] box pointer to the reference mhix box
  64  * @return        generated mhixbox pointer
  65  */
  66 mhixbox_param_t * gene_mhixbox(box_param_t *box);
  67
  68
  69 /**
  70  * search a marker index by marker code from mhix box
  71  *
  72  * @param[in] code marker code
  73  * @param[in] mhix mhix box pointer
  74  * @return         found marker index pointer
  75  */
  76 markeridx_param_t * search_markeridx(Byte2_t code, mhixbox_param_t *mhix);
  77
  78
  79 /**
  80  * print mhix box parameters
  81  *
  82  * @param[in] mhix mhix box pointer
  83  */
  84 void print_mhixbox(mhixbox_param_t *mhix);
  85
  86
  87 /**
  88  * print marker index parameters
  89  *
  90  * @param[in] markeridx marker index pointer
  91  */
  92 void print_markeridx(markeridx_param_t *markeridx);
  93
  94
  95 /**
  96  * delete mhix box
  97  *
  98  * @param[in,out] mhix address of the mhix box pointer
  99  */
 100 void delete_mhixbox(mhixbox_param_t **mhix);
 101
 102 #endif      /* !MHIXBOX_MANAGER_H_ */