feat(server): extract full-size previews from RAW images

Author: eligao

mobile/openapi/lib/model/asset_media_size.dart

@@ -8294,6 +8294,7 @@
       },
       "AssetMediaSize": {
         "enum": [
+          "original",
           "preview",
           "thumbnail"
         ],
@@ -10020,6 +10021,7 @@
       "PathType": {
         "enum": [
           "original",
+          "extracted",
           "preview",
           "thumbnail",
           "encoded_video",

mobile/openapi/lib/model/path_type.dart

@@ -3429,6 +3429,7 @@ export enum AssetJobName {
     TranscodeVideo = "transcode-video"
 }
 export enum AssetMediaSize {
+    Original = "original",
     Preview = "preview",
     Thumbnail = "thumbnail"
 }
@@ -3479,6 +3480,7 @@ export enum PathEntityType {
 }
 export enum PathType {
     Original = "original",
+    Extracted = "extracted",
     Preview = "preview",
     Thumbnail = "thumbnail",
     EncodedVideo = "encoded_video",

open-api/immich-openapi-specs.json

@@ -26,7 +26,7 @@ export interface MoveRequest {
   };
 }
 
-export type GeneratedImageType = AssetPathType.PREVIEW | AssetPathType.THUMBNAIL;
+export type GeneratedImageType = AssetPathType.PREVIEW | AssetPathType.THUMBNAIL | AssetPathType.EXTRACTED;
 export type GeneratedAssetType = GeneratedImageType | AssetPathType.ENCODED_VIDEO;
 
 let instance: StorageCore | null;

open-api/typescript-sdk/src/fetch-client.ts

@@ -4,6 +4,11 @@ import { ArrayNotEmpty, IsArray, IsEnum, IsNotEmpty, IsString, ValidateNested }
 import { Optional, ValidateBoolean, ValidateDate, ValidateUUID } from 'src/validation';
 
 export enum AssetMediaSize {
+  /**
+   * An original-sized JPG extracted from the RAW image,
+   * or otherwise the original non-RAW image itself.
+   */
+  ORIGINAL = 'original',
   PREVIEW = 'preview',
   THUMBNAIL = 'thumbnail',
 }

server/src/cores/storage.core.ts

@@ -33,6 +33,10 @@ export enum AssetType {
 }
 
 export enum AssetFileType {
+  /**
+   * An full/large-size image extracted/converted from RAW photos
+   */
+  EXTRACTED = 'extracted',
   PREVIEW = 'preview',
   THUMBNAIL = 'thumbnail',
 }
@@ -237,6 +241,7 @@ export enum ManualJobName {
 
 export enum AssetPathType {
   ORIGINAL = 'original',
+  EXTRACTED = 'extracted',
   PREVIEW = 'preview',
   THUMBNAIL = 'thumbnail',
   ENCODED_VIDEO = 'encoded_video',

server/src/dtos/asset-media.dto.ts

@@ -180,6 +180,7 @@ export interface IAssetRepository {
   updateDuplicates(options: AssetUpdateDuplicateOptions): Promise<void>;
   update(asset: AssetUpdateOptions): Promise<void>;
   remove(asset: AssetEntity): Promise<void>;
+  removeAssetFile(path: string): Promise<void>;
   findLivePhotoMatch(options: LivePhotoSearchOptions): Promise<AssetEntity | null>;
   getStatistics(ownerId: string, options: AssetStatsOptions): Promise<AssetStats>;
   getTimeBuckets(options: TimeBucketOptions): Promise<TimeBucketItem[]>;

server/src/enum.ts

@@ -281,6 +281,10 @@ export class AssetRepository implements IAssetRepository {
     await this.repository.remove(asset);
   }
 
+  async removeAssetFile(path: string): Promise<void> {
+    await this.fileRepository.delete({ path });
+  }
+
   @GenerateSql({ params: [{ ownerId: DummyValue.UUID, libraryId: DummyValue.UUID, checksum: DummyValue.BUFFER }] })
   getByChecksum({
     ownerId,

server/src/interfaces/asset.interface.ts

@@ -44,6 +44,11 @@ export class MediaRepository implements IMediaRepository {
 
   async extract(input: string, output: string): Promise<boolean> {
     try {
+      // remove existing output file if it exists
+      // as exiftool-vendord does not support overwriting via "-w!" flag
+      // and throws "1 files could not be read" error when the output file exists
+      await fs.unlink(output).catch(() => null);
+      this.logger.debug('Extracting JPEG from RAW image:', input);
       await exiftool.extractJpgFromRaw(input, output);
     } catch (error: any) {
       this.logger.debug('Could not extract JPEG from image, trying preview', error.message);
@@ -98,6 +103,10 @@ export class MediaRepository implements IMediaRepository {
       pipeline = pipeline.extract(options.crop);
     }
 
+    // Infinity is a special value that means no resizing
+    if (options.size === Infinity) {
+      return pipeline;
+    }
     return pipeline.resize(options.size, options.size, { fit: 'outside', withoutEnlargement: true });
   }