1. Graphics Mill 11.6.21
  2. Working with Image Formats

Controlling Image Format Detection

When processing user-uploaded images, relying solely on file extensions (e.g., .jpg, .png) is unreliable. Users may rename non-image files (such as .txt) to mimic valid image extensions, leading to errors or security risks during processing. Graphics Mill addresses this by detecting image formats based on file signatures rather than extensions, except for specific cases like RAW and TARGA formats.

This article explains how Graphics Mill determines image formats and demonstrates how to use the Aurigma.GraphicsMill.Codecs.CodecRegistry class to customize and enforce supported formats, ensuring robust and secure image handling.

How Graphics Mill Detects Image Formats

Graphics Mill prioritizes file signature analysis to identify image formats. When you call ImageReader.Create(String), the library examines the file's binary content to determine its format, except for RAW and TARGA files. For these formats, Graphics Mill checks the file extension first due to performance considerations and the ambiguity of RAW files (which may technically be valid TIFFs).

This approach ensures:

  • Accuracy: Files are validated based on their actual content, not just their extension.
  • Performance: Signature checks are efficient and avoid unnecessary processing of invalid files.

Developers can override this default behavior for specific use cases, as described later.

Using CodecRegistry for Custom Format Control

To restrict or reorder the formats Graphics Mill supports, use the CodecRegistry class. This allows you to:

  1. Define a specific list of allowed formats.
  2. Control the order in which formats are checked.

Example: Restricting Supported Formats

The following code demonstrates how to create a CodecRegistry instance that only supports a predefined set of formats:

C# 
// Define the order and list of supported formats.
var formatOrder = new[]
{
    FileFormat.Jpeg,
    FileFormat.Png,
    FileFormat.Gif,
    FileFormat.Tiff,
    FileFormat.Bmp,
    FileFormat.WebP,
    FileFormat.Tga,
    FileFormat.Svg,
    FileFormat.Pdf,
    FileFormat.Psd,
    FileFormat.Raw,
};

// Initialize CodecRegistry with the specified formats.
var codecRegistry = new CodecRegistry(formatOrder);

// Open a file stream.
string path = "example.jpg";
using (var fs = new FileStream(path, FileMode.Open, FileAccess.Read))
{
    // Use TryCreateReader to avoid exceptions.
    using (var reader = codecRegistry.TryCreateReader(fs))
    {
        if (reader != null)
        {
            // Format is supported.
            Console.WriteLine($"Detected format: {reader.FileFormat}");
        }
        else
        {
            // Format is not supported or file is invalid.
            Console.WriteLine("Unsupported or invalid image format.");
        }
    }
}

Key Points:

  • Format Order: The order in the formatOrder array determines the priority of format checks. Place frequently used or critical formats first for performance optimization.
  • Error Handling: If a file does not match any registered format, CodecRegistry.TryCreateReader(Stream) returns null instead of throwing an exception. This approach simplifies error handling by eliminating the need for try-catch blocks, making it ideal for scenarios like batch processing or user uploads where performance and reliability are critical.

Conclusion

CodecRegistry provides a powerful way to control image format detection, ensuring that only valid and supported formats are processed. By customizing the list of allowed formats and their detection order, developers can enhance both the security and performance of their applications.

See Also

Reference

Manual