AaronFiore/electrum
1
0
Fork 0
Code Activity

qt: new qrreader using QtMultimedia; drop CalinsQRReader(mac)

Browse Source 
This commit ports the work of EchterAgo and cculianu from Electron-Cash,
to implement a new toolchain to scan qr codes.

Previously, on Linux and Win, we have been using zbar to access the camera
and read qrcodes; and on macOS we used CalinsQRReader (an objective-C
project by cculianu).

The new toolchain added here can use QtMultimedia to access the camera,
and then feed that image into zbar. When used this way, zbar needs
fewer dependencies and is easier to compile, in particular it can be
compiled for macOS.

The new toolchain works on all three platforms, with some caveats
(see code comments in related commits) -- so we also keep the end-to-end
zbar toolchain; but at least we can drop CalinsQRReader.

The related changes in Electron-Cash are spread over 50+ commits (several PRs and direct
pushes to master), but see in particular:
https://github.com/Electron-Cash/Electron-Cash/pull/1376

some other interesting links:
b2b737001c
163224cf1f
3b31e0fcb1
eda015908e
https://github.com/Electron-Cash/Electron-Cash/pull/1545
052aa06c23
This commit is contained in:
SomberNight
2021-06-25 15:48:22 +02:00
parent 129d5ba417
commit c1dbcab9bb
24 changed files with 1630 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
electrum/qrreader/__init__.py Normal file
View File

@@ -0,0 +1,61 @@
#!/usr/bin/env python3
#
# Electron Cash - lightweight Bitcoin client
# Copyright (C) 2019 Axel Gembe <derago@gmail.com>
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from typing import Optional
from ..logging import get_logger
from .abstract_base import AbstractQrCodeReader, QrCodeResult
_logger = get_logger(__name__)
class MissingLib(RuntimeError):
''' Raised by underlying implementation if missing libs '''
pass
def get_qr_reader() -> Optional[AbstractQrCodeReader]:
"""
Get the Qr code reader for the current platform
"""
try:
from .zbar import ZbarQrCodeReader
return ZbarQrCodeReader()
"""
# DEBUG CODE BELOW
# If you want to test this code on a platform that doesn't yet work or have
# zbar, use the below...
class Fake(AbstractQrCodeReader):
def read_qr_code(self, buffer, buffer_size, dummy, width, height, frame_id = -1):
''' fake noop to test '''
return []
return Fake()
"""
except MissingLib as e:
_logger.exception("")
return None

77
electrum/qrreader/abstract_base.py Normal file
View File

@@ -0,0 +1,77 @@
#!/usr/bin/env python3
#
# Electron Cash - lightweight Bitcoin client
# Copyright (C) 2019 Axel Gembe <derago@gmail.com>
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
import ctypes
from typing import List, Tuple
from abc import ABC, abstractmethod
QrCodePoint = Tuple[int, int]
QrCodePointList = List[QrCodePoint]
class QrCodeResult():
"""
A detected QR code.
"""
def __init__(self, data: str, center: QrCodePoint, points: QrCodePointList):
self.data: str = data
self.center: QrCodePoint = center
self.points: QrCodePointList = points
def __str__(self) -> str:
return 'data: {} center: {} points: {}'.format(self.data, self.center, self.points)
def __hash__(self):
return hash(self.data)
def __eq__(self, other):
return self.data == other.data
def __ne__(self, other):
return not self == other
class AbstractQrCodeReader(ABC):
"""
Abstract base class for QR code readers.
"""
def interval(self) -> float:
''' Reimplement to specify a time (in seconds) that the implementation
recommends elapse between subsequent calls to read_qr_code.
Implementations that have very expensive and/or slow detection code
may want to rate-limit read_qr_code calls by overriding this function.
e.g.: to make detection happen every 200ms, you would return 0.2 here.
Defaults to 0.0'''
return 0.0
@abstractmethod
def read_qr_code(self, buffer: ctypes.c_void_p,
buffer_size: int, # overall image size in bytes
rowlen_bytes: int, # the scan line length in bytes. (many libs, such as OSX, expect this value to properly grok image data)
width: int, height: int, frame_id: int = -1) -> List[QrCodeResult]:
"""
Reads a QR code from an image buffer in Y800 / GREY format.
Returns a list of detected QR codes which includes their data and positions.
"""

