summaryrefslogtreecommitdiff
path: root/src/jp2kheader.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/jp2kheader.c')
-rw-r--r--src/jp2kheader.c296
1 files changed, 296 insertions, 0 deletions
diff --git a/src/jp2kheader.c b/src/jp2kheader.c
new file mode 100644
index 0000000..f91c42d
--- /dev/null
+++ b/src/jp2kheader.c
@@ -0,0 +1,296 @@
+/*====================================================================*
+ - Copyright (C) 2001 Leptonica. All rights reserved.
+ -
+ - Redistribution and use in source and binary forms, with or without
+ - modification, are permitted provided that the following conditions
+ - are met:
+ - 1. Redistributions of source code must retain the above copyright
+ - notice, this list of conditions and the following disclaimer.
+ - 2. Redistributions in binary form must reproduce the above
+ - copyright notice, this list of conditions and the following
+ - disclaimer in the documentation and/or other materials
+ - provided with the distribution.
+ -
+ - 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 ANY
+ - 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.
+ *====================================================================*/
+
+/*
+ * jp2kheader.c
+ *
+ * Read header
+ * l_int32 readHeaderJp2k()
+ * l_int32 freadHeaderJp2k()
+ * l_int32 readHeaderMemJp2k()
+ * l_int32 fgetJp2kResolution()
+ *
+ * Note: these function read image metadata from a jp2k file, without
+ * using any jp2k libraries.
+ *
+ * To read and write jp2k data, using the OpenJPEG library
+ * (http://www.openjpeg.org), see jpegio.c.
+ */
+
+#include <string.h>
+#include <math.h>
+#include "allheaders.h"
+
+#ifndef NO_CONSOLE_IO
+#define DEBUG_IHDR 0
+#endif /* ~NO_CONSOLE_IO */
+
+/* --------------------------------------------*/
+#if USE_JP2KHEADER /* defined in environ.h */
+/* --------------------------------------------*/
+
+ /* a sanity check on the size read from file */
+static const l_int32 MAX_JP2K_WIDTH = 100000;
+static const l_int32 MAX_JP2K_HEIGHT = 100000;
+
+/*--------------------------------------------------------------------*
+ * Stream interface *
+ *--------------------------------------------------------------------*/
+/*!
+ * readHeaderJp2k()
+ *
+ * Input: filename
+ * &w (<optional return>)
+ * &h (<optional return>)
+ * &bps (<optional return>, bits/sample)
+ * &spp (<optional return>, samples/pixel)
+ * Return: 0 if OK, 1 on error
+ */
+l_int32
+readHeaderJp2k(const char *filename,
+ l_int32 *pw,
+ l_int32 *ph,
+ l_int32 *pbps,
+ l_int32 *pspp)
+{
+l_int32 ret;
+FILE *fp;
+
+ PROCNAME("readHeaderJp2k");
+
+ if (pw) *pw = 0;
+ if (ph) *ph = 0;
+ if (pbps) *pbps = 0;
+ if (pspp) *pspp = 0;
+ if (!filename)
+ return ERROR_INT("filename not defined", procName, 1);
+
+ if ((fp = fopenReadStream(filename)) == NULL)
+ return ERROR_INT("image file not found", procName, 1);
+ ret = freadHeaderJp2k(fp, pw, ph, pbps, pspp);
+ fclose(fp);
+ return ret;
+}
+
+
+/*!
+ * freadHeaderJp2k()
+ *
+ * Input: stream opened for read
+ * &w (<optional return>)
+ * &h (<optional return>)
+ * &bps (<optional return>, bits/sample)
+ * &spp (<optional return>, samples/pixel)
+ * Return: 0 if OK, 1 on error
+ */
+l_int32
+freadHeaderJp2k(FILE *fp,
+ l_int32 *pw,
+ l_int32 *ph,
+ l_int32 *pbps,
+ l_int32 *pspp)
+{
+l_uint8 buf[80]; /* just need the first 80 bytes */
+l_int32 nread;
+
+ PROCNAME("freadHeaderJp2k");
+
+ if (pw) *pw = 0;
+ if (ph) *ph = 0;
+ if (pbps) *pbps = 0;
+ if (pspp) *pspp = 0;
+ if (!fp)
+ return ERROR_INT("fp not defined", procName, 1);
+
+ rewind(fp);
+ nread = fread(buf, 1, sizeof(buf), fp);
+ if (nread != sizeof(buf))
+ return ERROR_INT("read failure", procName, 1);
+
+ readHeaderMemJp2k(buf, sizeof(buf), pw, ph, pbps, pspp);
+ rewind(fp);
+ return 0;
+}
+
+
+/*!
+ * readHeaderMemJp2k()
+ *
+ * Input: data
+ * size (at least 80)
+ * &w (<optional return>)
+ * &h (<optional return>)
+ * &bps (<optional return>, bits/sample)
+ * &spp (<optional return>, samples/pixel)
+ * Return: 0 if OK, 1 on error
+ *
+ * Notes:
+ * (1) The ISO/IEC reference for jpeg2000 is
+ * http://www.jpeg.org/public/15444-1annexi.pdf
+ * and the file format syntax begins at page 127.
+ * (2) The Image Header Box begins with 'ihdr' = 0x69686472 in
+ * big-endian order. This typically, but not always, starts
+ * byte 44, with the big-endian data fields beginning at byte 48:
+ * h: 4 bytes
+ * w: 4 bytes
+ * spp: 2 bytes
+ * bps: 1 byte (contains bps - 1)
+ */
+l_int32
+readHeaderMemJp2k(const l_uint8 *data,
+ size_t size,
+ l_int32 *pw,
+ l_int32 *ph,
+ l_int32 *pbps,
+ l_int32 *pspp)
+{
+l_int32 format, val, w, h, bps, spp, loc, found, windex;
+l_uint8 ihdr[4] = {0x69, 0x68, 0x64, 0x72}; /* 'ihdr' */
+
+ PROCNAME("readHeaderMemJp2k");
+
+ if (pw) *pw = 0;
+ if (ph) *ph = 0;
+ if (pbps) *pbps = 0;
+ if (pspp) *pspp = 0;
+ if (!data)
+ return ERROR_INT("data not defined", procName, 1);
+ if (size < 80)
+ return ERROR_INT("size < 80", procName, 1);
+ findFileFormatBuffer(data, &format);
+ if (format != IFF_JP2)
+ return ERROR_INT("not jp2 file", procName, 1);
+
+ /* Search for beginning of the Image Header Box: 'ihdr' */
+ arrayFindSequence(data, size, ihdr, 4, &loc, &found);
+ if (!found)
+ return ERROR_INT("image parameters not found", procName, 1);
+#if DEBUG_IHDR
+ if (loc != 44)
+ L_INFO("Beginning of ihdr is at byte %d\n", procName, loc);
+#endif /* DEBUG_IHDR */
+
+ windex = loc / 4 + 1;
+ val = *((l_uint32 *)data + windex);
+ h = convertOnLittleEnd32(val);
+ val = *((l_uint32 *)data + windex + 1);
+ w = convertOnLittleEnd32(val);
+ val = *((l_uint16 *)data + 2 * (windex + 2));
+ spp = convertOnLittleEnd16(val);
+ bps = *(data + 4 * (windex + 2) + 2) + 1;
+ if (w > MAX_JP2K_WIDTH || h > MAX_JP2K_HEIGHT)
+ return ERROR_INT("unrealistically large sizes", procName, 1);
+ if (pw) *pw = w;
+ if (ph) *ph = h;
+ if (pbps) *pbps = bps;
+ if (pspp) *pspp = spp;
+ return 0;
+}
+
+
+/*
+ * fgetJp2kResolution()
+ *
+ * Input: stream (opened for read)
+ * &xres, &yres (<return> resolution in ppi)
+ * Return: 0 if found; 1 if not found or on error
+ *
+ * Notes:
+ * (1) If the capture resolution field is not set, this is not an error;
+ * the returned resolution values are 0 (designating 'unknown').
+ * (2) Side-effect: this rewinds the stream.
+ * (3) The capture resolution box is optional in the jp2 spec, and
+ * it is usually not written.
+ * (4) The big-endian data fields that follow the 4 bytes of 'resc' are:
+ * ynum: 2 bytes
+ * ydenom: 2 bytes
+ * xnum: 2 bytes
+ * xdenom: 2 bytes
+ * yexp: 1 byte
+ * xexp: 1 byte
+ */
+l_int32
+fgetJp2kResolution(FILE *fp,
+ l_int32 *pxres,
+ l_int32 *pyres)
+{
+l_uint8 xexp, yexp;
+l_uint8 *data;
+l_uint16 xnum, ynum, xdenom, ydenom; /* these jp2k fields are 2-byte */
+l_int32 loc, found;
+l_uint8 resc[4] = {0x72, 0x65, 0x73, 0x63}; /* 'resc' */
+size_t nbytes;
+l_float64 xres, yres;
+
+ PROCNAME("fgetJp2kResolution");
+
+ if (pxres) *pxres = 0;
+ if (pyres) *pyres = 0;
+ if (!pxres || !pyres)
+ return ERROR_INT("&xres and &yres not both defined", procName, 1);
+ if (!fp)
+ return ERROR_INT("stream not opened", procName, 1);
+
+ rewind(fp);
+ data = l_binaryReadStream(fp, &nbytes);
+ rewind(fp);
+
+ /* Search for the start of the first capture resolution box: 'resc' */
+ arrayFindSequence(data, nbytes, resc, 4, &loc, &found);
+ if (!found) {
+ L_WARNING("image resolution not found\n", procName);
+ LEPT_FREE(data);
+ return 1;
+ }
+
+ /* Extract the fields and calculate the resolution in pixels/meter.
+ * See section 1.5.3.7.1 of JPEG 2000 ISO/IEC 15444-1 spec. */
+ ynum = data[loc + 5] << 8 | data[loc + 4];
+ ynum = convertOnLittleEnd16(ynum);
+ ydenom = data[loc + 7] << 8 | data[loc + 6];
+ ydenom = convertOnLittleEnd16(ydenom);
+ xnum = data[loc + 9] << 8 | data[loc + 8];
+ xnum = convertOnLittleEnd16(xnum);
+ xdenom = data[loc + 11] << 8 | data[loc + 10];
+ xdenom = convertOnLittleEnd16(xdenom);
+ yexp = data[loc + 12];
+ xexp = data[loc + 13];
+ yres = ((l_float64)ynum / (l_float64)ydenom) * pow(10.0, (l_float64)yexp);
+ xres = ((l_float64)xnum / (l_float64)xdenom) * pow(10.0, (l_float64)xexp);
+
+ /* Convert from pixels/meter to ppi */
+ yres *= (300.0 / 11811.0);
+ xres *= (300.0 / 11811.0);
+ *pyres = (l_int32)(yres + 0.5);
+ *pxres = (l_int32)(xres + 0.5);
+
+ LEPT_FREE(data);
+ return 0;
+}
+
+/* --------------------------------------------*/
+#endif /* USE_JP2KHEADER */
+/* --------------------------------------------*/
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-16 16:59:56 +0000