Skip to content

Commit 01dc7e5

Browse files
ollydevollydev
committed
dev
1 parent d7d57b4 commit 01dc7e5

27 files changed

+1530
-838
lines changed

‎.github/workflows/autobuild.yml

-140
This file was deleted.

‎.github/workflows/build.yml

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: Build
2+
3+
on:
4+
push:
5+
branches:
6+
- '**'
7+
pull_request:
8+
branches:
9+
- '**'
10+
11+
jobs:
12+
build:
13+
name: ${{ matrix.config.name }}
14+
runs-on: ${{ matrix.config.os }}
15+
defaults:
16+
run:
17+
shell: bash
18+
strategy:
19+
fail-fast: false
20+
matrix:
21+
config:
22+
- name: Windows 64
23+
os: windows-latest
24+
cpu: x86_64
25+
build-mode: WIN64
26+
binary: libsimpleocr64.dll
27+
28+
- name: Windows 32
29+
os: windows-latest
30+
cpu: i386
31+
build-mode: WIN32
32+
binary: libsimpleocr32.dll
33+
34+
- name: Linux 64
35+
os: ubuntu-latest
36+
cpu: x86_64
37+
build-mode: LINUX64
38+
binary: libsimpleocr64.so
39+
40+
- name: AArch64
41+
os: ubuntu-latest
42+
cpu: aarch64
43+
build-mode: AARCH64
44+
binary: libsimpleocr64.so.aarch64
45+
46+
- name: MacOS 64
47+
os: macos-latest
48+
cpu: x86_64
49+
build-mode: DARWIN64
50+
binary: libsimpleocr64.dylib
51+
52+
steps:
53+
- uses: actions/[email protected]
54+
55+
- name: Install Lazarus
56+
uses: ollydev/[email protected]
57+
with:
58+
cpu: ${{ matrix.config.cpu }}
59+
laz-branch: lazarus_2_2_0_RC1
60+
fpc-branch: release_3_2_2_rc1
61+
62+
- name: Build SimpleOCR
63+
run: |
64+
lazbuild --build-mode=${{ matrix.config.build-mode }} SimpleOCR.lpi
65+
66+
- name: Test SimpleOCR
67+
if: matrix.config.name == 'Windows 32'
68+
run: |
69+
unzip -q fonts
70+
cd test
71+
lazbuild tester.lpi
72+
./tester.exe
73+
74+
- name: Upload Binary
75+
uses: actions/[email protected]
76+
with:
77+
name: ${{ matrix.config.binary }}
78+
path: ${{ matrix.config.binary }}

‎.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
*.so.aarch64
55
*.bat
66
*.dylib
7+
*.res
8+
*.exe
79
backup
810
lib
9-
*.res
11+
/fonts/

‎README.md

+74-43
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,94 @@
1-
## SimpleOCR
1+
# SimpleOCR
22

