Structs

This page documents the parameter structures used to configure Perfectly Clear corrections.

Core runtime structures

These foundational data structures are used throughout the SDK for image buffers, engine instances, and analysis profiles.

PFCIMAGE

Defines an image buffer including dimensions, pixel format, and data pointer for SDK processing.

typedef struct {
    int width;
    int height;
    int stride;
    PFCPIXELFORMAT format;
    unsigned char *data;
} PFCIMAGE;

Notes:

The stride may be larger than width times bytes per pixel if rows are padded for alignment. The SDK modifies image data in place during processing.

PFCENGINE

Contains the internal engine pointer and initialization status for a processing engine instance.

typedef struct {
    PFCINTERNAL pEngine;
    PFCENGINESTATUS status;
} PFCENGINE;

PFCIMAGEPROFILE

Contains pre-calculated analysis data and feature status codes returned by PFC_Calc.

typedef struct {
    PFCINTERNAL pPfcParam;
    PFCINTERNAL pNoiseParam;
    PFCINTERNAL pRedEyeParam;
    PFCINTERNAL pSFBParam;
    PFCINTERNAL pInternal;
    
    PFCCORE_STATUS CORE_Status;
    PFCNR_STATUS NR_Status;
    PFCFB_STATUS FB_Status;
    PFCRE_STATUS RE_Status;
    
    int Status;
} PFCIMAGEPROFILE;

Note: The PFCPROFILE type is a pointer to PFCIMAGEPROFILE:

#define PFCPROFILE PFCIMAGEPROFILE*

For background synchronization workflows, PFCBGPROFILE is defined as an internal profile handle:

#define PFCBGPROFILE PFCINTERNAL

Geometry structures

PFCPOINT

Represents a two-dimensional point with integer x and y coordinates.

typedef struct {
    int x;
    int y;
} PFCPOINT;

PFCRECT

Represents a rectangular region with position and dimensions.

typedef struct {
    int left;
    int top;
    int width;
    int height;
} PFCRECT;

Face detection structures

PFCFBFACEINFO

Contains simplified face geometry including eye positions and face bounds from Face Beautification detection.

typedef struct {
    PFCPOINT leftEye;
    PFCPOINT rightEye;
    PFCRECT face;
} PFCFBFACEINFO;

PFCFACERECT

Contains comprehensive face detection data including landmarks, angles, and confidence scores from Face Aware Exposure analysis.

typedef struct PFCFaceRect {
    PFCRECT rect;
    PFCRECT rcEyeL;
    PFCRECT rcEyeR;
    PFCRECT rcMouth;
    PFCPOINT ptEyeL;
    PFCPOINT ptEyeR;
    int angle;
    int blinkLevel;
    int blinkLevelL;
    int blinkLevelR;
    int confidence;
    int smileLevel;
    int yawAngle;
    int FAE[3];
    int widthImage;
    int heightImage;
    struct PFCFaceRect *pNext;
} PFCFACERECT;

PDF image utility classes

These C++ helper classes support iterating and replacing PFC-compatible images embedded in PDF files.

PFCPDFImage

Represents a single image extracted from a PDF document and exposes both expanded and compressed image representations.

PFCPDFImageIterator

Iterates over PFC-supported images in a PDF and automatically embeds modified images back into the document.

Master parameter structure

This section covers the top-level structure that contains all correction parameters.

PFCPARAM

The master structure that aggregates all correction parameter groups into a single configuration object.

typedef struct {
    PFCCOREPARAM core;
    PFCFBPARAM fb;
    PFCNRPARAM nr;
    PFCREPARAM re;
    PFCV3PARAM v3;
    PFCV3PARAM layer[3];
    PFCCOREMask mask[3];
    DP2PARAM dp2;
} PFCPARAM;

Core parameters

These parameters control the fundamental image corrections including exposure, contrast, color, and sharpening.

PFCCOREPARAM

Contains all settings for core image corrections such as exposure adjustment, contrast enhancement, color restoration, and sharpening.

Face beautification parameters

These parameters control portrait enhancement features including skin smoothing, eye enhancement, and facial contouring.

PFCFBPARAM

Contains all settings for Face Beautification corrections including skin smoothing, eye enhancement, teeth whitening, and facial contouring.

Noise removal parameters

These parameters control the noise reduction algorithm behavior and strength.

PFCNRPARAM

Contains settings for intelligent noise detection and removal with preset-based configurations.

Red eye parameters

These parameters control automatic red eye detection and correction.

PFCREPARAM

Contains settings for automatic red eye detection and removal in flash photography.

V3 parameters

These parameters control advanced finishing effects including LUTs, color grading, and final adjustments.

PFCV3PARAM

Contains settings for V3 finishing corrections including LUT application, Image Ambulance, and final color adjustments.

Supporting structures

These structures provide additional data types used within the main parameter structures.

PFC3DLutInfo

References a 3D LUT file for color grading and creative effects.

SELECTIVECOLOR

Defines a selective color correction that targets a specific hue range for adjustment.

PFCCOREMask

Defines a gradient mask for applying selective corrections to specific image regions.

Notes:

• Coordinates are relative to the final crop-rotated image (Y/height, X/width).
• height for linear masks defines distance from centerY where gradient reaches 1.0.
• radius is used only for MASK_ROUNDRECT.

DP2PARAM

Contains settings for AI-powered white balance and color density corrections.

PFCSCENEDESCRIPTION

Contains metadata about a detected scene returned from PFC_GetSceneDescription.

BGMASKPARAM

Defines parameters for background mask generation used with background synchronization workflows.