Error Code Index

This page provides a comprehensive reference for all status codes returned by the Perfectly Clear SDK. Use this guide to interpret return values and determine the appropriate action.

How return codes work

The SDK uses different return code systems depending on the function:

• PFC_AutoCorrect() and PFC_Apply(): Return a composite integer that encodes status for multiple features
• PFC_SetProtectionPath(): Returns license validation status
• PFC_ReadPresets(): Returns preset loading status

Interpreting composite return codes

When PFC_AutoCorrect() or PFC_Apply() returns a value greater than zero, it's a warning code that contains status information for four correction features encoded in different byte positions:

The following example demonstrates how to decode a composite return code:

PFCAPPLYSTATUS status = PFC_Apply(&im, pEngine, pProfile, param, NULL, 100, NULL);

if (status > APPLY_SUCCESS) {
    // Extract individual feature statuses
    int nrStatus = NRRETCODE(status);
    int coreStatus = CORERETCODE(status);
    int fbStatus = FBRETCODE(status);
    int reStatus = RERETCODE(status);
    
    printf("Noise Removal status: %d\n", nrStatus);
    printf("Core correction status: %d\n", coreStatus);
    printf("Face Beautification status: %d\n", fbStatus);
    printf("Red Eye Removal status: %d\n", reStatus);
}

Apply function status codes

These codes are returned by PFC_AutoCorrect() and PFC_Apply() as the primary return value when the operation fails or completes with warnings.

Success and errors (PFCAPPLYSTATUS)

The PFCAPPLYSTATUS enumeration defines all possible return values from the apply functions. Negative values indicate errors that prevented processing, while zero indicates success:

Feature-specific status codes

When the return code is greater than zero, extract individual feature statuses using the decoding macros. Each feature has its own status enumeration.

Noise removal status (PFCNR_STATUS)

The noise removal status indicates whether noise reduction was successfully applied. Extract this value using NRRETCODE(status):

Core correction status (PFCCORE_STATUS)

The core correction status reflects the outcome of exposure, color, and contrast adjustments. Extract this value using CORERETCODE(status):

Face beautification status (PFCFB_STATUS)

The face beautification status indicates whether facial enhancements were applied. Extract this value using FBRETCODE(status):

Red eye removal status (PFCRE_STATUS)

The red eye removal status indicates whether red eye correction was applied. Extract this value using RERETCODE(status):

License status codes

These codes are returned by PFC_SetProtectionPath() and indicate the result of license validation:

Preset loading status codes

These codes are returned by PFC_ReadPresets() and PFC_ReadPresetsFromStream() when loading correction parameters from preset files:

Status value decoder

Use this section to decode composite return values into their component feature statuses.

For a return code like 524288:

1. Convert to hexadecimal: 524288 = 0x00080000
2. Extract bytes:
   • Bits 0–7 (NR): 0x00 = 0 (success)
   • Bits 8–15 (Core): 0x00 = 0 (success)
   • Bits 16–23 (FB): 0x08 = 8 (PFC_FB_NO_CORRECTION)
   • Bits 24–31 (RE): 0x00 = 0 (success)

This indicates Face Beautification detected faces but applied no corrections (perhaps beautification parameters were all set to zero).

Quick decode formula

These C/C++ macro definitions from PerfectlyClearPro.h extract individual status values from a composite return code:

#define NRRETCODE(x)   (x & 0x000000FF)
#define CORERETCODE(x) ((x >> 8) & 0x000000FF)
#define FBRETCODE(x)   ((x >> 16) & 0x000000FF)
#define RERETCODE(x)   ((x >> 24) & 0x000000FF)

Common composite return values

This table lists frequently encountered composite return values and their meanings: