javax.imageio.spi徹底解説：Java Image I/Oでカスタム画像フォーマットを扱う

Javaで画像ファイルを扱う際、多くの開発者がjavax.imageio.ImageIOクラスにお世話になったことでしょう。 ImageIO.read(File)やImageIO.write(BufferedImage, String, File)といった静的メソッドは、数行のコードでJPEG、PNG、GIFといった標準的な画像フォーマットを手軽に読み書きできるため、非常に強力です。

しかし、その手軽さの裏には、強力で拡張性の高いフレームワークが存在します。それが、Java Image I/O APIです。 そして、その拡張性の核となるのが、今回解説するjavax.imageio.spiパッケージです。SPIは “Service Provider Interface” の略で、直訳すると「サービス提供者のためのインターフェース」となります。

簡単に言えば、ImageIOが標準で提供する機能（JPEGやPNGの読み書き）だけでは不十分な場合に、開発者自身が新しい機能を追加するための「プラグインの仕組み」を提供するのがjavax.imageio.spiの役割です。 例えば、医療用の特殊な画像フォーマットや、ゲームで使われる独自のテクスチャフォーマットなどをJavaで扱いたい場合、このSPIを利用して独自の画像リーダーやライターを作成することになります。

javax.imageio.spiパッケージにはいくつかの重要なクラスやインターフェースが含まれていますが、特に中心的な役割を担うのは以下の5つです。 これらのクラスは、画像I/Oの各プロセスに対応しています。

ほとんどの場合、カスタムフォーマットに対応させるために主に実装するのはImageReaderSpiとImageWriterSpi、そしてそれらが生成するImageReaderとImageWriterです。 本記事でも、この2つのSPIの実装に焦点を当てて解説を進めます。

それでは、実際に独自の画像フォーマットを読み込むためのリーダーを作成してみましょう。 ここでは、以下のような非常にシンプルな仕様の架空の画像フォーマット「.myimg」を考えます。

このフォーマットを読み込むには、ImageReaderSpiとImageReaderの2つのクラスを実装する必要があります。

ステップ1: `MyImageReaderSpi` の実装

ImageReaderSpiは、サービスプロバイダの「顔」となるクラスです。 このSPIがどのようなフォーマットを扱えるのか、バージョンは何か、といった情報を提供し、実際にデコード可能かどうかを判定します。

<?xml version="1.0" encoding="UTF-8"?>
package com.example.imageio;
import javax.imageio.ImageReader;
import javax.imageio.spi.ImageReaderSpi;
import javax.imageio.stream.ImageInputStream;
import java.io.IOException;
import java.util.Locale;
public class MyImageReaderSpi extends ImageReaderSpi { private static final String VENDOR_NAME = "MyCompany"; private static final String VERSION = "1.0"; private static final String FORMAT_NAME = "myimg"; private static final String[] NAMES = { "myimg", "MYIMG" }; private static final String[] SUFFIXES = { "myimg" }; private static final String[] MIME_TYPES = { "image/x-myimg" }; // このリーダーが入力として受け取れるクラス private static final Class[] INPUT_TYPES = { ImageInputStream.class }; // このリーダーに対応するライターのSPIクラス名（あれば） private static final String[] WRITER_SPI_NAMES = { "com.example.imageio.MyImageWriterSpi" }; // マジックナンバー private static final byte[] MAGIC_BYTES = { (byte) 'M', (byte) 'Y', (byte) 'I', (byte) 'M' }; public MyImageReaderSpi() { super( VENDOR_NAME, VERSION, NAMES, SUFFIXES, MIME_TYPES, "com.example.imageio.MyImageReader", // 対応するImageReaderクラスの完全修飾名 INPUT_TYPES, WRITER_SPI_NAMES, false, // ストリームメタデータをサポートするか null, null, null, null, true, // イメージメタデータをサポートするか "com.example.imageio.MyFormatMetadata", // メタデータクラス名 "com.example.imageio.MyFormatMetadataFormat", // メタデータフォーマットクラス名 null, null ); } @Override public String getDescription(Locale locale) { return "MyImage custom image format reader"; } @Override public boolean canDecodeInput(Object source) throws IOException { if (!(source instanceof ImageInputStream)) { return false; } ImageInputStream iis = (ImageInputStream) source; byte[] b = new byte; // 先頭の数バイトを読み込んで判定する try { // 現在位置をマーク iis.mark(); // 4バイト読み込む iis.readFully(b); // マークした位置に戻す iis.reset(); } catch (IOException e) { return false; } return (b == MAGIC_BYTES && b == MAGIC_BYTES && b == MAGIC_BYTES && b == MAGIC_BYTES); } @Override public ImageReader createReaderInstance(Object extension) throws IOException { return new MyImageReader(this); }
}

