Skip to content

Commit

Permalink
Change log link (#52)
Browse files Browse the repository at this point in the history
* Adding a link to the changelog.

Signed-off-by: [email protected] <[email protected]>

* Remove markdownnotes.

Signed-off-by: [email protected] <[email protected]>

* Removed a duplicate list of codecs.

Signed-off-by: [email protected] <[email protected]>

* Adding links to ffmpegInputs.

Signed-off-by: [email protected] <[email protected]>

---------

Signed-off-by: [email protected] <[email protected]>
Co-authored-by: [email protected] <[email protected]>
  • Loading branch information
richardssam and SamRichardsDisney authored Oct 29, 2023
1 parent b905ffd commit d6b2216
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 17 deletions.
16 changes: 4 additions & 12 deletions Encoding.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,10 @@ We are going to focus on codecs that match one of the following conditions:
* Supported by common web browsers.
* Have good compression ratios with good color fidelity.
* Supported by common apps, e.g. Resolve, RV, AVID.
* Commonly requested as a delivery format by studios or clients.

## Encoding <a name="encode"></a>


A good starting point for encoding options is here: [https://trac.ffmpeg.org/wiki/Encode/VFX](https://trac.ffmpeg.org/wiki/Encode/VFX)


We have encoding guides for the following:
1. [h264](Encodeh264.html)
2. [Prores](EncodeProres.html)
3. [DNxHD](EncodeDNxHD.html)
4. [AV1](EncodeAv1.html)
5. [VP9](EncodeVP9.html)
6. [HEVC/H265](EncodeHevc.html)

## Codecs reviewed

| Codec Family | ffmpeg codec | Bit depth | Pixel format supported | Web Support | HDR |
Expand Down Expand Up @@ -103,3 +92,6 @@ See:
TODO:
* Figure out the missing metadata so that ffmpeg can correctly decode a quicktime to still.
*

### See Also
* Another good reference for encoding options is here: [https://trac.ffmpeg.org/wiki/Encode/VFX](https://trac.ffmpeg.org/wiki/Encode/VFX) although the page is a little out of date.
4 changes: 2 additions & 2 deletions Quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This document is based on results from ffmpeg 4.4, we have not tested with 5.0 y

# H264 Encoding from an image sequence for Web Review

If you are encoding from an image sequence (e.g. imagefile.0000.png imagefile.0001.png ...) to h264 using ffmpeg, we recommend:
If you are encoding from an [image sequence](FfmpegInputs.html) (e.g. imagefile.0000.png imagefile.0001.png ...) to h264 using ffmpeg, we recommend:

<!---
name: test_quickstart
Expand Down Expand Up @@ -46,7 +46,7 @@ ffmpeg -r 24 -start_number 1 -i inputfile.%04d.png \
**-color_range tv** | mp4 metadata - specifying color range as 16-235 (which is default for web playback).
**-colorspace bt709** | mp4 metadata - specifying bt709 yuv color pixel format
**-color_primaries bt709** | mp4 metadata - bt709 color gamut primaries
**-color_trc iec61966-2-1** | mp4 metadata color transfer = iec61966-2-1 = sRGB - See tests below.
**-color_trc iec61966-2-1** | mp4 metadata color transfer = iec61966-2-1 = sRGB - See tests [here](WebColorPreservation.html). In some cases, you may also want -color_trc bt709 see (

**-vf "scale=in_color_matrix=bt709:out_color_matrix=bt709"** means use the sw-scale filter, setting:

Expand Down
9 changes: 8 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ exclude: ["ICC", "*.yml", "enctests/*/*.mov",
"enctests/sources/encsources/*/*.png", "enctests/sources/encsources/*/*.exr",
"enctests/sources/encsources/*/*.tif", "enctests/sources/hdr_sources/*/*.png",
"enctests/*/*.mov",
"MarkdownNotes.md",
"enctests/sources/hdr_sources/*/*.exr", "enctests/sources/Sintel-trailer-1080p-png",
"enctests/sources/1080p"]

Expand Down Expand Up @@ -36,4 +37,10 @@ aux_links:
"Academy Software Foundation (ASWF)":
- "https://www.aswf.io/"
# Makes Aux links open in a new tab. Default is false
aux_links_new_tab: false
aux_links_new_tab: false

nav_external_links:
- title: Changelog
url: https://github.com/just-the-docs/just-the-docs
hide_icon: false # set to true to hide the external link icon - defaults to false
opens_in_new_tab: true # set to true to open this link in a new tab - defaults to false
2 changes: 0 additions & 2 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,3 @@ This document is primarily the work of Sam Richards. The test suite was develope
### Feedback and error reporting.

We welcome feedback on this document, please report any errors or suggestions to the [github issues](https://github.com/AcademySoftwareFoundation/EncodingGuidelines/issues) page.

.

0 comments on commit d6b2216

Please sign in to comment.