Modernize previews #37564

aentwist · 2023-04-04T02:19:45Z

Closes #13552
Closes #30118

Summary

See commits and #13552

add preview format setting
add preview quality setting
add avif support

TODO

tests
documentation

Checklist

Code is properly formatted
Sign-off message is added to all commits
Tests (unit, integration, api and/or acceptance) are included
Screenshots before/after for front-end changes
Documentation (manuals or wiki) has been updated or is not required
Backports requested where applicable (ex: critical bugfixes)

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

Fix preview providers generate thumbnails based on source file type instead of their type. This worked because providers were always called with a file of the same type. This is not an assumption that can be made any longer. Note that preview providers don't actually know their type - although they should - so instead make them respect an optional MIME type parameter to avoid potential breaking changes. Signed-off-by: Anderson Entwistle <[email protected]>

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

Allow preview format to be specified to be a specific type for all files. Previously, preview format was the same type as the original file. Format can be jpeg, png, gif, webp, or avif. Signed-off-by: Anderson Entwistle <[email protected]>

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

aentwist · 2023-04-04T02:27:13Z

lib/private/legacy/OC_Image.php

+			$this->logger->error(
+				'Preview quality must be an integer from 0 to 100; got ' .
+				"$quality. Falling back to the default preview quality."
+			);


Need to set the quality to the default here

JanisPlayer · 2023-09-12T09:14:42Z

lib/private/legacy/OC_Image.php

+				$res = imagewebp($this->resource, null, $quality);
+				break;
+			case "image/avif":
+				$res = imageavif($this->resource, null, $quality);


Missing speed:
imageavif($this->resource, null, $quality,10);

lib/private/legacy/OC_Image.php

@@ -727,6 +765,15 @@
 					$this->logger->debug('OC_Image->loadFromFile, webp images not supported: ' . $imagePath, ['app' => 'core']);
 				}
 				break;
+			case IMAGETYPE_AVIF:


lib/private/legacy/OC_Image.php

@@ -727,6 +765,15 @@
 					$this->logger->debug('OC_Image->loadFromFile, webp images not supported: ' . $imagePath, ['app' => 'core']);
 				}
 				break;
