Update the README and the programmers guide - #262
Open
kpchoi wants to merge 1 commit into
Open
Conversation
kpchoi
force-pushed
the
docs_related_spec
branch
3 times, most recently
from
August 8, 2026 05:17
c43509d to
8f480e2
Compare
kpchoi
force-pushed
the
docs_related_spec
branch
7 times, most recently
from
August 8, 2026 05:59
0946b84 to
7a5a27a
Compare
Signed-off-by: KP Choi <kp5.choi@samsung.com>
kpchoi
force-pushed
the
docs_related_spec
branch
from
August 8, 2026 06:03
7a5a27a to
f70ad98
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation updates across the README and the programmers guide. No code change.
Specification references
draft-ietf-avtcore-rtp-apv, which has replaced the individualdraft-lim-rtp-apv.readme/profile_ext.mdis renamed toreadme/apv_ext.md(recorded as a git rename, so history is preserved). No remaining references to the old name.Features list
Application examples
The encoder had two example lines and the decoder one. The encoder section now covers raw versus Y4M input, quality selection (fixed QP with a preset, target bitrate, APV Family), profile selection, RGB content, tiles and threads including an extension profile with small tiles, reconstruction output with a frame hash, and encoding a part of the input. The decoder section covers Y4M and raw output, hash verification and decoding without output, bit depth and P210 conversion, limiting access units with a thread count, and PBU-based decoding with tile-based partial decoding. Every command was run against the sample sequence before being documented.
Programmers guide: common types
The section listed four types and left out the ones a reader meets first, including the instance handles
oapve_tandoapvd_t. It now groups the types a caller works with and says what each is for:oapve_t,oapvd_t,oapvm_t) with their create and delete functions, what state each holds, and the note that an instance is not internally serialized, so one instance per encoding or decoding threadoapve_cdesc_t,oapvd_cdesc_t,oapvm_cdesc_t), which configure an instance at create timeoapve_param_ton its own, since it is the encoder setting structure rather than a descriptor, noting that it starts fromoapve_param_default()and that most of it can be changed per frame at run time withoapve_config()oapv_imgb_t,oapv_bitb_tincluding thebsizeversusssizedistinction,oapv_frm_t/oapv_frms_twith thepbu_typevalues and the role ofgroup_id)oapve_stat_t/oapvd_stat_t,oapv_au_info_t,oapv_frm_info_t,oapv_tile_pos_t,oapvm_payload_t)Every description was checked against the declarations in
oapv.h.Programmers guide: type members and structure
Each type the guide lists now has a table of its members and what they are for: the creation descriptors,
oapve_param_t,oapv_imgb_t,oapv_bitb_t,oapv_frm_t/oapv_frms_t,oapve_stat_t/oapvd_stat_t,oapv_frm_info_t,oapv_tile_pos_tandoapvm_payload_t. Every member name was cross-checked against the declarations inoapv.h, which is not modified by this PR.The sections "Writing an encoder" and "Writing a decoder" become "Encoder API" and "Decoder API", since the old titles read as if they were about writing prose rather than calling the library, and the introduction and the README pointer are reworded to match. The guide is also reordered so that each topic sits under the API it belongs to: "Encoding RGB content" becomes a subsection of the encoder API, "Zero-copy decoding input with memory-mapped files" a subsection of the decoder API, and the combined "Runtime configuration" section is split into an encoder part covering
oapve_config()and a decoder part coveringoapvd_config(), each under its own API.Graphic logo
The black logo and the white logo are each meant for the opposite background, so on any given page one of them blends in and looks blank. A short note now says so and suggests dragging over it, or opening the image file, to see it.