QRbitstream.php

<?php
/*
 * PHP QR Code encoder
 *
 * Bitstream class
 *
 * Based on libqrencode C library distributed under LGPL 2.1
 * Copyright (C) 2006, 2007, 2008, 2009 Kentaro Fukuchi <fukuchi@megaui.net>
 *
 * PHP QR Code is distributed under LGPL 3
 * Copyright (C) 2010-2013 Dominik Dzienia <deltalab at poczta dot fm>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */
    
	/** @addtogroup CoreGroup */
	/** @{ */
	
    /**
    PHP bit stream.
    Class implementing array of bits (= 1 or 0 ints). Allows to initialize and append
    bits from given Integer or array of Bytes.
    */
    class QRbitstream {
    
        /**
        Array containing bit data stream 
        */
        public $data = array();
        
        //----------------------------------------------------------------------
        /** 
        @return Integer size of byte stream
        */
        public function size()
        {
            return count($this->data);
        }
        
        //----------------------------------------------------------------------
        /** 
        Allocates bit stream, fills bit data stream with 0's.
        This operation is __destructive__, will replace orginal stream contents!
        @param Integer $setLength desired target stream size
        @return Integer 0 on success, other on failure
        */
        public function allocate($setLength)
        {
            $this->data = array_fill(0, $setLength, 0);
            return 0;
        }
    
        //----------------------------------------------------------------------
        /**
        Creates new bit stream from given Integer number.
        @param Integer $bits bit count 
        @param Integer $num integer to convert
        @return QRbitstream bit stream object containing first $bits bits from $num in order from LSB to MSB
        */
        public static function newFromNum($bits, $num)
        {
            $bstream = new QRbitstream();
            $bstream->allocate($bits);
            
            $mask = 1 << ($bits - 1);
            for($i=0; $i<$bits; $i++) {
                if($num & $mask) {
                    $bstream->data[$i] = 1;
                } else {
                    $bstream->data[$i] = 0;
                }
                $mask = $mask >> 1;
            }

            return $bstream;
        }
        
        //----------------------------------------------------------------------
        /**
        Creates new bit stream from given byte array.
        @param Integer $size size of array
        @param Array $data array ob bytes
        @return QRbitstream bit stream object containing bit contents of given bytes array
        */
        public static function newFromBytes($size, $data)
        {
            $bstream = new QRbitstream();
            $bstream->allocate($size * 8);
            $p=0;

            for($i=0; $i<$size; $i++) {
                $mask = 0x80;
                for($j=0; $j<8; $j++) {
                    if($data[$i] & $mask) {
                        $bstream->data[$p] = 1;
                    } else {
                        $bstream->data[$p] = 0;
                    }
                    $p++;
                    $mask = $mask >> 1;
                }
            }

            return $bstream;
        }
        
        //----------------------------------------------------------------------
        /**
        Appends given bit stream at end of this stream.
        @param QRbitstream $arg bit stream to be appended
        @return Integer status of append operation, 0 when success, -1 when $arg is null
        */
        public function append(QRbitstream $arg)
        {
            if (is_null($arg)) {
                return -1;
            }
            
            if($arg->size() == 0) {
                return 0;
            }
            
            if($this->size() == 0) {
                $this->data = $arg->data;
                return 0;
            }
            
            $this->data = array_values(array_merge($this->data, $arg->data));

            return 0;
        }
        
        //----------------------------------------------------------------------
        /**
        Appends bit stream cteated from given Integer number at end of current stream.
        @param Integer $bits bit count 
        @param Integer $num integer to convert
        @return Integer status of append operation, status of append operation, 0 when success, -1 otherwise
        */
        public function appendNum($bits, $num)
        {
            if ($bits == 0) 
                return 0;

            $b = QRbitstream::newFromNum($bits, $num);
            
            if(is_null($b))
                return -1;

            $ret = $this->append($b);
            unset($b);

            return $ret;
        }

        //----------------------------------------------------------------------
        /**
        Appends bit stream created from from given byte array at end of current stream.
        @param Integer $size size of array
        @param Array $data array ob bytes
        @return Integer status of append operation, status of append operation, 0 when success, -1 otherwise
        */
        public function appendBytes($size, $data)
        {
            if ($size == 0) 
                return 0;

            $b = QRbitstream::newFromBytes($size, $data);
            
            if(is_null($b))
                return -1;

            $ret = $this->append($b);
            unset($b);

            return $ret;
        }
        
        //----------------------------------------------------------------------
        /** 
        Converts current bit stream into byte array.
        @returns Array array of bytes
        */
        public function toByte()
        {
        
            $size = $this->size();

            if($size == 0) {
                return array();
            }
            
            $data = array_fill(0, (int)(($size + 7) / 8), 0);
            $bytes = (int)($size / 8);

            $p = 0;
            
            for($i=0; $i<$bytes; $i++) {
                $v = 0;
                for($j=0; $j<8; $j++) {
                    $v = $v << 1;
                    $v |= $this->data[$p];
                    $p++;
                }
                $data[$i] = $v;
            }
            
            if($size & 7) {
                $v = 0;
                for($j=0; $j<($size & 7); $j++) {
                    $v = $v << 1;
                    $v |= $this->data[$p];
                    $p++;
                }
                $data[$bytes] = $v;
            }

            return $data;
        }

    }

	/** @}*/