fix(server): adjust panorama medata for new image dimensions

Author: meesfrensel

server/src/repositories/media.repository.ts

@@ -121,19 +121,15 @@ export class MediaRepository {
     }
   }
 
-  async copyTagGroup(tagGroup: string, source: string, target: string): Promise<boolean> {
+  async writeTags(tags: WriteTags, output: string): Promise<boolean> {
     try {
-      await exiftool.write(
-        target,
-        {},
-        {
-          ignoreMinorErrors: true,
-          writeArgs: ['-TagsFromFile', source, `-${tagGroup}:all>${tagGroup}:all`, '-overwrite_original'],
-        },
-      );
+      await exiftool.write(output, tags, {
+        ignoreMinorErrors: true,
+        writeArgs: ['-overwrite_original'],
+      });
       return true;
     } catch (error: any) {
-      this.logger.warn(`Could not copy tag data to image: ${error.message}`);
+      this.logger.warn(`Could not write tags to image: ${error.message}`);
       return false;
     }
   }

server/src/repositories/metadata.repository.ts

@@ -72,6 +72,21 @@ export interface ImmichTags extends Omit<Tags, TagsWithWrongTypes> {
 
   AndroidMake?: string;
   AndroidModel?: string;
+
+  UsePanoramaViewer?: boolean;
+  ProjectionType?: string;
+  PoseHeadingDegrees?: number;
+  PosePitchDegrees?: number;
+  PoseRollDegrees?: number;
+  InitialViewHeadingDegrees?: number;
+  InitialViewPitchDegrees?: number;
+  InitialViewRollDegrees?: number;
+  CroppedAreaImageWidthPixels?: number;
+  CroppedAreaImageHeightPixels?: number;
+  FullPanoWidthPixels?: number;
+  FullPanoHeightPixels?: number;
+  CroppedAreaLeftPixels?: number;
+  CroppedAreaTopPixels?: number;
 }
 
 @Injectable()

server/src/services/media.service.spec.ts

@@ -865,7 +865,12 @@ describe(MediaService.name, () => {
       mocks.systemMetadata.get.mockResolvedValue({ image: { fullsize: { enabled: false } } });
       mocks.media.extract.mockResolvedValue({ buffer: extractedBuffer, format: RawExtractedFormat.Jpeg });
       mocks.media.getImageDimensions.mockResolvedValue({ width: 3840, height: 2160 });
-      mocks.media.copyTagGroup.mockResolvedValue(true);
+      mocks.metadata.readTags.mockResolvedValue({
+        ProjectionType: 'equirectangular',
+        PoseHeadingDegrees: 127,
+        FullPanoWidthPixels: 3840,
+        FullPanoHeightPixels: 2160,
+      });
 
       mocks.assetJob.getForGenerateThumbnailJob.mockResolvedValue(assetStub.panoramaTif);
 
@@ -892,10 +897,14 @@ describe(MediaService.name, () => {
         expect.any(String),
       );
 
-      expect(mocks.media.copyTagGroup).toHaveBeenCalledTimes(2);
-      expect(mocks.media.copyTagGroup).toHaveBeenCalledWith(
-        'XMP-GPano',
-        assetStub.panoramaTif.originalPath,
+      expect(mocks.media.writeTags).toHaveBeenCalledTimes(2);
+      expect(mocks.media.writeTags).toHaveBeenCalledWith(
+        {
+          ProjectionType: 'equirectangular',
+          PoseHeadingDegrees: 127,
+          FullPanoWidthPixels: 2560,
+          FullPanoHeightPixels: 1440,
+        },
         expect.any(String),
       );
     });

server/src/services/media.service.ts

@@ -47,6 +47,28 @@ interface UpsertFileOptions {
   path: string;
 }
 
+const PANORAMA_CONSTANTS = [
+  'UsePanoramaViewer',
+  'ProjectionType',
+  'PoseHeadingDegrees',
+  'PosePitchDegrees',
+  'PoseRollDegrees',
+  'InitialViewHeadingDegrees',
+  'InitialViewPitchDegrees',
+  'InitialViewRollDegrees',
+] as const;
+
+const PANORAMA_SCALABLES = [
+  'CroppedAreaImageWidthPixels',
+  'CroppedAreaImageHeightPixels',
+  'FullPanoWidthPixels',
+  'FullPanoHeightPixels',
+  'CroppedAreaLeftPixels',
+  'CroppedAreaTopPixels',
+] as const;
+
+const PANORAMA_ALL = [...PANORAMA_CONSTANTS, ...PANORAMA_SCALABLES] as const;
+
 @Injectable()
 export class MediaService extends BaseService {
   videoInterfaces: VideoInterfaces = { dri: [], mali: false };
@@ -316,12 +338,37 @@ export class MediaService extends BaseService {
 
     const outputs = await Promise.all(promises);
 
-    if (asset.exifInfo.projectionType === 'EQUIRECTANGULAR') {
+    const originalSize = asset.exifInfo.exifImageHeight;
+    if (asset.exifInfo.projectionType === 'EQUIRECTANGULAR' && originalSize) {
+      // preview size is min(preview size, original size) so do the same for pano pixel adjustment
+      const scaleRatio = Math.min(1, image.preview.size / originalSize);
+      const originalTags = await this.metadataRepository.readTags(asset.originalPath);
+
+      const previewTags = {} as Record<string, string | number | boolean>;
+      const fullsizeTags = {} as Record<string, string | number | boolean>;
+
+      for (const key of PANORAMA_CONSTANTS) {
+        if (key in originalTags && originalTags[key]) {
+          previewTags[key] = originalTags[key];
+        }
+      }
+      for (const key of PANORAMA_SCALABLES) {
+        if (key in originalTags && originalTags[key]) {
+          previewTags[key] = Math.round(originalTags[key] * scaleRatio);
+        }
+      }
+
+      if (fullsizePath) {
+        for (const key of PANORAMA_ALL) {
+          if (key in originalTags && originalTags[key]) {
+            fullsizeTags[key] = originalTags[key];
+          }
+        }
+      }
+
       const promises = [
-        this.mediaRepository.copyTagGroup('XMP-GPano', asset.originalPath, previewPath),
-        fullsizePath
-          ? this.mediaRepository.copyTagGroup('XMP-GPano', asset.originalPath, fullsizePath)
-          : Promise.resolve(),
+        this.mediaRepository.writeTags(previewTags, previewPath),
+        fullsizePath ? this.mediaRepository.writeTags(fullsizeTags, fullsizePath) : Promise.resolve(),
       ];
       await Promise.all(promises);
     }

server/test/fixtures/asset.stub.ts

@@ -897,6 +897,7 @@ export const assetStub = {
     exifInfo: {
       fileSizeInByte: 5000,
       projectionType: 'EQUIRECTANGULAR',
+      exifImageHeight: 2160,
     } as Exif,
     duplicateId: null,
     isOffline: false,

server/test/repositories/media.repository.mock.ts

@@ -6,7 +6,7 @@ export const newMediaRepositoryMock = (): Mocked<RepositoryInterface<MediaReposi
   return {
     generateThumbnail: vitest.fn().mockImplementation(() => Promise.resolve()),
     writeExif: vitest.fn().mockImplementation(() => Promise.resolve()),
-    copyTagGroup: vitest.fn().mockImplementation(() => Promise.resolve()),
+    writeTags: vitest.fn().mockResolvedValue(true),
     generateThumbhash: vitest.fn().mockResolvedValue(Buffer.from('')),
     decodeImage: vitest.fn().mockResolvedValue({ data: Buffer.from(''), info: {} }),
     extract: vitest.fn().mockResolvedValue(null),