Kotlin Native for CLIs

When making Command Line Interfaces (CLIs) it sure would be nice to use everyone's favorite language, but we also have to think about things like distribution and portability. While we can zip up our jars and assets, ask the user to extract them somewhere, and write a shell script to configure the JVM, classpath, and launch our Jar, there are also other options that allow us to write in Kotlin, while also building tools that look and feel just like any other on a user's system.

When I first wrote Differ, a Kotlin Multiplatform library for image comparison, the sample app was a Kotlin JVM app like any other, which exercised the library by letting you provide two images for comparison and printing the results to STDOUT. It soon became apparent that the sample app would also make a useful CLI, but JVM based CLIs involve quite a bit of overhead to distribute and run. Since Differ is a multiplatform library, Kotlin Native was a straightforward solution to make a CLI written in Kotlin which looks and feels just like any other native tool on a developer machine.

In this talk we'll discuss situations in which Kotlin Native can be a great tool for building CLIs, some of the downsides of using Kotlin Native over other tools, and some of the tools and libraries that can help. Using real world examples, we'll explore how you can build, package and run CLIs just like other tools installed on your system. After this talk, you'll be prepared to use Kotlin Native to create your own useful, portable, and testable CLIs that work just like any other utility.

Transcript

1. Kotlin/Native CLIs Ryan Harter @ryan@harter.us
2. Differ
3. • Kotlin Multiplatform image dif f ing library • Like diff, but for images • Comparator backing Dropshots Differ
4. Differ interface ImageComparator { data class ComparisonResult( val pixelDifferences: Int, val pixelCount: Int, val width: Int, val height: Int, ) fun compare(left: Image, right: Image, diff: Mask? = null): ComparisonResult }
5. / / Common interface Image { val width: Int val height: Int fun getPixel(x: Int, y: Int): Color } Differ
6. / / JVM private class BufferedImageWrapper( private val delegate: BufferedImage ) : Image { override val width: Int = delegate.width override val height: Int = delegate.height override fun getPixel(x: Int, y: Int): Color = delegate.getRGB(x, y).let( :: Color) } Differ
7. private class BufferedImageWrapper( / / Android internal class BitmapImage( private val src: Bitmap ) : Image { override val width: Int get() = src.width override val height: Int get() = src.height override fun getPixel(x: Int, y: Int): Color = Color(src.getPixel(x, y)) }
8. Differ
9. Differ
10. Differ Di ff er
11. Differ Di ff er Dropshots
12. Differ Di ff er Dropshots differ CLI
13. Differ Di ff er Dropshots differ rharter $ ./differ
14. Differ ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png
15. Differ ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png Images are different 222407 pixels are different Time: 338ms Differences: 222407 (8.044234%) FAIL ⬢[rharter@toolbox differ]$
16. Differ ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png
17. Differ ⬢[rharter@toolbox differ]$ $JAVA_HOME/jre/sh/java -classpath ?? ? \ 
 com.dropbox.differ.cli.MainKt -- verbose cat.png cat-bad.png
18. Differ ⬢[rharter@toolbox differ]$ brew install java ⬢[rharter@toolbox differ]$ $JAVA_HOME/jre/sh/java -classpath
19. Differ ⬢[rharter@toolbox differ]$ brew install java ⬢[rharter@toolbox differ]$ unzip all_the_jars.zip ⬢[rharter@toolbox differ]$ $JAVA_HOME/jre/sh/java -classpath
20. Differ ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png Images are different 222407 pixels are different Time: 338ms Differences: 222407 (8.044234%) FAIL ⬢[rharter@toolbox differ]$
21. Differ ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png Images are different 222407 pixels are different Time: 338ms Differences: 222407 (8.044234%) FAIL ⬢[rharter@toolbox differ]$ Time: 338ms
22. Kotlin/Native for CLIs?
23. • Can we make it feel native? • How do we handle dependencies? Single binary? • Can we make distribution easier? • Can we get better performance? Kotlin/Native for CLIs?
24. Migrating Differ CLI to Kotlin/Native
25. dependencies { implementation(libs.kotlinx.cli) implementation(libs.kotlinx.io) implementation(project(":differ")) } application { mainClass.set("com.dropbox.differ.cli.MainKt") } plugins { alias(libs.plugins.kotlin.jvm) id("application") }
26. dependencies { implementation(libs.kotlinx.cli) implementation(libs.kotlinx.io) implementation(project(":differ")) } application { mainClass.set("com.dropbox.differ.cli.MainKt") } plugins { alias(libs.plugins.kotlin.multiplatform) id("application") }
27. kotlin { jvm { withJava() } macosX64() macosArm64() linuxX64() sourceSets { val commonMain by getting { dependencies { implementation(libs.kotlinx.cli) implementation(libs.kotlinx.io) implementation(project(":differ")) } application { } } } }
28. dependencies { implementation(libs.kotlinx.cli) implementation(libs.kotlinx.io) implementation(project(":differ")) } } application { mainClass.set("com.dropbox.differ.cli.MainKt") } } } targets.withType<KotlinNativeTarget> { binaries { executable { baseName = "differ" entryPoint = "com.dropbox.differ.cli.main" } } }
29. Dependencies
30. Dependencies differ CLI
31. Dependencies Di ff er differ CLI
32. Dependencies Di ff er differ CLI kotlinx-cli
33. Dependencies Di ff er differ CLI kotlinx-cli image loading?
34. Dependencies
35. Dependencies
36. Dependencies Static
37. Dependencies Static Dynamic
38. Dependencies Static Dynamic
39. Executable Executable Dependencies Static Dynamic
40. Executable Executable Dependencies Static Dynamic
41. Executable Executable Dependencies Static Dynamic Operating System
42. Executable Executable Dependencies Static Dynamic
43. Dependencies Static Dynamic Executable Executable Executable Executable Executable Executable Executable Executable
44. Dependencies Static Dynamic stb_image libpng
45. stb_image https://github.com/nothings/stb
46. single- f ile public domain (or MIT licensed) libraries for C/C++ stb_image https://github.com/nothings/stb
47. stb_image https://github.com/nothings/stb
48. # stbimage.def headers = stb_image.h headerFilter = stb_image.h package = stb.image - -- #define STB_IMAGE_IMPLEMENTATION #include "stb_image.h" stb_image https://github.com/nothings/stb
49. # stbimage.def headers = stb_image.h headerFilter = stb_image.h package = stb.image - -- #define STB_IMAGE_IMPLEMENTATION #include "stb_image.h" headers = stb_image.h stb_image https://github.com/nothings/stb
50. # stbimage.def headers = stb_image.h headerFilter = stb_image.h package = stb.image - -- #define STB_IMAGE_IMPLEMENTATION #include "stb_image.h" headerFilter = stb_image.h stb_image https://github.com/nothings/stb
51. # stbimage.def headers = stb_image.h headerFilter = stb_image.h package = stb.image - -- #define STB_IMAGE_IMPLEMENTATION #include "stb_image.h" package = stb.image stb_image https://github.com/nothings/stb
52. # stbimage.def headers = stb_image.h headerFilter = stb_image.h package = stb.image - -- #define STB_IMAGE_IMPLEMENTATION #include "stb_image.h" - -- stb_image https://github.com/nothings/stb
53. # stbimage.def headers = stb_image.h headerFilter = stb_image.h package = stb.image - -- #define STB_IMAGE_IMPLEMENTATION #include "stb_image.h" #define STB_IMAGE_IMPLEMENTATION #include "stb_image.h" stb_image https://github.com/nothings/stb
54. / * stb_image - v2.27 - public domain image loader - http: // nothings.org/stb no warranty implied; use at your own risk Do this: #define STB_IMAGE_IMPLEMENTATION before you include this file in *one* C or C ++ file to create the implementation. / / i.e. it should look like this: #include .. . #include .. . #include .. . #define STB_IMAGE_IMPLEMENTATION #include "stb_image.h" You can #define STBI_ASSERT(x) before the #include to avoid using assert.h. And #define STBI_MALLOC, STBI_REALLOC, and STBI_FREE to avoid using malloc,realloc,free stb_image https://github.com/nothings/stb
55. / / Basic usage (see HDR discussion below for HDR usage): / / int x,y,n; / / unsigned char *data = stbi_load(filename, &x, &y, &n, 0); / / // ... process data if not NULL ... / / // ... x = width, y = height, n = # 8-bit components per pixel ... / / // ... replace '0' with '1' .. '4' to force that many components per pixel / / // ... but 'n' will always be the number that it would have been if you said 0 / / stbi_image_free(data) stb_image https://github.com/nothings/stb
56. class StbImage internal constructor(filePath: String) : Image { } stb_image https://github.com/nothings/stb
57. class StbImage internal constructor(filePath: String) : Image { } override val width: Int override val height: Int stb_image https://github.com/nothings/stb
58. class StbImage internal constructor(filePath: String) : Image { } override val width: Int override val height: Int private val pointer: CPointer<UByteVar> / / unsigned char * stb_image https://github.com/nothings/stb
59. class StbImage internal constructor(filePath: String) : Image { } override val width: Int override val height: Int private val pointer: CPointer<UByteVar> / / unsigned char * init { } stb_image https://github.com/nothings/stb
60. class StbImage internal constructor(filePath: String) : Image { } override val width: Int override val height: Int private val pointer: CPointer<UByteVar> / / unsigned char * init { } val data = stbi_load(filePath, ? ? ? , , , 0) stb_image https://github.com/nothings/stb
61. class StbImage internal constructor(filePath: String) : Image { } override val width: Int override val height: Int private val pointer: CPointer<UByteVar> / / unsigned char * init { } pointer = data ?. reinterpret() ?: throw Exception("Failed to read image from file: $filePath") val data = stbi_load(filePath, ? ? ? , , , 0) stb_image https://github.com/nothings/stb
62. class StbImage internal constructor(filePath: String) : Image { } override val width: Int :
63. class StbImage internal constructor(filePath: String) : Image { } override val width: Int override val height: Int private val pointer: CPointer<UByteVar> / / unsigned char * init { } pointer = data ?. reinterpret() ?: throw Exception("Failed to read image from file: $filePath") val data = stbi_load(filePath, ? ? ? , , , 0) stb_image https://github.com/nothings/stb
64. class StbImage internal constructor(filePath: String) : Image { } override val width: Int override val height: Int private val pointer: CPointer<UByteVar> / / unsigned char * init { } pointer = data ?. reinterpret() ?: throw Exception("Failed to read image from file: $filePath") val arena = Arena() try { } finally { arena.clear() } val data = stbi_load(filePath, ? ? ? , , , 0) stb_image https://github.com/nothings/stb
65. } private val pointer: CPointer<UByteVar> / / unsigned char * init { } pointer = data ?. reinterpret() ?: throw Exception("Failed to read image from file: $filePath") val arena = Arena() try { } finally { arena.clear() } val x = arena.alloc<IntVar>() val y = arena.alloc<IntVar>() val n = arena.alloc<IntVar>() val data = stbi_load(filePath, ? ? ? , , , 0) stb_image https://github.com/nothings/stb
66. } private val pointer: CPointer<UByteVar> / / unsigned char * init { } val data = stbi_load(filePath, pointer = data ?. reinterpret() ?: throw Exception("Failed to read image from file: $filePath") val arena = Arena() try { } finally { arena.clear() } val x = arena.alloc<IntVar>() val y = arena.alloc<IntVar>() val n = arena.alloc<IntVar>() , , , 0) x.ptr y.ptr n.ptr stb_image https://github.com/nothings/stb
67. } } val data = stbi_load(filePath, pointer = data ?. reinterpret() ?: throw Exception("Failed to read image from file: $filePath") } finally { arena.clear() } val x = arena.alloc<IntVar>() val y = arena.alloc<IntVar>() val n = arena.alloc<IntVar>() , , , 0) x.ptr y.ptr n.ptr width = x.value height = y.value channels = n.value stb_image https://github.com/nothings/stb
68. } } ?: throw Exception("Failed to read image from file: $filePath") } finally { arena.clear() } width = x.value height = y.value channels = n.value override fun getPixel(x: Int, y: Int): Color { } stb_image https://github.com/nothings/stb
69. } } ?: throw Exception("Failed to read image from file: $filePath") } finally { arena.clear() } width = x.value height = y.value channels = n.value override fun getPixel(x: Int, y: Int): Color { } val pixelOffset = (x + y * width) * channels stb_image https://github.com/nothings/stb
70. } } } finally { arena.clear() } height = y.value channels = n.value override fun getPixel(x: Int, y: Int): Color { } val pixelOffset = (x + y * width) * channels return Color( r = pointer[pixelOffset + 0], g = pointer[pixelOffset + 1], b = pointer[pixelOffset + 2], a = pointer[pixelOffset + 3], ) stb_image https://github.com/nothings/stb
71. } } val pixelOffset = (x + y * width) * channels return Color( r = pointer[pixelOffset + 0], g = pointer[pixelOffset + 1], b = pointer[pixelOffset + 2], a = pointer[pixelOffset + 3], ) stb_image https://github.com/nothings/stb fun close() { stbi_image_free(pointer) }
72. class StbImage internal constructor(filePath: String) : Image { override val width: Int override val height: Int private val pointer: CPointer<UByteVar> / / unsigned char * init { val data = stbi_load(filePath, pointer = data ?. reinterpret() ?: throw Exception("Failed to read image from file: $filePath") val arena = Arena() try { val x = arena.alloc<IntVar>() val y = arena.alloc<IntVar>() val n = arena.alloc<IntVar>() , , , 0) x.ptr y.ptr n.ptr width = x.value height = y.value stb_image https://github.com/nothings/stb
73. Dependencies Static Dynamic stb_image libpng
74. libpng http://www.libpng.org/
75. libpng http://www.libpng.org/ libpng is the of f icial PNG reference library.
76. libpng http://www.libpng.org/
77. libpng http://www.libpng.org/ # libpng.def headers = png.h headerFilter = png.h package = libpng compilerOpts.osx = -I/usr/local/include -I/opt/homebrew/include/libpng16 compilerOpts.linux = -I/usr/include/libpng -I/usr/include/libpng16 linkerOpts.osx = -L/usr/local/lib -L/opt/homebrew/lib -lpng linkerOpts.linux = -L/usr/lib/x86_64-linux-gnu -lpng
78. libpng http://www.libpng.org/ # libpng.def headers = png.h headerFilter = png.h package = libpng compilerOpts.osx = -I/usr/local/include -I/opt/homebrew/include/libpng16 compilerOpts.linux = -I/usr/include/libpng -I/usr/include/libpng16 linkerOpts.osx = -L/usr/local/lib -L/opt/homebrew/lib -lpng linkerOpts.linux = -L/usr/lib/x86_64-linux-gnu -lpng headers = png.h headerFilter = png.h package = libpng
79. libpng http://www.libpng.org/ # libpng.def headers = png.h headerFilter = png.h package = libpng compilerOpts.osx = -I/usr/local/include -I/opt/homebrew/include/libpng16 compilerOpts.linux = -I/usr/include/libpng -I/usr/include/libpng16 linkerOpts.osx = -L/usr/local/lib -L/opt/homebrew/lib -lpng linkerOpts.linux = -L/usr/lib/x86_64-linux-gnu -lpng compilerOpts.osx = -I/usr/local/include -I/opt/homebrew/include/libpng16 compilerOpts.linux = -I/usr/include/libpng -I/usr/include/libpng16
80. libpng http://www.libpng.org/ # libpng.def headers = png.h headerFilter = png.h package = libpng compilerOpts.osx = -I/usr/local/include -I/opt/homebrew/include/libpng16 compilerOpts.linux = -I/usr/include/libpng -I/usr/include/libpng16 linkerOpts.osx = -L/usr/local/lib -L/opt/homebrew/lib -lpng linkerOpts.linux = -L/usr/lib/x86_64-linux-gnu -lpng linkerOpts.osx = -L/usr/local/lib -L/opt/homebrew/lib -lpng linkerOpts.linux = -L/usr/lib/x86_64-linux-gnu -lpng
81. class PNGImage(val filePath: String) : Image { private val arena = Arena() private val data: CPointer<UByteVar> override val width: Int override val height: Int init { val loadArena = Arena() try { val realPath = memScoped { val tmp = allocArray<ByteVar>(PATH_MAX) realpath(filePath, tmp) tmp.toKString() } val fp = fopen(realPath, "rb") ?: error("Failed to open file pointer at $realPath") libpng http://www.libpng.org/
82. private fun getChannel(x: Int, y: Int, channel: Int): UByte { val pixelOffset = (x + y * width) * 4 return data[pixelOffset + channel] } override fun getPixel(x: Int, y: Int): Color = Color( r = getChannel(x, y, 0), g = getChannel(x, y, 0), b = getChannel(x, y, 0), a = getChannel(x, y, 0), ) fun close() { arena.clear() } } libpng http://www.libpng.org/
83. class PNGImage(val filePath: String) : Image { private val arena = Arena() private val data: CPointer<UByteVar> override val width: Int override val height: Int init { val loadArena = Arena() try { val realPath = memScoped { val tmp = allocArray<ByteVar>(PATH_MAX) realpath(filePath, tmp) tmp.toKString() } val fp = fopen(realPath, "rb") ?: error("Failed to open file pointer at $realPath") libpng http://www.libpng.org/
84. Dependencies Static Dynamic stb_image libpng
85. Dependencies Static Dynamic stb_image libpng JVM ImageIO
86. ImageIO javax.image
87. ImageIO javax.image private class BufferedImageWrapper( override fun getPixel(x: Int, y: Int): Color = delegate.getRGB(x, y).let( :: Color) ) : Image { private val delegate: BufferedImage / / JVM override val width: Int = delegate.width override val height: Int = delegate.height }
88. ImageIO javax.image private class BufferedImageWrapper( override fun getPixel(x: Int, y: Int): Color = delegate.getRGB(x, y).let( :: Color) ) : Image { private val delegate: BufferedImage / / JVM override val width: Int = delegate.width override val height: Int = delegate.height } BufferedImage
89. ImageIO javax.image private class BufferedImageWrapper( override fun getPixel(x: Int, y: Int): Color = delegate.getRGB(x, y).let( :: Color) ) : Image { private val delegate: BufferedImage / / JVM override val width: Int = delegate.width override val height: Int = delegate.height }
90. ImageIO javax.image private class BufferedImageWrapper( override fun getPixel(x: Int, y: Int): Color = delegate.getRGB(x, y).let( :: Color) ) : Image { private val delegate: BufferedImage / / JVM override val width: Int = delegate.width override val height: Int = delegate.height } fun Image(filePath: String): Image = BufferedImageWrapper(ImageIO.read(File(filePath)))
91. ImageIO javax.image private class BufferedImageWrapper( override fun getPixel(x: Int, y: Int): Color = delegate.getRGB(x, y).let( :: Color) ) : Image { private val delegate: BufferedImage / / JVM override val width: Int = delegate.width override val height: Int = delegate.height } fun Image(filePath: String): Image = BufferedImageWrapper(ImageIO.read(File(filePath))) ImageIO.read(File(filePath))
92. Dependencies Static Dynamic stb_image libpng JVM ImageIO
93. Performance
94. Performance Static Dynamic stb_image libpng
95. stb_image https://github.com/nothings/stb ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png Starting to load first image: ./differ/src/commonTest/resources/cat.png Loaded ./differ/src/commonTest/resources/cat.png in 96ms Starting to load second image: ./differ/src/commonTest/resources/cat-bad.png Loaded ./differ/src/commonTest/resources/cat-bad.png in 95ms Starting comparison Finished comparison in 1609ms Images are different 222407 pixels are different Time: 1811ms Differences: 222407 (8.044234%) FAIL
96. stb_image https://github.com/nothings/stb ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png Starting to load first image: ./differ/src/commonTest/resources/cat.png Loaded ./differ/src/commonTest/resources/cat.png in 96ms Starting to load second image: ./differ/src/commonTest/resources/cat-bad.png Loaded ./differ/src/commonTest/resources/cat-bad.png in 95ms Starting comparison Finished comparison in 1609ms Images are different 222407 pixels are different Time: 1811ms Differences: 222407 (8.044234%) FAIL Loaded ./differ/src/commonTest/resources/cat.png in 96ms Loaded ./differ/src/commonTest/resources/cat-bad.png in 95ms
97. stb_image https://github.com/nothings/stb ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png Starting to load first image: ./differ/src/commonTest/resources/cat.png Loaded ./differ/src/commonTest/resources/cat.png in 96ms Starting to load second image: ./differ/src/commonTest/resources/cat-bad.png Loaded ./differ/src/commonTest/resources/cat-bad.png in 95ms Starting comparison Finished comparison in 1609ms Images are different 222407 pixels are different Time: 1811ms Differences: 222407 (8.044234%) FAIL Loaded ./differ/src/commonTest/resources/cat.png in 96ms Loaded ./differ/src/commonTest/resources/cat-bad.png in 95ms Finished comparison in 1609ms
98. Performance Static Dynamic stb_image libpng
99. Performance Static Dynamic stb_image libpng Load: 95ms Comparison: 1609ms
100. ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png Starting to load first image: ./differ/src/commonTest/resources/cat.png Loaded ./differ/src/commonTest/resources/cat.png in 43ms Starting to load second image: ./differ/src/commonTest/resources/cat-bad.png Loaded ./differ/src/commonTest/resources/cat-bad.png in 43ms Starting comparison Finished comparison in 1602ms Images are different 149973 pixels are different Time: 1712ms Differences: 149973 (5.424371%) FAIL libpng http://www.libpng.org/
101. ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png Starting to load first image: ./differ/src/commonTest/resources/cat.png Loaded ./differ/src/commonTest/resources/cat.png in 43ms Starting to load second image: ./differ/src/commonTest/resources/cat-bad.png Loaded ./differ/src/commonTest/resources/cat-bad.png in 43ms Starting comparison Finished comparison in 1602ms Images are different 149973 pixels are different Time: 1712ms Differences: 149973 (5.424371%) FAIL libpng http://www.libpng.org/ Loaded ./differ/src/commonTest/resources/cat.png in 43ms Loaded ./differ/src/commonTest/resources/cat-bad.png in 43ms
102. ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png Starting to load first image: ./differ/src/commonTest/resources/cat.png Loaded ./differ/src/commonTest/resources/cat.png in 43ms Starting to load second image: ./differ/src/commonTest/resources/cat-bad.png Loaded ./differ/src/commonTest/resources/cat-bad.png in 43ms Starting comparison Finished comparison in 1602ms Images are different 149973 pixels are different Time: 1712ms Differences: 149973 (5.424371%) FAIL libpng http://www.libpng.org/ Loaded ./differ/src/commonTest/resources/cat.png in 43ms Loaded ./differ/src/commonTest/resources/cat-bad.png in 43ms Finished comparison in 1602ms
103. Performance Static Dynamic stb_image libpng Load: 95ms Comparison: 1609ms
104. Performance Static Dynamic stb_image libpng Load: 95ms Comparison: 1609ms Load: 43ms Comparison: 1602ms
105. Performance Static Dynamic JVM ImageIO stb_image libpng Load: 95ms Comparison: 1609ms Load: 43ms Comparison: 1602ms
106. ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png Starting to load first image: ./differ/src/commonTest/resources/cat.png Loaded ./differ/src/commonTest/resources/cat.png in 136ms Starting to load second image: ./differ/src/commonTest/resources/cat-bad.png Loaded ./differ/src/commonTest/resources/cat-bad.png in 77ms Starting comparison Finished comparison in 188ms Images are different 222407 pixels are different Time: 407ms Differences: 222407 (8.044234%) FAIL ImageIO javax.image
107. ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png Starting to load first image: ./differ/src/commonTest/resources/cat.png Loaded ./differ/src/commonTest/resources/cat.png in 136ms Starting to load second image: ./differ/src/commonTest/resources/cat-bad.png Loaded ./differ/src/commonTest/resources/cat-bad.png in 77ms Starting comparison Finished comparison in 188ms Images are different 222407 pixels are different Time: 407ms Differences: 222407 (8.044234%) FAIL ImageIO javax.image Loaded ./differ/src/commonTest/resources/cat.png in 136ms Loaded ./differ/src/commonTest/resources/cat-bad.png in 77ms
108. ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png Starting to load first image: ./differ/src/commonTest/resources/cat.png Loaded ./differ/src/commonTest/resources/cat.png in 136ms Starting to load second image: ./differ/src/commonTest/resources/cat-bad.png Loaded ./differ/src/commonTest/resources/cat-bad.png in 77ms Starting comparison Finished comparison in 188ms Images are different 222407 pixels are different Time: 407ms Differences: 222407 (8.044234%) FAIL ImageIO javax.image Loaded ./differ/src/commonTest/resources/cat.png in 136ms Loaded ./differ/src/commonTest/resources/cat-bad.png in 77ms Finished comparison in 188ms
109. Performance Static Dynamic JVM ImageIO stb_image libpng Load: 95ms Comparison: 1609ms Load: 43ms Comparison: 1602ms
110. Performance Static Dynamic JVM ImageIO stb_image libpng Load: 95ms Comparison: 1609ms Load: 43ms Comparison: 1602ms Load: ~110ms Comparison: 188ms
111. Distribution
112. Executable Executable Distribution Static Dynamic Operating System
113. stb_image https://github.com/nothings/stb ⬢[rharter@toolbox differ]$ curl -o ./differ https: // example.com/differ
114. stb_image https://github.com/nothings/stb ⬢[rharter@toolbox differ]$ curl -o ./differ https: // example.com/differ |====================================================>| 100%
115. stb_image https://github.com/nothings/stb ⬢[rharter@toolbox differ]$ curl -o ./differ https: // example.com/differ |====================================================>| 100% ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png
116. stb_image https://github.com/nothings/stb ⬢[rharter@toolbox differ]$ curl -o ./differ https: // example.com/differ |====================================================>| 100% ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png Starting to load first image: ./differ/src/commonTest/resources/cat.png Loaded ./differ/src/commonTest/resources/cat.png in 96ms Starting to load second image: ./differ/src/commonTest/resources/cat-bad.png Loaded ./differ/src/commonTest/resources/cat-bad.png in 95ms Starting comparison Finished comparison in 1609ms Images are different 222407 pixels are different Time: 1811ms Differences: 222407 (8.044234%)
117. stb_image https://github.com/nothings/stb ⬢[rharter@toolbox differ]$ curl -o ./differ https: // example.com/differ
118. stb_image https://github.com/nothings/stb ⬢[rharter@toolbox differ]$ curl -o ./differ https: // example.com/differ-macosArm64
119. stb_image https://github.com/nothings/stb ⬢[rharter@toolbox differ]$ curl -o ./differ https: // example.com/differ-macosArm64 ⬢[rharter@toolbox differ]$ curl -o ./differ https: // example.com/differ-macosX86 or
120. stb_image https://github.com/nothings/stb ⬢[rharter@toolbox differ]$ curl -o ./differ https: // example.com/differ-macosArm64 ⬢[rharter@toolbox differ]$ curl -o ./differ https: // example.com/differ-macosX86 or ⬢[rharter@toolbox differ]$ curl -o ./differ https: // example.com/differ-linuxX64 or
121. stb_image https://github.com/nothings/stb ⬢[rharter@toolbox differ]$ curl -o ./differ https: // example.com/differ-macosArm64 ⬢[rharter@toolbox differ]$ curl -o ./differ https: // example.com/differ-macosX86 or ⬢[rharter@toolbox differ]$ curl -o ./differ https: // example.com/differ-linuxX64 or or
122. Executable Executable Distribution Static Dynamic Operating System
123. ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png libpng http://www.libpng.org/
124. ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png ./differ: error while loading shared libraries: libpng16.so.16: cannot open shared object file: No such file or directory ⬢[rharter@toolbox differ]$ libpng http://www.libpng.org/
125. ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png ./differ: error while loading shared libraries: libpng16.so.16: cannot open shared object file: No such file or directory ⬢[rharter@toolbox differ]$ libpng http://www.libpng.org/ sudo dnf install -y libpng
126. ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png ./differ: error while loading shared libraries: libpng16.so.16: cannot open shared object file: No such file or directory ⬢[rharter@toolbox differ]$ libpng http://www.libpng.org/ Doing things and working hard ... sudo dnf install -y libpng
127. ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png ./differ: error while loading shared libraries: libpng16.so.16: cannot open shared object file: No such file or directory ⬢[rharter@toolbox differ]$ libpng http://www.libpng.org/ sudo dnf install -y libpng Doing things and working hard ... ⬢[rharter@toolbox differ]$
128. ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png ./differ: error while loading shared libraries: libpng16.so.16: cannot open shared object file: No such file or directory ⬢[rharter@toolbox differ]$ libpng http://www.libpng.org/ sudo dnf install -y libpng Doing things and working hard ... ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png
129. ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png ./differ: error while loading shared libraries: libpng16.so.16: cannot open shared object file: No such file or directory ⬢[rharter@toolbox differ]$ libpng http://www.libpng.org/ sudo dnf install -y libpng Doing things and working hard ... ⬢[rharter@toolbox differ]$ ./differ -- verbose cat.png cat-bad.png Starting to load first image: ./differ/src/commonTest/resources/cat.png Loaded ./differ/src/commonTest/resources/cat.png in 43ms Starting to load second image: ./differ/src/commonTest/resources/cat-bad.png Loaded ./differ/src/commonTest/resources/cat-bad.png in 43ms Starting comparison Finished comparison in 1602ms Images are different
130. Executable Executable Distribution Static Dynamic Operating System
131. Distribution Static JVM Executable Operating System Executable Dynamic
132. Distribution Static Dynamic JVM Executable Operating System Executable Executable
133. ImageIO javax.image ⬢[rharter@toolbox differ]$ java \
134. ImageIO javax.image ⬢[rharter@toolbox differ]$ java \ -classpath $APP_HOME/lib/cli-jvm-0.0.2-SNAPSHOT.jar:$APP_HOME/lib/ kotlinx-io-0.1.16.jar:$APP_HOME/lib/differ-jvm-0.0.2-SNAPSHOT.jar: $APP_HOME/lib/kotlinx-cli-jvm-0.3.4.jar:$APP_HOME/lib/kotlin-stdlib- jdk8-1.8.0.jar:$APP_HOME/lib/kotlin-stdlib-jdk7-1.8.0.jar:$APP_HOME/lib/ kotlin-stdlib-1.8.0.jar:$APP_HOME/lib/kotlin-stdlib-common-1.8.0.jar: $APP_HOME/lib/atomicfu-common-0.14.1.jar:$APP_HOME/lib/ annotations-13.0.jar \
135. ImageIO javax.image ⬢[rharter@toolbox differ]$ java \ -classpath $APP_HOME/lib/cli-jvm-0.0.2-SNAPSHOT.jar:$APP_HOME/lib/ kotlinx-io-0.1.16.jar:$APP_HOME/lib/differ-jvm-0.0.2-SNAPSHOT.jar: $APP_HOME/lib/kotlinx-cli-jvm-0.3.4.jar:$APP_HOME/lib/kotlin-stdlib- jdk8-1.8.0.jar:$APP_HOME/lib/kotlin-stdlib-jdk7-1.8.0.jar:$APP_HOME/lib/ kotlin-stdlib-1.8.0.jar:$APP_HOME/lib/kotlin-stdlib-common-1.8.0.jar: $APP_HOME/lib/atomicfu-common-0.14.1.jar:$APP_HOME/lib/ annotations-13.0.jar \ com.dropbox.differ.cli.jvm.JvmMainKt \
136. ImageIO javax.image ⬢[rharter@toolbox differ]$ java \ -classpath $APP_HOME/lib/cli-jvm-0.0.2-SNAPSHOT.jar:$APP_HOME/lib/ kotlinx-io-0.1.16.jar:$APP_HOME/lib/differ-jvm-0.0.2-SNAPSHOT.jar: $APP_HOME/lib/kotlinx-cli-jvm-0.3.4.jar:$APP_HOME/lib/kotlin-stdlib- jdk8-1.8.0.jar:$APP_HOME/lib/kotlin-stdlib-jdk7-1.8.0.jar:$APP_HOME/lib/ kotlin-stdlib-1.8.0.jar:$APP_HOME/lib/kotlin-stdlib-common-1.8.0.jar: $APP_HOME/lib/atomicfu-common-0.14.1.jar:$APP_HOME/lib/ annotations-13.0.jar \ com.dropbox.differ.cli.jvm.JvmMainKt \ - - verbose cat.png cat-bad.png
137. ImageIO javax.image ⬢[rharter@toolbox differ]$ java -jar cli-jvm-0.0.2.jar \ - - verbose cat.png cat-bad.png
138. ImageIO javax.image ⬢[rharter@toolbox differ]$ ./gradlew tasks
139. ImageIO javax.image ⬢[rharter@toolbox differ]$ ./gradlew tasks . . . Distribution tasks ------------------ assembleDist - Assembles the main distributions distTar - Bundles the project as a distribution. distZip - Bundles the project as a distribution. installDist - Installs the project as a distribution as-is. . . .
140. ImageIO javax.image ⬢[rharter@toolbox differ]$ ./gradlew tasks . . . Distribution tasks ------------------ assembleDist - Assembles the main distributions distTar - Bundles the project as a distribution. distZip - Bundles the project as a distribution. installDist - Installs the project as a distribution as-is. . . . installDist
141. ImageIO javax.image
142. ImageIO javax.image
143. - - verbose cat.png cat-bad.png ⬢[rharter@toolbox differ]$ ./differ ImageIO javax.image
144. - - verbose cat.png cat-bad.png ⬢[rharter@toolbox differ]$ ./bin/cli ImageIO javax.image
145. - - verbose cat.png cat-bad.png ⬢[rharter@toolbox differ]$ ./bin/cli Starting to load first image: ./differ/src/commonTest/resources/cat.png Loaded ./differ/src/commonTest/resources/cat.png in 136ms Starting to load second image: ./differ/src/commonTest/resources/cat-bad.png Loaded ./differ/src/commonTest/resources/cat-bad.png in 77ms Starting comparison Finished comparison in 188ms Images are different 222407 pixels are different Time: 407ms Differences: 222407 (8.044234%) FAIL ImageIO javax.image
146. Conclusion
147. Conclusion
148. Conclusion • Native dependencies are easier
149. Conclusion • Native dependencies are easier
150. Conclusion • Native dependencies are easier • Native performance is always better
151. Conclusion • Native dependencies are easier • Native performance is always better
152. Conclusion • Native dependencies are easier • Native performance is always better • Native distribution is easier
153. Conclusion • Native dependencies are easier • Native performance is always better • Native distribution is easier
154. Conclusion • Native dependencies are easier • Native performance is always better • Native distribution is easier • You should test your assumptions to see what works for you
155. Kotlin/Native CLIs Ryan Harter @ryan@harter.us