Add glossary, case scenarios, and GUI-based transcoding tools#486
Add glossary, case scenarios, and GUI-based transcoding tools#486gnd8596 wants to merge 143 commits intoamiaopensource:gh-pagesfrom
Conversation
Added a glossary section with definitions and examples for technical terms related to codecs. Started Codec and add an anchor link to Codec Defaults section
Add event listener for hash link clicks to toggle visibility of hidden sections.
Added bibliography and video codec section to FLAC entry.
Updated glossary section with detailed codec descriptions and added bibliographic references.
Updated the description of the transcoding command to include a hyperlink for Apple ProRes 422.
Added information about Shutter Encoder and fixed a typo.
|
Hello! This looks really good, but is there any chance that you could tidy it up into discrete commits for easier reviewing? e.g. one commit per new recipe/entry/change Edit: recommend something like this: # Make sure you have the latest gh-pages branch (prob the case already, just being thorough here)
git fetch --all
# Remove your commits but keep your changes in your working directory
git reset --mixed amiaopensource:gh-pages
# Use the patch commit to add each recipe/change in a separate commit
git add . --patch # NB: this can be abbreviated to git add . -p
gcmsg "Add glossary of technical terms"
# and so on... |
|
+1!
This is great but it would make it easier to review and merge if it was
broken up a bit.
…On Mon 22 Dec 2025 at 02:31, Katherine Frances Nagels < ***@***.***> wrote:
*kfrn* left a comment (amiaopensource/ffmprovisr#486)
<#486 (comment)>
Hello! This looks really good, but is there any chance that you could tidy
it up into discrete commits for easier reviewing? e.g. one commit per new
recipe/entry/change
—
Reply to this email directly, view it on GitHub
<#486 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAITFPVHAPQNO6RQH5SZWDL4C5JWNAVCNFSM6AAAAACPOPVQJSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTMOBQGA4TSNRSHE>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
|
|
Thanks for your feedback @kieranjol and @kfrn. I wanted to reach out as the professor of the two students submitting this pull request as part of a class assignment. I completely understand that thematic commits are regarded as best practice. However, I'm wondering if you can extend some grace even though the code will be a bit harder to review. The students were using Github for the first time and this is their first ever pull request. I believe you can review the version of FFmprovisr with their changes here if that's helpful: https://gnd8596.github.io/GD_CH_ffmprovisr/ |
|
Hi Jonathan,
I understand your point. It is a bit overwhelming to go through all the
changes (I tried there but realised it would take a more focussed
session) but I hope to find some time to go through them. Perhaps we could
tackle it by breaking down some of the high level changes.
For example, before going into a deeper review, I’m not sure if expanding
the scope of this project to include GUI tools is the right thing to do?
I’d be leaning towards removing those sections and perhaps diverting the
great info to a project such as COPTR?
Best,
Kieran
…On Mon 6 Apr 2026 at 00:03, Jonathan Farbowitz ***@***.***> wrote:
*jmf-nyu* left a comment (amiaopensource/ffmprovisr#486)
<#486 (comment)>
Thanks for your feedback @kieranjol <https://github.com/kieranjol> and
@kfrn <https://github.com/kfrn>.
I wanted to reach out as the professor of the two students submitting this
pull request as part of a class assignment. I completely understand that
thematic commits are regarded as best practice. However, I'm wondering if
you can extend some grace even though the code will be a bit harder to
review. The students were using Github for the first time and this is their
first ever pull request.
I believe you can review the version of FFmprovisr with their changes here
if that's helpful: https://gnd8596.github.io/GD_CH_ffmprovisr/
—
Reply to this email directly, view it on GitHub
<#486 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAITFPWWGDFEDQXNITIKQFD4ULQ23AVCNFSM6AAAAACPOPVQJSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHM2DCOBZGY3TOMRXGU>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
In my personal opinion, it would be more interesting to discuss how to integrate ffmprovisr-derived recipes into HandBrake, Shutter Encoder and Audacity. |
retokromer
left a comment
There was a problem hiding this comment.
Started reviewing, but need much more time.
| </ul> | ||
| </li> | ||
| <li><p id="ProRes422">Apple ProRes 422:</p> | ||
| <p>Apple ProRes 422 is a proprietary video codec developed by Apple for editing and post-production purposes. It supports resolutions up to 8K and uses compression algorithms based on the discrete cosine transform. All ProRes variants use <a href="#chromasubsampling">chroma sampling</a> of 4:2:2 at 10-bit color depth. </p> |
There was a problem hiding this comment.
I would say also in the second sentence All ProRes 422 variants, because this information does not apply to the ProRes 4444 family nor the ProRes RAW family.
| <p class="indent">Bibliography:</p> | ||
| <ul> | ||
| <p><a href="https://trac.ffmpeg.org/wiki/Encode/FFV1">FFmpeg Documentation</a></p> | ||
| <p><a href="https://www.ffmpeg.org/~michael/ffv1.html">FFV1 Video Codec Specification by Michael Niedermayer</a></p> |
There was a problem hiding this comment.
This reference is interesting for historical reasons, but I really would include the official specification IETF RFC 9043.
Checklist
This pull request adds a structured glossary of core FFmpeg and digital preservation terms, embeds glossary links throughout ffmprovisr, and introduces several real-world case scenarios illustrating common FFmpeg uses.
Changes include:
This work was informed by interviews with moving image preservation professionals and aims to lower barriers to entry for students and small institutions.