Skip to content

Commit d6b2216

Browse files
authored
Change log link (#52)
* 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]>
1 parent b905ffd commit d6b2216

File tree

4 files changed

+14
-17
lines changed

4 files changed

+14
-17
lines changed

Encoding.md

+4-12
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,10 @@ We are going to focus on codecs that match one of the following conditions:
1414
* Supported by common web browsers.
1515
* Have good compression ratios with good color fidelity.
1616
* Supported by common apps, e.g. Resolve, RV, AVID.
17+
* Commonly requested as a delivery format by studios or clients.
1718

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

20-
21-
A good starting point for encoding options is here: [https://trac.ffmpeg.org/wiki/Encode/VFX](https://trac.ffmpeg.org/wiki/Encode/VFX)
22-
23-
24-
We have encoding guides for the following:
25-
1. [h264](Encodeh264.html)
26-
2. [Prores](EncodeProres.html)
27-
3. [DNxHD](EncodeDNxHD.html)
28-
4. [AV1](EncodeAv1.html)
29-
5. [VP9](EncodeVP9.html)
30-
6. [HEVC/H265](EncodeHevc.html)
31-
3221
## Codecs reviewed
3322

3423
| Codec Family | ffmpeg codec | Bit depth | Pixel format supported | Web Support | HDR |
@@ -103,3 +92,6 @@ See:
10392
TODO:
10493
* Figure out the missing metadata so that ffmpeg can correctly decode a quicktime to still.
10594
*
95+
96+
### See Also
97+
* 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.

Quickstart.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This document is based on results from ffmpeg 4.4, we have not tested with 5.0 y
1212

1313
# H264 Encoding from an image sequence for Web Review
1414

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

1717
<!---
1818
name: test_quickstart
@@ -46,7 +46,7 @@ ffmpeg -r 24 -start_number 1 -i inputfile.%04d.png \
4646
**-color_range tv** | mp4 metadata - specifying color range as 16-235 (which is default for web playback).
4747
**-colorspace bt709** | mp4 metadata - specifying bt709 yuv color pixel format
4848
**-color_primaries bt709** | mp4 metadata - bt709 color gamut primaries
49-
**-color_trc iec61966-2-1** | mp4 metadata color transfer = iec61966-2-1 = sRGB - See tests below.
49+
**-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 (
5050

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

_config.yml

+8-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ exclude: ["ICC", "*.yml", "enctests/*/*.mov",
44
"enctests/sources/encsources/*/*.png", "enctests/sources/encsources/*/*.exr",
55
"enctests/sources/encsources/*/*.tif", "enctests/sources/hdr_sources/*/*.png",
66
"enctests/*/*.mov",
7+
"MarkdownNotes.md",
78
"enctests/sources/hdr_sources/*/*.exr", "enctests/sources/Sintel-trailer-1080p-png",
89
"enctests/sources/1080p"]
910

@@ -36,4 +37,10 @@ aux_links:
3637
"Academy Software Foundation (ASWF)":
3738
- "https://www.aswf.io/"
3839
# Makes Aux links open in a new tab. Default is false
39-
aux_links_new_tab: false
40+
aux_links_new_tab: false
41+
42+
nav_external_links:
43+
- title: Changelog
44+
url: https://github.com/just-the-docs/just-the-docs
45+
hide_icon: false # set to true to hide the external link icon - defaults to false
46+
opens_in_new_tab: true # set to true to open this link in a new tab - defaults to false

index.md

-2
Original file line numberDiff line numberDiff line change
@@ -63,5 +63,3 @@ This document is primarily the work of Sam Richards. The test suite was develope
6363
### Feedback and error reporting.
6464

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

0 commit comments

Comments
 (0)