Skip to content

Add comments to entity group API - #1864

Merged
farindk merged 4 commits into
strukturag:masterfrom
torusrxxx:patch-6
Aug 30, 2026
Merged

farindk merged 4 commits into
strukturag:masterfrom
torusrxxx:patch-6

Conversation

@torusrxxx

Copy link
Copy Markdown
Contributor

Added comments to clarify the meanings of FourCC constants for entity group types.

I intend to add some stereo and multilayer HEVC support and APIs in the future, starting with heif-info dumping support, then continue adding decode support with FFmpeg codec. I'm now able to dump multilayer HEIC images with heif-info. If you want to see the code now I can do a pull request.

Added comments to clarify the meanings of FourCC constants for entity group types.
@bradh

bradh commented Jul 11, 2026

Copy link
Copy Markdown
Contributor

There are a lot of other entity group types, see https://mp4ra.org/registered-types/entity-groups

So just describing them here doesn't really make sense. It would be better to define constants for the 4CCs like we do for branding and just add the documentation references there.

Added definitions for alternative image, stereo pair, and multi-resolution pyramid entity groups.
*
* The entity group consists of multiple alternative versions, the application should display only one of them. The most preferred image comes first.
*
* See ISO/IEC 23008-12 Section 9.4.3.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure these are the right references. Section 9 in ISO/IEC 23008-12:2025 (page 67) is just a pointer back to ISO/IEC 14496-12. If we're going to do this (and I think its useful), then it needs to have a revision as well as the right reference.

Suggested change
* See ISO/IEC 23008-12 Section 9.4.3.
* See ISO/IEC 14496-12:2026 Section 8.15.3.1.

*
* The entity group consists of stereoscopic pair. The first image is left image, the second image is right image.
*
* See ISO/IEC 23008-12 Section 9.4.3.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* See ISO/IEC 23008-12 Section 9.4.3.
* See ISO/IEC 23008-12:2025 Section 6.8.5.

/**
* Multi-resolution pyramid.
*
* The entity group consists of multiple resolution versions. Low resolution image comes first.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The entity group consists of multiple resolution versions. Low resolution image comes first.
* The entity group consists of multiple resolution versions. Low resolution image comes first.
*
* See ISO/IEC 23008-12:2025/Amd. 1:2025 Section 6.8.12.

Updated comments for entity groups and added new entity groups in ISO IEC 23008-12:2025.

@bradh bradh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could also consider stem if we're going to add ster.

* The entity group consists of multiple alternative versions, the application should display only one of them. The most preferred image comes first.
*
* See ISO/IEC 23008-12 Section 9.4.3.
* See ISO/IEC 23008-12:2017 Section 9.4.3.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use of 2017 version seems dubious here.

@farindk
farindk merged commit a110dc9 into strukturag:master Aug 30, 2026
39 of 40 checks passed
farindk added a commit that referenced this pull request Aug 30, 2026
Fix comment indentation and trailing whitespace, correct the 'wbbr' title
(white balance bracketing), fix a typo in the 'favc' description, and
shorten the descriptions. Section references verified against the spec
texts.
@farindk

farindk commented Aug 30, 2026

Copy link
Copy Markdown
Member

Thanks @torusrxxx and @bradh . I've cleaned it up a bit.

@torusrxxx
torusrxxx deleted the patch-6 branch September 8, 2026 03:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants