<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[59589] trunk: Media: improve Imagick handling of colors and alpha channel for PNG image uploads.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/59589">59589</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/59589","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>adamsilverstein</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2025-01-07 22:33:37 +0000 (Tue, 07 Jan 2025)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Media: improve Imagick handling of colors and alpha channel for PNG image uploads.
Fix an issue where index color (8 bit) PNG uploads were output as true color (24 bit) PNGs, significantly increasing their size. When using Imagick, PNG output images will now match the colors of the uploaded image.
Also, correct handling of PNG alpha channel information so it is preserved in output images.
Props adamsilverstein, pbearne, nosilver4u, peterdavehello, joemcgill, azaozz, codex-m, kirasong, justlevine, jokanane, sallyruchman, wpfed, tgsrvrs, antpb, tb1909.
Fixes <a href="https://core.trac.wordpress.org/ticket/36477">#36477</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpimageeditorimagickphp">trunk/src/wp-includes/class-wp-image-editor-imagick.php</a></li>
<li><a href="#trunktestsphpunittestsimageeditorImagickphp">trunk/tests/phpunit/tests/image/editorImagick.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li>trunk/tests/phpunit/data/images/png-tests/</li>
<li><a href="#trunktestsphpunitdataimagespngtestsPalette_iconor8png">trunk/tests/phpunit/data/images/png-tests/Palette_icon-or8.png</a></li>
<li><a href="#trunktestsphpunitdataimagespngtestscloudflarestatuspng">trunk/tests/phpunit/data/images/png-tests/cloudflare-status.png</a></li>
<li><a href="#trunktestsphpunitdataimagespngtestsdeskcat8png">trunk/tests/phpunit/data/images/png-tests/deskcat8.png</a></li>
<li><a href="#trunktestsphpunitdataimagespngtestsrabbittimepalettedor8png">trunk/tests/phpunit/data/images/png-tests/rabbit-time-paletted-or8.png</a></li>
<li><a href="#trunktestsphpunitdataimagespngteststest8png">trunk/tests/phpunit/data/images/png-tests/test8.png</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpimageeditorimagickphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-image-editor-imagick.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-image-editor-imagick.php 2025-01-07 21:04:35 UTC (rev 59588)
+++ trunk/src/wp-includes/class-wp-image-editor-imagick.php 2025-01-07 22:33:37 UTC (rev 59589)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -484,7 +484,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->image->setOption( 'png:compression-filter', '5' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->image->setOption( 'png:compression-level', '9' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->image->setOption( 'png:compression-strategy', '1' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->image->setOption( 'png:exclude-chunk', 'all' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Check to see if a PNG is indexed, and find the pixel depth.
+ if ( is_callable( array( $this->image, 'getImageDepth' ) ) ) {
+ $indexed_pixel_depth = $this->image->getImageDepth();
+
+ // Indexed PNG files get some additional handling.
+ if ( 0 < $indexed_pixel_depth && 8 >= $indexed_pixel_depth ) {
+ // Check for an alpha channel.
+ if (
+ is_callable( array( $this->image, 'getImageAlphaChannel' ) )
+ && $this->image->getImageAlphaChannel()
+ ) {
+ $this->image->setOption( 'png:include-chunk', 'tRNS' );
+ } else {
+ $this->image->setOption( 'png:exclude-chunk', 'all' );
+ }
+
+ // Reduce colors in the images to maximum needed, using the global colorspace.
+ $max_colors = pow( 2, $indexed_pixel_depth );
+ if ( is_callable( array( $this->image, 'getImageColors' ) ) ) {
+ $current_colors = $this->image->getImageColors();
+ $max_colors = min( $max_colors, $current_colors );
+ }
+ $this->image->quantizeImage( $max_colors, $this->image->getColorspace(), 0, false, false );
+
+ /**
+ * If the colorspace is 'gray', use the png8 format to ensure it stays indexed.
+ */
+ if ( Imagick::COLORSPACE_GRAY === $this->image->getImageColorspace() ) {
+ $this->image->setOption( 'png:format', 'png8' );
+ }
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /*
</span></span></pre></div>
<a id="trunktestsphpunitdataimagespngtestsPalette_iconor8png"></a>
<div class="binary"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/data/images/png-tests/Palette_icon-or8.png</h4>
<pre class="diff"><span>
<span class="cx">(Binary files differ)
</span></span></pre></div>
<span class="cx" style="display: block; padding: 0 10px">Index: trunk/tests/phpunit/data/images/png-tests/Palette_icon-or8.png
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- trunk/tests/phpunit/data/images/png-tests/Palette_icon-or8.png 2025-01-07 21:04:35 UTC (rev 59588)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ trunk/tests/phpunit/data/images/png-tests/Palette_icon-or8.png 2025-01-07 22:33:37 UTC (rev 59589)
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/data/images/png-tests/Palette_icon-or8.png
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span><a id="svnmimetype"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:mime-type</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+application/octet-stream
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunitdataimagespngtestscloudflarestatuspng"></a>
<div class="binary"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/data/images/png-tests/cloudflare-status.png</h4>
<pre class="diff"><span>
<span class="cx">(Binary files differ)
</span></span></pre></div>
<span class="cx" style="display: block; padding: 0 10px">Index: trunk/tests/phpunit/data/images/png-tests/cloudflare-status.png
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- trunk/tests/phpunit/data/images/png-tests/cloudflare-status.png 2025-01-07 21:04:35 UTC (rev 59588)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ trunk/tests/phpunit/data/images/png-tests/cloudflare-status.png 2025-01-07 22:33:37 UTC (rev 59589)
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/data/images/png-tests/cloudflare-status.png
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span><a id="svnmimetype"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:mime-type</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+application/octet-stream
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunitdataimagespngtestsdeskcat8png"></a>
<div class="binary"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/data/images/png-tests/deskcat8.png</h4>
<pre class="diff"><span>
<span class="cx">(Binary files differ)
</span></span></pre></div>
<span class="cx" style="display: block; padding: 0 10px">Index: trunk/tests/phpunit/data/images/png-tests/deskcat8.png
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- trunk/tests/phpunit/data/images/png-tests/deskcat8.png 2025-01-07 21:04:35 UTC (rev 59588)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ trunk/tests/phpunit/data/images/png-tests/deskcat8.png 2025-01-07 22:33:37 UTC (rev 59589)
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/data/images/png-tests/deskcat8.png
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span><a id="svnmimetype"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:mime-type</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+application/octet-stream
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunitdataimagespngtestsrabbittimepalettedor8png"></a>
<div class="binary"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/data/images/png-tests/rabbit-time-paletted-or8.png</h4>
<pre class="diff"><span>
<span class="cx">(Binary files differ)
</span></span></pre></div>
<span class="cx" style="display: block; padding: 0 10px">Index: trunk/tests/phpunit/data/images/png-tests/rabbit-time-paletted-or8.png
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- trunk/tests/phpunit/data/images/png-tests/rabbit-time-paletted-or8.png 2025-01-07 21:04:35 UTC (rev 59588)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ trunk/tests/phpunit/data/images/png-tests/rabbit-time-paletted-or8.png 2025-01-07 22:33:37 UTC (rev 59589)
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/data/images/png-tests/rabbit-time-paletted-or8.png
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span><a id="svnmimetype"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:mime-type</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+application/octet-stream
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunitdataimagespngteststest8png"></a>
<div class="binary"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/data/images/png-tests/test8.png</h4>
<pre class="diff"><span>
<span class="cx">(Binary files differ)
</span></span></pre></div>
<span class="cx" style="display: block; padding: 0 10px">Index: trunk/tests/phpunit/data/images/png-tests/test8.png
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- trunk/tests/phpunit/data/images/png-tests/test8.png 2025-01-07 21:04:35 UTC (rev 59588)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ trunk/tests/phpunit/data/images/png-tests/test8.png 2025-01-07 22:33:37 UTC (rev 59589)
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/data/images/png-tests/test8.png
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span><a id="svnmimetype"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:mime-type</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+application/octet-stream
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunittestsimageeditorImagickphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/image/editorImagick.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/image/editorImagick.php 2025-01-07 21:04:35 UTC (rev 59588)
+++ trunk/tests/phpunit/tests/image/editorImagick.php 2025-01-07 22:33:37 UTC (rev 59589)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -758,4 +758,57 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function __return_eight() {
</span><span class="cx" style="display: block; padding: 0 10px"> return 8;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Test that resizes are smaller for 16 bit PNG images.
+ *
+ * @ticket 36477
+ *
+ * @dataProvider data_resizes_are_small_for_16bit_images
+ */
+ public function test_resizes_are_small_for_16bit_images( $file ) {
+
+ $temp_file = DIR_TESTDATA . '/images/test-temp.png';
+
+ $imagick_image_editor = new WP_Image_Editor_Imagick( $file );
+ $imagick_image_editor->load();
+ $size = $imagick_image_editor->get_size();
+
+ $org_filesize = filesize( $file );
+
+ $imagick_image_editor->resize( $size['width'] * .5, $size['height'] * .5 );
+
+ $saved = $imagick_image_editor->save( $temp_file );
+
+ $new_filesize = filesize( $temp_file );
+
+ unlink( $temp_file );
+
+ $this->assertLessThan( $org_filesize, $new_filesize, 'The resized image file size is not smaller than the original file size.' );
+ }
+
+ /**
+ * data_test_resizes_are_small_for_16bit
+ *
+ * @return array[]
+ */
+ public static function data_resizes_are_small_for_16bit_images() {
+ return array(
+ 'cloudflare-status' => array(
+ DIR_TESTDATA . '/images/png-tests/cloudflare-status.png',
+ ),
+ 'deskcat8' => array(
+ DIR_TESTDATA . '/images/png-tests/deskcat8.png',
+ ),
+ '17-c3-duplicate-entries' => array(
+ DIR_TESTDATA . '/images/png-tests/Palette_icon-or8.png',
+ ),
+ 'rabbit-time-paletted' => array(
+ DIR_TESTDATA . '/images/png-tests/rabbit-time-paletted-or8.png',
+ ),
+ 'test8' => array(
+ DIR_TESTDATA . '/images/png-tests/test8.png',
+ ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>