Skip to content

Commit

Permalink
Expand comments in avifGainMap. (#1866)
Browse files Browse the repository at this point in the history
  • Loading branch information
maryla-uc authored Dec 11, 2023
1 parent 5c9bb26 commit 7f8daa5
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions include/avif/avif.h
Original file line number Diff line number Diff line change
Expand Up @@ -642,29 +642,34 @@ typedef struct avifGainMap
{
// Gain map pixels.
// Owned by the avifGainMap and gets freed when calling avifGainMapDestroy().
// Used fields: width, height, depth, yufFormat, yuvRange,
// Used fields: width, height, depth, yuvFormat, yuvRange,
// yuvChromaSamplePosition, yuvPlanes, yuvRowBytes, imageOwnsYUVPlanes,
// matrixCoefficients. colorPrimaries and transferCharacteristics shall be 2.
// Other fields are ignored.
// matrixCoefficients. The colorPrimaries and transferCharacteristics fields
// shall be 2. Other fields are ignored.
struct avifImage * image;

// Gain map metadata.
// For an image grid, the metadata shall be identical for all cells.
// When encoding an image grid, all metadata below shall be identical for all
// cells.

// Gain map metadata used to interpret and apply the gain map pixel data.
avifGainMapMetadata metadata;

// Colorimetry of the alternate image.
// Colorimetry of the alternate image (ICC profile and/or CICP information
// of the alternate image that the gain map was created from).
avifRWData altICC;
avifColorPrimaries altColorPrimaries;
avifTransferCharacteristics altTransferCharacteristics;
avifMatrixCoefficients altMatrixCoefficients;
avifRange altYUVRange;

// Hint on the approximate amount of colour resolution available after fully
// applying the gain map.
// applying the gain map ('pixi' box content of the alternate image that the
// gain map was created from).
uint32_t altDepth;
uint32_t altPlaneCount;

// Optimal viewing conditions of the alternate image.
// Optimal viewing conditions of the alternate image ('clli' box content
// of the alternate image that the gain map was created from).
avifContentLightLevelInformationBox altCLLI;
} avifGainMap;

Expand Down

0 comments on commit 7f8daa5

Please sign in to comment.