Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yigithanyigit committed Jul 29, 2024
1 parent 3cd68b5 commit a110c35
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions libvmaf/include/libvmaf/libvmaf.h
Original file line number Diff line number Diff line change
Expand Up @@ -253,12 +253,32 @@ int vmaf_score_at_index_model_collection(VmafContext *vmaf,
int vmaf_feature_score_at_index(VmafContext *vmaf, const char *feature_name,
double *score, unsigned index);

/**
* Metadata structure.
*
* @param feature_name Name of the feature to fetch.
*
* @param picture_index Picture index.
*
* @param score Score.
*
* @note This structure is used to pass metadata to a callback function.
*/
typedef struct VmafMetadata {
char *feature_name;
unsigned picture_index;
double score;
} VmafMetadata;

/**
* Metadata configuration.
*
* @param feature_name Name of the feature to fetch.
*
* @param callback Callback to receive metadata.
*
* @param data User data to pass to the callback.
*/
typedef struct VmafMetadataConfiguration {
char *feature_name;
void (*callback)(void *data, VmafMetadata *metadata);
Expand Down

0 comments on commit a110c35

Please sign in to comment.