+			case IMAGETYPE_AVIF:
+				if (imagetypes() & IMG_AVIF) {


lib/private/legacy/OC_Image.php

+				if (imagetypes() & IMG_AVIF) {
+					if (!$this->checkImageSize($imagePath)) return false;
+
+					$this->resource = imagecreatefromavif($imagePath);


lib/public/IPreview.php

@@ -108,10 +108,11 @@
 	 * Check if a preview can be generated for a file
 	 *
 	 * @param \OCP\Files\FileInfo $file
+	 * @param ?string $previewMimeType MIME type of the preview to be generated


lib/private/Preview/Avif.php

+	}
+
+	public function isAvailable(FileInfo $file): bool {
+		return (bool) (imagetypes() & IMG_AVIF);


lib/private/Preview/GeneratorHelper.php

 		if ($provider instanceof Imaginary) {
 			return $provider->getCroppedThumbnail($file, $maxWidth, $maxHeight, $crop) ?? false;
 		}
-		return $provider->getThumbnail($file, $maxWidth, $maxHeight) ?? false;
+		return $provider->getThumbnail($file, $maxWidth, $maxHeight, $mimeType) ?? false;


aentwist · 2023-04-06T19:43:51Z

I tried to avoid breaking changes because I was hoping to get this out quick as a feature release.

Now I see that Nextcloud does not follow semantic versioning? Also the release cadence for majors is much quicker than expected... about every 6 months?

If the target is next major then some stuff should be broken here. At minimum the default JPEG quality, which is currently preserved.

aentwist · 2023-04-06T19:47:04Z

lib/private/legacy/OC_Image.php

+	/**
+	 * Default quality for jpeg images
+	 * 
+	 * @deprecated this choice should be left to the image library
+	 * @see https://www.php.net/manual/en/function.imagejpeg.php#refsect1-function.imagejpeg-parameters
+	 */
 	protected const DEFAULT_JPEG_QUALITY = 80;



aentwist · 2023-04-06T19:53:47Z

lib/private/legacy/OC_Image.php

@@ -381,12 +389,14 @@ public function data(): ?string {
 			case "image/jpeg":
 				/** @psalm-suppress InvalidScalarArgument */
 				imageinterlace($this->resource, (PHP_VERSION_ID >= 80000 ? true : 1));
-				$quality = $this->getJpegQuality();
-				$res = imagejpeg($this->resource, null, $quality);
+				$res = imagejpeg($this->resource, null, $this->getJpegQuality());


use $quality (backed by format quality setting from 0-100 with default -1 instead of format jpeg_quality from 10-100 with default 80)

-1 -> ~75 (breaking change)

aentwist · 2023-04-06T19:54:10Z

lib/private/legacy/OC_Image.php

@@ -407,6 +444,8 @@ public function __toString() {

 	/**
 	 * @return int
+	 * 
+	 * @deprecated
 	 */
 	protected function getJpegQuality(): int {


aentwist · 2023-04-06T20:00:40Z

lib/private/Preview/Generator.php

@@ -51,6 +51,8 @@ class Generator {
 	public const SEMAPHORE_ID_ALL = 0x0a11;
 	public const SEMAPHORE_ID_NEW = 0x07ea;

+	private \OCP\ILogger $logger;


I don't actually write PHP. Can this leading slash be removed?

aentwist · 2023-04-06T20:00:51Z

lib/private/Preview/Generator.php

@@ -72,12 +82,49 @@ public function __construct(
 		EventDispatcherInterface $legacyEventDispatcher,
 		IEventDispatcher $eventDispatcher
 	) {
+		$this->logger = \OC::$server->getLogger();


Can this leading slash be removed?

aentwist · 2023-04-06T20:03:05Z

lib/private/Preview/Generator.php

+					// Although we know the provider here, and it *should* know
+					// its own MIME type, note that it actually doesn't - so we
+					// have to pass it.
+					// 
+					// *`IProviderV2->getMimeType`*
+					// 
+					// > Regex with the mimetypes that are supported by this
+					// provider
+					// 
+					// This is also the case for `$this->getSmallImagePreview`.
+					$preview = $this->helper->getThumbnail($provider, $file, $maxWidth, $maxHeight, false, $mimeType);


High value target for another, potentially big breaking change. Should be a separate issue.. probably. I've already done too much refactoring here.

aentwist · 2023-04-06T20:04:31Z

lib/private/Preview/Generator.php

+	 * 
+	 * @deprecated this is goofy
+	 * @see https://www.php.net/manual/en/function.image-type-to-extension.php
 	 */
 	private function getExtention($mimeType) {
 		switch ($mimeType) {


Also consider targeting this... separate issue

aentwist · 2023-04-06T20:08:36Z

lib/private/legacy/OC_Image.php

+		// If quality is not set by the user or is invalid, then set it to the
+		// GD default value to entrust choosing a well-optimized default
+		// quality to the image library (which should make a much more educated
+		// choice than we would make). Hopefully GD doesn't mangle this idea...
+		// but it appears they do - WebP default should be 75 yet is 80.
+		// 
+		// See https://developers.google.com/speed/webp/docs/cwebp#options
+		if (!$quality) $quality = -1;


This will be very hard to communicate effectively to users. We don't know what the defaults are, and defaults (when using -1) should be tuned to / vary by format. Maybe we should set a default? Also I have very little faith in PHP to handle this idea correctly even though it should..

susnux · 2024-03-18T21:53:18Z

@aentwist are you still working on this? Because to be mergeable the PR needs the be rebased (resolve conflicts) and the code analysis errors need to be fixed.

Thank you :)

aentwist · 2024-03-19T03:52:07Z

No, I am not

susnux · 2024-03-19T11:45:23Z

No, I am not

Sad, but thank you for the pull request! We can have this as inspiration to fix the issues. With PHP 8.1 providing AVIF support we should be able to mainline this with Nextcloud 30.

aentwist · 2024-08-01T10:05:37Z

Closing due to Nextcloud's jank release process, where I am unfortunately tagged for every single release, hopefully only under the condition that this is open. This is spot on with the rest of my Nextcloud experience. I do not, and have not ever used Nextcloud, cannot recommend Nextcloud, and do not like getting 5 emails from being tagged in a random beta release. Please feel free to use this, or even reopen it, when there is a plan to actually move it forward. Good luck. AVIF is awesome.

aentwist · 2024-08-08T19:40:07Z

Reopening in good faith in light of a newer alternative I have [to closing the PR] to not be tagged all the time #46946 (comment). Thank goodness, I really hope this can be useful.

we changed a bit the behaviour, you can use the Draft state to avoid mentions

susnux · 2024-08-14T11:01:44Z

In case someone asks why this was closed:

Pull requests that get reassigned multiple major versions, thus not getting merged, are probably orphaned.
Meaning probably the creator lost their interest in getting it merged (so the PR is not in a merge-able state).
If you want to work on this again, feel free to reopen. Otherwise there is no good reason in having 🧟 PRs out here.

skjnldsv · 2024-08-14T12:04:13Z

Closing due to Nextcloud's jank release process, where I am unfortunately tagged for every single release, hopefully only under the condition that this is open. This is spot on with the rest of my Nextcloud experience. I do not, and have not ever used Nextcloud, cannot recommend Nextcloud, and do not like getting 5 emails from being tagged in a random beta release. Please feel free to use this, or even reopen it, when there is a plan to actually move it forward. Good luck. AVIF is awesome.

And adding an extra reply, after reading this.
I 100% get it @aentwist. I'm sorry you're experiencing this.
It's very hard to find a release process that fits everyone. Many are ok with this, but there are PRs like yours that drags on time and unfortunately, as you can see, community or nc devs did not reviewed this PR in more than a year.

I really appreciate you taking the time to write this, especially since you mentioned you're not a php dev, that shows some good faith. If someone wants to re-open or create a separate PR to continue this work, please feel free to do so. Unless this gets scheduled from other Nextcloud devs, if a PR isn't all green and ready, it's hard for us to invest that much time into guiding you to a mergeable state.

We're always open for discussion, and the closure is not a definitive state, it's about cleaning staled PRs.
Have a nice day!
John

aentwist added 6 commits April 3, 2023 22:13

fix: dataMimeType returns the wrong MIME type

ed4be10

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

refactor: add option to check preview availability for a specific format

5a87d4a

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

feat: add preview format setting

ba3499b

Allow preview format to be specified to be a specific type for all files. Previously, preview format was the same type as the original file. Format can be jpeg, png, gif, webp, or avif. Signed-off-by: Anderson Entwistle <[email protected]>

feat: add preview quality setting for lossy compression

d38f33f

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

feat: add AVIF support

8d09ec9

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

aentwist commented Apr 4, 2023

View reviewed changes

github-advanced-security bot found potential problems Apr 4, 2023

View reviewed changes

szaimen added this to the Nextcloud 27 milestone Apr 4, 2023

szaimen added the 2. developing Work in progress label Apr 4, 2023

aentwist commented Apr 6, 2023

View reviewed changes

This was referenced May 3, 2023

27.0.0 beta 1 #38038

Merged

27.0.0 beta 2 #38137

Closed

27.0.0 beta 2 #38139

Merged

skjnldsv modified the milestones: Nextcloud 27, Nextcloud 28 May 9, 2023

aentwist mentioned this pull request May 29, 2023

[Bug]: Error deleting file #38356

Closed

9 tasks

JanisPlayer mentioned this pull request Sep 12, 2023

Add AVIF Thumbnail Generation #40048

Open

17 tasks

skjnldsv mentioned this pull request Nov 1, 2023

chore: 28.0.0 beta 1 #41228

Merged

This was referenced Nov 6, 2023

28.0.0 beta 2 #41314

Merged

28.0.0 beta 3 #41379

Merged

AndyScherzinger removed this from the Nextcloud 28 milestone Nov 10, 2023

susnux added this to the Nextcloud 30 milestone Mar 18, 2024

susnux requested review from a team, ArtificialOwl, nfebe and sorbaugh and removed request for a team March 18, 2024 21:51

susnux removed request for ArtificialOwl, nfebe and sorbaugh March 19, 2024 11:44

susnux removed this from the Nextcloud 30 milestone Mar 19, 2024

susnux added the help wanted label Mar 19, 2024

JanisPlayer mentioned this pull request Mar 24, 2024

Allow more preview formats #13552

Open

joshtrichards added the feature: previews and thumbnails label Apr 4, 2024

susnux added this to the Nextcloud 30 milestone Apr 18, 2024

This was referenced Jul 30, 2024

30.0.0 beta 2 #46870

Merged

30.0.0 beta 3 #46946

Merged

aentwist closed this Aug 1, 2024

aentwist reopened this Aug 8, 2024

aentwist marked this pull request as draft August 8, 2024 19:40

skjnldsv modified the milestones: Nextcloud 30, Nextcloud 31 Aug 14, 2024

skjnldsv closed this Aug 14, 2024

skjnldsv removed this from the Nextcloud 31 milestone Aug 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Modernize previews #37564

Modernize previews #37564

aentwist commented Apr 4, 2023 •

edited by solracsf

Loading

aentwist Apr 4, 2023

JanisPlayer Sep 12, 2023

aentwist commented Apr 6, 2023

aentwist Apr 6, 2023

aentwist Apr 6, 2023 •

edited

Loading

aentwist Apr 6, 2023

aentwist Apr 6, 2023

aentwist Apr 6, 2023

aentwist Apr 6, 2023 •

edited

Loading

aentwist Apr 6, 2023

aentwist Apr 6, 2023

susnux commented Mar 18, 2024

aentwist commented Mar 19, 2024

susnux commented Mar 19, 2024

aentwist commented Aug 1, 2024

aentwist commented Aug 8, 2024 •

edited

Loading

susnux commented Aug 14, 2024 •

edited

Loading

skjnldsv commented Aug 14, 2024

Modernize previews #37564

Modernize previews #37564

Conversation

aentwist commented Apr 4, 2023 • edited by solracsf Loading

Summary

TODO

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aentwist commented Apr 6, 2023

Choose a reason for hiding this comment

aentwist Apr 6, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aentwist Apr 6, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

susnux commented Mar 18, 2024

aentwist commented Mar 19, 2024

susnux commented Mar 19, 2024

aentwist commented Aug 1, 2024

aentwist commented Aug 8, 2024 • edited Loading

susnux commented Aug 14, 2024 • edited Loading

skjnldsv commented Aug 14, 2024

aentwist commented Apr 4, 2023 •

edited by solracsf

Loading

aentwist Apr 6, 2023 •

edited

Loading

aentwist Apr 6, 2023 •

edited

Loading

aentwist commented Aug 8, 2024 •

edited

Loading

susnux commented Aug 14, 2024 •

edited

Loading