libultrahdr.Function.decodeJPEGMetadata - MONOGRID/gainmap-js GitHub Wiki
@monogrid/gainmap-js / libultrahdr / decodeJPEGMetadata
decodeJPEGMetadata()
Function: decodeJPEGMetadata(
file
):Promise
<{errorMessage
:any
;gainMap
:any
;metadata
:string
|ArrayBuffer
|Int8Array
<ArrayBufferLike
> |Uint8Array
<ArrayBufferLike
> |Uint8ClampedArray
<ArrayBufferLike
>;parsedMetadata
:GainMapMetadata
;sdr
:any
;success
:boolean
; }>
Defined in: src/libultrahdr/decode-jpeg-metadata.ts:24
Decodes a JPEG file with an embedded Gainmap and XMP Metadata (aka JPEG-R)
Parameters
file
Uint8Array
A Jpeg file Uint8Array.
Returns
Promise
<{ errorMessage
: any
; gainMap
: any
; metadata
: string
| ArrayBuffer
| Int8Array
<ArrayBufferLike
> | Uint8Array
<ArrayBufferLike
> | Uint8ClampedArray
<ArrayBufferLike
>; parsedMetadata
: GainMapMetadata
; sdr
: any
; success
: boolean
; }>
The decoded data
Deprecated
Example
import { decodeJPEGMetadata } from '@monogrid/gainmap-js/libultrahdr'
// fetch a JPEG image containing a gainmap as ArrayBuffer
const gainmap = new Uint8Array(await (await fetch('gainmap.jpeg')).arrayBuffer())
// extract data from the JPEG
const { gainMap, sdr, parsedMetadata } = await decodeJPEGMetadata(gainmap)
Throws
if the provided file cannot be parsed or does not contain a valid Gainmap