zlib.deflate と zlib.inflate

zlib.deflate (圧縮) と zlib.inflate (展開) は、 » RFC 1951 で述べられている圧縮方法を 実装したものです。deflate フィルタには、次の 3 つの パラメータを連想配列形式で渡すことができます: level は、圧縮の度合いを 1から9 までで表した ものです。数字が大きいほど圧縮後のサイズが小さくなりますが、そのぶん 処理時間が長くかかります。次の2つの値は特別な意味を持ちます。 0 (一切圧縮しない)、そして -1 (zlib のデフォルト設定 -- 現在は 6)。 window は、圧縮用ループバックウィンドウのサイズを （2 を底とする）対数で指定します。大きな値 (15 -- つまり 32768 バイトまで 引き上げる) を指定するとメモリをふんだんに利用してより小さく圧縮されます。 一方、小さな値 (9 -- つまり 512 バイトまで絞り込む) を指定すると、圧縮の 効率は落ちますがメモリの消費量を抑えられます。値を指定しなかった際の window の初期値は、現在 15 です。 zlib.deflate フィルタは DEFLATE、ZLIB、GZIP の 3 つの圧縮方法を実装しており、どれを使うかは window パラメータの値で決まります。 window パラメータの下位 4 ビットは、内部で使われる「ヒストリバッファ」の サイズを、2 を底とする対数で指定するもので、8 から 15 までの 範囲を取ります。それ以外のビットの意味は、 以下のとおりです。

• DEFLATE (» RFC 1951) は、ヘッダもチェックサムも持たない生の圧縮アルゴリズムです。 window パラメータに -9 から -15 の範囲の値を指定した場合に、この圧縮が行われます。 この圧縮アルゴリズムは、zlib.deflate フィルタが生成する すべてのフォーマットの基礎になっています。 文字列を直接扱う関数としては、gzdeflate() と gzinflate() が対応します。

• ZLIB (» RFC 1950) は、DEFLATE アルゴリズムを適用した上で、2 バイトのヘッダと、 圧縮前のデータの Adler32 チェックサムをビッグエンディアンのバイトオーダーで 格納した 4 バイトのトレーラーを追加します:

  ZLIB = ZLIBHEADER(2B)  DEFLATE  ADLER32(4B)

  2 バイトのヘッダをビッグエンディアンの 16 ビット符号なし整数として読んだ値は、 31 の倍数でなければなりません。 window パラメータに 8 から 15 の範囲の値を指定した場合に、 このフォーマットが生成されます。 文字列を直接扱う関数としては、gzcompress() と gzuncompress() が対応します。

• GZIP (» RFC 1952) は、DEFLATE アルゴリズムを適用した上で、ヘッダと、 圧縮前のデータの CRC32 チェックサムおよびその長さを、 どちらもリトルエンディアンのバイトオーダーで格納したトレーラーを追加します:

  GZIP = GZIPHEADER(10B)  DEFLATE  CRC32(4B)  LENGTH(4B)

  これが .gz ファイルのフォーマットです。 GZIPHEADER には、順に GZIP シグネチャ (\x1f\x8B)、 圧縮メソッド (\x08)、値がゼロのフラグバイト、 値がゼロの 4 バイトの更新時刻、圧縮レベルに応じた extra-flags バイト、 そして現在のオペレーティングシステム (\x00 = FAT ファイルシステム、 \x03 = Unix など) が格納されます。 window パラメータに 9+16=25 から 15+16=31 の範囲の値を指定した場合に、 このフォーマットが生成されます。 圧縮前のデータの長さには 4GB という上限があることに注意してください。 この上限を超えた場合、LENGTH の部分には実際の長さを 2^32 で割った余りだけが格納されます。 文字列を直接扱う関数としては、gzencode() と gzdecode() が対応します。また gzopen() 関数を使うと、.gz ファイルの読み書きができます。

• DEFLATE (» RFC 1951): window=-$W を指定します。$W には、圧縮時に使った値以上を指定します。 値がわからない場合は window=-15 を指定してください。

• ZLIB (» RFC 1950): window=$W を指定します。$W の値は ZLIB ヘッダから取得できます。 値がわからない場合は window=15 を指定してください。

