encoder.go 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552
  1. // package for QR barcode generation.
  2. package qr
  3. import (
  4. "fmt"
  5. "github.com/boombuler/barcode"
  6. "image"
  7. )
  8. type encodeFn func(content string, eccLevel ErrorCorrectionLevel) (*barcode.BitList, *versionInfo, error)
  9. type Encoding byte
  10. const (
  11. // Choose best matching encoding
  12. Auto Encoding = iota
  13. // Encode only numbers [0-9]
  14. Numeric
  15. // Encode only uppercase letters, numbers and [Space], $, %, *, +, -, ., /, :
  16. AlphaNumeric
  17. // Encodes string as utf-8
  18. Unicode
  19. )
  20. func (e Encoding) getEncoder() encodeFn {
  21. switch e {
  22. case Auto:
  23. return encodeAuto
  24. case Numeric:
  25. return encodeNumeric
  26. case AlphaNumeric:
  27. return encodeAlphaNumeric
  28. case Unicode:
  29. return encodeUnicode
  30. }
  31. return nil
  32. }
  33. func (e Encoding) String() string {
  34. switch e {
  35. case Auto:
  36. return "Auto"
  37. case Numeric:
  38. return "Numeric"
  39. case AlphaNumeric:
  40. return "AlphaNumeric"
  41. case Unicode:
  42. return "Unicode"
  43. }
  44. return ""
  45. }
  46. // Encodes the given content to a QR barcode
  47. func Encode(content string, level ErrorCorrectionLevel, mode Encoding) (barcode.Barcode, error) {
  48. bits, vi, err := mode.getEncoder()(content, level)
  49. if err != nil {
  50. return nil, err
  51. }
  52. if bits == nil || vi == nil {
  53. return nil, fmt.Errorf("Unable to encode \"%s\" with error correction level %s and encoding mode %s", content, level, mode)
  54. }
  55. blocks := splitToBlocks(bits.ItterateBytes(), vi)
  56. data := blocks.interleave(vi)
  57. result := render(data, vi)
  58. result.content = content
  59. return result, nil
  60. }
  61. func render(data []byte, vi *versionInfo) *qrcode {
  62. dim := vi.modulWidth()
  63. results := make([]*qrcode, 8)
  64. for i := 0; i < 8; i++ {
  65. results[i] = newBarcode(dim)
  66. }
  67. occupied := newBarcode(dim)
  68. setAll := func(x int, y int, val bool) {
  69. occupied.Set(x, y, true)
  70. for i := 0; i < 8; i++ {
  71. results[i].Set(x, y, val)
  72. }
  73. }
  74. drawFinderPatterns(vi, setAll)
  75. drawAlignmentPatterns(occupied, vi, setAll)
  76. //Timing Pattern:
  77. var i int
  78. for i = 0; i < dim; i++ {
  79. if !occupied.Get(i, 6) {
  80. setAll(i, 6, i%2 == 0)
  81. }
  82. if !occupied.Get(6, i) {
  83. setAll(6, i, i%2 == 0)
  84. }
  85. }
  86. // Dark Module
  87. setAll(8, dim-8, true)
  88. drawVersionInfo(vi, setAll)
  89. drawFormatInfo(vi, -1, occupied.Set)
  90. for i := 0; i < 8; i++ {
  91. drawFormatInfo(vi, i, results[i].Set)
  92. }
  93. // Write the data
  94. var curBitNo int = 0
  95. for pos := range itterateModules(occupied) {
  96. var curBit bool
  97. if curBitNo < len(data)*8 {
  98. curBit = ((data[curBitNo/8] >> uint(7-(curBitNo%8))) & 1) == 1
  99. } else {
  100. curBit = false
  101. }
  102. for i := 0; i < 8; i++ {
  103. setMasked(pos.X, pos.Y, curBit, i, results[i].Set)
  104. }
  105. curBitNo += 1
  106. }
  107. lowestPenalty := ^uint(0)
  108. lowestPenaltyIdx := -1
  109. for i := 0; i < 8; i++ {
  110. p := results[i].calcPenalty()
  111. if p < lowestPenalty {
  112. lowestPenalty = p
  113. lowestPenaltyIdx = i
  114. }
  115. }
  116. return results[lowestPenaltyIdx]
  117. }
  118. func setMasked(x, y int, val bool, mask int, set func(int, int, bool)) {
  119. switch mask {
  120. case 0:
  121. val = val != (((y + x) % 2) == 0)
  122. break
  123. case 1:
  124. val = val != ((y % 2) == 0)
  125. break
  126. case 2:
  127. val = val != ((x % 3) == 0)
  128. break
  129. case 3:
  130. val = val != (((y + x) % 3) == 0)
  131. break
  132. case 4:
  133. val = val != (((y/2 + x/3) % 2) == 0)
  134. break
  135. case 5:
  136. val = val != (((y*x)%2)+((y*x)%3) == 0)
  137. break
  138. case 6:
  139. val = val != ((((y*x)%2)+((y*x)%3))%2 == 0)
  140. break
  141. case 7:
  142. val = val != ((((y+x)%2)+((y*x)%3))%2 == 0)
  143. }
  144. set(x, y, val)
  145. }
  146. func itterateModules(occupied *qrcode) <-chan image.Point {
  147. result := make(chan image.Point)
  148. allPoints := make(chan image.Point)
  149. go func() {
  150. curX := occupied.dimension - 1
  151. curY := occupied.dimension - 1
  152. isUpward := true
  153. for true {
  154. if isUpward {
  155. allPoints <- image.Pt(curX, curY)
  156. allPoints <- image.Pt(curX-1, curY)
  157. curY -= 1
  158. if curY < 0 {
  159. curY = 0
  160. curX -= 2
  161. if curX == 6 {
  162. curX -= 1
  163. }
  164. if curX < 0 {
  165. break
  166. }
  167. isUpward = false
  168. }
  169. } else {
  170. allPoints <- image.Pt(curX, curY)
  171. allPoints <- image.Pt(curX-1, curY)
  172. curY += 1
  173. if curY >= occupied.dimension {
  174. curY = occupied.dimension - 1
  175. curX -= 2
  176. if curX == 6 {
  177. curX -= 1
  178. }
  179. isUpward = true
  180. if curX < 0 {
  181. break
  182. }
  183. }
  184. }
  185. }
  186. close(allPoints)
  187. }()
  188. go func() {
  189. for pt := range allPoints {
  190. if !occupied.Get(pt.X, pt.Y) {
  191. result <- pt
  192. }
  193. }
  194. close(result)
  195. }()
  196. return result
  197. }
  198. func drawFinderPatterns(vi *versionInfo, set func(int, int, bool)) {
  199. dim := vi.modulWidth()
  200. drawPattern := func(xoff int, yoff int) {
  201. for x := -1; x < 8; x++ {
  202. for y := -1; y < 8; y++ {
  203. val := (x == 0 || x == 6 || y == 0 || y == 6 || (x > 1 && x < 5 && y > 1 && y < 5)) && (x <= 6 && y <= 6 && x >= 0 && y >= 0)
  204. if x+xoff >= 0 && x+xoff < dim && y+yoff >= 0 && y+yoff < dim {
  205. set(x+xoff, y+yoff, val)
  206. }
  207. }
  208. }
  209. }
  210. drawPattern(0, 0)
  211. drawPattern(0, dim-7)
  212. drawPattern(dim-7, 0)
  213. }
  214. func drawAlignmentPatterns(occupied *qrcode, vi *versionInfo, set func(int, int, bool)) {
  215. drawPattern := func(xoff int, yoff int) {
  216. for x := -2; x <= 2; x++ {
  217. for y := -2; y <= 2; y++ {
  218. val := x == -2 || x == 2 || y == -2 || y == 2 || (x == 0 && y == 0)
  219. set(x+xoff, y+yoff, val)
  220. }
  221. }
  222. }
  223. positions := vi.alignmentPatternPlacements()
  224. for _, x := range positions {
  225. for _, y := range positions {
  226. if occupied.Get(x, y) {
  227. continue
  228. }
  229. drawPattern(x, y)
  230. }
  231. }
  232. }
  233. func drawFormatInfo(vi *versionInfo, usedMask int, set func(int, int, bool)) {
  234. var formatInfo []bool
  235. switch vi.Level {
  236. case L:
  237. switch usedMask {
  238. case 0:
  239. formatInfo = []bool{true, true, true, false, true, true, true, true, true, false, false, false, true, false, false}
  240. break
  241. case 1:
  242. formatInfo = []bool{true, true, true, false, false, true, false, true, true, true, true, false, false, true, true}
  243. break
  244. case 2:
  245. formatInfo = []bool{true, true, true, true, true, false, true, true, false, true, false, true, false, true, false}
  246. break
  247. case 3:
  248. formatInfo = []bool{true, true, true, true, false, false, false, true, false, false, true, true, true, false, true}
  249. break
  250. case 4:
  251. formatInfo = []bool{true, true, false, false, true, true, false, false, false, true, false, true, true, true, true}
  252. break
  253. case 5:
  254. formatInfo = []bool{true, true, false, false, false, true, true, false, false, false, true, true, false, false, false}
  255. break
  256. case 6:
  257. formatInfo = []bool{true, true, false, true, true, false, false, false, true, false, false, false, false, false, true}
  258. break
  259. case 7:
  260. formatInfo = []bool{true, true, false, true, false, false, true, false, true, true, true, false, true, true, false}
  261. break
  262. }
  263. break
  264. case M:
  265. switch usedMask {
  266. case 0:
  267. formatInfo = []bool{true, false, true, false, true, false, false, false, false, false, true, false, false, true, false}
  268. break
  269. case 1:
  270. formatInfo = []bool{true, false, true, false, false, false, true, false, false, true, false, false, true, false, true}
  271. break
  272. case 2:
  273. formatInfo = []bool{true, false, true, true, true, true, false, false, true, true, true, true, true, false, false}
  274. break
  275. case 3:
  276. formatInfo = []bool{true, false, true, true, false, true, true, false, true, false, false, true, false, true, true}
  277. break
  278. case 4:
  279. formatInfo = []bool{true, false, false, false, true, false, true, true, true, true, true, true, false, false, true}
  280. break
  281. case 5:
  282. formatInfo = []bool{true, false, false, false, false, false, false, true, true, false, false, true, true, true, false}
  283. break
  284. case 6:
  285. formatInfo = []bool{true, false, false, true, true, true, true, true, false, false, true, false, true, true, true}
  286. break
  287. case 7:
  288. formatInfo = []bool{true, false, false, true, false, true, false, true, false, true, false, false, false, false, false}
  289. break
  290. }
  291. break
  292. case Q:
  293. switch usedMask {
  294. case 0:
  295. formatInfo = []bool{false, true, true, false, true, false, true, false, true, false, true, true, true, true, true}
  296. break
  297. case 1:
  298. formatInfo = []bool{false, true, true, false, false, false, false, false, true, true, false, true, false, false, false}
  299. break
  300. case 2:
  301. formatInfo = []bool{false, true, true, true, true, true, true, false, false, true, true, false, false, false, true}
  302. break
  303. case 3:
  304. formatInfo = []bool{false, true, true, true, false, true, false, false, false, false, false, false, true, true, false}
  305. break
  306. case 4:
  307. formatInfo = []bool{false, true, false, false, true, false, false, true, false, true, true, false, true, false, false}
  308. break
  309. case 5:
  310. formatInfo = []bool{false, true, false, false, false, false, true, true, false, false, false, false, false, true, true}
  311. break
  312. case 6:
  313. formatInfo = []bool{false, true, false, true, true, true, false, true, true, false, true, true, false, true, false}
  314. break
  315. case 7:
  316. formatInfo = []bool{false, true, false, true, false, true, true, true, true, true, false, true, true, false, true}
  317. break
  318. }
  319. break
  320. case H:
  321. switch usedMask {
  322. case 0:
  323. formatInfo = []bool{false, false, true, false, true, true, false, true, false, false, false, true, false, false, true}
  324. break
  325. case 1:
  326. formatInfo = []bool{false, false, true, false, false, true, true, true, false, true, true, true, true, true, false}
  327. break
  328. case 2:
  329. formatInfo = []bool{false, false, true, true, true, false, false, true, true, true, false, false, true, true, true}
  330. break
  331. case 3:
  332. formatInfo = []bool{false, false, true, true, false, false, true, true, true, false, true, false, false, false, false}
  333. break
  334. case 4:
  335. formatInfo = []bool{false, false, false, false, true, true, true, false, true, true, false, false, false, true, false}
  336. break
  337. case 5:
  338. formatInfo = []bool{false, false, false, false, false, true, false, false, true, false, true, false, true, false, true}
  339. break
  340. case 6:
  341. formatInfo = []bool{false, false, false, true, true, false, true, false, false, false, false, true, true, false, false}
  342. break
  343. case 7:
  344. formatInfo = []bool{false, false, false, true, false, false, false, false, false, true, true, true, false, true, true}
  345. break
  346. }
  347. break
  348. }
  349. if usedMask == -1 {
  350. formatInfo = []bool{true, true, true, true, true, true, true, true, true, true, true, true, true, true, true} // Set all to true cause -1 --> occupied mask.
  351. }
  352. if len(formatInfo) == 15 {
  353. dim := vi.modulWidth()
  354. set(0, 8, formatInfo[0])
  355. set(1, 8, formatInfo[1])
  356. set(2, 8, formatInfo[2])
  357. set(3, 8, formatInfo[3])
  358. set(4, 8, formatInfo[4])
  359. set(5, 8, formatInfo[5])
  360. set(7, 8, formatInfo[6])
  361. set(8, 8, formatInfo[7])
  362. set(8, 7, formatInfo[8])
  363. set(8, 5, formatInfo[9])
  364. set(8, 4, formatInfo[10])
  365. set(8, 3, formatInfo[11])
  366. set(8, 2, formatInfo[12])
  367. set(8, 1, formatInfo[13])
  368. set(8, 0, formatInfo[14])
  369. set(8, dim-1, formatInfo[0])
  370. set(8, dim-2, formatInfo[1])
  371. set(8, dim-3, formatInfo[2])
  372. set(8, dim-4, formatInfo[3])
  373. set(8, dim-5, formatInfo[4])
  374. set(8, dim-6, formatInfo[5])
  375. set(8, dim-7, formatInfo[6])
  376. set(dim-8, 8, formatInfo[7])
  377. set(dim-7, 8, formatInfo[8])
  378. set(dim-6, 8, formatInfo[9])
  379. set(dim-5, 8, formatInfo[10])
  380. set(dim-4, 8, formatInfo[11])
  381. set(dim-3, 8, formatInfo[12])
  382. set(dim-2, 8, formatInfo[13])
  383. set(dim-1, 8, formatInfo[14])
  384. }
  385. }
  386. func drawVersionInfo(vi *versionInfo, set func(int, int, bool)) {
  387. var versionInfoBits []bool
  388. switch vi.Version {
  389. case 7:
  390. versionInfoBits = []bool{false, false, false, true, true, true, true, true, false, false, true, false, false, true, false, true, false, false}
  391. break
  392. case 8:
  393. versionInfoBits = []bool{false, false, true, false, false, false, false, true, false, true, true, false, true, true, true, true, false, false}
  394. break
  395. case 9:
  396. versionInfoBits = []bool{false, false, true, false, false, true, true, false, true, false, true, false, false, true, true, false, false, true}
  397. break
  398. case 10:
  399. versionInfoBits = []bool{false, false, true, false, true, false, false, true, false, false, true, true, false, true, false, false, true, true}
  400. break
  401. case 11:
  402. versionInfoBits = []bool{false, false, true, false, true, true, true, false, true, true, true, true, true, true, false, true, true, false}
  403. break
  404. case 12:
  405. versionInfoBits = []bool{false, false, true, true, false, false, false, true, true, true, false, true, true, false, false, false, true, false}
  406. break
  407. case 13:
  408. versionInfoBits = []bool{false, false, true, true, false, true, true, false, false, false, false, true, false, false, false, true, true, true}
  409. break
  410. case 14:
  411. versionInfoBits = []bool{false, false, true, true, true, false, false, true, true, false, false, false, false, false, true, true, false, true}
  412. break
  413. case 15:
  414. versionInfoBits = []bool{false, false, true, true, true, true, true, false, false, true, false, false, true, false, true, false, false, false}
  415. break
  416. case 16:
  417. versionInfoBits = []bool{false, true, false, false, false, false, true, false, true, true, false, true, true, true, true, false, false, false}
  418. break
  419. case 17:
  420. versionInfoBits = []bool{false, true, false, false, false, true, false, true, false, false, false, true, false, true, true, true, false, true}
  421. break
  422. case 18:
  423. versionInfoBits = []bool{false, true, false, false, true, false, true, false, true, false, false, false, false, true, false, true, true, true}
  424. break
  425. case 19:
  426. versionInfoBits = []bool{false, true, false, false, true, true, false, true, false, true, false, false, true, true, false, false, true, false}
  427. break
  428. case 20:
  429. versionInfoBits = []bool{false, true, false, true, false, false, true, false, false, true, true, false, true, false, false, true, true, false}
  430. break
  431. case 21:
  432. versionInfoBits = []bool{false, true, false, true, false, true, false, true, true, false, true, false, false, false, false, false, true, true}
  433. break
  434. case 22:
  435. versionInfoBits = []bool{false, true, false, true, true, false, true, false, false, false, true, true, false, false, true, false, false, true}
  436. break
  437. case 23:
  438. versionInfoBits = []bool{false, true, false, true, true, true, false, true, true, true, true, true, true, false, true, true, false, false}
  439. break
  440. case 24:
  441. versionInfoBits = []bool{false, true, true, false, false, false, true, true, true, false, true, true, false, false, false, true, false, false}
  442. break
  443. case 25:
  444. versionInfoBits = []bool{false, true, true, false, false, true, false, false, false, true, true, true, true, false, false, false, false, true}
  445. break
  446. case 26:
  447. versionInfoBits = []bool{false, true, true, false, true, false, true, true, true, true, true, false, true, false, true, false, true, true}
  448. break
  449. case 27:
  450. versionInfoBits = []bool{false, true, true, false, true, true, false, false, false, false, true, false, false, false, true, true, true, false}
  451. break
  452. case 28:
  453. versionInfoBits = []bool{false, true, true, true, false, false, true, true, false, false, false, false, false, true, true, false, true, false}
  454. break
  455. case 29:
  456. versionInfoBits = []bool{false, true, true, true, false, true, false, false, true, true, false, false, true, true, true, true, true, true}
  457. break
  458. case 30:
  459. versionInfoBits = []bool{false, true, true, true, true, false, true, true, false, true, false, true, true, true, false, true, false, true}
  460. break
  461. case 31:
  462. versionInfoBits = []bool{false, true, true, true, true, true, false, false, true, false, false, true, false, true, false, false, false, false}
  463. break
  464. case 32:
  465. versionInfoBits = []bool{true, false, false, false, false, false, true, false, false, true, true, true, false, true, false, true, false, true}
  466. break
  467. case 33:
  468. versionInfoBits = []bool{true, false, false, false, false, true, false, true, true, false, true, true, true, true, false, false, false, false}
  469. break
  470. case 34:
  471. versionInfoBits = []bool{true, false, false, false, true, false, true, false, false, false, true, false, true, true, true, false, true, false}
  472. break
  473. case 35:
  474. versionInfoBits = []bool{true, false, false, false, true, true, false, true, true, true, true, false, false, true, true, true, true, true}
  475. break
  476. case 36:
  477. versionInfoBits = []bool{true, false, false, true, false, false, true, false, true, true, false, false, false, false, true, false, true, true}
  478. break
  479. case 37:
  480. versionInfoBits = []bool{true, false, false, true, false, true, false, true, false, false, false, false, true, false, true, true, true, false}
  481. break
  482. case 38:
  483. versionInfoBits = []bool{true, false, false, true, true, false, true, false, true, false, false, true, true, false, false, true, false, false}
  484. break
  485. case 39:
  486. versionInfoBits = []bool{true, false, false, true, true, true, false, true, false, true, false, true, false, false, false, false, false, true}
  487. break
  488. case 40:
  489. versionInfoBits = []bool{true, false, true, false, false, false, true, true, false, false, false, true, true, false, true, false, false, true}
  490. break
  491. }
  492. if len(versionInfoBits) > 0 {
  493. for i := 0; i < len(versionInfoBits); i++ {
  494. x := (vi.modulWidth() - 11) + i%3
  495. y := i / 3
  496. set(x, y, versionInfoBits[len(versionInfoBits)-i-1])
  497. set(y, x, versionInfoBits[len(versionInfoBits)-i-1])
  498. }
  499. }
  500. }
  501. func addPaddingAndTerminator(bl *barcode.BitList, vi *versionInfo) {
  502. for i := 0; i < 4 && bl.Len() < vi.totalDataBytes()*8; i++ {
  503. bl.AddBit(false)
  504. }
  505. for bl.Len()%8 != 0 {
  506. bl.AddBit(false)
  507. }
  508. for i := 0; bl.Len() < vi.totalDataBytes()*8; i++ {
  509. if i%2 == 0 {
  510. bl.AddByte(236)
  511. } else {
  512. bl.AddByte(17)
  513. }
  514. }
  515. }