Artifact 7228665d7ca2b6c7190c31bc0eb45a71aa72f495:

0000: 44 20 32 30 31 39 2d 30 34 2d 32 36 54 30 36 3a  D 2019-04-26T06:
0010: 34 37 3a 32 36 2e 35 37 35 0a 4c 20 64 6d 74 78  47:26.575.L dmtx
0020: 5c 73 63 6f 6d 6d 61 6e 64 0a 50 20 35 37 38 36  \scommand.P 5786
0030: 30 31 31 30 31 63 31 39 31 30 34 35 66 30 63 35  01101c191045f0c5
0040: 33 38 30 62 39 63 38 32 62 38 30 65 61 63 63 63  380b9c82b80eaccc
0050: 35 39 30 63 0a 55 20 63 68 77 0a 57 20 32 37 31  590c.U chw.W 271
0060: 31 0a 3c 68 32 3e 64 6d 74 78 20 63 6f 6d 6d 61  1.<h2>dmtx comma
0070: 6e 64 3c 2f 68 32 3e 0d 0a 0d 0a 3c 68 33 3e 4e  nd</h2>....<h3>N
0080: 61 6d 65 3c 2f 68 33 3e 0d 0a 0d 0a 3c 62 3e 64  ame</h3>....<b>d
0090: 6d 74 78 3a 3a 2a 3c 2f 62 3e 20 2d 20 69 6e 74  mtx::*</b> - int
00a0: 65 72 66 61 63 65 20 74 6f 20 74 68 65 20 6c 69  erface to the li
00b0: 62 64 6d 74 78 2e 6f 72 67 20 44 61 74 61 20 4d  bdmtx.org Data M
00c0: 61 74 72 69 78 20 43 6f 64 65 20 73 63 61 6e 6e  atrix Code scann
00d0: 65 72 20 6c 69 62 72 61 72 79 2e 0d 0a 0d 0a 3c  er library.....<
00e0: 68 33 3e 53 79 6e 6f 70 73 69 73 3c 2f 68 33 3e  h3>Synopsis</h3>
00f0: 0d 0a 0d 0a 3c 74 74 3e 70 61 63 6b 61 67 65 20  ....<tt>package 
0100: 72 65 71 75 69 72 65 20 64 6d 74 78 3c 2f 74 74  require dmtx</tt
0110: 3e 3c 62 72 3e 0d 0a 3c 74 74 3e 64 6d 74 78 3a  ><br>..<tt>dmtx:
0120: 3a 64 65 63 6f 64 65 20 3f 6f 70 74 69 6f 6e 73  :decode ?options
0130: 3f 3c 2f 74 74 3e 3c 62 72 3e 0d 0a 3c 74 74 3e  ?</tt><br>..<tt>
0140: 64 6d 74 78 3a 3a 61 73 79 6e 63 5f 64 65 63 6f  dmtx::async_deco
0150: 64 65 20 3f 6f 70 74 69 6f 6e 73 3f 3c 2f 74 74  de ?options?</tt
0160: 3e 0d 0a 0d 0a 3c 68 33 3e 44 65 73 63 72 69 70  >....<h3>Descrip
0170: 74 69 6f 6e 3c 2f 68 33 3e 0d 0a 0d 0a 54 68 65  tion</h3>....The
0180: 73 65 20 63 6f 6d 6d 61 6e 64 73 20 61 72 65 20  se commands are 
0190: 75 73 65 64 20 74 6f 20 73 63 61 6e 20 44 61 74  used to scan Dat
01a0: 61 20 4d 61 74 72 69 78 20 43 6f 64 65 73 20 6f  a Matrix Codes o
01b0: 66 66 20 70 69 78 65 6c 20 69 6d 61 67 65 20 64  ff pixel image d
01c0: 61 74 61 2e 0d 0a 0d 0a 3c 74 74 3e 64 6d 74 78  ata.....<tt>dmtx
01d0: 3a 3a 64 65 63 6f 64 65 20 3c 69 3e 70 68 6f 74  ::decode <i>phot
01e0: 6f 45 74 63 3c 2f 69 3e 20 3f 3c 69 3e 73 63 61  oEtc</i> ?<i>sca
01f0: 6c 65 20 74 69 6d 65 6f 75 74 3c 2f 69 3e 3f 3c  le timeout</i>?<
0200: 2f 74 74 3e 0d 0a 0d 0a 20 20 20 20 53 63 61 6e  /tt>....    Scan
0210: 73 20 74 68 65 20 70 68 6f 74 6f 20 69 6d 61 67  s the photo imag
0220: 65 20 3c 74 74 3e 3c 69 3e 70 68 6f 74 6f 45 74  e <tt><i>photoEt
0230: 63 3c 2f 69 3e 3c 2f 74 74 3e 20 66 6f 72 20 44  c</i></tt> for D
0240: 61 74 61 20 4d 61 74 72 69 78 20 43 6f 64 65 20  ata Matrix Code 
0250: 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e 20 41 6c 74  information. Alt
0260: 65 72 6e 61 74 69 76 65 6c 79 2c 20 3c 74 74 3e  ernatively, <tt>
0270: 3c 69 3e 70 68 6f 74 6f 45 74 63 3c 2f 69 3e 3c  <i>photoEtc</i><
0280: 2f 74 74 3e 20 63 61 6e 20 62 65 20 61 20 66 6f  /tt> can be a fo
0290: 75 72 20 65 6c 65 6d 65 6e 74 20 6c 69 73 74 20  ur element list 
02a0: 64 65 73 63 72 69 62 69 6e 67 20 61 20 67 72 65  describing a gre
02b0: 79 73 63 61 6c 65 20 6f 72 20 52 47 42 20 69 6d  yscale or RGB im
02c0: 61 67 65 20 61 73 20 61 20 62 79 74 65 20 61 72  age as a byte ar
02d0: 72 61 79 2e 20 54 68 65 20 65 6c 65 6d 65 6e 74  ray. The element
02e0: 73 20 6d 75 73 74 20 62 65 20 77 69 64 74 68 2c  s must be width,
02f0: 20 68 65 69 67 68 74 2c 20 64 65 70 74 68 20 61   height, depth a
0300: 6e 64 20 62 79 74 65 20 61 72 72 61 79 20 6f 66  nd byte array of
0310: 20 74 68 65 20 69 6d 61 67 65 20 69 6e 20 74 68   the image in th
0320: 69 73 20 6f 72 64 65 72 2e 20 54 68 65 20 6f 70  is order. The op
0330: 74 69 6f 6e 61 6c 20 69 6e 74 65 67 65 72 20 70  tional integer p
0340: 61 72 61 6d 65 74 65 72 20 3c 74 74 3e 3c 69 3e  arameter <tt><i>
0350: 73 63 61 6c 65 3c 2f 69 3e 3c 2f 74 74 3e 20 64  scale</i></tt> d
0360: 6f 77 6e 73 61 6d 70 6c 65 73 20 74 68 65 20 69  ownsamples the i
0370: 6d 61 67 65 20 62 65 66 6f 72 65 20 74 68 65 20  mage before the 
0380: 73 63 61 6e 20 74 61 6b 65 73 20 70 6c 61 63 65  scan takes place
0390: 2e 20 54 68 65 20 6f 70 74 69 6f 6e 61 6c 20 3c  . The optional <
03a0: 74 74 3e 3c 69 3e 74 69 6d 65 6f 75 74 3c 2f 69  tt><i>timeout</i
03b0: 3e 3c 2f 74 74 3e 20 6c 69 6d 69 74 73 20 74 68  ></tt> limits th
03c0: 65 20 73 63 61 6e 20 70 72 6f 63 65 73 73 20 74  e scan process t
03d0: 6f 20 74 68 61 74 20 6d 61 6e 79 20 6d 69 6c 6c  o that many mill
03e0: 69 73 65 63 6f 6e 64 73 2e 20 54 68 65 20 63 6f  iseconds. The co
03f0: 6d 6d 61 6e 64 20 72 65 74 75 72 6e 73 20 61 20  mmand returns a 
0400: 74 68 72 65 65 20 65 6c 65 6d 65 6e 74 20 6c 69  three element li
0410: 73 74 20 6d 61 64 65 20 75 70 20 6f 66 20 61 20  st made up of a 
0420: 66 6c 61 67 20 69 6e 64 69 63 61 74 69 6e 67 20  flag indicating 
0430: 73 75 63 63 65 73 73 20 28 3d 31 29 20 6f 72 20  success (=1) or 
0440: 66 61 69 6c 75 72 65 20 28 3d 30 29 20 6f 66 20  failure (=0) of 
0450: 74 68 65 20 73 63 61 6e 20 70 72 6f 63 65 73 73  the scan process
0460: 2c 20 74 68 65 20 61 6d 6f 75 6e 74 20 6f 66 20  , the amount of 
0470: 6d 69 6c 6c 69 73 65 63 6f 6e 64 73 20 73 70 65  milliseconds spe
0480: 6e 74 20 6f 6e 20 64 65 63 6f 64 69 6e 67 2c 20  nt on decoding, 
0490: 61 6e 64 20 74 68 65 20 73 63 61 6e 20 72 65 73  and the scan res
04a0: 75 6c 74 20 61 73 20 61 20 62 79 74 65 20 61 72  ult as a byte ar
04b0: 72 61 79 2e 0d 0a 0d 0a 3c 74 74 3e 64 6d 74 78  ray.....<tt>dmtx
04c0: 3a 3a 61 73 79 6e 63 5f 64 65 63 6f 64 65 20 3c  ::async_decode <
04d0: 69 3e 70 68 6f 74 6f 45 74 63 20 63 61 6c 6c 62  i>photoEtc callb
04e0: 61 63 6b 3c 2f 69 3e 20 3f 3c 69 3e 73 63 61 6c  ack</i> ?<i>scal
04f0: 65 20 74 69 6d 65 6f 75 74 3c 2f 69 3e 3f 3c 2f  e timeout</i>?</
0500: 74 74 3e 0d 0a 0d 0a 20 20 20 20 53 69 6d 69 6c  tt>....    Simil
0510: 61 72 20 74 6f 20 3c 74 74 3e 64 6d 74 78 3a 3a  ar to <tt>dmtx::
0520: 64 65 63 6f 64 65 3c 2f 74 74 3e 20 62 75 74 20  decode</tt> but 
0530: 74 68 65 20 64 65 63 6f 64 65 72 20 69 73 20 72  the decoder is r
0540: 75 6e 20 61 73 20 61 20 62 61 63 6b 67 72 6f 75  un as a backgrou
0550: 6e 64 20 74 68 72 65 61 64 20 61 6e 64 20 74 68  nd thread and th
0560: 65 20 72 65 73 75 6c 74 20 69 73 20 70 72 65 73  e result is pres
0570: 65 6e 74 65 64 20 74 6f 20 61 20 3c 74 74 3e 3c  ented to a <tt><
0580: 69 3e 63 61 6c 6c 62 61 63 6b 3c 2f 69 3e 3c 2f  i>callback</i></
0590: 74 74 3e 20 70 72 6f 63 65 64 75 72 65 2e 20 49  tt> procedure. I
05a0: 74 20 72 65 71 75 69 72 65 73 20 74 68 65 20 54  t requires the T
05b0: 63 6c 20 63 6f 72 65 20 62 65 69 6e 67 20 62 75  cl core being bu
05c0: 69 6c 74 20 77 69 74 68 20 74 68 72 65 61 64 20  ilt with thread 
05d0: 73 75 70 70 6f 72 74 2c 20 61 6e 64 20 61 20 72  support, and a r
05e0: 75 6e 6e 69 6e 67 20 65 76 65 6e 74 20 6c 6f 6f  unning event loo
05f0: 70 20 73 69 6e 63 65 20 74 68 65 20 63 61 6c 6c  p since the call
0600: 62 61 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64 20  back is invoked 
0610: 61 73 20 61 6e 20 65 76 65 6e 74 20 6f 72 20 64  as an event or d
0620: 6f 2d 77 68 65 6e 2d 69 64 6c 65 20 68 61 6e 64  o-when-idle hand
0630: 6c 65 72 2e 20 54 68 72 65 65 20 61 64 64 69 74  ler. Three addit
0640: 69 6f 6e 61 6c 20 61 72 67 75 6d 65 6e 74 73 20  ional arguments 
0650: 61 72 65 20 70 61 73 73 65 64 20 74 6f 20 3c 74  are passed to <t
0660: 74 3e 3c 69 3e 63 61 6c 6c 62 61 63 6b 3c 2f 69  t><i>callback</i
0670: 3e 3c 2f 74 74 3e 3a 20 61 20 66 6c 61 67 20 69  ></tt>: a flag i
0680: 6e 64 69 63 61 74 69 6e 67 20 73 75 63 63 65 73  ndicating succes
0690: 73 20 28 3d 31 29 20 6f 72 20 66 61 69 6c 75 72  s (=1) or failur
06a0: 65 20 28 3d 30 29 20 6f 66 20 74 68 65 20 73 63  e (=0) of the sc
06b0: 61 6e 20 70 72 6f 63 65 73 73 2c 20 74 68 65 20  an process, the 
06c0: 6e 75 6d 62 65 72 20 6f 66 20 6d 69 6c 6c 69 73  number of millis
06d0: 65 63 6f 6e 64 73 20 66 6f 72 20 64 65 63 6f 64  econds for decod
06e0: 69 6e 67 2c 20 61 6e 64 20 74 68 65 20 73 63 61  ing, and the sca
06f0: 6e 20 72 65 73 75 6c 74 20 61 73 20 61 20 62 79  n result as a by
0700: 74 65 20 61 72 72 61 79 2e 20 54 68 65 20 6f 70  te array. The op
0710: 74 69 6f 6e 61 6c 20 70 61 72 61 6d 65 74 65 72  tional parameter
0720: 73 20 3c 74 74 3e 3c 69 3e 73 63 61 6c 65 3c 2f  s <tt><i>scale</
0730: 69 3e 3c 2f 74 74 3e 20 61 6e 64 20 3c 74 74 3e  i></tt> and <tt>
0740: 3c 69 3e 74 69 6d 65 6f 75 74 3c 2f 69 3e 3c 2f  <i>timeout</i></
0750: 74 74 3e 20 68 61 76 65 20 74 68 65 20 73 61 6d  tt> have the sam
0760: 65 20 6d 65 61 6e 69 6e 67 20 61 73 20 69 6e 20  e meaning as in 
0770: 74 68 65 20 3c 74 74 3e 64 6d 74 78 3a 3a 64 65  the <tt>dmtx::de
0780: 63 6f 64 65 3c 2f 74 74 3e 20 63 6f 6d 6d 61 6e  code</tt> comman
0790: 64 2e 20 54 68 65 20 64 65 66 61 75 6c 74 20 74  d. The default t
07a0: 69 6d 65 6f 75 74 20 76 61 6c 75 65 20 69 73 20  imeout value is 
07b0: 31 30 30 30 20 6d 69 6c 6c 69 73 65 63 6f 6e 64  1000 millisecond
07c0: 73 2e 20 43 61 75 74 69 6f 6e 3a 20 6f 6e 6c 79  s. Caution: only
07d0: 20 61 20 73 69 6e 67 6c 65 20 74 68 72 65 61 64   a single thread
07e0: 20 69 6e 73 74 61 6e 63 65 20 69 73 20 73 75 70   instance is sup
07f0: 70 6f 72 74 65 64 20 70 65 72 20 54 63 6c 20 69  ported per Tcl i
0800: 6e 74 65 72 70 72 65 74 65 72 2c 20 69 2e 65 2e  nterpreter, i.e.
0810: 20 61 6e 6f 74 68 65 72 20 61 73 79 6e 63 68 72   another asynchr
0820: 6f 6e 6f 75 73 20 64 65 63 6f 64 65 20 70 72 6f  onous decode pro
0830: 63 65 73 73 20 63 61 6e 20 6f 6e 6c 79 20 62 65  cess can only be
0840: 20 73 74 61 72 74 65 64 20 77 68 65 6e 20 61 20   started when a 
0850: 70 72 65 76 69 6f 75 73 20 64 65 63 6f 64 65 20  previous decode 
0860: 70 72 6f 63 65 73 73 20 68 61 73 20 66 69 6e 69  process has fini
0870: 73 68 65 64 2e 0d 0a 0d 0a 3c 74 74 3e 64 6d 74  shed.....<tt>dmt
0880: 78 3a 3a 61 73 79 6e 63 5f 64 65 63 6f 64 65 20  x::async_decode 
0890: 61 62 6f 72 74 3c 2f 74 74 3e 0d 0a 0d 0a 20 20  abort</tt>....  
08a0: 20 20 41 62 6f 72 74 73 20 61 20 72 75 6e 6e 69    Aborts a runni
08b0: 6e 67 20 61 73 79 6e 63 68 72 6f 6e 6f 75 73 20  ng asynchronous 
08c0: 64 65 63 6f 64 65 20 70 72 6f 63 65 73 73 2e 0d  decode process..
08d0: 0a 0d 0a 3c 74 74 3e 64 6d 74 78 3a 3a 61 73 79  ...<tt>dmtx::asy
08e0: 6e 63 5f 64 65 63 6f 64 65 20 73 74 61 74 75 73  nc_decode status
08f0: 3c 2f 74 74 3e 0d 0a 0d 0a 20 20 20 20 52 65 74  </tt>....    Ret
0900: 75 72 6e 73 20 74 68 65 20 63 75 72 72 65 6e 74  urns the current
0910: 20 73 74 61 74 65 20 6f 66 20 74 68 65 20 61 73   state of the as
0920: 79 6e 63 68 72 6f 6e 6f 75 73 20 64 65 63 6f 64  ynchronous decod
0930: 65 20 61 73 20 61 20 73 74 72 69 6e 67 3a 20 3c  e as a string: <
0940: 74 74 3e 3c 69 3e 73 74 6f 70 70 65 64 3c 2f 69  tt><i>stopped</i
0950: 3e 3c 2f 74 74 3e 20 77 68 65 6e 20 6e 6f 20 61  ></tt> when no a
0960: 73 79 6e 63 68 72 6f 6e 6f 75 73 20 64 65 63 6f  synchronous deco
0970: 64 65 20 74 68 72 65 61 64 20 68 61 73 20 62 65  de thread has be
0980: 65 6e 20 73 74 61 72 74 65 64 2c 20 3c 74 74 3e  en started, <tt>
0990: 3c 69 3e 72 75 6e 6e 69 6e 67 3c 2f 69 3e 3c 2f  <i>running</i></
09a0: 74 74 3e 20 77 68 65 6e 20 61 20 61 73 79 6e 63  tt> when a async
09b0: 68 72 6f 6e 6f 75 73 20 64 65 63 6f 64 65 20 69  hronous decode i
09c0: 73 20 69 6e 20 70 72 6f 67 72 65 73 73 2c 20 61  s in progress, a
09d0: 6e 64 20 3c 74 74 3e 3c 69 3e 72 65 61 64 79 3c  nd <tt><i>ready<
09e0: 2f 69 3e 3c 2f 74 74 3e 20 77 68 65 6e 20 74 68  /i></tt> when th
09f0: 65 20 6e 65 78 74 20 61 73 79 6e 63 68 72 6f 6e  e next asynchron
0a00: 6f 75 73 20 64 65 63 6f 64 65 20 63 61 6e 20 62  ous decode can b
0a10: 65 20 73 74 61 72 74 65 64 2e 0d 0a 0d 0a 3c 74  e started.....<t
0a20: 74 3e 64 6d 74 78 3a 3a 61 73 79 6e 63 5f 64 65  t>dmtx::async_de
0a30: 63 6f 64 65 20 73 74 6f 70 3c 2f 74 74 3e 0d 0a  code stop</tt>..
0a40: 0d 0a 20 20 20 20 53 74 6f 70 73 20 74 68 65 20  ..    Stops the 
0a50: 62 61 63 6b 67 72 6f 75 6e 64 20 74 68 72 65 61  background threa
0a60: 64 20 66 6f 72 20 61 73 79 6e 63 68 72 6f 6e 6f  d for asynchrono
0a70: 75 73 20 64 65 63 6f 64 69 6e 67 20 69 66 20 69  us decoding if i
0a80: 74 20 68 61 73 20 62 65 65 6e 20 69 6d 70 6c 69  t has been impli
0a90: 63 69 74 65 6c 79 20 73 74 61 72 74 65 64 20 62  citely started b
0aa0: 79 20 61 20 70 72 69 6f 72 20 3c 74 74 3e 64 6d  y a prior <tt>dm
0ab0: 74 78 3a 3a 61 73 79 6e 63 5f 64 65 63 6f 64 65  tx::async_decode
0ac0: 3c 2f 74 74 3e 2e 20 54 68 69 73 20 63 61 6e 20  </tt>. This can 
0ad0: 62 65 20 75 73 65 66 75 6c 20 74 6f 20 63 6f 6e  be useful to con
0ae0: 73 65 72 76 65 20 6d 65 6d 6f 72 79 20 72 65 73  serve memory res
0af0: 6f 75 72 63 65 73 2e 0d 0a 0a 5a 20 38 63 37 63  ources....Z 8c7c
0b00: 30 35 65 38 63 63 30 32 31 63 30 31 62 66 37 37  05e8cc021c01bf77
0b10: 63 62 65 39 31 64 34 38 37 38 64 33 0a           cbe91d4878d3.