PowerToys/src/modules/powerrename/lib/WICMetadataExtractor.h

// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

#pragma once
#include "MetadataTypes.h"
#include "MetadataResultCache.h"
#include "PropVariantValue.h"
#include <wincodec.h>
#include <atlbase.h>

// Forward declarations for unit test friend classes
namespace WICMetadataExtractorTests
{
    class ExtractAVIFMetadataTests;
}

namespace PowerRenameLib
{
    /// <summary>
    /// Metadata path format based on container type
    /// </summary>
    enum class MetadataPathFormat
    {
        JPEG,  // Uses /app1/ifd/... paths (JPEG)
        IFD    // Uses /ifd/... paths (HEIF, TIFF, etc.)
    };

    /// <summary>
    /// Windows Imaging Component (WIC) implementation for metadata extraction
    /// Provides efficient batch extraction of all metadata types with built-in caching
    /// </summary>
    class WICMetadataExtractor
    {
        // Friend declarations for unit testing
        friend class WICMetadataExtractorTests::ExtractAVIFMetadataTests;

    public:
        WICMetadataExtractor();
        ~WICMetadataExtractor();

        // Public metadata extraction methods
        bool ExtractEXIFMetadata(
            const std::wstring& filePath,
            EXIFMetadata& outMetadata);

        bool ExtractXMPMetadata(
            const std::wstring& filePath,
            XMPMetadata& outMetadata);

        void ClearCache();

    private:
        // WIC factory management
        static CComPtr<IWICImagingFactory> GetWICFactory();
        static void InitializeWIC();

        // WIC operations
        CComPtr<IWICBitmapDecoder> CreateDecoder(const std::wstring& filePath);
        CComPtr<IWICMetadataQueryReader> GetMetadataReader(IWICBitmapDecoder* decoder);

        bool LoadEXIFMetadata(const std::wstring& filePath, EXIFMetadata& outMetadata);
        bool LoadXMPMetadata(const std::wstring& filePath, XMPMetadata& outMetadata);

        // Batch extraction methods
        void ExtractAllEXIFFields(IWICMetadataQueryReader* reader, EXIFMetadata& metadata, MetadataPathFormat pathFormat);
        void ExtractGPSData(IWICMetadataQueryReader* reader, EXIFMetadata& metadata, MetadataPathFormat pathFormat);
        void ExtractAllXMPFields(IWICMetadataQueryReader* reader, XMPMetadata& metadata);

        // Internal container format detection
        MetadataPathFormat GetMetadataPathFormatFromDecoder(IWICBitmapDecoder* decoder);

        // Field reading helpers
        std::optional<SYSTEMTIME> ReadDateTime(IWICMetadataQueryReader* reader, const std::wstring& path);
        std::optional<std::wstring> ReadString(IWICMetadataQueryReader* reader, const std::wstring& path);
        std::optional<int64_t> ReadInteger(IWICMetadataQueryReader* reader, const std::wstring& path);
        std::optional<double> ReadDouble(IWICMetadataQueryReader* reader, const std::wstring& path);

        // Helper methods
        std::optional<PropVariantValue> ReadMetadata(IWICMetadataQueryReader* reader, const std::wstring& path);

    private:
        MetadataResultCache cache;
    };
}