php-qrcode/_sources/Appendix/Performance-considerations.md.txt

# Performance considerations

Generating a QR Code is not a trivial task - it is a combination of countless complex mathematical operations on top of rendering the output.

This library seeks not to be the fastest QR Code generator, but instead to provide flexibility and user friendlyness,
which in turn comes with a slight performance cost.


## Version

The [version of the QR symbol](./Terminology.md#version) is one of the major performance factors as it
determines the size of the symbol and therefore the amount of data that can be stored. Iterating over the internal
representation of the matrix takes more time with increasing size and the internals iterate over the matrix a LOT.

Because of that, you want to select the smallest possible version for the given data of course, which the encoder does by default.
However, sometimes the possibly varying size of the symbol may not be desired and you want to choose a fixed size, in which case
you should determine the maximum size of the input data and choose a version that fits.


## Ecc level

Another factor is the [ECC level](./Terminology.md#ecc-error-correction-coding) that determines the error correction capacity. The default setting is the lowest capacity (L, 7%)
which allows the highest amount of data to be stored and which is good enough for e.g. on-screen display or poster prints.
ECC level H on the other hand allows for up to 30% error correction capacity, which is great for "high risk" applications such as prints on mail.
With increasing error correction capacity, the maximum amount of data a symbol can hold decreases, and a higher version number may be necessary.


## Data mode

By default, the encoder auto-detects the best [mode for data encoding](Terminology.md#mode) (numeric, alphanumeric, kanji, hanzi or 8-bit binary)
and depending on the length of the given data, the detection costs an increasing amount of time. To circumvent this,
you can call one of the "add segment" methods on the `QRCode` instance, for example: `$qrcode->addByteSegment($data)`.

Generally, using 8-bit binary mode (or just "byte mode") is the fast and fail-safe mode for any kind of data, and with
[ECI](https://en.wikipedia.org/wiki/Extended_Channel_Interpretation) it even offers support for character sets other than UTF-8.
So, unless you want to fit a large amount of japanese or chinese characters into a QR symbol of a certain version,
encoding those characters as 3 or 4 byte UTF-8 may still be faster in 8-bit byte than in the "compressed" 13-bit double byte modes.


## Mask pattern

[Evaluating the QR symbol](./Terminology.md#data-masking) in order to pick the right [mask pattern](./Terminology.md#mask-pattern)
is a complex and costly operation that is necessary to ensure the symbol is readable. Although [there is an option](../Usage/Configuration-settings.md#maskpattern)
to override the evaluation and manually set a mask pattern, this is not recommended unless you know exactly what you're doing
as it can render a QR symbol unreadable.

The table below shows the performance impact (in miliseconds) of the mask pattern evaluation for select versions, the times may vary between systems.

| version | time (ms) |
|---------|----------:|
| **1**   |     2.285 |
| **5**   |     5.867 |
| **10**  |    12.737 |
| **20**  |    34.045 |
| **30**  |    64.914 |
| **40**  |   107.027 |


## Output

Output rendering depends heavily on the size of the QR matrix, the desired type and the underlying libraries and/or PHP extensions.
Especially the rendering of raster images through GD or ImageMagick can be very slow, depending on [the scale setting](../Usage/Configuration-settings.md#scale),
filters and image type.

Below a comparison of the performance for the several built-in output classes (times in miliseconds, scale = 5):

|                   |     v5 |    v10 |     v20 |     v30 |     v40 |
|-------------------|-------:|-------:|--------:|--------:|--------:|
| **QRMarkupSVG**   |  3.732 |  8.645 |  21.127 |  43.753 |  73.885 |
| **QRMarkupHTML**  |  0.522 |  1.308 |   2.761 |   5.201 |   9.572 |
| **QRGdImageBMP**  |  5.998 | 12.541 |  32.336 |  62.842 | 106.482 |
| **QRGdImageGIF**  |  3.427 |  6.817 |  17.925 |  35.136 |  57.477 |
| **QRGdImageJPEG** |  2.284 |  4.882 |  12.097 |  23.862 |  40.226 |
| **QRGdImagePNG**  |  4.523 |  9.377 |  26.207 |  49.066 |  82.074 |
| **QRGdImageWEBP** |  8.211 | 17.367 |  47.095 |  91.378 | 150.288 |
| **QRStringJSON**  |  0.043 |  0.066 |   0.158 |   0.301 |   0.492 |
| **QRStringText**  |  0.229 |  0.387 |   0.952 |   1.759 |   3.045 |
| **QRImagick**     | 37.694 | 68.808 | 172.962 | 325.085 | 529.897 |
| **QRFpdf**        |  6.578 | 12.466 |  33.021 |  61.198 | 100.059 |
| **QREps**         |  1.269 |  2.694 |   6.933 |  14.181 |  25.886 |