ネットワーク　その７　ビットフィールドで圧縮

ビットフィールドは古くから知られている素晴らしいデータパッキング手法です。C#プログラマーがビットフィールドを使う機会は非常に少ないですが、ネットワークパケットの圧縮にはもってこいなので、この機会に使ってみましょう。

バイトは８ビット、intは３２ビット。でも、送るべきデータが８ビットや３２ビットの倍数にならないときはどうします？例えば以下のようなデータを送るとします。

    bool isAlive;       // 生きているか？
    bool isFiring;      // 撃っているか？

    enum Species    // 種類
    {
        Camel,          // ラクダ
        Cat,            // ねこ
        Caterpillar,    // いもむし
        Cheetah,        // チーター
        Chimpanzee,     // チンパンジー
        Cobra,          // コブラ
        Cormorant,      // 鵜(う)
        Cougar,         // クーガー
        Coyote,         // コヨーテ
        Crab,           // カニ
        Crocodile,      // ワニ
    }

    packetWriter.Write(isAlive);
    packetWriter.Write(isFiring);
    packetWriter.Write((byte)species)

これで３バイトになりますが、実際にはそんなにいりません。ブーリアン型は１ビットしか必要としませんし、生物の種類も１１種しか居ないので４ビットで足ります。

それぞれのフィールドにどれだけのビット数が必要かが判れば、ビットシフトすることによって複数のビット群を１つbyteやintにまとめることができます。使いやすいように、指定されたビット群をbyteやintといった値にまとめるメソッドを作るといいでしょう。

ここでは、先の例では３バイトを送っていたところを１バイトにまとめて送ることができます(まだ２ビット余ってる)

    void AddToBitfield( ref int bitfield, int bitCount, int value )
    {
        bitfield <<= bitCount;
        bitfield |= value;
    }

    int bitfield = 0;
    AddToBitfield( ref bitfield, 1, isAlive? 1: 0 );
    AddToBitfield( ref bitfield, 1, isFiring? 1: 0 );
    AddToBitfield( ref bitfield, 4, (int)species );

    packetWriter.Write((byte)bitfield);

AddToBitfieldメソッドは２つのことをします

現在のビットフィールドを左シフト(「<<」演算子を使う)して、新しいフィールドを確保
新しいビット群を設定(「|」演算子を使う)

読み込むためには、逆のプロセスを行います。

    int ReadFromBitfield( ref int bitfield, int bitCount )
    {
        int value = bitfield & ((1 << bitCount) - 1 );
        bitfield >>= bitCount;
        return value;
    }

    int bitfield = PacketReader.ReadByte();
    species = (Species)ReadFromBitfield( ref bitfield, 4 );
    isFiring = ReadFromBitfield( ref bitfield, 1 ) != 0;
    isAlive = ReadFromBitfield( ref bitfield, 1 ) != 0;