zxing_barcode_reader.dart
8.48 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
import 'dart:async';
import 'dart:js_interop';
import 'dart:ui';
import 'package:mobile_scanner/src/enums/barcode_format.dart';
import 'package:mobile_scanner/src/enums/camera_facing.dart';
import 'package:mobile_scanner/src/enums/torch_state.dart';
import 'package:mobile_scanner/src/objects/barcode_capture.dart';
import 'package:mobile_scanner/src/objects/start_options.dart';
import 'package:mobile_scanner/src/web/barcode_reader.dart';
import 'package:mobile_scanner/src/web/javascript_map.dart';
import 'package:mobile_scanner/src/web/media_track_constraints_delegate.dart';
import 'package:mobile_scanner/src/web/zxing/result.dart';
import 'package:mobile_scanner/src/web/zxing/zxing_browser_multi_format_reader.dart';
import 'package:web/web.dart' as web;
// TODO: remove the JSAny casts once upgraded to a package:web version that restores "implements JSAny"
/// A barcode reader implementation that uses the ZXing library.
final class ZXingBarcodeReader extends BarcodeReader {
ZXingBarcodeReader();
/// The listener for media track settings changes.
void Function(web.MediaTrackSettings)? _onMediaTrackSettingsChanged;
/// The internal media stream track constraints delegate.
final MediaTrackConstraintsDelegate _mediaTrackConstraintsDelegate =
const MediaTrackConstraintsDelegate();
/// The internal barcode reader.
ZXingBrowserMultiFormatReader? _reader;
@override
bool get isScanning => _reader?.stream != null;
@override
Size get videoSize {
final web.HTMLVideoElement? videoElement = _reader?.videoElement;
if (videoElement == null) {
return Size.zero;
}
return Size(
videoElement.videoWidth.toDouble(),
videoElement.videoHeight.toDouble(),
);
}
@override
String get scriptUrl => 'https://unpkg.com/@zxing/library@0.19.1';
/// Get the barcode format from the ZXing library, for the given [format].
static int getZXingBarcodeFormat(BarcodeFormat format) {
switch (format) {
case BarcodeFormat.aztec:
return 0;
case BarcodeFormat.codabar:
return 1;
case BarcodeFormat.code39:
return 2;
case BarcodeFormat.code93:
return 3;
case BarcodeFormat.code128:
return 4;
case BarcodeFormat.dataMatrix:
return 5;
case BarcodeFormat.ean8:
return 6;
case BarcodeFormat.ean13:
return 7;
case BarcodeFormat.itf:
return 8;
case BarcodeFormat.pdf417:
return 10;
case BarcodeFormat.qrCode:
return 11;
case BarcodeFormat.upcA:
return 14;
case BarcodeFormat.upcE:
return 15;
case BarcodeFormat.unknown:
case BarcodeFormat.all:
default:
return -1;
}
}
JSMap? _createReaderHints(List<BarcodeFormat> formats) {
if (formats.isEmpty || formats.contains(BarcodeFormat.all)) {
return null;
}
final JSMap hints = JSMap();
// Set the formats hint.
// See https://github.com/zxing-js/library/blob/master/src/core/DecodeHintType.ts#L45
hints.set(
2.toJS,
[
for (final BarcodeFormat format in formats)
getZXingBarcodeFormat(format).toJS,
].toJS,
);
return hints;
}
/// Prepare the [web.MediaStream] for the barcode reader video input.
///
/// This method requests permission to use the camera.
Future<web.MediaStream?> _prepareMediaStream(
CameraFacing cameraDirection,
) async {
if ((web.window.navigator.mediaDevices as JSAny?).isUndefinedOrNull) {
return null;
}
final capabilities =
web.window.navigator.mediaDevices.getSupportedConstraints();
final web.MediaStreamConstraints constraints;
if ((capabilities as JSAny).isUndefinedOrNull || !capabilities.facingMode) {
constraints = web.MediaStreamConstraints(video: true.toJS);
} else {
final String facingMode = switch (cameraDirection) {
CameraFacing.back => 'environment',
CameraFacing.front => 'user',
};
constraints = web.MediaStreamConstraints(
video: web.MediaTrackConstraintSet(
facingMode: facingMode.toJS,
) as JSAny,
);
}
final JSAny? mediaStream = await web.window.navigator.mediaDevices
.getUserMedia(constraints)
.toDart;
return mediaStream as web.MediaStream?;
}
/// Prepare the video element for the barcode reader.
///
/// The given [videoElement] is attached to the DOM, by attaching it to the [containerElement].
/// The camera video output is then attached to both the barcode reader (to detect barcodes),
/// and the video element (to display the camera output).
Future<void> _prepareVideoElement(
web.HTMLVideoElement videoElement, {
required CameraFacing cameraDirection,
required web.HTMLElement containerElement,
}) async {
// Attach the video element to the DOM, through its parent container.
containerElement.appendChild(videoElement);
// Set up the camera output stream.
// This will request permission to use the camera.
final web.MediaStream? stream = await _prepareMediaStream(cameraDirection);
if (stream != null) {
final JSPromise? result = _reader?.attachStreamToVideo.callAsFunction(
null,
stream as JSAny,
videoElement as JSAny,
) as JSPromise?;
await result?.toDart;
final web.MediaTrackSettings? settings =
_mediaTrackConstraintsDelegate.getSettings(stream);
if (settings != null) {
_onMediaTrackSettingsChanged?.call(settings);
}
}
}
@override
Stream<BarcodeCapture> detectBarcodes() {
final controller = StreamController<BarcodeCapture>();
controller.onListen = () {
_reader?.decodeContinuously.callAsFunction(
null,
_reader?.videoElement as JSAny?,
(Result? result, JSAny? error) {
if (!controller.isClosed && result != null) {
controller.add(
BarcodeCapture(
barcodes: [result.toBarcode],
),
);
}
}.toJS,
);
};
// The onCancel() method of the controller is called
// when the stream subscription returned by this method is cancelled in `MobileScannerWeb.stop()`.
// This avoids both leaving the barcode scanner running and a memory leak for the stream subscription.
controller.onCancel = () async {
_reader?.stopContinuousDecode.callAsFunction();
_reader?.reset.callAsFunction();
await controller.close();
};
return controller.stream;
}
@override
Future<bool> hasTorch() {
final web.MediaStream? mediaStream = _reader?.stream;
if (mediaStream == null) {
return Future<bool>.value(false);
}
return _mediaTrackConstraintsDelegate.hasFlashlight(mediaStream);
}
@override
void setMediaTrackSettingsListener(
void Function(web.MediaTrackSettings) listener,
) {
_onMediaTrackSettingsChanged ??= listener;
}
@override
Future<void> setTorchState(TorchState value) async {
switch (value) {
case TorchState.unavailable:
return Future<void>.value();
case TorchState.off:
case TorchState.on:
final web.MediaStream? mediaStream = _reader?.stream;
if (mediaStream == null) {
return Future<void>.value();
}
await _mediaTrackConstraintsDelegate.setFlashlightState(
mediaStream,
value,
);
final web.MediaTrackSettings? settings =
_mediaTrackConstraintsDelegate.getSettings(mediaStream);
if (settings != null) {
_onMediaTrackSettingsChanged?.call(settings);
}
}
}
@override
Future<void> start(
StartOptions options, {
required web.HTMLElement containerElement,
}) async {
final int detectionTimeoutMs = options.detectionTimeoutMs;
final List<BarcodeFormat> formats = options.formats;
if (formats.contains(BarcodeFormat.unknown)) {
formats.removeWhere((element) => element == BarcodeFormat.unknown);
}
_reader = ZXingBrowserMultiFormatReader(
_createReaderHints(formats),
detectionTimeoutMs.toJS,
);
final web.HTMLVideoElement videoElement =
web.document.createElement('video') as web.HTMLVideoElement;
await _prepareVideoElement(
videoElement,
cameraDirection: options.cameraDirection,
containerElement: containerElement,
);
}
@override
Future<void> stop() async {
_onMediaTrackSettingsChanged = null;
_reader?.stopContinuousDecode.callAsFunction();
_reader?.reset.callAsFunction();
_reader = null;
}
}