• GZIP (» RFC 1952): window=$W+16 を指定します。GZIP ヘッダは window サイズを保持していないので、 圧縮時に使った値がわからない場合は window=31 を指定してください。

• ZLIB or GZIP: ヘッダを自動で検出させるには window=$W+32 を指定します。こうすると どちらのフォーマットも認識して展開できます。 window=15+32=47 にしておくのが安全です。

注意:

level は一番よく使われるパラメータなので、このパラメータについては （配列形式ではなく）直接整数値として設定することも可能にしています。

zlib サポートが有効な場合、 zlib.* 圧縮フィルタが利用可能になります。

<?php
$params = array('level' => 6, 'window' => 15, 'memory' => 9);

$original_text = "This is a test.\nThis is only a test.\nThis is not an important string.\n";
echo "もとのテキストの長さは " . strlen($original_text) . " 文字です。\n";

$fp = fopen('test.deflated', 'w');
stream_filter_append($fp, 'zlib.deflate', STREAM_FILTER_WRITE, $params);
fwrite($fp, $original_text);
fclose($fp);

echo "圧縮後のファイルの大きさは " . filesize('test.deflated') . " バイトです。\n";
echo "もとのテキストは:\n";
/* readfile と zlib.inflate を利用し、メモリ上で展開します */
readfile('php://filter/zlib.inflate/resource=test.deflated');

/* 生成される出力:

もとのテキストの長さは 70 文字です。
圧縮後のファイルの大きさは 56 バイトです。
もとのテキストは:
This is a test.
This is only a test.
This is not an important string.

 */
?>

<?php
$original_text = "This is a test.\nThis is only a test.\nThis is not an important string.\n";
echo "もとのテキストの長さは " . strlen($original_text) . " 文字です。\n";

$fp = fopen('test.deflated', 'w');
/* この "6" は、パラメータ "level" が 6 であるということ */
stream_filter_append($fp, 'zlib.deflate', STREAM_FILTER_WRITE, 6);
fwrite($fp, $original_text);
fclose($fp);

echo "圧縮後のファイルの大きさは " . filesize('test.deflated') . " バイトです。\n";

/* 生成される出力:

もとのテキストの長さは 70 文字です。
圧縮後のファイルの大きさは 56 バイトです。

 */
?>

bzip2.compress と bzip2.decompress

bzip2.compress と bzip2.decompress は、上で示した zlib フィルタと同じような動作をします。 bzip2.compress フィルタには、次の 2 つの パラメータを連想配列形式で渡すことができます: blocks は 1 から 9 までの整数値を設定します。 これは一時領域として割り当てるメモリのサイズを 100kバイトブロックの 数で示したものです。 work も整数値で、0 から 250 までの値を設定します。 これは、通常の圧縮方法がうまくいかなかった際に、どのくらい再試行した後で 速度の遅い（ただしより確実な）方法に切りかえるかを示します。 このパラメータは圧縮の速度のみに影響します。圧縮後のデータのサイズや 圧縮時のメモリ使用量は変わりません。0 を指定した場合は、bzip ライブラリの 初期設定値が利用されます。 bzip2.decompress フィルタには 1 つのパラメータを 渡すことができます。このパラメータは普通に論理型の値として渡すことも できますし、連想配列形式で small という名前の 要素として渡すこともできます。 small を true に設定した場合、bzip ライブラリは メモリ使用量をできるだけ抑えるようになり、その分、処理速度は遅くなります。

bz2 サポートが有効な場合、 bzip2.* 圧縮フィルタが利用可能になります。

<?php
$param = array('blocks' => 9, 'work' => 0);

echo "もとのファイルの大きさは " . filesize('LICENSE') . " バイトです。\n";

$fp = fopen('LICENSE.compressed', 'w');
stream_filter_append($fp, 'bzip2.compress', STREAM_FILTER_WRITE, $param);
fwrite($fp, file_get_contents('LICENSE'));
fclose($fp);

echo "圧縮後のファイルの大きさは " . filesize('LICENSE.compressed') . " バイトです。\n";

/* 生成される出力:

もとのファイルの大きさは 3288 バイトです。
圧縮後のファイルの大きさは 1488 バイトです。

 */
?>