Add option to validate raw codestreams (through API, possibly also CLI)

openpreserve / jpylyzer

JP2 (JPEG 2000 Part 1) validator and properties extractor. Jpylyzer was specifically created to check that a JP2 file really conforms to the format's specifications. Additionally jpylyzer is able to extract technical characteristics.

http://jpylyzer.openpreservation.org/

Other

69 stars 28 forks source link

Add option to validate raw codestreams (through API, possibly also CLI) #113

Closed bitsgalore closed 4 years ago

bitsgalore commented 5 years ago

Dev Effort

Description

Useful for e.g. validating frames within video containers (which are usually encoded as raw codestreams, not JP2).

bitsgalore commented 5 years ago

Implies a few interface changes:

Function checkOneFile: add format argument (default jp2, optionally j2c)
CLI: add --format option (default: jp2, optionally j2c)

Output changes:

isValidJP2 element: rename to isValid, specify format in new formatattribute (format="jp2"; format="j2c")

Since this will break existing deployments anyway, we might as well apply the additional changes proposed here.

In that case the output schema must be updated as well. This would probably imply a new major version (jpylyzer 2.0).

bitsgalore commented 5 years ago

Following Jack O' Sullivan's comment at 21-3 Product Board call: consider adding option to generate "old style" output for backward compatibility.

bitsgalore commented 5 years ago

Most of these changes now implemented in testcodestream branch. TODO:

~~perhaps wrap tests/properties for codestream validation in contiguousCodestreamBox element (now absent because parsing already starts from within that box, which may possibly be confusing)?~~ No, because in case of a raw codestream this "box" does not even exist (in JP2 the contiguousCodestreamBox is just a wrapper structure around the codestream)
add new schema + further overhaul output fmt - done!
test API - done, also schema here, + updated test files, may need some more testing.
Possibly rename some internal variables (e.g. isValidJP2) as well for clarity - done!
Update documentation (also API) - done!
Update Debian doc files - done!
Update web site, incl http://jpylyzer.openpreservation.org//usage.html

UPDATE