DFX SDK Changelog

This project adheres to Semantic Versioning.

4.9.0

• Added timestamp_millisec to VideoFrame. If it's not NaN then timedstamp_ns will be ignored.
• Added experimental Frame::getQualityMetrics and Frame::getStarRating
• Changed types from uint64_t to uint32_t for ChunkPayload::{first_chunk_start_time_s, start_time_s, end_time_s} and VideoFrame::number
• Renamed VideoFrame::ChannelOrder::Infrared24 to VideoFrame::ChannelOrder::Infrared888 (not supported yet)
• Deprecated Factory::initializeStudy(FILE), Factory::addToStudy(FILE) and Factory::addToStudy(MEMORY) and corresponding C-API calls
• Deprecated C-API calls for dfx_frame_get_region_names, dfx_frame_get_region_polygon, dfx_frame_get_region_int_property and dfx_frame_get_region_histogram.
• Optimizations to improve speed, lower memory usage and create smaller payloads
• Bug fixes relating to chunk duration rounding, frame timestamps, color orders and more

4.4.1

• Added DFXFactory.getSdkID and removed bundled study config files
• Increased the limit for client provided properties from 10 to 100
• Added additional enum types in anticipation of future releases (not supported yet)
• Fixed bug in HMAC calculation
• Other bug fixes and performance improvements

4.3.3-alpha1

• Fixed bug where setProperty does not change values of keys that already exist.

4.3.2-alpha1

• Fixed bug regression in v2 response parsing with the introduction of v3 response parsing in the SDK.

4.3.1-alpha1

• Fixed minor bug in decodeMeasurementResult

4.3.0-alpha1

• Added support for API v3 streaming result handling with optional study based marker responses

4.2.1-alpha1

• Fixed issue in DFXFactory.addToStudyFromFile which called initialize.
• Added: CppCollector.cancelCollection() (instead of stopCollection), and introduced CppCollection.forceComplete() to enable clients to get the final payload when not enough frames are available (ie. last segment of a video file).
• Fixed off-by-one issue on Frame processing when handling video file.
• Enhanced extraction filtering capabilities to reduce payload sizes.
• Improved filter quality

4.1.0

• Added fine-grained tracking for data with multiple faces.

4.0.5

• Added HiSilicon armv7 build (for private distribution)

4.0.4

• Added dfx_sdk_version
• Fixed issue with 4-channel images
• Fixed string issue in C to C++ interface on Windows
• Fixed issue in getRegionNames()

4.0.1

• Fixed issues with building example code
• Improved documentation

4.0.0

• Tagged to 4.0.0, no functional changes

3.13.18

• Added Collector->stopCollection()
• Added Collector->getMode()
• Added Collector->prepareMeasurement()

3.13.10

• Documentation cleanup and added a result to Collector.setProperty() to indicate failure.

3.13.8

• Frame.addFace() and Frame.addMarker() return bool in case they fail because a limit has been reached. ChunkPayload now contains a valid flag to indicate the payload was succesfully constructed.

3.13.7

• Added Collector.getRequiredPosePointIDs() to help document the necessary pose points required for a study.
• Added support for payload hmac sha1 property to enable server validation of payload properties.

3.13.3

• Removed the Collector.initializeConfigPath() from the Public API.
• Added support for Factory.initializeStudy() and Factory.initializeStudyFromFile() to support loading a study definition from both memory and file. Retained support for the deepaffex.lua loading model through the initializeStudyFile() call.

3.12.2

• Added more error handling and provided a last error message.

3.12.0

• setMode, setTargetFPS, setChunkDurationSeconds, setNumberChunks, enableConstraint, disableConstraint now all return a bool to indicate success/failure.
• Changed the payload from milliseconds to all values in seconds.

3.11.0

• Redesigned the DFX C++ structure to reducing the complexity of the ambiguous DFXClient. DFXClient has been replaced with DFXFactory (original Factory consolidated).

3.10.0

• New streaming/discrete mode supported.

3.9.0

• Additional features integrated to support a streaming payload.

3.8.0

• Decoupled the data collection from payload generation with the addition of dfx_chunk_data.

3.7.1

• Reduced the running Collector memory requirement under certain scenarios.

3.7.0

• Removed the dependency on dfx_collector when creating dfx_face instances. The signature for dfx_face_create() no longer takes a dfx_collector.

3.6.0

• Added constraints tracking eyebrow movement when available.

3.5.4

• Fixed initialization race when loading models.

3.5.3

• Support for building DFX SDK on 64-bit Windows platform.

3.5.2

• Better face management to support tracking multiple faces.
• Fixed potential deadlock on resetCollector()