This project is Qt & Qml wrapper for ZXing-C++ Library that is used for decoding and generating 1D and 2D barcodes. This particular C++ ZXing port is one of the most recent C++ versions of popular ZXing library using modern compilers.
The goal of this project was to create convenient filter allowing to process video frame from phone camera. Thanks to SCodes you can start scanning barcodes in few steps. We used Qt 5.15 to built both wrapper and example application, but it's compatible with older Qt versions as well. Feel free to read "How to scan barcodes in Qt Qml application" blog post if you are interested in the details behind scanning mechanism. This blog post contains step by step tutorial on how to do that.
SCodes supports generating barcodes as well. It is covered in "How to generate barcode in Qt Qml" application blog post.
There are plenty of supported formats and we constantly work on adding new.
| Format | Supports scanning | Supports generating |
|---|---|---|
| UPC-A | ✔️ | ✔️ |
| UPC-E | ✔️ | ✔️ |
| EAN-8 | ✔️ | ✔️ |
| EAN-13 | ✔️ | ✔️ |
| DataBar | ✔️ | ❌ |
| DataBar Expanded | ❌ | ❌ |
| Code 39 | ✔️ | ✔️ |
| Code 93 | ✔️ | ✔️ |
| Code 128 | ✔️ | ✔️ |
| Codabar | ✔️ | ✔️ |
| ITF | ❌ | ✔️ |
| Format | Supports scanning | Supports generating |
|---|---|---|
| QR Code | ✔️ | ✔️ |
| DataMatrix | ✔️ | ✔️ |
| Aztec | ✔️ | ✔️ |
| PDF417 | ✔️ | ✔️ |
| MaxiCode | ❌ | ❌ |
All you need to do is to follow these steps.
- Add SCodes as submodule, by typing
git submodule add git@gitlab.com:scythestudio/scodes.git - Update submodule
git submodule update --recursive --init(you can also put wrapper files to your project manually without adding submodule) - Add
include(scodes/src/SCodes.prito your .pro file - Import SCodes in your Qml file
import com.scythestudio.scodes 1.0 - Import multimedia module
import QtMultimedia 5.15 - If build fails, try to add
CONFIG += c++17to your .pro file - You are done. Get inspired by QML Barcode Reader demo to test wrapper.
- Add SCodes as submodule, by typing
git submodule add git@gitlab.com:scythestudio/scodes.git - Update submodule
git submodule update --recursive --init(you can also put wrapper files to your project manually without adding submodule) - Add to your project SCodes library
add_subdirectory(SCodes)- Link SCodes library to your library or executable.
target_link_libraries(${PROJECT_NAME} PUBLIC SCodes)- Import SCodes in your Qml file
import com.scythestudio.scodes 1.0- You are done. Get inspired by QML Barcode Reader demo to test wrapper.
SBarcodeFilter is a class that you need to use for scanning case. By default it scans only specific basic formats of code (Code 39, Code 93, Code 128, QR Code and DataMatrix.).
The goal of that is to limit number of possible formats and improve performance.
To specify formats that should be accepted by the SBarcodeFilter instance, you need to set it's format property accordingly. This property allows setting multiple enum values as it's for flags. Add the following to your SBarcodeFilter item in Qml code:
Component.onCompleted: {
barcodeFilter.format = SCodes.OneDCodes
}See the enumeration values that represent supported formats in SBarcodeFormat.h
To accept all supported formats use SCodes.Any.
If you use Qt version older than 5.15 you need to manually register SBarcodeFilter e.g. in main.cpp. Use this line for this purpose:
qmlRegisterType<MyClass>("com.scythestudio.scodes", 1, 0, "SBarcodeFilter");Don't forget to firstly include SBarcodeFilter.
In the case of barcodes scanning you will need to expose SBarcodeGenerator class. If you are using SCodes for this case, check our QML Barcode Generator demo to do that easily!
SCodes project was developed and is maintained mainly by Scythe Studio company. We are an official Qt Service Partner and a provider of Qt Software Development services including:
- Desktop applications development
- Mobile applications development
- Embedded systems development
- Qt and C++ consulting
- UI/UX designing
Do not hesitate visting https://scythe-studio.com to discover our capabilities and learn more about Qt Software Development from Scythe Studio Blog.