src/lib/openjpip/marker_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     MARKER_MANAGER_H_
  32 # define    MARKER_MANAGER_H_
  33
  34 #include "codestream_manager.h"
  35
  36
  37 /** Marker parameters*/
  38 typedef struct marker_param {
  39     codestream_param_t cs; /**< corresponding codestream*/
  40     Byte2_t code;          /**< marker code*/
  41     OPJ_OFF_T offset;        /**< offset relative to the start of the codestream ( including the length parameter but not the marker itself)*/
  42     Byte2_t length;        /**< marker segment length*/
  43 } marker_param_t;
  44
  45
  46 /**
  47  * set marker parameters from inputs
  48  *
  49  * @param[in] cs     marker code
  50  * @param[in] code   marker code
  51  * @param[in] offset offset in the codestream
  52  * @param[in] length marker segment length
  53  * @return           structure of generated marker parameters
  54  */
  55 marker_param_t set_marker(codestream_param_t cs, Byte2_t code, OPJ_OFF_T offset,
  56                           Byte2_t length);
  57
  58
  59 /**
  60  * fetch marker content 1-bytes of data in file stream
  61  *
  62  * @param[in] marker marker structure
  63  * @param[in] offset start Byte position in marker
  64  * @return           fetched code
  65  */
  66 Byte_t fetch_marker1byte(marker_param_t marker, OPJ_OFF_T offset);
  67
  68 /**
  69  * fetch marker content 2-byte big endian Byte codes in file stream
  70  *
  71  * @param[in] marker marker structure
  72  * @param[in] offset start Byte position in marker
  73  * @return           fetched code
  74  */
  75 Byte2_t fetch_marker2bytebigendian(marker_param_t marker, OPJ_OFF_T offset);
  76
  77 /**
  78  * fetch marker content 4-byte big endian Byte codes in file stream
  79  *
  80  * @param[in] marker marker structure
  81  * @param[in] offset start Byte position in marker
  82  * @return           fetched code
  83  */
  84 Byte4_t fetch_marker4bytebigendian(marker_param_t marker, OPJ_OFF_T offset);
  85
  86
  87 #endif      /* !MARKER_MANAGER_H_ */