-
Notifications
You must be signed in to change notification settings - Fork 7
/
device.go
536 lines (492 loc) · 17.3 KB
/
device.go
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
// Package kobo contains stuff related to Kobo devices, firmware, and nickel.
package kobo
import (
"fmt"
"image"
)
// See https://gist.github.com/pgaskin/613b34c23f026f7c39c50ee32f5e167e and
// https://github.com/shermp/Kobo-UNCaGED/issues/16
// Device is a device model.
type Device int
// Hardware is a hardware revision.
type Hardware int
// CodeNames are used to identify the device category, devices, and variations.
type (
// CodeName represents an individual codename. Note that a codename can be
// used for more than one thing in a triplet.
CodeName string
// CodeNameTriplet represents a triplet of class/family/secondary codenames.
// Note that nothing in nickel says a device can only have 3, but everything
// so far implies that (and it makes sense).
CodeNameTriplet [3]CodeName
)
// CoverType is used to identify different cover dimensions used for different
// purposes by nickel.
type CoverType string
// Devices (not including really old ones, like Kobo eReader, Wireless, Literati, and Vox).
const (
DeviceTouchAB Device = 310
DeviceTouchC Device = 320
DeviceGlo Device = 330
DeviceMini Device = 340
DeviceAuraHD Device = 350
DeviceAura Device = 360
DeviceAuraH2O Device = 370
DeviceGloHD Device = 371
DeviceTouch2 Device = 372
DeviceAuraONE Device = 373
DeviceAuraH2OEdition2v1 Device = 374
DeviceAuraEdition2v1 Device = 375
DeviceClaraHD Device = 376
DeviceShine3 Device = 676
DeviceForma Device = 377
DeviceEpos2 Device = 677
DeviceAuraH2OEdition2v2 Device = 378
DeviceAuraEdition2v2 Device = 379
DeviceForma32 Device = 380
DeviceAuraONELimitedEdition Device = 381
DeviceNia Device = 382
DeviceSage Device = 383
DeviceLibraH2O Device = 384
DeviceClara2E Device = 386
DeviceElipsa Device = 387
DeviceLibra2 Device = 388
DeviceElipsa2E Device = 389
DeviceLibraColour Device = 390
DeviceVisionColour Device = 690
DeviceClaraBW Device = 391
DeviceShine Device = 691
DeviceClaraColour Device = 393
DeviceShineColor Device = 693
)
// Hardware revisions.
const (
HardwareKobo3 Hardware = 3
HardwareKobo4 Hardware = 4
HardwareKobo5 Hardware = 5
HardwareKobo6 Hardware = 6
HardwareKobo7 Hardware = 7
HardwareKobo8 Hardware = 8
HardwareKobo9 Hardware = 9
HardwareKobo10 Hardware = 10
HardwareKobo11 Hardware = 11
HardwareKobo12 Hardware = 12
)
// Codenames.
const (
CodeNameNone CodeName = ""
CodeNameDesktop CodeName = "desktop"
CodeNameNickel1 CodeName = "nickel1"
CodeNameNickel2 CodeName = "nickel2"
CodeNameMerch CodeName = "merch"
CodeNameVox CodeName = "vox"
CodeNameTrilogy CodeName = "trilogy"
CodeNamePixie CodeName = "pixie"
CodeNamePika CodeName = "pika"
CodeNameDragon CodeName = "dragon"
CodeNameDahlia CodeName = "dahlia"
CodeNameAlyssum CodeName = "alyssum"
CodeNameSnow CodeName = "snow"
CodeNameNova CodeName = "nova"
CodeNameStorm CodeName = "storm"
CodeNameDaylight CodeName = "daylight"
CodeNameSuperDaylight CodeName = "superDaylight"
CodeNameFrost CodeName = "frost"
CodeNameFrost32 CodeName = "frost32"
CodeNamePhoenix CodeName = "phoenix"
CodeNameKraken CodeName = "kraken"
CodeNameStar CodeName = "star"
CodeNameCadmus CodeName = "cadmus"
CodeNameLuna CodeName = "luna"
CodeNameGoldfinch CodeName = "goldfinch"
CodeNameEuropa CodeName = "europa"
CodeNameIo CodeName = "io"
CodeNameCondor CodeName = "condor"
CodeNameMonza CodeName = "monza"
CodeNameMonzaTolino CodeName = "monzaTolino"
CodeNameSpaBW CodeName = "spaBW"
CodeNameSpaTolinoBW CodeName = "spaTolinoBW"
CodeNameSpaColour CodeName = "spaColour"
CodeNameSpaTolinoColour CodeName = "spaTolinoColour"
CodeNameLoki CodeName = "loki"
CodeNameFreya CodeName = "freya"
)
// Cover types.
const (
CoverTypeFull CoverType = "N3_FULL"
CoverTypeLibFull CoverType = "N3_LIBRARY_FULL"
CoverTypeLibList CoverType = "N3_LIBRARY_LIST"
CoverTypeLibGrid CoverType = "N3_LIBRARY_GRID"
)
// Devices returns a slice of all supported devices.
func Devices() []Device {
return []Device{DeviceTouchAB, DeviceTouchC, DeviceGlo, DeviceMini, DeviceAuraHD, DeviceAura, DeviceAuraH2O, DeviceGloHD, DeviceTouch2, DeviceAuraONE, DeviceAuraH2OEdition2v1, DeviceAuraEdition2v1, DeviceClaraHD, DeviceForma, DeviceAuraH2OEdition2v2, DeviceAuraEdition2v2, DeviceForma32, DeviceAuraONELimitedEdition, DeviceNia, DeviceSage, DeviceLibraH2O, DeviceClara2E, DeviceElipsa, DeviceLibra2, DeviceElipsa2E}
}
// CoverTypes returns a slice of all implemented nickel cover types.
func CoverTypes() []CoverType {
return []CoverType{CoverTypeFull, CoverTypeLibFull, CoverTypeLibList, CoverTypeLibGrid}
}
// DeviceByID gets a device by its full ID string.
func DeviceByID(id string) (Device, bool) {
for _, device := range Devices() {
if device.IDString() == id {
return device, true
}
}
return 0, false
}
// ID returns the numerical device ID.
func (d Device) ID() int {
return int(d)
}
// IDString returns the full ID string.
func (d Device) IDString() string {
return fmt.Sprintf("00000000-0000-0000-0000-%012d", d.ID())
}
func (d Device) IsTolino() bool {
return d.ID()/100 == 6
}
func (d Device) String() string {
return d.Name()
}
// Name returns the full device name.
func (d Device) Name() string {
cd := d.CodeNames()
dev := cd.FamilyString()
if sec := cd.SecondaryString(); sec != "" {
dev += " " + sec
}
switch d {
case DeviceTouchAB:
dev += " A/B"
case DeviceTouchC:
dev += " C"
case DeviceAuraEdition2v1, DeviceAuraEdition2v2:
dev += " Edition 2"
}
switch d {
case DeviceAuraEdition2v1, DeviceAuraH2OEdition2v1:
dev += " v1"
case DeviceAuraEdition2v2, DeviceAuraH2OEdition2v2:
dev += " v2"
}
return dev
}
// Hardware returns the hardware revision.
func (d Device) Hardware() Hardware {
switch d {
case DeviceTouchAB:
return HardwareKobo3
case DeviceTouchC, DeviceMini, DeviceGlo, DeviceAuraHD:
return HardwareKobo4
case DeviceAura, DeviceAuraH2O:
return HardwareKobo5
case DeviceGloHD, DeviceTouch2, DeviceAuraH2OEdition2v1, DeviceAuraONE, DeviceAuraONELimitedEdition, DeviceAuraEdition2v1:
return HardwareKobo6
case DeviceAuraH2OEdition2v2, DeviceAuraEdition2v2, DeviceClaraHD, DeviceShine3, DeviceForma, DeviceEpos2, DeviceForma32, DeviceNia, DeviceLibraH2O:
return HardwareKobo7
case DeviceSage, DeviceElipsa:
return HardwareKobo8
case DeviceLibra2:
return HardwareKobo9
case DeviceClara2E:
return HardwareKobo10
case DeviceElipsa2E, DeviceLibraColour, DeviceVisionColour:
return HardwareKobo11
case DeviceClaraBW, DeviceShine, DeviceClaraColour, DeviceShineColor:
return HardwareKobo12
}
panic("unknown device")
}
// Hardware returns the numerical hardware revision.
func (h Hardware) Hardware() int {
return int(h)
}
func (h Hardware) String() string {
return fmt.Sprintf("kobo%d", int(h))
}
// Is replicates the Device::is* functions in libnickel.
func (d Device) Is(n CodeName) bool {
cn := d.CodeNames()
return n != CodeNameNone && (cn.Class() == n || cn.Family() == n || cn.Secondary() == n)
}
// CodeNames returns the codename triplet for the device (like libnickel). Note:
// Nickel has a slightly different definition if Class, Family, and Secondary,
// but these triplets are correct (i.e. Device::is* will match nickel, and the
// hierachy is correct). These were determined by static analysis of libnickel.
// See PR#1 for details.
func (d Device) CodeNames() CodeNameTriplet {
switch d {
case DeviceTouchAB, DeviceTouchC:
return CodeNameTriplet{CodeNameTrilogy, CodeNameTrilogy, CodeNameNone}
case DeviceMini:
return CodeNameTriplet{CodeNameTrilogy, CodeNamePixie, CodeNameNone}
case DeviceTouch2:
return CodeNameTriplet{CodeNameTrilogy, CodeNamePika, CodeNameNone}
case DeviceAuraHD:
return CodeNameTriplet{CodeNameDragon, CodeNameDragon, CodeNameNone}
case DeviceAuraH2O:
return CodeNameTriplet{CodeNameDragon, CodeNameDahlia, CodeNameNone}
case DeviceGloHD:
return CodeNameTriplet{CodeNameDragon, CodeNameAlyssum, CodeNameNone}
case DeviceAuraH2OEdition2v1, DeviceAuraH2OEdition2v2:
return CodeNameTriplet{CodeNameDragon, CodeNameSnow, CodeNameNone}
case DeviceClaraHD:
return CodeNameTriplet{CodeNameDragon, CodeNameNova, CodeNameNone}
case DeviceShine3:
return CodeNameTriplet{CodeNameDragon, CodeNameLoki, CodeNameNone}
case DeviceLibraH2O:
return CodeNameTriplet{CodeNameDragon, CodeNameStorm, CodeNameNone}
case DeviceClara2E:
return CodeNameTriplet{CodeNameDragon, CodeNameGoldfinch, CodeNameNone}
case DeviceElipsa:
return CodeNameTriplet{CodeNameDragon, CodeNameEuropa, CodeNameNone}
case DeviceLibra2:
return CodeNameTriplet{CodeNameDragon, CodeNameIo, CodeNameNone}
case DeviceElipsa2E:
return CodeNameTriplet{CodeNameDragon, CodeNameCondor, CodeNameNone}
case DeviceLibraColour:
return CodeNameTriplet{CodeNameDragon, CodeNameMonza, CodeNameNone}
case DeviceVisionColour:
return CodeNameTriplet{CodeNameDragon, CodeNameMonzaTolino, CodeNameNone}
case DeviceClaraBW:
return CodeNameTriplet{CodeNameDragon, CodeNameSpaBW, CodeNameNone}
case DeviceShine:
return CodeNameTriplet{CodeNameDragon, CodeNameSpaTolinoBW, CodeNameNone}
case DeviceClaraColour:
return CodeNameTriplet{CodeNameDragon, CodeNameSpaColour, CodeNameNone}
case DeviceShineColor:
return CodeNameTriplet{CodeNameDragon, CodeNameSpaTolinoColour, CodeNameNone}
case DeviceAuraONE:
return CodeNameTriplet{CodeNameDaylight, CodeNameDaylight, CodeNameNone}
case DeviceAuraONELimitedEdition:
return CodeNameTriplet{CodeNameDaylight, CodeNameDaylight, CodeNameSuperDaylight}
case DeviceForma:
return CodeNameTriplet{CodeNameDaylight, CodeNameFrost, CodeNameNone}
case DeviceEpos2:
return CodeNameTriplet{CodeNameDaylight, CodeNameFreya, CodeNameNone}
case DeviceForma32:
return CodeNameTriplet{CodeNameDaylight, CodeNameFrost, CodeNameFrost32}
case DeviceSage:
return CodeNameTriplet{CodeNameDaylight, CodeNameCadmus, CodeNameNone}
case DeviceAura:
return CodeNameTriplet{CodeNamePhoenix, CodeNamePhoenix, CodeNameNone}
case DeviceGlo:
return CodeNameTriplet{CodeNamePhoenix, CodeNameKraken, CodeNameNone}
case DeviceAuraEdition2v1, DeviceAuraEdition2v2:
return CodeNameTriplet{CodeNamePhoenix, CodeNameStar, CodeNameNone}
case DeviceNia:
return CodeNameTriplet{CodeNamePhoenix, CodeNameLuna, CodeNameNone}
}
panic("unknown device")
}
func (c CodeName) String() string {
return string(c)
}
func (c CodeNameTriplet) String() string {
if c[2] != CodeNameNone {
return fmt.Sprintf("class=%s family=%s secondary=%s", c[0], c[1], c[2])
}
return fmt.Sprintf("class=%s family=%s", c[0], c[1])
}
// Family is short for Device.CodeNames().FamilyString().
func (d Device) Family() string {
return d.CodeNames().FamilyString()
}
// Class gets the class/category.
func (c CodeNameTriplet) Class() CodeName {
return c[0]
}
// Family gets the family/model (i.e. part of a class)
func (c CodeNameTriplet) Family() CodeName {
return c[1]
}
// FamilyString gets the human readable family/model.
func (c CodeNameTriplet) FamilyString() string {
switch c.Family() {
case CodeNameDesktop:
return "Kobo Desktop"
case CodeNameNickel1:
return "Kobo eReader"
case CodeNameNickel2:
return "Kobo Wireless eReader"
case CodeNameMerch:
return "Literati / LookBook eReader"
case CodeNameVox:
return "Kobo Vox"
case CodeNameTrilogy:
return "Kobo Touch"
case CodeNamePixie:
return "Kobo Mini"
case CodeNamePika:
return "Kobo Touch 2.0"
case CodeNameDragon:
return "Kobo Aura HD"
case CodeNameDahlia:
return "Kobo Aura H2O"
case CodeNameAlyssum:
return "Kobo Glo HD"
case CodeNameSnow:
return "Kobo Aura H2O Edition 2"
case CodeNameNova:
return "Kobo Clara HD"
case CodeNameStorm:
return "Kobo Libra H2O"
case CodeNameDaylight:
return "Kobo Aura ONE"
case CodeNameFrost:
return "Kobo Forma"
case CodeNamePhoenix:
return "Kobo Aura"
case CodeNameKraken:
return "Kobo Glo"
case CodeNameStar:
return "Kobo Aura"
case CodeNameCadmus:
return "Kobo Sage"
case CodeNameLuna:
return "Kobo Nia"
case CodeNameGoldfinch:
return "Kobo Clara 2E"
case CodeNameEuropa:
return "Kobo Elipsa"
case CodeNameIo:
return "Kobo Libra 2"
case CodeNameCondor:
return "Kobo Elipsa 2E"
case CodeNameMonza:
return "Kobo Libra Colour"
case CodeNameMonzaTolino:
return "tolino vision color"
case CodeNameSpaBW:
return "Kobo Clara BW"
case CodeNameSpaTolinoBW:
return "Kobo Clara Colour"
case CodeNameSpaColour:
return "tolino shine"
case CodeNameSpaTolinoColour:
return "tolino shine color"
case CodeNameLoki:
return "tolino Shine 3"
case CodeNameFreya:
return "tolino Epos 2"
}
panic("unknown family")
}
// Secondary gets the secondary device codename (i.e. refines the family).
func (c CodeNameTriplet) Secondary() CodeName {
return c[2]
}
// SecondaryString returns the human readable string to append to FamilyString
// if applicable (e.g. Limited Edition, 32GB).
func (c CodeNameTriplet) SecondaryString() string {
switch c.Secondary() {
case CodeNameNone:
return ""
case CodeNameSuperDaylight:
return "Limited Edition"
case CodeNameFrost32:
return "32GB"
}
panic("unknown secondary")
}
// CoverSize returns the cover size for a cover type for a Device. Currently,
// everything except for the Full cover is the same for every device.
func (d Device) CoverSize(t CoverType) image.Point {
if t == CoverTypeLibList {
return image.Pt(60, 90)
} else if t == CoverTypeLibGrid {
return image.Pt(149, 223)
} else if t == CoverTypeLibFull {
return image.Pt(355, 530)
} else if t != CoverTypeFull {
panic("unknown cover type")
}
switch d.CodeNames().Family() {
case CodeNameDragon, CodeNameSnow:
return image.Pt(1080, 1440)
case CodeNameDahlia:
return image.Pt(1080, 1429)
case CodeNameAlyssum, CodeNameNova, CodeNameGoldfinch:
return image.Pt(1072, 1448)
case CodeNameStorm, CodeNameIo:
return image.Pt(1264, 1680)
case CodeNameDaylight, CodeNameEuropa, CodeNameCondor:
return image.Pt(1404, 1872)
case CodeNameFrost, CodeNameCadmus:
return image.Pt(1440, 1920)
case CodeNamePhoenix:
return image.Pt(758, 1014)
case CodeNameKraken, CodeNameStar, CodeNameLuna:
return image.Pt(758, 1024)
default:
return image.Pt(600, 800)
}
}
// CoverSized returns a size resized to the correct size using the same logic as
// nickel.
func (d Device) CoverSized(t CoverType, orig image.Point) image.Point {
return t.Resize(d.CoverSize(t), orig)
}
// NickelString returns the internal string used in nickel to identify the cover
// type.
func (c CoverType) NickelString() string {
return string(c)
}
func (c CoverType) String() string {
return c.NickelString()
}
// Resize returns the dimensions to resize sz to for the cover type and target size.
func (c CoverType) Resize(target image.Point, sz image.Point) image.Point {
switch c {
case CoverTypeFull:
return resizeKeepAspectRatio(sz, target, false)
case CoverTypeLibFull, CoverTypeLibGrid, CoverTypeLibList:
return resizeKeepAspectRatio(sz, target, true)
}
panic("unknown cover type")
}
// GeneratePath generates the path for the cover of an ImageID. The path is always
// separated with forward slashes.
func (c CoverType) GeneratePath(external bool, iid string) string {
cdir := ".kobo-images"
if external {
cdir = "koboExtStorage/images-cache"
}
dir1, dir2, base := hashedImageParts(iid)
return fmt.Sprintf("%s/%s/%s/%s - %s.parsed", cdir, dir1, dir2, base, c.NickelString())
}
// StorageGB returns the advertised storage capacity of a Device.
func (d Device) StorageGB() int {
switch d {
case DeviceTouchAB, DeviceTouchC, DeviceMini:
return 2
case DeviceTouch2, DeviceAuraHD, DeviceAuraH2O, DeviceGloHD, DeviceAura, DeviceGlo, DeviceAuraEdition2v1, DeviceAuraEdition2v2:
return 4
case DeviceAuraH2OEdition2v1, DeviceAuraH2OEdition2v2, DeviceClaraHD, DeviceShine3, DeviceLibraH2O, DeviceAuraONE, DeviceForma, DeviceEpos2, DeviceNia:
return 8
case DeviceClara2E, DeviceClaraBW, DeviceShine, DeviceClaraColour, DeviceShineColor:
return 16
case DeviceAuraONELimitedEdition, DeviceForma32, DeviceSage, DeviceElipsa, DeviceLibra2, DeviceElipsa2E, DeviceLibraColour, DeviceVisionColour:
return 32
}
panic("unknown device")
}
// DisplayPPI returns the display Pixels Per Inch (PPI) of a Device.
func (d Device) DisplayPPI() int {
switch d {
case DeviceTouchAB, DeviceTouchC, DeviceTouch2:
return 167
case DeviceMini:
return 200
case DeviceAura, DeviceGlo, DeviceAuraEdition2v1, DeviceAuraEdition2v2, DeviceNia:
return 212
case DeviceElipsa, DeviceElipsa2E:
return 227
case DeviceAuraHD, DeviceAuraH2O, DeviceAuraH2OEdition2v1, DeviceAuraH2OEdition2v2:
return 265
case DeviceClaraHD, DeviceShine3, DeviceLibraH2O, DeviceAuraONE, DeviceForma, DeviceEpos2, DeviceGloHD, DeviceAuraONELimitedEdition, DeviceForma32, DeviceSage, DeviceLibra2, DeviceClara2E, DeviceClaraBW, DeviceShine, DeviceClaraColour, DeviceShineColor, DeviceLibraColour, DeviceVisionColour:
return 300
}
panic("unknown device")
}