src/bin/jp2/convert.h

   1 /*
   2  * The copyright in this software is being made available under the 2-clauses
   3  * BSD License, included below. This software may be subject to other third
   4  * party and contributor rights, including patent rights, and no such rights
   5  * are granted under this license.
   6  *
   7  * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
   8  * Copyright (c) 2002-2014, Professor Benoit Macq
   9  * Copyright (c) 2001-2003, David Janssens
  10  * Copyright (c) 2002-2003, Yannick Verschueren
  11  * Copyright (c) 2003-2007, Francois-Olivier Devaux
  12  * Copyright (c) 2003-2014, Antonin Descampe
  13  * Copyright (c) 2005, Herve Drolon, FreeImage Team
  14  * All rights reserved.
  15  *
  16  * Redistribution and use in source and binary forms, with or without
  17  * modification, are permitted provided that the following conditions
  18  * are met:
  19  * 1. Redistributions of source code must retain the above copyright
  20  *    notice, this list of conditions and the following disclaimer.
  21  * 2. Redistributions in binary form must reproduce the above copyright
  22  *    notice, this list of conditions and the following disclaimer in the
  23  *    documentation and/or other materials provided with the distribution.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  26  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  29  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  */
  37 #ifndef __J2K_CONVERT_H
  38 #define __J2K_CONVERT_H
  39
  40 /**@name RAW component encoding parameters */
  41 /*@{*/
  42 typedef struct raw_comp_cparameters {
  43     /** subsampling in X direction */
  44     int dx;
  45     /** subsampling in Y direction */
  46     int dy;
  47     /*@}*/
  48 } raw_comp_cparameters_t;
  49
  50 /**@name RAW image encoding parameters */
  51 /*@{*/
  52 typedef struct raw_cparameters {
  53     /** width of the raw image */
  54     int rawWidth;
  55     /** height of the raw image */
  56     int rawHeight;
  57     /** number of components of the raw image */
  58     int rawComp;
  59     /** bit depth of the raw image */
  60     int rawBitDepth;
  61     /** signed/unsigned raw image */
  62     OPJ_BOOL rawSigned;
  63     /** raw components parameters */
  64     raw_comp_cparameters_t *rawComps;
  65     /*@}*/
  66 } raw_cparameters_t;
  67
  68 /* Component precision clipping */
  69 void clip_component(opj_image_comp_t* component, OPJ_UINT32 precision);
  70 /* Component precision scaling */
  71 void scale_component(opj_image_comp_t* component, OPJ_UINT32 precision);
  72
  73 /* planar / interleaved conversions */
  74 typedef void (* convert_32s_CXPX)(const OPJ_INT32* pSrc, OPJ_INT32* const* pDst,
  75                                   OPJ_SIZE_T length);
  76 extern const convert_32s_CXPX convert_32s_CXPX_LUT[5];
  77 typedef void (* convert_32s_PXCX)(OPJ_INT32 const* const* pSrc, OPJ_INT32* pDst,
  78                                   OPJ_SIZE_T length, OPJ_INT32 adjust);
  79 extern const convert_32s_PXCX convert_32s_PXCX_LUT[5];
  80 /* bit depth conversions */
  81 typedef void (* convert_XXx32s_C1R)(const OPJ_BYTE* pSrc, OPJ_INT32* pDst,
  82                                     OPJ_SIZE_T length);
  83 extern const convert_XXx32s_C1R convert_XXu32s_C1R_LUT[9]; /* up to 8bpp */
  84 typedef void (* convert_32sXXx_C1R)(const OPJ_INT32* pSrc, OPJ_BYTE* pDst,
  85                                     OPJ_SIZE_T length);
  86 extern const convert_32sXXx_C1R convert_32sXXu_C1R_LUT[9]; /* up to 8bpp */
  87
  88
  89 /* TGA conversion */
  90 opj_image_t* tgatoimage(const char *filename, opj_cparameters_t *parameters);
  91 int imagetotga(opj_image_t * image, const char *outfile);
  92
  93 /* BMP conversion */
  94 opj_image_t* bmptoimage(const char *filename, opj_cparameters_t *parameters);
  95 int imagetobmp(opj_image_t *image, const char *outfile);
  96
  97 /* TIFF conversion*/
  98 opj_image_t* tiftoimage(const char *filename, opj_cparameters_t *parameters);
  99 int imagetotif(opj_image_t *image, const char *outfile);
 100 /**
 101 Load a single image component encoded in PGX file format
 102 @param filename Name of the PGX file to load
 103 @param parameters *List ?*
 104 @return Returns a greyscale image if successful, returns NULL otherwise
 105 */
 106 opj_image_t* pgxtoimage(const char *filename, opj_cparameters_t *parameters);
 107 int imagetopgx(opj_image_t *image, const char *outfile);
 108
 109 opj_image_t* pnmtoimage(const char *filename, opj_cparameters_t *parameters);
 110 int imagetopnm(opj_image_t *image, const char *outfile, int force_split);
 111
 112 /* RAW conversion */
 113 int imagetoraw(opj_image_t * image, const char *outfile);
 114 int imagetorawl(opj_image_t * image, const char *outfile);
 115 opj_image_t* rawtoimage(const char *filename, opj_cparameters_t *parameters,
 116                         raw_cparameters_t *raw_cp);
 117 opj_image_t* rawltoimage(const char *filename, opj_cparameters_t *parameters,
 118                          raw_cparameters_t *raw_cp);
 119
 120 /* PNG conversion*/
 121 extern int imagetopng(opj_image_t *image, const char *write_idf);
 122 extern opj_image_t* pngtoimage(const char *filename,
 123                                opj_cparameters_t *parameters);
 124
 125 #endif /* __J2K_CONVERT_H */
 126