Skip to content

Add glossary, case scenarios, and GUI-based transcoding tools#486

Open
gnd8596 wants to merge 143 commits intoamiaopensource:gh-pagesfrom
gnd8596:gh-pages
Open

Add glossary, case scenarios, and GUI-based transcoding tools#486
gnd8596 wants to merge 143 commits intoamiaopensource:gh-pagesfrom
gnd8596:gh-pages

Conversation

@gnd8596
Copy link
Copy Markdown

@gnd8596 gnd8596 commented Dec 18, 2025

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:

  • A new glossary with definitions, context, and references
  • Embedded glossary links across existing recipes
  • Case scenarios broken into context, solution, and outcome
  • Documentation for GUI-based tools (Shutter Encoder, XLD, and HandBrake) to support users with limited command-line experience

This work was informed by interviews with moving image preservation professionals and aims to lower barriers to entry for students and small institutions.

chocolatti and others added 30 commits November 20, 2025 20:05
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.
@kfrn
Copy link
Copy Markdown
Member

kfrn commented Dec 22, 2025

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...

@kieranjol
Copy link
Copy Markdown
Collaborator

kieranjol commented Dec 22, 2025 via email

@jmf-nyu
Copy link
Copy Markdown
Contributor

jmf-nyu commented Apr 5, 2026

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/

@kieranjol
Copy link
Copy Markdown
Collaborator

kieranjol commented Apr 6, 2026 via email

@retokromer
Copy link
Copy Markdown
Member

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?

In my personal opinion, it would be more interesting to discuss how to integrate ffmprovisr-derived recipes into HandBrake, Shutter Encoder and Audacity.

Copy link
Copy Markdown
Member

@retokromer retokromer left a comment

Choose a reason for hiding this comment

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

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>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This reference is interesting for historical reasons, but I really would include the official specification IETF RFC 9043.

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.

6 participants