重要なポイント:

• super() コンストラクタで、このSPIが担当するフォーマットの基本情報（フォーマット名、拡張子、MIMEタイプなど）を渡します。
• canDecodeInput(Object source) メソッドが最も重要です。引数で渡された入力ソース（通常は ImageInputStream）が、このSPIで処理できるフォーマットかどうかを判定します。ここでは、ストリームの先頭4バイトを読み込み、マジックナンバーと一致するかどうかで判定しています。判定後は、mark()とreset()でストリームの位置を元に戻すのが作法です。
• createReaderInstance(Object extension) メソッドは、実際に画像を読み込むImageReaderのインスタンスを生成して返します。

ステップ2: `MyImageReader` の実装

次に、MyImageReaderSpiによって生成される、実際のデコード処理を行うImageReaderクラスを実装します。

<?xml version="1.0" encoding="UTF-8"?>
package com.example.imageio;
import javax.imageio.ImageReadParam;
import javax.imageio.ImageReader;
import javax.imageio.ImageTypeSpecifier;
import javax.imageio.spi.ImageReaderSpi;
import javax.imageio.stream.ImageInputStream;
import java.awt.image.BufferedImage;
import java.io.IOException;
import java.util.Collections;
import java.util.Iterator;
public class MyImageReader extends ImageReader { private ImageInputStream iis; private int width; private int height; private boolean gotHeader = false; protected MyImageReader(ImageReaderSpi originatingProvider) { super(originatingProvider); } @Override public void setInput(Object input, boolean seekForwardOnly, boolean ignoreMetadata) { super.setInput(input, seekForwardOnly, ignoreMetadata); if (input instanceof ImageInputStream) { this.iis = (ImageInputStream) input; } else { // サポートしない入力タイプ throw new IllegalArgumentException("Input not an ImageInputStream!"); } this.gotHeader = false; // 新しい入力が設定されたのでヘッダーは未読 } // ヘッダー情報を読み込むプライベートメソッド private void readHeader() throws IOException { if (gotHeader) { return; } if (iis == null) { throw new IllegalStateException("Input not set!"); } // マジックナンバーを読み飛ばす（Spiでチェック済みだが念のため） iis.seek(0); if (iis.readInt() != 0x4D59494D) { throw new IOException("Not a MYIMG file!"); } this.width = iis.readInt(); this.height = iis.readInt(); this.gotHeader = true; } @Override public int getNumImages(boolean allowSearch) throws IOException { return 1; // このフォーマットは1イメージのみ } @Override public int getWidth(int imageIndex) throws IOException { checkIndex(imageIndex); readHeader(); return width; } @Override public int getHeight(int imageIndex) throws IOException { checkIndex(imageIndex); readHeader(); return height; } @Override public Iterator<ImageTypeSpecifier> getImageTypes(int imageIndex) throws IOException { checkIndex(imageIndex); // このフォーマットは常にTYPE_INT_ARGB ImageTypeSpecifier specifier = ImageTypeSpecifier.createFromBufferedImageType(BufferedImage.TYPE_INT_ARGB); return Collections.singletonList(specifier).iterator(); } @Override public BufferedImage read(int imageIndex, ImageReadParam param) throws IOException { checkIndex(imageIndex); readHeader(); // ヘッダー情報（12バイト）の直後からピクセルデータが始まる iis.seek(12); BufferedImage image = new BufferedImage(width, height, BufferedImage.TYPE_INT_ARGB); int[] pixel = new int; // 1ピクセルずつ読み込むためのバッファ for (int y = 0; y < height; y++) { for (int x = 0; x < width; x++) { int argb = iis.readInt(); pixel = argb; // BufferedImageのRasterにピクセルデータを書き込む image.getRaster().setDataElements(x, y, 1, 1, pixel); } } return image; } private void checkIndex(int imageIndex) { if (imageIndex != 0) { throw new IndexOutOfBoundsException("Only image index 0 is valid"); } } // メタデータ関連のメソッドは今回はnullを返すなど簡易的に実装 @Override public javax.imageio.metadata.IIOMetadata getStreamMetadata() throws IOException { return null; } @Override public javax.imageio.metadata.IIOMetadata getImageMetadata(int imageIndex) throws IOException { checkIndex(imageIndex); return null; }
}

重要なポイント:

• setInput() で入力ストリームを受け取ります。
• getWidth(), getHeight(), read() などが呼び出された際に、必要であればヘッダー情報を読み込むreadHeader()を呼び出します。ヘッダーのパースは一度だけ行われるようにフラグで管理するのが効率的です。
• 中核となるのは read(int imageIndex, ImageReadParam param) メソッドです。ここで、入力ストリームからピクセルデータをバイト単位で読み込み、BufferedImage を構築していきます。
• フォーマットの仕様に従って、ストリームを正確に読み進めることが重要です。iis.readInt() など、ImageInputStream が提供するメソッドを駆使します。

読み込みができたら、次は書き込みです。リーダーと同様に、ImageWriterSpiとImageWriterの2つのクラスを実装します。

ステップ1: `MyImageWriterSpi` の実装

ImageWriterSpiも、サービスプロバイダの「顔」です。このSPIがどのフォーマットで書き出せるかをImageIOフレームワークに伝えます。

<?xml version="1.0" encoding="UTF-8"?>
package com.example.imageio;
import javax.imageio.ImageTypeSpecifier;
import javax.imageio.ImageWriter;
import javax.imageio.spi.ImageWriterSpi;
import javax.imageio.stream.ImageOutputStream;
import java.util.Locale;
public class MyImageWriterSpi extends ImageWriterSpi { // ReaderSpiと同様の定数定義 private static final String VENDOR_NAME = "MyCompany"; private static final String VERSION = "1.0"; private static final String FORMAT_NAME = "myimg"; private static final String[] NAMES = { "myimg", "MYIMG" }; private static final String[] SUFFIXES = { "myimg" }; private static final String[] MIME_TYPES = { "image/x-myimg" }; private static final Class[] OUTPUT_TYPES = { ImageOutputStream.class }; private static final String[] READER_SPI_NAMES = { "com.example.imageio.MyImageReaderSpi" }; public MyImageWriterSpi() { super( VENDOR_NAME, VERSION, NAMES, SUFFIXES, MIME_TYPES, "com.example.imageio.MyImageWriter", // 対応するImageWriterクラス OUTPUT_TYPES, READER_SPI_NAMES, false, null, null, null, null, true, "com.example.imageio.MyFormatMetadata", "com.example.imageio.MyFormatMetadataFormat", null, null ); } @Override public boolean canEncodeImage(ImageTypeSpecifier type) { // このライターは、あらゆるタイプのBufferedImageをARGBに変換して書き込むことができる return true; } @Override public ImageWriter createWriterInstance(Object extension) { return new MyImageWriter(this); } @Override public String getDescription(Locale locale) { return "MyImage custom image format writer"; }
}

重要なポイント:

• 基本的な構造はImageReaderSpiと似ています。
• canEncodeImage(ImageTypeSpecifier type) メソッドは、引数で渡されたイメージタイプ（ColorModelやSampleModelの情報を持つ）をこのライターがエンコードできるかを返します。ここでは単純にtrueを返していますが、特定のフォーマット（例えばグレースケールのみなど）しか扱えない場合は、ここで厳密に判定する必要があります。
• createWriterInstance() で、実際の書き込み処理を行うMyImageWriterを生成します。

ステップ2: `MyImageWriter` の実装

最後に、BufferedImageのデータを.myimgフォーマットのバイトストリームに変換して書き出すImageWriterを実装します。

<?xml version="1.0" encoding="UTF-8"?>
package com.example.imageio;
import javax.imageio.IIOImage;
import javax.imageio.ImageTypeSpecifier;
import javax.imageio.ImageWriteParam;
import javax.imageio.ImageWriter;
import javax.imageio.metadata.IIOMetadata;
import javax.imageio.spi.ImageWriterSpi;
import javax.imageio.stream.ImageOutputStream;
import java.awt.image.BufferedImage;
import java.awt.image.RenderedImage;
import java.io.IOException;
public class MyImageWriter extends ImageWriter { private ImageOutputStream ios; protected MyImageWriter(ImageWriterSpi originatingProvider) { super(originatingProvider); } @Override public void setOutput(Object output) { super.setOutput(output); if (output instanceof ImageOutputStream) { this.ios = (ImageOutputStream) output; } else { throw new IllegalArgumentException("Output not an ImageOutputStream!"); } } @Override public void write(IIOMetadata streamMetadata, IIOImage image, ImageWriteParam param) throws IOException { if (ios == null) { throw new IllegalStateException("Output not set!"); } if (!(image.getRenderedImage() instanceof BufferedImage)) { throw new IOException("Only BufferedImage can be written."); } BufferedImage bi = (BufferedImage) image.getRenderedImage(); int width = bi.getWidth(); int height = bi.getHeight(); // 1. マジックナンバーを書き込む ios.writeInt(0x4D59494D); // 2. 幅と高さを書き込む ios.writeInt(width); ios.writeInt(height); // 3. ピクセルデータを書き込む for (int y = 0; y < height; y++) { for (int x = 0; x < width; x++) { // BufferedImageからARGB値を取得 int argb = bi.getRGB(x, y); ios.writeInt(argb); } } // ストリームをフラッシュ ios.flush(); } // 以下は今回は使用しないが実装が必要な抽象メソッド @Override public IIOMetadata getDefaultStreamMetadata(ImageWriteParam param) { return null; } @Override public IIOMetadata getDefaultImageMetadata(ImageTypeSpecifier imageType, ImageWriteParam param) { return null; } @Override public IIOMetadata convertStreamMetadata(IIOMetadata inData, ImageWriteParam param) { return null; } @Override public IIOMetadata convertImageMetadata(IIOMetadata inData, ImageTypeSpecifier imageType, ImageWriteParam param) { return null; }
}

重要なポイント:

• setOutput() で出力ストリームを受け取ります。
• 中心となるのは write(IIOMetadata, IIOImage, ImageWriteParam) メソッドです。IIOImageオブジェクトからRenderedImage（通常はBufferedImage）を取得します。
• フォーマットの仕様に従い、ヘッダー情報（マジックナンバー、幅、高さ）を順番に出力ストリームに書き込みます。
• BufferedImageのgetRGB(x, y)メソッドでピクセルデータを一つずつ取得し、ストリームに書き込んでいきます。

ここまでで、カスタムフォーマットを扱うためのリーダーとライターのクラス群が完成しました。 しかし、このままではImageIOはこれらのクラスの存在を知りません。 Javaのサービスローダーの仕組みを使って、作成したSPIをサービスとして登録する必要があります。

サービスの登録: `META-INF/services`

サービスを登録するには、プロジェクトのリソースディレクトリ（MavenやGradleならsrc/main/resources）にMETA-INF/servicesというディレクトリを作成します。 そして、その中に「インターフェースの完全修飾名」をファイル名とするテキストファイルを作成し、ファイル内に「実装クラスの完全修飾名」を記述します。

今回の例では、以下の2つのファイルを作成します。

com.example.imageio.MyImageReaderSpi

com.example.imageio.MyImageWriterSpi

このように設定してJARファイルをビルドすると、ImageIOはアプリケーションのクラスパスをスキャンする際にこれらのファイルを見つけ、記述されているSPIクラスを自動的にレジストリに登録します。

SPIの利用

SPIが正しく登録されれば、あとは何も特別なことをする必要はありません。いつものようにImageIOクラスを使うだけです。

<?xml version="1.0" encoding="UTF-8"?>
import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.IOException;
import java.util.Arrays;
public class Main { public static void main(String[] args) throws IOException { // 利用可能なリーダー/ライターのフォーマット名を確認 System.out.println("Reader formats: " + Arrays.toString(ImageIO.getReaderFormatNames())); System.out.println("Writer formats: " + Arrays.toString(ImageIO.getWriterFormatNames())); // --- 書き込みテスト --- BufferedImage imageToWrite = new BufferedImage(100, 50, BufferedImage.TYPE_INT_ARGB); // 適当な画像を生成 for(int y = 0; y < imageToWrite.getHeight(); y++) { for(int x = 0; x < imageToWrite.getWidth(); x++) { int a = 255; int r = (x * 255) / 100; int g = (y * 255) / 50; int b = 128; int p = (a << 24) | (r << 16) | (g << 8) | b; imageToWrite.setRGB(x, y, p); } } File outputFile = new File("test.myimg"); // "myimg"というフォーマット名を指定して書き込む boolean success = ImageIO.write(imageToWrite, "myimg", outputFile); System.out.println("Write successful: " + success); // --- 読み込みテスト --- if (success) { File inputFile = new File("test.myimg"); BufferedImage imageToRead = ImageIO.read(inputFile); if (imageToRead != null) { System.out.println("Read successful!"); System.out.println("Image dimensions: " + imageToRead.getWidth() + "x" + imageToRead.getHeight()); } else { System.out.println("Failed to read image."); } } }
}

このコードを実行すると、コンソールに表示されるフォーマット名一覧にmyimgが追加されていることが確認できます。 そして、ImageIO.write()とImageIO.read()が、私たちが作成したカスタムSPIを自動的に検出し、利用して.myimgファイルの読み書きを実行します。 これがJava Image I/Oのプラグインアーキテクチャの力です。

スレッドセーフティ

SPIクラス（ImageReaderSpi, ImageWriterSpiなど）のインスタンスは、アプリケーション内で共有される可能性があります。 そのため、SPIクラス自体はステートレス（状態を持たない）に設計する必要があります。状態を持つような変数は宣言しないようにしましょう。

一方で、ImageReaderやImageWriterのインスタンスは、createReaderInstance()やcreateWriterInstance()が呼ばれるたびに新しく生成されます。 したがって、特定の読み書き処理に固有の状態（現在のストリーム位置や読み込んだヘッダー情報など）は、これらのImageReader/ImageWriterクラスのインスタンス変数として保持するのが正しい設計です。

`IIORegistry` と動的な登録

ImageIOは、サービスプロバイダの管理にjavax.imageio.spi.IIORegistryというクラスを使用しています。 通常、META-INF/servicesによる自動登録で十分ですが、実行時に動的にSPIを登録・解除することも可能です。

<?xml version="1.0" encoding="UTF-8"?>
// IIORegistryのデフォルトインスタンスを取得
IIORegistry registry = IIORegistry.getDefaultInstance();
// 手動でSPIのインスタンスを生成して登録する
ImageReaderSpi mySpi = new MyImageReaderSpi();
registry.registerServiceProvider(mySpi);
// 登録を解除する
registry.deregisterServiceProvider(mySpi);

この方法は、プラグインを動的にロード・アンロードするような高度なアプリケーションで役立つ可能性があります。

パフォーマンスに関する考慮事項

大規模な画像を扱う場合、パフォーマンスは非常に重要になります。 特にread()やwrite()メソッド内でのI/O処理はボトルネックになりがちです。

• バッファリング: 1バイトずつ読み書きするのではなく、ある程度の大きさのバイト配列（バッファ）を使ってまとめて読み書きすることで、I/O回数を減らし、パフォーマンスを向上させることができます。ImageInputStreamやImageOutputStreamは、効率的なI/Oのためのメソッドを提供しています。
• リソースの解放: ImageReaderやImageWriterは、内部でストリームなどのリソースを保持します。dispose()メソッドをオーバーライドして、不要になったリソースを明示的に解放する処理を記述することが推奨されます。ImageIOは通常、処理の完了後に自動でdispose()を呼び出します。

本記事では、Javaのjavax.imageio.spiパッケージを利用して、独自のカスタム画像フォーマットに対応する方法を詳細に解説しました。

javax.imageio.spiをマスターすることで、Javaの画像処理の可能性は大きく広がります。 標準でサポートされていない特殊なフォーマットであっても、この強力なプラグインアーキテクチャを活用すれば、柔軟かつエレガントに対応することが可能です。 ぜひ、この知識をあなたの次のプロジェクトで活かしてみてください。