Skip to content

Commit 153c277

Browse files
committed
added encoder options descriptions onto README
1 parent d27be2b commit 153c277

1 file changed

Lines changed: 80 additions & 1 deletion

File tree

README.md

Lines changed: 80 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This is a plugin that adds support for AVIF files until official support has bee
44

55
To register this plugin with pillow you will need to add `import pillow_avif` somewhere in your application.
66

7-
## how to build on Windows
7+
## how to build and install on Windows
88

99
- install miniforge
1010
- install VS2019
@@ -20,6 +20,53 @@ To register this plugin with pillow you will need to add `import pillow_avif` so
2020

2121
## encoding options
2222

23+
## "qmin"
24+
25+
encoding quality. integer. Quality range is 0 to 63
26+
27+
encoder->minQuantizer
28+
29+
| value | meanings |
30+
|-----:|-----------|
31+
| 0| AVIF_QUANTIZER_BEST_QUALITY |
32+
| 63| AVIF_QUANTIZER_WORST_QUALITY |
33+
34+
## "qmax"
35+
36+
encoding quality. integer. Quality range is 0 to 63
37+
38+
encoder->maxQuantizer
39+
40+
| value | meanings |
41+
|-----:|-----------|
42+
| 0| AVIF_QUANTIZER_BEST_QUALITY |
43+
| 63| AVIF_QUANTIZER_WORST_QUALITY |
44+
45+
## "speed"
46+
47+
encoding speed. slower should make for a better quality. integer.
48+
49+
| value | meanings |
50+
|-----:|-----------|
51+
| -1| AVIF_SPEED_DEFAULT |
52+
| 0| AVIF_SPEED_SLOWEST |
53+
| 10| AVIF_SPEED_FASTEST |
54+
55+
## "codec"
56+
57+
default is "auto".
58+
encoder availability depends on the build settings of libav1f.
59+
60+
| value | meanings |
61+
|-----:|-----------|
62+
| "auto" | auto |
63+
| "dav1d" | dav1d |
64+
| "libgav1" | libgav1 |
65+
| "aom" | aom |
66+
| "rav1e" | rav1e |
67+
| "svt" | svt |
68+
69+
2370
## "range"
2471

2572
| value | meanings |
@@ -50,6 +97,38 @@ encoding quality, integer number ranging 0 to 100
5097
| 75 | default color encoding quality |
5198
| 100 | best color encoding quality |
5299

100+
## "tile_rows_log2"
101+
102+
default is 0
103+
104+
## "tile_cols_log2"
105+
106+
default is 0
107+
108+
## "alpha_premultiplied"
109+
110+
if true, enc_options.alpha_premultiplied is AVIF_TRUE
111+
112+
## "autotiling"
113+
114+
if true, enc_options.autotiling is AVIF_TRUE
115+
116+
## "icc_bytes"
117+
118+
it is set to avifImageSetProfileICC()
119+
120+
## "exif_bytes"
121+
122+
is is set to avifImageSetMetadataExif()
123+
124+
## "xmp_bytes"
125+
126+
is is set to avifImageSetMetadataXMP
127+
128+
## "advanced"
129+
130+
follows pytuple. it is set to avifEncoderSetCodecSpecificOption()
131+
53132
## "color_primaries"
54133

55134
| value | meanings |

0 commit comments

Comments
 (0)