Fully supports progressive JPGS and Interlaced images for 3.x #394
Conversation
|
TODO:
|
|
@ADmad would you mind to take a look and tell me what you think? I'm not sure if introducing this new encoding strategy would be the best for this package. feedbacks are welcome :) |
|
Sorry I haven't had the time to look into this but could you please address the failing tests in the meantime. |
|
@ADmad I addressed all the issues that Github Actions was issuing. Before setting this ready for review, could you point me the best place where I could add the tests for the progressive/interlaced images I am introducing? |
| { | ||
| $format = $this->getFormat($image); | ||
| $quality = $this->getQuality(); | ||
| $driver = $image->driver(); | ||
| $interlace = false; | ||
| $shouldInterlace = filter_var($this->getParam('interlace'), FILTER_VALIDATE_BOOLEAN); |
There was a problem hiding this comment.
I added this new API option. It will allow to use progressive/interlaced images.
Example:
- Progressive PNG:
<img src="kayaks.jpg?w=500&interlacer=1"> - Interlaced PNG:
<img src="kayaks.png?w=500&interlacer=1">
|
|
||
| if ('pjpg' === $format) { | ||
| $interlace = true; | ||
|
|
||
| $shouldInterlace = true; |
There was a problem hiding this comment.
If format is set to pjpeg, it will set automatically the interlace option to output a progressive JPG
| @@ -255,7 +254,6 @@ public function getManipulators(): array | |||
| new Watermark($this->getWatermarks(), $this->getWatermarksPathPrefix() ?? ''), | |||
| new Background(), | |||
| new Border(), | |||
| new Encode(), | |||
There was a problem hiding this comment.
It was necessary to remove the Encode manipulator from the list. This manipulator will be invoked in a better place.
| } | ||
|
|
||
| return $image; | ||
| return $image->encodeByExtension(...$encoderOptions); |
There was a problem hiding this comment.
Due the latest changes on Intervention package. It was necessary to change the return type of this class, to return the encoded image instance instead just the image instance.
| $encoder = new Encode(); | ||
| $encoder->setParams($params); | ||
| /** @var \Intervention\Image\Interfaces\EncodedImageInterface */ | ||
| $encoded = $encoder->run($image); | ||
|
|
||
| return $encoded->toString(); |
There was a problem hiding this comment.
Since there was some important changes on how Intervention process images, it was necessary to move the Encode manipulator to run here instead.
This will make sure that it will run at the end of all manipulators, sine it returns a EncodedImage instance. Also it will avoid the strategy used before, causing double encoding of the given image.
There was a problem hiding this comment.
If encoding is no longer a "normal" manipulation then I would rather move/remove the Maipulators/Encode class. We could add it's methods to Api class itself. That would also avoid having to change the return type of ManipulatorInterface::run().
|
@ADmad I added some comments to help the review process. Ideally, it would be good to add tests for the new option added to the image API. But I don't have idea what would be the best place to put it. |
| break; | ||
| case 'gif': | ||
| case 'png': | ||
| $encoderOptions['interlaced'] = $shouldInterlace; |
There was a problem hiding this comment.
Quality option isn't used for png/gif?
| case 'png': | ||
| $encoderOptions['interlaced'] = $shouldInterlace; | ||
| break; | ||
| default: |
There was a problem hiding this comment.
For the sake of completeness we can throw an exception here with message Invalid format provided: {$format}.
| { | ||
| $format = $this->getFormat($image); | ||
| $quality = $this->getQuality(); | ||
| $driver = $image->driver(); | ||
| $interlace = false; | ||
| $shouldInterlace = filter_var($this->getParam('interlace'), FILTER_VALIDATE_BOOLEAN); |
There was a problem hiding this comment.
Please add the interlace option to the docs.
| $encoder = new Encode(); | ||
| $encoder->setParams($params); | ||
| /** @var \Intervention\Image\Interfaces\EncodedImageInterface */ | ||
| $encoded = $encoder->run($image); | ||
|
|
||
| return $encoded->toString(); |
There was a problem hiding this comment.
If encoding is no longer a "normal" manipulation then I would rather move/remove the Maipulators/Encode class. We could add it's methods to Api class itself. That would also avoid having to change the return type of ManipulatorInterface::run().
The intent of this PR is to introduce support to generate progressive JPEGs or interlaced images.
Couple days ago, the author of Intervention provided support to accomplish that https://github.com/Intervention/image/releases/tag/3.6.0
With that, I did some adjustments on Glide API to get the desired support.
Highlights:
Encodemanipulator moved from the$manipulatorslist, because it needs to be the last manipulator to run when generating the images.Encodemanipulator now returns aEncodedImage. This change avoids to double encode image when generating it.Encodealso makes more use of Interventionenumsto encode the image properly.