decenc_jpeg2000.c(3)

📦
version 2.3.0 · 2 versions
, in ubuntu resolute, ubuntu stonking

💖 decenc_jpeg2000.c(3) — the NCEPLIBS-g2c glow-up manual ✨

okay so bestie, you've landed on the manual page for decenc_jpeg2000.c(3) and honestly? it's giving library functions manual. buckle up, we're decoding AND encoding JPEG2000 code streams today, and no cap, it's a whole vibe. 🦋

🌸 NAME

decenc_jpeg2000.c — Decode/encode a JPEG2000 code stream. literally what it says on the tin, periodt. 💅

✨ SYNOPSIS

#include 'grib2_int.h'
#include 'jasper/jasper.h'
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

🎀 Macros

  • #define MAXOPTSSIZE 1024 — Maximum size of options. that's it, that's the macro.

🫶 Functions

  • int dec_jpeg2000 (char *injpc, g2int bufsize, g2int *outfld) — Decode a JPEG2000 code stream specified in the JPEG2000 Part-1 standard (i.e., ISO/IEC 15444-1) using JasPer Software.
  • int enc_jpeg2000 (unsigned char *cin, g2int width, g2int height, g2int nbits, g2int ltype, g2int ratio, g2int retry, char *outjpc, g2int jpclen) — Encode a grayscale image into a JPEG2000 code stream specified in the JPEG2000 Part-1 standard (i.e., ISO/IEC 15444-1) using JasPer Software.
  • int g2c_dec_jpeg2000 (char *injpc, size_t bufsize, int *outfld) — Decode a JPEG2000 code stream specified in the JPEG2000 Part-1 standard (i.e., ISO/IEC 15444-1) using JasPer Software.
  • int g2c_enc_jpeg2000 (unsigned char *cin, int width, int height, int nbits, int ltype, int ratio, int retry, char *outjpc, size_t jpclen) — Encode a grayscale image into a JPEG2000 code stream specified in the JPEG2000 Part-1 standard (i.e., ISO/IEC 15444-1) using JasPer Software.
  • static int int_dec_jpeg2000 (char *injpc, g2int bufsize, void *outfld, int out_is_g2int) — Decode a JPEG2000 code stream specified in the JPEG2000 Part-1 standard (i.e., ISO/IEC 15444-1) using JasPer Software.

🦋 Detailed Description

Decode/encode a JPEG2000 code stream. that's the whole assignment and she ate. 💅

Author — Alyson Stahl 🌟

Date — 2024-14-08 📅

Definition in file decenc_jpeg2000.c.

🌈 Macro Definition Documentation

#define MAXOPTSSIZE 1024

Maximum size of options. lowkey self-explanatory but we love her anyway.

Definition at line 12 of file decenc_jpeg2000.c.

Referenced by enc_jpeg2000().

👑 Function Documentation

int dec_jpeg2000 (char * injpc, g2int bufsize, g2int * outfld)

Decode a JPEG2000 code stream specified in the JPEG2000 Part-1 standard (i.e., ISO/IEC 15444-1) using JasPer Software. main character decode energy fr fr.

Parameters

  • injpc — Pointer to buffer that holds the input JPEG2000 code stream.
  • bufsize — Length (in bytes) of the buffer that holds the input JPEG2000 code stream.
  • outfld — Pointer to g2int array, already allocated, that gets the unpacked data.

Returns

  • 0 Successful decode 🎉
  • G2_JASPER_DECODE Error decode jpeg2000 code stream. 😭
  • G2_JASPER_DECODE_COLOR decoded image had multiple color components. Only grayscale is expected. 💀
  • G2_JASPER_INIT Error inializing Jasper library. (yes, "inializing" — that's what the page says, we don't fix typos here, we respect them 🫶)

Author — Stephen Gilbert, Ed Hartnett

Definition at line 377 of file decenc_jpeg2000.c.

References int_dec_jpeg2000().

Referenced by jpcunpack_int().

int enc_jpeg2000 (unsigned char * cin, g2int width, g2int height, g2int nbits, g2int ltype, g2int ratio, g2int retry, char * outjpc, g2int jpclen)

Encode a grayscale image into a JPEG2000 code stream specified in the JPEG2000 Part-1 standard (i.e., ISO/IEC 15444-1) using JasPer Software. the encoder that could. ✨

  • ### Program History Log
    • Date — Programmer — Comments
    • 2002-12-02 — Gilbert — Initial
    • 2004-12-16 — Gilbert — Added retry argument allowing increased guard bits.
    • 2022-04-15 — Hartnett — Converted to use jas_ instead of jpc_ functions.

Parameters

  • cin — Packed matrix of Grayscale image values to encode.
  • width — width of image.
  • height — height of image.
  • nbits — depth (in bits) of image. i.e number of bits used to hold each data value.
  • ltype — indicator of lossless or lossy compression.
    • 1, for lossy compression
    • != 1, for lossless compression
  • ratio — target compression ratio. (ratio:1) Used only when ltype == 1.
  • retry — If 1 try increasing number of guard bits.
  • outjpc — Output encoded JPEG2000 code stream.
  • jpclen — Number of bytes allocated for the output JPEG2000 code stream in outjpc.