3-
SimpleOCR is a Simba plugin for reading text in Old School RuneScape.
3+
SimpleOCR is a Simba plugin for reading text in Old School RuneScape originally developed by [@slackydev](https://github.com/slackydev/SimpleOCR).
44

5-
Results:
5+
The algorithm is very much designed for the games "blocky" text where no anti aliasing is applied. Every pixel of the glyph must match for for a character to be recognized.
66

7-
![Example](docs/uptext-1.png)
8-
```
9-
Recognized: Talk-to Grand Exchange Clerk / 262 more options
10-
````
7+
The actual character recognition is quite similar to calling Simba's `FindBitmap` for every character in the fontset.
118

12-
![Example](docs/uptext-2.png)
13-
```
14-
Recognized: Climb-up Ladder / 2 more option
9+
----
10+
11+
## Exported Methods
12+
13+
```pascal
14+
function TSimpleOCR.Recognize(Area: TBox; Filter: TOCRFilter; Font: TFontSet): String;
15+
function TSimpleOCR.RecognizeStatic(Area: TBox; Filter: TOCRFilter; Font: TFontSet; MaxWalk: Integer = 20): String;
16+
function TSimpleOCR.RecognizeLines(Area: TBox; Filter: TOCRFilter; Font: TFontSet; out TextBounds: TBoxArray): TStringArray; overload;
17+
function TSimpleOCR.RecognizeLines(Area: TBox; Filter: TOCRFilter; Font: TFontSet): TStringArray; overload;
18+
function TSimpleOCR.RecognizeUpText(Area: TBox; Filter: TOCRFilter; Font: TFontSet; MaxWalk: Integer = 20): String;
19+
function TSimpleOCR.RecognizeNumber(Area: TBox; Filter: TOCRFilter; Font: TFontSet): Int64;
20+
21+
function TSimpleOCR.LocateText(Area: TBox; Font: TFontSet; Filter: TOCRFilter; out Bounds: TBox): Single; overload;
22+
function TSimpleOCR.LocateText(Area: TBox; Font: TFontSet; out Bounds: TBox): Single; overload;
1523
```
1624

17-
-----
25+
----
1826

19-
## Exports
27+
## Filters
2028

21-
```pascal
22-
procedure TFontSet.Load(constref Font: String; constref Space: Int32 = 4);
23-
function TSimpleOCR.DrawText(constref Text: String; constref FontSet: TFontSet): T2DIntegerArray;
24-
function TSimpleOCR.Recognize(constref B: TBox; constref Filter: TCompareRules; constref Font: TFontSet; constref IsStatic: Boolean = False; constref MaxWalk: Int32 = 40): String; overload;
25-
function TSimpleOCR.RecognizeNumber(constref B: TBox; constref Filter: TCompareRules; constref Font: TFontSet; constref IsStatic: Boolean = False; constref MaxWalk: Int32 = 40): Int64;
26-
function TSimpleOCR.LocateText(constref B: TBox; constref Text: String; constref Font: TFontSet; constref Filter: TCompareRules; out Bounds: TBox): Single; overload;
27-
function TSimpleOCR.LocateText(constref B: TBox; constref Text: String; constref Font: TFontSet; constref Filter: TCompareRules; constref MinMatch: Single = 1): Boolean; overload;
28-
```
29+
- ### Color filter
2930

30-
-----
31+
Basic color finding.
32+
```pascal
33+
function TOCRColorFilter.Create(Colors, Tolerances: TIntegerArray): TOCRColorFilter; static;
34+
function TOCRColorFilter.Create(Colors: TIntegerArray): TOCRColorFilter; static; overload;
35+
```
36+
Example:
37+
```pascal
38+
TOCRColorFilter.Create([255]); // Find color red
39+
```
40+
![Example](images/filter_color_200.png)
3141

32-
`Filter` parameter:
42+
---
3343

34-
```pascal
35-
TCompareRules = packed record
36-
Color, Tolerance: Int32; // Color and tolerance. Color can be -1 to match any color.
37-
UseShadow: Boolean; // If the fontset has a shadow, it can be used to improve recognition.
38-
ShadowMaxValue: Int32; // Max brightness of shadow, Shadows are black so this is often low.
39-
Threshold: Boolean; // Threshold the image? If so all above fields are ignored.
40-
ThresholdAmount: Int32; // Threshold amount.
41-
ThresholdInvert: Boolean; // Threshold invert?
42-
UseShadowForColor: Boolean; // Find and offset shadows by (-1,-1) and use most common color to recognize text with.
43-
MinCharacterMatch: Int32; // Minimum hits required to match a character. Useful to remove smaller characters (like dots) that are often misread.
44-
end;
45-
```
44+
- ### Invert Color Filter
45+
46+
Basic color finding but inverted.
47+
```pascal
48+
function TOCRInvertColorFilter.Create(Colors, Tolerances: TIntegerArray): TOCRInvertColorFilter; static; overload;
49+
function TOCRInvertColorFilter.Create(Colors: TIntegerArray): TOCRInvertColorFilter; static; overload;
50+
```
51+
Example:
52+
```pascal
53+
TOCRInvertColorFilter.Create([3358536, 0], [3, 10]); // Everything but brown and black (text shadow)
54+
```
55+
![Example](images/filter_invertcolor_200.png)
56+
57+
---
4658

47-
-----
59+
- ### Threshold Filter
4860

49-
`IsStatic` parameter:
61+
If a pixel brightness value is greater than a threshold amount, it is assigned white, else it is assigned black.
62+
```pascal
63+
function TOCRThresholdFilter.Create(Amount: Integer; Invert: Boolean = False): TOCRThresholdFilter; static;
64+
```
65+
Example:
66+
```pascal
67+
TOCRThresholdFilter.Create(10); // Orange and red are brighter than the brown background
68+
```
69+
![Example](images/filter_threshold_200.png)
5070

51-
If the starting position (X1,Y1) of the text never changes the text is static which greatly increases accuracy and speed. If this is the case you must pass the *pixel perfect* bounds of the text you want to read.
71+
---
5272

53-
-----
73+
- ### Shadow Filter
5474

55-
`MaxWalk` parameter:
75+
First shadows are found using average R,G,B value. `Shadow = (R+G+B div 3) < MaxShadowValue`
5676

57-
How far the OCR looks on the X axis before giving up. By default this is `40` so if no characaters are matched in 40 pixels the function finishes.
77+
Next shadow pixels are offset by -1,-1. The most common color from the offset pixels is used for the search color.
78+
```pascal
79+
function TOCRShadowFilter.Create(MaxShadowValue: Integer = 25; Tolerance: Integer = 5): TOCRShadowFilter; static;
80+
```
81+
Example:
82+
```pascal
83+
TOCRShadowFilter.Create();
84+
```
85+
![Example](images/filter_shadow_400.png)
86+
87+
----
5888

59-
-----
89+
## Locate Text
6090

61-
`LocateText` function:
91+
The `LocateText` function does **not** OCR! An image of the desired text is generated and searched for. Again quite similar to Simba's `FindBitmap`.
92+
- A filter is not required if each pixel of the text is the exact same color. Although this is quite a lot slower.
93+
- Will not work if the spacing between characters is dynamic.
6294

63-
LocateText does not OCR! In simple terms a bitmap of the text is created (Using DrawText) and searched for. Color can be `-1` though each pixel of the text must be the exact same color.

0 commit comments

Comments
 (0)