183
electrum/qrreader/zbar.py Normal file
View File

@@ -0,0 +1,183 @@
#!/usr/bin/env python3
#
# Electron Cash - lightweight Bitcoin client
# Copyright (C) 2019 Axel Gembe <derago@gmail.com>
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
import sys
import ctypes
import os
from typing import List
from enum import IntEnum
from ..logging import get_logger
from . import MissingLib
from .abstract_base import AbstractQrCodeReader, QrCodeResult
_logger = get_logger(__name__)
if sys.platform == 'darwin':
LIBNAME = 'libzbar.0.dylib'
elif sys.platform in ('windows', 'win32'):
LIBNAME = 'libzbar-0.dll'
else:
LIBNAME = 'libzbar.so.0'
try:
try:
LIBZBAR = ctypes.cdll.LoadLibrary(os.path.join(os.path.dirname(__file__), '..', LIBNAME))
except OSError as e:
LIBZBAR = ctypes.cdll.LoadLibrary(LIBNAME)
LIBZBAR.zbar_image_create.restype = ctypes.c_void_p
LIBZBAR.zbar_image_scanner_create.restype = ctypes.c_void_p
LIBZBAR.zbar_image_scanner_get_results.restype = ctypes.c_void_p
LIBZBAR.zbar_symbol_set_first_symbol.restype = ctypes.c_void_p
LIBZBAR.zbar_symbol_get_data.restype = ctypes.POINTER(ctypes.c_char_p)
LIBZBAR.zbar_image_scanner_set_config.argtypes = [ctypes.c_void_p, ctypes.c_int, ctypes.c_int, ctypes.c_int]
LIBZBAR.zbar_image_set_sequence.argtypes = [ctypes.c_void_p, ctypes.c_int]
LIBZBAR.zbar_image_set_size.argtypes = [ctypes.c_void_p, ctypes.c_int, ctypes.c_int]
LIBZBAR.zbar_image_set_format.argtypes = [ctypes.c_void_p, ctypes.c_int]
LIBZBAR.zbar_image_set_data.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int, ctypes.c_void_p]
LIBZBAR.zbar_image_scanner_recycle_image.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
LIBZBAR.zbar_scan_image.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
LIBZBAR.zbar_image_scanner_get_results.argtypes = [ctypes.c_void_p]
LIBZBAR.zbar_symbol_set_first_symbol.argtypes = [ctypes.c_void_p]
LIBZBAR.zbar_symbol_get_data_length.argtypes = [ctypes.c_void_p]
LIBZBAR.zbar_symbol_get_data.argtypes = [ctypes.c_void_p]
LIBZBAR.zbar_symbol_get_loc_size.argtypes = [ctypes.c_void_p]
LIBZBAR.zbar_symbol_get_loc_x.argtypes = [ctypes.c_void_p, ctypes.c_int]
LIBZBAR.zbar_symbol_get_loc_y.argtypes = [ctypes.c_void_p, ctypes.c_int]
LIBZBAR.zbar_symbol_next.argtypes = [ctypes.c_void_p]
LIBZBAR.zbar_image_scanner_destroy.argtypes = [ctypes.c_void_p]
LIBZBAR.zbar_image_destroy.argtypes = [ctypes.c_void_p]
#if is_verbose:
#LIBZBAR.zbar_set_verbosity(100)
except OSError:
_logger.exception("Failed to load zbar")
LIBZBAR = None
FOURCC_Y800 = 0x30303859
@ctypes.CFUNCTYPE(None, ctypes.c_void_p)
def zbar_cleanup(image):
"""
Do nothing, this is just so zbar doesn't try to manage our QImage buffers
"""
class ZbarSymbolType(IntEnum):
"""
Supported symbol types, see zbar_symbol_type_e in zbar.h
"""
EAN2 = 2
EAN5 = 5
EAN8 = 8
UPCE = 9
ISBN10 = 10
UPCA = 12
EAN13 = 13
ISBN13 = 14
COMPOSITE = 15
I25 = 25
DATABAR = 34
DATABAR_EXP = 35
CODABAR = 38
CODE39 = 39
PDF417 = 57
QRCODE = 64
SQCODE = 80
CODE93 = 93
CODE128 = 128
class ZbarConfig(IntEnum):
"""
Supported configuration options, see zbar_config_e in zbar.h
"""
ENABLE = 0
class ZbarQrCodeReader(AbstractQrCodeReader):
"""
Reader that uses libzbar
"""
def __init__(self):
if not LIBZBAR:
raise MissingLib('Zbar library not found')
# Set up zbar
self.zbar_scanner = LIBZBAR.zbar_image_scanner_create()
self.zbar_image = LIBZBAR.zbar_image_create()
# Disable all symbols
for sym_type in ZbarSymbolType:
LIBZBAR.zbar_image_scanner_set_config(self.zbar_scanner, sym_type, ZbarConfig.ENABLE, 0)
# Enable only QR codes
LIBZBAR.zbar_image_scanner_set_config(self.zbar_scanner, ZbarSymbolType.QRCODE,
ZbarConfig.ENABLE, 1)
def __del__(self):
if LIBZBAR:
LIBZBAR.zbar_image_scanner_destroy(self.zbar_scanner)
LIBZBAR.zbar_image_destroy(self.zbar_image)
def read_qr_code(self, buffer: ctypes.c_void_p, buffer_size: int,
rowlen_bytes: int, # this param is ignored in this implementation
width: int, height: int, frame_id: int = -1) -> List[QrCodeResult]:
LIBZBAR.zbar_image_set_sequence(self.zbar_image, frame_id)
LIBZBAR.zbar_image_set_size(self.zbar_image, width, height)
LIBZBAR.zbar_image_set_format(self.zbar_image, FOURCC_Y800)
LIBZBAR.zbar_image_set_data(self.zbar_image, buffer, buffer_size, zbar_cleanup)
LIBZBAR.zbar_image_scanner_recycle_image(self.zbar_scanner, self.zbar_image)
LIBZBAR.zbar_scan_image(self.zbar_scanner, self.zbar_image)
result_set = LIBZBAR.zbar_image_scanner_get_results(self.zbar_scanner)
res = []
symbol = LIBZBAR.zbar_symbol_set_first_symbol(result_set)
while symbol:
symbol_data_len = LIBZBAR.zbar_symbol_get_data_length(symbol)
symbol_data_ptr = LIBZBAR.zbar_symbol_get_data(symbol)
symbol_data_bytes = ctypes.string_at(symbol_data_ptr, symbol_data_len)
symbol_data = symbol_data_bytes.decode('utf-8')
symbol_loc = []
symbol_loc_len = LIBZBAR.zbar_symbol_get_loc_size(symbol)
for i in range(0, symbol_loc_len):
# Normalize the coordinates into 0..1 range by dividing by width / height
symbol_loc_x = LIBZBAR.zbar_symbol_get_loc_x(symbol, i)
symbol_loc_y = LIBZBAR.zbar_symbol_get_loc_y(symbol, i)
symbol_loc.append((symbol_loc_x, symbol_loc_y))
# Find the center by getting the average values of the corners x and y coordinates
symbol_loc_sum_x = sum([l[0] for l in symbol_loc])
symbol_loc_sum_y = sum([l[1] for l in symbol_loc])
symbol_loc_center = (int(symbol_loc_sum_x / symbol_loc_len), int(symbol_loc_sum_y / symbol_loc_len))
res.append(QrCodeResult(symbol_data, symbol_loc_center, symbol_loc))
symbol = LIBZBAR.zbar_symbol_next(symbol)
return res