Add AVIF_ENABLE_COMPLIANCE_WARDEN #1611
Conversation
Use github.com/gpac/ComplianceWarden as a dependency to check all AVIF bitstreams output by avifEncoderFinish(). Introduce AVIF_USE_CXX to regroup use cases requiring C++.
[skip ci]
src/compliance.cc is only compiled if it is defined.
echo prints literal "\\n", printf appends '\n' correctly.
| extern const SpecDesc * const globalSpecIsobmff; | ||
| extern const SpecDesc * const globalSpecMiaf; | ||
|
|
||
| avifResult avifIsCompliant(uint8_t * data, size_t size) |
There was a problem hiding this comment.
This function should be marked as extern "C". We are currently relying on the extern "C" of this function's declaration in avif/internal.h, but it would be good to explicitly mark this function's definition as extern "C".
| @@ -471,6 +471,10 @@ __attribute__((__format__(__printf__, 2, 3))) | |||
| #endif | |||
| void avifDiagnosticsPrintf(avifDiagnostics * diag, const char * format, ...); | |||
|
|
|||
| #if defined(AVIF_ENABLE_COMPLIANCE_WARDEN) | |||
| avifResult avifIsCompliant(uint8_t * data, size_t size); | |||
There was a problem hiding this comment.
Nit: Can data be declared as const uint8_t *?
| @@ -642,6 +692,11 @@ if(NOT SKIP_INSTALL_ALL) | |||
| endif() | |||
|
|
|||
| if(AVIF_CODEC_LIBRARIES MATCHES vmaf) | |||
| # vmaf only impacts the avifenc and avifdec targets below, not the library avif target above. | |||
There was a problem hiding this comment.
Super nit: impacts => affects
library avif => avif library
This comment should also mention the examples, right? I.e., the avif library and examples targets.
| parseFunc(&topReader); | ||
| // gpac/ComplianceWarden will print the formatted result page to stdout, warnings and errors inclusive. | ||
| AVIF_CHECKERR(!checkComplianceStd(topReader.myBox, topReader.specs[0]), AVIF_RESULT_BMFF_PARSE_FAILED); | ||
| return AVIF_RESULT_OK; |
There was a problem hiding this comment.
Instead of reaching into the inside of ComplianceWarden, it seems better to invoke the cw program and parse its output or check its exit status. I am not up to date on the latest functions for doing this, but we can start with popen():
https://pubs.opengroup.org/onlinepubs/9699919799/functions/popen.html
There was a problem hiding this comment.
I prefer the current approach but feel free to send a pull request.
Use github.com/gpac/ComplianceWarden as a dependency to check all AVIF bitstreams output by avifEncoderFinish().
Introduce
AVIF_USE_CXXin CMakeLists.txt to regroup the use cases requiring C++.AVIF_ENABLE_COMPLIANCE_WARDENis OFF in GitHub CI because many tests fail.For example, the following build instructions
gives
Some are due to warnings but there are also errors, such as for
avifmetadatatest.cc>ExifButDefaultIrotImir:These should be investigated and ComplianceWarden or libavif should be fixed when relevant.
The LICENSE is fine because there is no "Redistributions of source code", "Redistributions in binary form" and "Neither the name of the copyright holder nor the names of its contributors" are used.
compliance_warden.shis a bit hacky but it can be improved later on.