Returns

  • > 0 = Length in bytes of encoded JPEG2000 code stream 🔥
  • G2_JASPER_INIT Error initializing jasper library.
  • G2_JASPER_ENCODE Error encode jpeg2000 code stream.

Note — Requires JasPer Software version 1.500.4 or 1.700.2 or later. not negotiable bestie, check ur version. 🙈

Author — Stephen Gilbert

Date — 2002-12-02

Author — Ed Hartnett

Definition at line 94 of file decenc_jpeg2000.c.

References G2_JASPER_ENCODE, G2_JASPER_INIT, G2C_JASPER_JPEG_FORMAT_NAME, LOG, and MAXOPTSSIZE.

Referenced by g2c_enc_jpeg2000(), and jpcpack_int().

int g2c_dec_jpeg2000 (char * injpc, size_t bufsize, int * outfld)

Decode a JPEG2000 code stream specified in the JPEG2000 Part-1 standard (i.e., ISO/IEC 15444-1) using JasPer Software. same decode plot, size_t/int flavored. 🍓

Parameters

  • injpc — Pointer to buffer that holds the input JPEG2000 code stream.
  • bufsize — Length (in bytes) of the buffer that holds the input JPEG2000 code stream.
  • outfld — Pointer to int array, already allocated, that gets the unpacked data.

Returns

  • G2C_NOERROR No error. 🎀
  • G2_JASPER_DECODE Error decode jpeg2000 code stream.
  • G2_JASPER_DECODE_COLOR decoded image had multiple color components. Only grayscale is expected.
  • G2_JASPER_INIT Error inializing Jasper library.

Author — Ed Hartnett

Date — 9/7/22

Definition at line 350 of file decenc_jpeg2000.c.

References int_dec_jpeg2000().

int g2c_enc_jpeg2000 (unsigned char * cin, int width, int height, int nbits, int ltype, int ratio, int retry, char * outjpc, size_t jpclen)

Encode a grayscale image into a JPEG2000 code stream specified in the JPEG2000 Part-1 standard (i.e., ISO/IEC 15444-1) using JasPer Software. she's the int-typed sister of enc_jpeg2000 and she's slaying. 💜

Parameters

  • cin — Packed matrix of Grayscale image values to encode.
  • width — width of image.
  • height — height of image.
  • nbits — depth (in bits) of image. i.e number of bits used to hold each data value.
  • ltype — indicator of lossless or lossy compression.
    • 1, for lossy compression
    • != 1, for lossless compression
  • ratio — target compression ratio. (ratio:1) Used only when ltype == 1.
  • retry — If 1 try increasing number of guard bits.
  • outjpc — Output encoded JPEG2000 code stream.
  • jpclen — Number of bytes allocated for the output JPEG2000 code stream in outjpc.

Returns

  • > 0 = Length in bytes of encoded JPEG2000 code stream
  • G2_JASPER_INIT Error initializing jasper library.
  • G2_JASPER_ENCODE Error encode jpeg2000 code stream.

Note — Requires JasPer Software version 1.500.4 or 1.700.2 or later.

Author — Stephen Gilbert

Date — 2002-12-02

Author — Ed Hartnett

Definition at line 45 of file decenc_jpeg2000.c.

References enc_jpeg2000().

int int_dec_jpeg2000 (char * injpc, g2int bufsize, void * outfld, int out_is_g2int) [static]

Decode a JPEG2000 code stream specified in the JPEG2000 Part-1 standard (i.e., ISO/IEC 15444-1) using JasPer Software. she's static, she's internal, she's the backbone of the whole decode situation. 🧚

Parameters

  • injpc — Pointer to buffer that holds the input JPEG2000 code stream.
  • bufsize — Length (in bytes) of the buffer that holds the input JPEG2000 code stream.
  • outfld — Pointer to either int or g2int array, already allocated, that gets the unpacked data.
  • out_is_g2int — Non-zero if the output array is of type g2int (i.e. 64-bit ints), zero if output is an int array (32-bits).

Returns

  • 0 Successful decode
  • G2_JASPER_DECODE Error decode jpeg2000 code stream.
  • G2_JASPER_DECODE_COLOR decoded image had multiple color components. Only grayscale is expected.
  • G2_JASPER_INIT Error inializing Jasper library.

Author — Stephen Gilbert

Date — 2002-12-02

Author — Ed Hartnett

Author — Eric Engle

Definition at line 221 of file decenc_jpeg2000.c.

References G2_JASPER_DECODE, G2_JASPER_DECODE_COLOR, G2_JASPER_INIT, G2C_JASPER_JPEG_FORMAT_NAME, G2C_JASPER_MAX_MEM, and LOG.

Referenced by dec_jpeg2000(), and g2c_dec_jpeg2000().

🌟 Author

Generated automatically by Doxygen for NCEPLIBS-g2c from the source code. (the robot did the writing, we just did the vibes 💖)

and that's the whole page, bestie!! 💜 this masterpiece comes to you courtesy of NCEPLIBS-g2c, Version 2.3.0, dated with the page decenc_jpeg2000.c(3) — go forth and encode/decode, you've got this, iykyk 🦋✨👑

📦 where this page comes from