/
ImagePut.ahk
1882 lines (1485 loc) · 80.8 KB
/
ImagePut.ahk
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
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
; Script: ImagePut.ahk
; License: MIT License
; Author: Edison Hua (iseahound)
; Date: 2021-09-28
; Version: v1.1
#Requires AutoHotkey v2-a134+
; Puts the image into a file format and returns a base64 encoded string.
; extension - File Encoding | string -> bmp, gif, jpg, png, tiff
; quality - JPEG Quality Level | integer -> 0 - 100
ImagePutBase64(image, extension := "", quality := "")
=> ImagePut("base64", image,,, extension, quality)
; Puts the image into a GDI+ Bitmap and returns a pointer.
ImagePutBitmap(image)
=> ImagePut("bitmap", image)
; Puts the image into a GDI+ Bitmap and returns a buffer object with GDI+ scope.
ImagePutBuffer(image)
=> ImagePut("buffer", image)
; Puts the image onto the clipboard and returns ClipboardAll().
ImagePutClipboard(image)
=> ImagePut("clipboard", image)
; Puts the image as the cursor and returns the variable A_Cursor.
; xHotspot - X Click Point | pixel -> 0 - width
; yHotspot - Y Click Point | pixel -> 0 - height
ImagePutCursor(image, xHotspot := "", yHotspot := "")
=> ImagePut("cursor", image,,, xHotspot, yHotspot)
; Puts the image behind the desktop icons and returns the string "desktop".
; scale - Scale Factor | real -> A_ScreenHeight / height.
ImagePutDesktop(image, scale := 1)
=> ImagePut("desktop", image,, scale)
; Puts the image into a file and returns a relative filepath.
; filepath - Filepath + Extension | string -> *.bmp, *.gif, *.jpg, *.png, *.tiff
; quality - JPEG Quality Level | integer -> 0 - 100
ImagePutFile(image, filepath := "", quality := "")
=> ImagePut("file", image,,, filepath, quality)
; Puts the image into a device independent bitmap and returns the handle.
; alpha - Alpha Replacement Color | RGB -> 0xFFFFFF
ImagePutHBitmap(image, alpha := "")
=> ImagePut("hBitmap", image,,, alpha)
; Puts the image into a file format and returns a hexadecimal encoded string.
; extension - File Encoding | string -> bmp, gif, jpg, png, tiff
; quality - JPEG Quality Level | integer -> 0 - 100
ImagePutHex(image, extension := "", quality := "")
=> ImagePut("hex", image,,, extension, quality)
; Puts the image into an icon and returns the handle.
ImagePutHIcon(image)
=> ImagePut("hBitmap", image)
; Puts the image into a file format and returns a pointer to a RandomAccessStream.
; extension - File Encoding | string -> bmp, gif, jpg, png, tiff
; quality - JPEG Quality Level | integer -> 0 - 100
ImagePutRandomAccessStream(image, extension := "", quality := "")
=> ImagePut("RandomAccessStream", image,,, extension, quality)
; Puts the image on the shared screen device context and returns an array of coordinates.
; screenshot - Screen Coordinates | array -> [x,y,w,h] or [0,0]
; alpha - Alpha Replacement Color | RGB -> 0xFFFFFF
ImagePutScreenshot(image, screenshot := "", alpha := "")
=> ImagePut("screenshot", image,,, screenshot, alpha)
; Puts the image into a file format and returns a pointer to a stream.
; extension - File Encoding | string -> bmp, gif, jpg, png, tiff
; quality - JPEG Quality Level | integer -> 0 - 100
ImagePutStream(image, extension := "", quality := "")
=> ImagePut("stream", image,,, extension, quality)
; Puts the image as the desktop wallpaper and returns the string "wallpaper".
ImagePutWallpaper(image)
=> ImagePut("wallpaper", image)
; Puts the image in a window and returns a handle to a window.
; title - Window Caption Title | string -> MyTitle
ImagePutWindow(image, title := "")
=> ImagePut("window", image,,, title)
class ImagePut {
; ImagePut() - Puts an image from anywhere to anywhere.
; cotype - Output Type | string -> Case Insensitive. Read documentation.
; image - Input Image | image -> Anything. Refer to ImageType().
; crop - Crop Coordinates | array -> [x,y,w,h] could be negative or percent.
; scale - Scale Factor | real -> 2.0
; terms* - Additional Parameters | variadic -> Extra parameters found in toCotype().
static call(cotype, image, crop := "", scale := "", terms*) {
this.gdiplusStartup()
; Take a guess as to what the image might be. (>90% accuracy!)
try type := this.DontVerifyImageType(image)
catch
type := this.ImageType(image)
; Qualify additional parameters for correctness.
_crop := IsObject(crop)
&& crop[1] ~= "^-?\d+(\.\d*)?%?$" && crop[2] ~= "^-?\d+(\.\d*)?%?$"
&& crop[3] ~= "^-?\d+(\.\d*)?%?$" && crop[4] ~= "^-?\d+(\.\d*)?%?$"
_scale := scale != 1 && scale ~= "^\d+(\.\d+)?$"
; Make a copy of the image as a pBitmap.
pBitmap := this.toBitmap(type, image)
; Crop the image.
if (_crop) {
pBitmap2 := this.BitmapCrop(pBitmap, crop)
DllCall("gdiplus\GdipDisposeImage", "ptr", pBitmap)
pBitmap := pBitmap2
}
; Scale the image.
if (_scale) {
pBitmap2 := this.BitmapScale(pBitmap, scale)
DllCall("gdiplus\GdipDisposeImage", "ptr", pBitmap)
pBitmap := pBitmap2
}
; Put the pBitmap to wherever the cotype specifies.
coimage := this.toCotype(cotype, pBitmap, terms*)
; Clean up the pBitmap copy. Export raw pointers if requested.
if !(cotype = "bitmap" || cotype = "buffer")
DllCall("gdiplus\GdipDisposeImage", "ptr", pBitmap)
this.gdiplusShutdown(cotype)
return coimage
}
static DontVerifyImageType(image) {
if !IsObject(image)
throw Error("Must be an object.")
; Check for image type declarations.
; Assumes that the user is telling the truth.
if ObjHasOwnProp(image, "clipboard") {
image := image.clipboard
return "clipboard"
}
if ObjHasOwnProp(image, "object") {
image := image.object
return "object"
}
if ObjHasOwnProp(image, "buffer") {
image := image.buffer
return "buffer"
}
if ObjHasOwnProp(image, "screenshot") {
image := image.screenshot
return "screenshot"
}
if ObjHasOwnProp(image, "window") {
image := image.window
return "window"
}
if ObjHasOwnProp(image, "desktop") {
image := image.desktop
return "desktop"
}
if ObjHasOwnProp(image, "wallpaper") {
image := image.wallpaper
return "wallpaper"
}
if ObjHasOwnProp(image, "cursor") {
image := image.cursor
return "cursor"
}
if ObjHasOwnProp(image, "url") {
image := image.url
return "url"
}
if ObjHasOwnProp(image, "file") {
image := image.file
return "file"
}
if ObjHasOwnProp(image, "monitor") {
image := image.monitor
return "monitor"
}
if ObjHasOwnProp(image, "hBitmap") {
image := image.hBitmap
return "hBitmap"
}
if ObjHasOwnProp(image, "hIcon") {
image := image.hIcon
return "hIcon"
}
if ObjHasOwnProp(image, "bitmap") {
image := image.bitmap
return "bitmap"
}
if ObjHasOwnProp(image, "stream") {
image := image.stream
return "stream"
}
if ObjHasOwnProp(image, "RandomAccessStream") {
image := image.RandomAccessStream
return "RandomAccessStream"
}
if ObjHasOwnProp(image, "hex") {
image := image.hex
return "hex"
}
if ObjHasOwnProp(image, "base64") {
image := image.base64
return "base64"
}
if ObjHasOwnProp(image, "sprite") {
image := image.sprite
return "sprite"
}
throw Error("Invalid type.")
}
static ImageType(image) {
; Throw if the image is an empty string.
if (image == "")
throw Error("Image data is an empty string.")
if IsObject(image) {
; A "clipboard" is a buffer object containing binary data returned by ClipboardAll()
if (image.base.HasOwnProp("__class") && image.base.__class == "ClipboardAll")
return "clipboard"
; A "object" has a pBitmap property that points to an internal GDI+ bitmap.
if image.HasOwnProp("pBitmap")
return "object"
; A "buffer" is an object with ptr and size properties.
if image.HasOwnProp("ptr") && image.HasOwnProp("size")
return "buffer"
; A "screenshot" is an array of 4 numbers.
if (image[1] ~= "^-?\d+$" && image[2] ~= "^-?\d+$" && image[3] ~= "^-?\d+$" && image[4] ~= "^-?\d+$")
return "screenshot"
}
; A "window" is anything considered a Window Title including ahk_class and "A".
if WinExist(image)
return "window"
; A "desktop" is a hidden window behind the desktop icons created by ImagePutDesktop.
if (image = "desktop")
return "desktop"
; A "wallpaper" is the desktop wallpaper.
if (image = "wallpaper")
return "wallpaper"
; A "cursor" is the name of a known cursor name.
if (image ~= "(?i)^(IDC|OCR)?_?(A_Cursor|AppStarting|Arrow|Cross|Help|IBeam|"
. "Icon|No|Size|SizeAll|SizeNESW|SizeNS|SizeNWSE|SizeWE|UpArrow|Wait|Unknown)$")
return "cursor"
; A "url" satisfies the url format.
if this.is_url(image)
return "url"
; A "file" is stored on the disk or network.
if FileExist(image)
return "file"
if IsInteger(image) {
; A non-zero "monitor" number identifies each display uniquely; and 0 refers to the entire virtual screen.
if (image >= 0 && image <= MonitorGetCount())
return "monitor"
; An "hBitmap" is a handle to a GDI Bitmap.
if (DllCall("GetObjectType", "ptr", image) == 7)
return "hBitmap"
; An "hIcon" is a handle to a GDI icon.
if DllCall("DestroyIcon", "ptr", DllCall("CopyIcon", "ptr", image, "ptr"))
return "hIcon"
; A "bitmap" is a pointer to a GDI+ Bitmap.
try if !DllCall("gdiplus\GdipGetImageType", "ptr", image, "ptr*", &type:=0) && (type == 1)
return "bitmap"
; Note 1: All GDI+ functions add 1 to the reference count of COM objects.
; Note 2: GDI+ pBitmaps that are queried cease to stay pBitmaps.
ObjRelease(image)
; A "stream" is a pointer to the IStream interface.
try if ComObjQuery(image, "{0000000C-0000-0000-C000-000000000046}")
return "stream"
; A "RandomAccessStream" is a pointer to the IRandomAccessStream interface.
try if ComObjQuery(image, "{905A0FE1-BC53-11DF-8C49-001E4FC686DA}")
return "RandomAccessStream"
}
; A "hex" string is binary image data encoded into text using hexadecimal.
if (StrLen(image) >= 116) && (image ~= "(?i)^\s*(0x)?[0-9a-f]+\s*$")
return "hex"
; A "base64" string is binary image data encoded into text using only 64 characters.
if (StrLen(image) >= 80) && (image ~= "^\s*(?:data:image\/[a-z]+;base64,)?"
. "(?:[A-Za-z0-9+\/]{4})*+(?:[A-Za-z0-9+\/]{3}=|[A-Za-z0-9+\/]{2}==)?\s*$")
return "base64"
; For more helpful error messages: Catch file names without extensions!
for extension in ["bmp","dib","rle","jpg","jpeg","jpe","jfif","gif","tif","tiff","png","ico","exe","dll"]
if FileExist(image "." extension)
throw Error("A ." extension " file extension is required!")
throw Error("Image type could not be identified.")
}
static toBitmap(type, image) {
if (type = "clipboard")
return this.from_clipboard()
if (type = "object")
return this.from_object(image)
if (type = "buffer")
return this.from_buffer(image)
if (type = "screenshot")
return this.from_screenshot(image)
if (type = "window")
return this.from_window(image)
if (type = "desktop")
return this.from_desktop()
if (type = "wallpaper")
return this.from_wallpaper()
if (type = "cursor")
return this.from_cursor()
if (type = "url")
return this.from_url(image)
if (type = "file")
return this.from_file(image)
if (type = "monitor")
return this.from_monitor(image)
if (type = "hBitmap")
return this.from_hBitmap(image)
if (type = "hIcon")
return this.from_hIcon(image)
if (type = "bitmap")
return this.from_bitmap(image)
if (type = "stream")
return this.from_stream(image)
if (type = "RandomAccessStream")
return this.from_RandomAccessStream(image)
if (type = "hex")
return this.from_hex(image)
if (type = "base64")
return this.from_base64(image)
if (type = "sprite")
return this.from_sprite(image)
throw Error("Conversion from type " type " is not supported.")
}
static toCotype(cotype, pBitmap, term1 := "", term2 := "", *) {
; toCotype("clipboard", pBitmap)
if (cotype = "clipboard")
return this.put_clipboard(pBitmap)
; toCotype("buffer", pBitmap)
if (cotype = "buffer")
return this.put_buffer(pBitmap)
; toCotype("screenshot", pBitmap, screenshot, alpha)
if (cotype = "screenshot")
return this.put_screenshot(pBitmap, term1, term2)
; toCotype("window", pBitmap, title)
if (cotype = "window")
return this.put_window(pBitmap, term1)
; toCotype("desktop", pBitmap)
if (cotype = "desktop")
return this.put_desktop(pBitmap)
; toCotype("wallpaper", pBitmap)
if (cotype = "wallpaper")
return this.put_wallpaper(pBitmap)
; toCotype("cursor", pBitmap, xHotspot, yHotspot)
if (cotype = "cursor")
return this.put_cursor(pBitmap, term1, term2)
; toCotype("url", pBitmap)
if (cotype = "url")
return this.put_url(pBitmap)
; toCotype("file", pBitmap, filename, quality)
if (cotype = "file")
return this.put_file(pBitmap, term1, term2)
; toCotype("hBitmap", pBitmap, alpha)
if (cotype = "hBitmap")
return this.put_hBitmap(pBitmap, term1)
; toCotype("hIcon", pBitmap)
if (cotype = "hIcon")
return this.put_hIcon(pBitmap)
; toCotype("bitmap", pBitmap)
if (cotype = "bitmap")
return pBitmap
; toCotype("stream", pBitmap, extension, quality)
if (cotype = "stream")
return this.put_stream(pBitmap, term1, term2)
; toCotype("RandomAccessStream", pBitmap, extension, quality)
if (cotype = "RandomAccessStream")
return this.put_RandomAccessStream(pBitmap, term1, term2)
; toCotype("hex", pBitmap, extension, quality)
if (cotype = "hex")
return this.put_hex(pBitmap, term1, term2)
; toCotype("base64", pBitmap, extension, quality)
if (cotype = "base64")
return this.put_base64(pBitmap, term1, term2)
throw Error("Conversion to type " cotype " is not supported.")
}
static DisposeImage(pBitmap) {
return DllCall("gdiplus\GdipDisposeImage", "ptr", pBitmap)
}
static BitmapCrop(pBitmap, crop) {
; Get Bitmap width, height, and format.
DllCall("gdiplus\GdipGetImageWidth", "ptr", pBitmap, "uint*", &width:=0)
DllCall("gdiplus\GdipGetImageHeight", "ptr", pBitmap, "uint*", &height:=0)
DllCall("gdiplus\GdipGetImagePixelFormat", "ptr", pBitmap, "uint*", &format:=0)
; Are the numbers percentages?
crop[3] := (crop[3] ~= "%$") ? SubStr(crop[3], 1, -1) * 0.01 * width : crop[3]
crop[4] := (crop[4] ~= "%$") ? SubStr(crop[4], 1, -1) * 0.01 * height : crop[4]
crop[1] := (crop[1] ~= "%$") ? SubStr(crop[1], 1, -1) * 0.01 * width : crop[1]
crop[2] := (crop[2] ~= "%$") ? SubStr(crop[2], 1, -1) * 0.01 * height : crop[2]
; If numbers are negative, subtract the values from the edge.
crop[3] := (crop[3] < 0) ? width - Abs(crop[3]) - Abs(crop[1]) : crop[3]
crop[4] := (crop[4] < 0) ? height - Abs(crop[4]) - Abs(crop[2]) : crop[4]
crop[1] := Abs(crop[1])
crop[2] := Abs(crop[2])
; Round to the nearest integer.
crop[3] := Round(crop[1] + crop[3]) - Round(crop[1]) ; A reminder that width and height
crop[4] := Round(crop[2] + crop[4]) - Round(crop[2]) ; are distances, not coordinates.
crop[1] := Round(crop[1]) ; so the abstract concept of a distance must be resolved
crop[2] := Round(crop[2]) ; into coordinates and then rounded and added up again.
; Variance Shift. Now place x,y before w,h because we are building abstracts from reals now.
; Before we were resolving abstracts into real coordinates, now it's the opposite.
; Ensure that coordinates can never exceed the expected Bitmap area.
safe_x := (crop[1] > width) ? 0 : crop[1] ; Zero x if bigger.
safe_y := (crop[2] > height) ? 0 : crop[2] ; Zero y if bigger.
safe_w := (crop[1] + crop[3] > width) ? width - safe_x : crop[3] ; Max w if bigger.
safe_h := (crop[2] + crop[4] > height) ? height - safe_y : crop[4] ; Max h if bigger.
; Clone
DllCall("gdiplus\GdipCloneBitmapAreaI"
, "int", safe_x
, "int", safe_y
, "int", safe_w
, "int", safe_h
, "int", format
, "ptr", pBitmap
, "ptr*", &pBitmapCrop:=0)
return pBitmapCrop
}
static BitmapScale(pBitmap, scale) {
; Get Bitmap width, height, and format.
DllCall("gdiplus\GdipGetImageWidth", "ptr", pBitmap, "uint*", &width:=0)
DllCall("gdiplus\GdipGetImageHeight", "ptr", pBitmap, "uint*", &height:=0)
DllCall("gdiplus\GdipGetImagePixelFormat", "ptr", pBitmap, "uint*", &format:=0)
safe_w := Ceil(width * scale)
safe_h := Ceil(height * scale)
; Create a new bitmap and get the graphics context.
DllCall("gdiplus\GdipCreateBitmapFromScan0"
, "int", safe_w, "int", safe_h, "int", 0, "int", format, "ptr", 0, "ptr*", &pBitmapScale:=0)
DllCall("gdiplus\GdipGetImageGraphicsContext", "ptr", pBitmapScale, "ptr*", &pGraphics:=0)
; Set settings in graphics context.
DllCall("gdiplus\GdipSetPixelOffsetMode", "ptr", pGraphics, "int", 2) ; Half pixel offset.
DllCall("gdiplus\GdipSetCompositingMode", "ptr", pGraphics, "int", 1) ; Overwrite/SourceCopy.
DllCall("gdiplus\GdipSetInterpolationMode", "ptr", pGraphics, "int", 7) ; HighQualityBicubic
; Draw Image.
DllCall("gdiplus\GdipCreateImageAttributes", "ptr*", &ImageAttr:=0)
DllCall("gdiplus\GdipSetImageAttributesWrapMode", "ptr", ImageAttr, "int", 3) ; WrapModeTileFlipXY
DllCall("gdiplus\GdipDrawImageRectRectI"
, "ptr", pGraphics
, "ptr", pBitmap
, "int", 0, "int", 0, "int", safe_w, "int", safe_h ; destination rectangle
, "int", 0, "int", 0, "int", width, "int", height ; source rectangle
, "int", 2
, "ptr", ImageAttr
, "ptr", 0
, "ptr", 0)
DllCall("gdiplus\GdipDisposeImageAttributes", "ptr", ImageAttr)
; Clean up the graphics context.
DllCall("gdiplus\GdipDeleteGraphics", "ptr", pGraphics)
return pBitmapScale
}
static is_url(url) {
; Thanks dperini - https://gist.github.com/dperini/729294
; Also see for comparisons: https://mathiasbynens.be/demo/url-regex
; Modified to be compatible with AutoHotkey. \u0000 -> \x{0000}.
; Force the declaration of the protocol because WinHttp requires it.
return url ~= "^(?i)"
. "(?:(?:https?|ftp):\/\/)" ; protocol identifier (FORCE)
. "(?:\S+(?::\S*)?@)?" ; user:pass BasicAuth (optional)
. "(?:"
; IP address exclusion
; private & local networks
. "(?!(?:10|127)(?:\.\d{1,3}){3})"
. "(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})"
. "(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})"
; IP address dotted notation octets
; excludes loopback network 0.0.0.0
; excludes reserved space >= 224.0.0.0
; excludes network & broadcast addresses
; (first & last IP address of each class)
. "(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])"
. "(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}"
. "(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))"
. "|"
; host & domain names, may end with dot
; can be replaced by a shortest alternative
; (?![-_])(?:[-\\w\\u00a1-\\uffff]{0,63}[^-_]\\.)+
. "(?:(?:[a-z0-9\x{00a1}-\x{ffff}][a-z0-9\x{00a1}-\x{ffff}_-]{0,62})?[a-z0-9\x{00a1}-\x{ffff}]\.)+"
; TLD identifier name, may end with dot
. "(?:[a-z\x{00a1}-\x{ffff}]{2,}\.?)"
. ")"
. "(?::\d{2,5})?" ; port number (optional)
. "(?:[/?#]\S*)?$" ; resource path (optional)
}
static from_clipboard() {
; Open the clipboard with exponential backoff.
loop
if DllCall("OpenClipboard", "ptr", 0)
break
else
if A_Index < 6
Sleep (2**(A_Index-1) * 30)
else throw Error("Clipboard could not be opened.")
; Prefer the PNG stream if available considering it supports transparency.
png := DllCall("RegisterClipboardFormat", "str", "png", "uint")
if DllCall("IsClipboardFormatAvailable", "uint", png, "int") {
hData := DllCall("GetClipboardData", "uint", png, "ptr")
DllCall("ole32\CreateStreamOnHGlobal", "ptr", hData, "int", true, "ptr*", &pStream:=0)
DllCall("gdiplus\GdipCreateBitmapFromStream", "ptr", pStream, "ptr*", &pBitmap:=0)
ObjRelease(pStream)
}
; Fallback to CF_BITMAP. This format does not support transparency even with put_hBitmap().
else if DllCall("IsClipboardFormatAvailable", "uint", 2, "int") {
hBitmap := DllCall("GetClipboardData", "uint", 2, "ptr")
DllCall("gdiplus\GdipCreateBitmapFromHBITMAP", "ptr", hBitmap, "ptr", 0, "ptr*", &pBitmap:=0)
DllCall("DeleteObject", "ptr", hBitmap)
}
DllCall("CloseClipboard")
return pBitmap
}
static from_object(image) {
return this.from_bitmap(image.pBitmap)
}
static from_buffer(image) {
; to do
}
static from_screenshot(image) {
; Thanks tic - https://www.autohotkey.com/boards/viewtopic.php?t=6517
; struct BITMAPINFOHEADER - https://docs.microsoft.com/en-us/windows/win32/api/wingdi/ns-wingdi-bitmapinfoheader
hdc := DllCall("CreateCompatibleDC", "ptr", 0, "ptr")
bi := Buffer(40, 0) ; sizeof(bi) = 40
NumPut( "uint", 40, bi, 0) ; Size
NumPut( "int", image[3], bi, 4) ; Width
NumPut( "int", -image[4], bi, 8) ; Height - Negative so (0, 0) is top-left.
NumPut("ushort", 1, bi, 12) ; Planes
NumPut("ushort", 32, bi, 14) ; BitCount / BitsPerPixel
hbm := DllCall("CreateDIBSection", "ptr", hdc, "ptr", bi, "uint", 0, "ptr*", &pBits:=0, "ptr", 0, "uint", 0, "ptr")
obm := DllCall("SelectObject", "ptr", hdc, "ptr", hbm, "ptr")
; Retrieve the device context for the screen.
sdc := DllCall("GetDC", "ptr", 0, "ptr")
; Copies a portion of the screen to a new device context.
DllCall("gdi32\BitBlt"
, "ptr", hdc, "int", 0, "int", 0, "int", image[3], "int", image[4]
, "ptr", sdc, "int", image[1], "int", image[2], "uint", 0x00CC0020 | 0x40000000) ; SRCCOPY | CAPTUREBLT
; Release the device context to the screen.
DllCall("ReleaseDC", "ptr", 0, "ptr", sdc)
; Convert the hBitmap to a Bitmap using a built in function as there is no transparency.
DllCall("gdiplus\GdipCreateBitmapFromHBITMAP", "ptr", hbm, "ptr", 0, "ptr*", &pBitmap:=0)
; Cleanup the hBitmap and device contexts.
DllCall("SelectObject", "ptr", hdc, "ptr", obm)
DllCall("DeleteObject", "ptr", hbm)
DllCall("DeleteDC", "ptr", hdc)
return pBitmap
}
static from_window(image) {
; Thanks tic - https://www.autohotkey.com/boards/viewtopic.php?t=6517
; Get the handle to the window.
image := WinExist(image)
; Restore the window if minimized! Must be visible for capture.
if DllCall("IsIconic", "ptr", image)
DllCall("ShowWindow", "ptr", image, "int", 4)
; Get the width and height of the client window.
Rect := Buffer(16) ; sizeof(RECT) = 16
DllCall("GetClientRect", "ptr", image, "ptr", Rect)
, width := NumGet(Rect, 8, "int")
, height := NumGet(Rect, 12, "int")
; struct BITMAPINFOHEADER - https://docs.microsoft.com/en-us/windows/win32/api/wingdi/ns-wingdi-bitmapinfoheader
hdc := DllCall("CreateCompatibleDC", "ptr", 0, "ptr")
bi := Buffer(40, 0) ; sizeof(bi) = 40
NumPut( "uint", 40, bi, 0) ; Size
NumPut( "int", width, bi, 4) ; Width
NumPut( "int", -height, bi, 8) ; Height - Negative so (0, 0) is top-left.
NumPut("ushort", 1, bi, 12) ; Planes
NumPut("ushort", 32, bi, 14) ; BitCount / BitsPerPixel
hbm := DllCall("CreateDIBSection", "ptr", hdc, "ptr", bi, "uint", 0, "ptr*", &pBits:=0, "ptr", 0, "uint", 0, "ptr")
obm := DllCall("SelectObject", "ptr", hdc, "ptr", hbm, "ptr")
; Print the window onto the hBitmap using an undocumented flag. https://stackoverflow.com/a/40042587
DllCall("PrintWindow", "ptr", image, "ptr", hdc, "uint", 0x3) ; PW_RENDERFULLCONTENT | PW_CLIENTONLY
; Additional info on how this is implemented: https://www.reddit.com/r/windows/comments/8ffr56/altprintscreen/
; Convert the hBitmap to a Bitmap using a built in function as there is no transparency.
DllCall("gdiplus\GdipCreateBitmapFromHBITMAP", "ptr", hbm, "ptr", 0, "ptr*", &pBitmap:=0)
; Cleanup the hBitmap and device contexts.
DllCall("SelectObject", "ptr", hdc, "ptr", obm)
DllCall("DeleteObject", "ptr", hbm)
DllCall("DeleteDC", "ptr", hdc)
return pBitmap
}
static from_desktop() {
; Find the child window.
windows := WinGetList("ahk_class WorkerW")
if (windows.length == 0)
throw Error("The hidden desktop window has not been initalized. Call ImagePutDesktop() first.")
Loop windows.length
hwnd := windows[A_Index]
until DllCall("FindWindowEx", "ptr", hwnd, "ptr", 0, "str", "SHELLDLL_DefView", "ptr", 0)
; Maybe this hack gets patched. Tough luck!
if !(WorkerW := DllCall("FindWindowEx", "ptr", 0, "ptr", hwnd, "str", "WorkerW", "ptr", 0, "ptr"))
throw Error("Could not locate hidden window behind desktop.")
; Get the width and height of the client window.
Rect := Buffer(16) ; sizeof(RECT) = 16
DllCall("GetClientRect", "ptr", WorkerW, "ptr", Rect)
, width := NumGet(Rect, 8, "int")
, height := NumGet(Rect, 12, "int")
; Get device context of spawned window.
sdc := DllCall("GetDCEx", "ptr", WorkerW, "ptr", 0, "int", 0x403, "ptr") ; LockWindowUpdate | Cache | Window
; struct BITMAPINFOHEADER - https://docs.microsoft.com/en-us/windows/win32/api/wingdi/ns-wingdi-bitmapinfoheader
hdc := DllCall("CreateCompatibleDC", "ptr", 0, "ptr")
bi := Buffer(40, 0) ; sizeof(bi) = 40
NumPut( "uint", 40, bi, 0) ; Size
NumPut( "int", width, bi, 4) ; Width
NumPut( "int", -height, bi, 8) ; Height - Negative so (0, 0) is top-left.
NumPut("ushort", 1, bi, 12) ; Planes
NumPut("ushort", 32, bi, 14) ; BitCount / BitsPerPixel
hbm := DllCall("CreateDIBSection", "ptr", hdc, "ptr", bi, "uint", 0, "ptr*", &pBits:=0, "ptr", 0, "uint", 0, "ptr")
obm := DllCall("SelectObject", "ptr", hdc, "ptr", hbm, "ptr")
; Copies a portion of the hidden window to a new device context.
DllCall("gdi32\BitBlt"
, "ptr", hdc, "int", 0, "int", 0, "int", width, "int", height
, "ptr", sdc, "int", 0, "int", 0, "uint", 0x00CC0020) ; SRCCOPY
; Convert the hBitmap to a Bitmap using a built in function as there is no transparency.
DllCall("gdiplus\GdipCreateBitmapFromHBITMAP", "ptr", hbm, "ptr", 0, "ptr*", &pBitmap:=0)
; Cleanup the hBitmap and device contexts.
DllCall("SelectObject", "ptr", hdc, "ptr", obm)
DllCall("DeleteObject", "ptr", hbm)
DllCall("DeleteDC", "ptr", hdc)
; Release device context of spawned window.
DllCall("ReleaseDC", "ptr", 0, "ptr", sdc)
return pBitmap
}
static from_wallpaper() {
; Get the width and height of all monitors.
width := DllCall("GetSystemMetrics", "int", 78, "int")
height := DllCall("GetSystemMetrics", "int", 79, "int")
; struct BITMAPINFOHEADER - https://docs.microsoft.com/en-us/windows/win32/api/wingdi/ns-wingdi-bitmapinfoheader
hdc := DllCall("CreateCompatibleDC", "ptr", 0, "ptr")
bi := Buffer(40, 0) ; sizeof(bi) = 40
NumPut( "uint", 40, bi, 0) ; Size
NumPut( "int", width, bi, 4) ; Width
NumPut( "int", -height, bi, 8) ; Height - Negative so (0, 0) is top-left.
NumPut("ushort", 1, bi, 12) ; Planes
NumPut("ushort", 32, bi, 14) ; BitCount / BitsPerPixel
hbm := DllCall("CreateDIBSection", "ptr", hdc, "ptr", bi, "uint", 0, "ptr*", &pBits:=0, "ptr", 0, "uint", 0, "ptr")
obm := DllCall("SelectObject", "ptr", hdc, "ptr", hbm, "ptr")
; Paints the desktop.
DllCall("PaintDesktop", "ptr", hdc)
; Convert the hBitmap to a Bitmap using a built in function as there is no transparency.
DllCall("gdiplus\GdipCreateBitmapFromHBITMAP", "ptr", hbm, "ptr", 0, "ptr*", &pBitmap:=0)
; Cleanup the hBitmap and device contexts.
DllCall("SelectObject", "ptr", hdc, "ptr", obm)
DllCall("DeleteObject", "ptr", hbm)
DllCall("DeleteDC", "ptr", hdc)
return pBitmap
}
static from_cursor() {
; Thanks 23W - https://stackoverflow.com/a/13295280
; struct CURSORINFO - https://docs.microsoft.com/en-us/windows/win32/api/winuser/ns-winuser-cursorinfo
ci := Buffer(16+A_PtrSize, 0) ; sizeof(CURSORINFO) = 20, 24
NumPut("int", ci.size, ci)
DllCall("GetCursorInfo", "ptr", ci)
; cShow := NumGet(ci, 4, "int") ; 0x1 = CURSOR_SHOWING, 0x2 = CURSOR_SUPPRESSED
, hCursor := NumGet(ci, 8, "ptr")
; xCursor := NumGet(ci, 8+A_PtrSize, "int")
; yCursor := NumGet(ci, 12+A_PtrSize, "int")
; Cursors are the same as icons!
pBitmap := this.from_hIcon(hCursor)
; Cleanup the handle to the cursor. Same as DestroyIcon.
DllCall("DestroyCursor", "ptr", hCursor)
return pBitmap
}
static from_url(image) {
req := ComObject("WinHttp.WinHttpRequest.5.1")
req.Open("GET", image)
req.Send()
IStream := ComObjQuery(req.ResponseStream, "{0000000C-0000-0000-C000-000000000046}")
DllCall("gdiplus\GdipCreateBitmapFromStream", "ptr", IStream, "ptr*", &pBitmap:=0)
IStream := ""
return pBitmap
}
static from_file(image) {
DllCall("gdiplus\GdipCreateBitmapFromFile", "wstr", image, "ptr*", &pBitmap:=0)
return pBitmap
}
static from_monitor(image) {
if (image > 0) {
MonitorGet(image, &Left, &Top, &Right, &Bottom)
x := Left
y := Top
w := Right - Left
h := Bottom - Top
} else {
x := DllCall("GetSystemMetrics", "int", 76, "int")
y := DllCall("GetSystemMetrics", "int", 77, "int")
w := DllCall("GetSystemMetrics", "int", 78, "int")
h := DllCall("GetSystemMetrics", "int", 79, "int")
}
return this.from_screenshot([x,y,w,h])
}
static from_hBitmap(image) {
; struct DIBSECTION - https://docs.microsoft.com/en-us/windows/win32/api/wingdi/ns-wingdi-dibsection
; struct BITMAP - https://docs.microsoft.com/en-us/windows/win32/api/wingdi/ns-wingdi-bitmap
dib := Buffer(64+5*A_PtrSize) ; sizeof(DIBSECTION) = 84, 104
DllCall("GetObject", "ptr", image, "int", dib.size, "ptr", dib)
, width := NumGet(dib, 4, "uint")
, height := NumGet(dib, 8, "uint")
, bpp := NumGet(dib, 18, "ushort")
; Fallback to built-in method if pixels are not 32-bit ARGB.
if (bpp != 32) { ; This built-in version is 120% faster but ignores transparency.
DllCall("gdiplus\GdipCreateBitmapFromHBITMAP", "ptr", image, "ptr", 0, "ptr*", &pBitmap:=0)
return pBitmap
}
; Create a handle to a device context and associate the image.
sdc := DllCall("CreateCompatibleDC", "ptr", 0, "ptr") ; Creates a memory DC compatible with the current screen.
sbm := DllCall("SelectObject", "ptr", sdc, "ptr", image, "ptr") ; Put the (hBitmap) image onto the device context.
; Create a device independent bitmap with negative height. All DIBs use the screen pixel format (pARGB).
; Use hbm to buffer the image such that top-down and bottom-up images are mapped to this top-down buffer.
; pBits is the pointer to (top-down) pixel values. The Scan0 will point to the pBits.
; struct BITMAPINFOHEADER - https://docs.microsoft.com/en-us/windows/win32/api/wingdi/ns-wingdi-bitmapinfoheader
hdc := DllCall("CreateCompatibleDC", "ptr", 0, "ptr")
bi := Buffer(40, 0) ; sizeof(bi) = 40
NumPut( "uint", 40, bi, 0) ; Size
NumPut( "int", width, bi, 4) ; Width
NumPut( "int", -height, bi, 8) ; Height - Negative so (0, 0) is top-left.
NumPut("ushort", 1, bi, 12) ; Planes
NumPut("ushort", 32, bi, 14) ; BitCount / BitsPerPixel
hbm := DllCall("CreateDIBSection", "ptr", hdc, "ptr", bi, "uint", 0, "ptr*", &pBits:=0, "ptr", 0, "uint", 0, "ptr")
obm := DllCall("SelectObject", "ptr", hdc, "ptr", hbm, "ptr")
; This is the 32-bit ARGB pBitmap (different from an hBitmap) that will receive the final converted pixels.
DllCall("gdiplus\GdipCreateBitmapFromScan0"
, "int", width, "int", height, "int", 0, "int", 0x26200A, "ptr", 0, "ptr*", &pBitmap:=0)
; Create a Scan0 buffer pointing to pBits. The buffer has pixel format pARGB.
Rect := Buffer(16, 0) ; sizeof(Rect) = 16
NumPut( "uint", width, Rect, 8) ; Width
NumPut( "uint", height, Rect, 12) ; Height
BitmapData := Buffer(16+2*A_PtrSize, 0) ; sizeof(BitmapData) = 24, 32
NumPut( "int", 4 * width, BitmapData, 8) ; Stride
NumPut( "ptr", pBits, BitmapData, 16) ; Scan0
; Use LockBits to create a writable buffer that converts pARGB to ARGB.
DllCall("gdiplus\GdipBitmapLockBits"
, "ptr", pBitmap
, "ptr", Rect
, "uint", 6 ; ImageLockMode.UserInputBuffer | ImageLockMode.WriteOnly
, "int", 0xE200B ; Format32bppPArgb
, "ptr", BitmapData) ; Contains the pointer (pBits) to the hbm.
; Copies the image (hBitmap) to a top-down bitmap. Removes bottom-up-ness if present.
DllCall("gdi32\BitBlt"
, "ptr", hdc, "int", 0, "int", 0, "int", width, "int", height
, "ptr", sdc, "int", 0, "int", 0, "uint", 0x00CC0020) ; SRCCOPY
; Convert the pARGB pixels copied into the device independent bitmap (hbm) to ARGB.
DllCall("gdiplus\GdipBitmapUnlockBits", "ptr", pBitmap, "ptr", BitmapData)
; Cleanup the hBitmap and device contexts.
DllCall("SelectObject", "ptr", hdc, "ptr", obm)
DllCall("DeleteObject", "ptr", hbm)
DllCall("DeleteDC", "ptr", hdc)
DllCall("SelectObject", "ptr", sdc, "ptr", sbm)
DllCall("DeleteDC", "ptr", sdc)
return pBitmap
}
static from_hIcon(image) {
; struct ICONINFO - https://docs.microsoft.com/en-us/windows/win32/api/winuser/ns-winuser-iconinfo
ii := Buffer(8+3*A_PtrSize, 0) ; sizeof(ICONINFO) = 20, 32
DllCall("GetIconInfo", "ptr", image, "ptr", ii)
; xHotspot := NumGet(ii, 4, "uint")
; yHotspot := NumGet(ii, 8, "uint")
, hbmMask := NumGet(ii, 8+A_PtrSize, "ptr") ; 12, 16
, hbmColor := NumGet(ii, 8+2*A_PtrSize, "ptr") ; 16, 24
; struct BITMAP - https://docs.microsoft.com/en-us/windows/win32/api/wingdi/ns-wingdi-bitmap
bm := Buffer(16+2*A_PtrSize) ; sizeof(BITMAP) = 24, 32
DllCall("GetObject", "ptr", hbmMask, "int", bm.size, "ptr", bm)
, width := NumGet(bm, 4, "uint")
, height := NumGet(bm, 8, "uint") / (hbmColor ? 1 : 2) ; Black and White cursors have doubled height.
; Clean up these hBitmaps.
DllCall("DeleteObject", "ptr", hbmMask)
DllCall("DeleteObject", "ptr", hbmColor)
; struct BITMAPINFOHEADER - https://docs.microsoft.com/en-us/windows/win32/api/wingdi/ns-wingdi-bitmapinfoheader
hdc := DllCall("CreateCompatibleDC", "ptr", 0, "ptr")
bi := Buffer(40, 0) ; sizeof(bi) = 40
NumPut( "uint", 40, bi, 0) ; Size
NumPut( "int", width, bi, 4) ; Width
NumPut( "int", -height, bi, 8) ; Height - Negative so (0, 0) is top-left.
NumPut("ushort", 1, bi, 12) ; Planes
NumPut("ushort", 32, bi, 14) ; BitCount / BitsPerPixel
hbm := DllCall("CreateDIBSection", "ptr", hdc, "ptr", bi, "uint", 0, "ptr*", &pBits:=0, "ptr", 0, "uint", 0, "ptr")
obm := DllCall("SelectObject", "ptr", hdc, "ptr", hbm, "ptr")
; This is the 32-bit ARGB pBitmap (different from an hBitmap) that will receive the final converted pixels.
DllCall("gdiplus\GdipCreateBitmapFromScan0"
, "int", width, "int", height, "int", 0, "int", 0x26200A, "ptr", 0, "ptr*", &pBitmap:=0)
; Create a Scan0 buffer pointing to pBits. The buffer has pixel format pARGB.
Rect := Buffer(16, 0) ; sizeof(Rect) = 16
NumPut( "uint", width, Rect, 8) ; Width
NumPut( "uint", height, Rect, 12) ; Height
BitmapData := Buffer(16+2*A_PtrSize, 0) ; sizeof(BitmapData) = 24, 32
NumPut( "int", 4 * width, BitmapData, 8) ; Stride
NumPut( "ptr", pBits, BitmapData, 16) ; Scan0
; Use LockBits to create a writable buffer that converts pARGB to ARGB.
DllCall("gdiplus\GdipBitmapLockBits"
, "ptr", pBitmap
, "ptr", Rect
, "uint", 6 ; ImageLockMode.UserInputBuffer | ImageLockMode.WriteOnly
, "int", 0xE200B ; Format32bppPArgb
, "ptr", BitmapData) ; Contains the pointer (pBits) to the hbm.
; Don't use DI_DEFAULTSIZE to draw the icon like DrawIcon does as it will resize to 32 x 32.
DllCall("DrawIconEx"
, "ptr", hdc, "int", 0, "int", 0
, "ptr", image, "int", 0, "int", 0
, "uint", 0, "ptr", 0, "uint", 0x1 | 0x2 | 0x4) ; DI_MASK | DI_IMAGE | DI_COMPAT
; Convert the pARGB pixels copied into the device independent bitmap (hbm) to ARGB.
DllCall("gdiplus\GdipBitmapUnlockBits", "ptr", pBitmap, "ptr", BitmapData)
; Cleanup the hBitmap and device contexts.
DllCall("SelectObject", "ptr", hdc, "ptr", obm)
DllCall("DeleteObject", "ptr", hbm)
DllCall("DeleteDC", "ptr", hdc)
return pBitmap
}
static from_bitmap(image) {