[EPIC-6378] Prepare/restructure for stable RC #19

yurii-scanbot · 2025-08-18T16:04:06Z

No description provided.

… sync across Java/Python/C wrappers

examples/c/src/snippets/license/floating_license.c

cyrillicw · 2025-08-19T14:38:42Z

examples/c/src/snippets/document/crop_and_analyse.c

+    if (ec != SCANBOTSDK_OK) { fprintf(stderr, "get_detection_result: %d: %s\n", ec, error_message(ec)); goto cleanup; }
+
+    scanbotsdk_document_detection_result_get_status(detect_result, &status);
+    printf("Document Detection Status = %d\n", (int)status);


Is int representation of the status useful for the user?

examples/c/src/snippets/document/detect_document.c

examples/c/src/snippets/datacapture/ocr.c

cyrillicw · 2025-08-19T14:56:56Z

examples/c/src/snippets/document/document_classifier.c

+    if (ec != SCANBOTSDK_OK) { fprintf(stderr, "classifier_run: %d: %s\n", ec, error_message(ec)); goto cleanup; }
+
+    ec = scanbotsdk_document_classifier_result_get_status(result, &status);
+    printf("Classifier Status: %d\n", (int)status);


Are int statuses here and below meaningful for the user?

examples/c/src/snippets/document/document_classifier.c

cyrillicw · 2025-08-20T07:47:54Z

examples/c/src/snippets/datacapture/credit_card_scanner.c

+    if (ec != SCANBOTSDK_OK) { fprintf(stderr, "get_check: %d\n", ec); return ec; }
+
+    scanbotsdk_credit_card_scanning_result_get_detection_status(result, &status);
+    printf("Document Detection Status = %d\n", (int)status);


Int status doesn't provide user with any useful information

examples/c/src/utils/utils.c

examples/c/src/main.c

cyrillicw · 2025-08-20T14:53:29Z

examples/c/src/main.c

+    else if (strcmp(category, "classify") == 0) {
+        if (!file_path) { print_usage(argv[0]); return 1; }
+
+        scanbotsdk_image_t *image = NULL;


image is not freed

refactored with
scanbotsdk_image_free(image);
at the end of condition

Better to have all free calls in cleanup block

Add snippets for nodejs wrapper

…eate configs

… commens and separated functions

…s for scanner/result/etc.

cyrillicw · 2025-08-26T09:45:44Z

examples/c/src/main.c

+    else if (strcmp(category, "classify") == 0) {
+        if (!file_path) { print_usage(argv[0]); return 1; }
+
+        scanbotsdk_image_t *image = NULL;


Better to have all free calls in cleanup block

cyrillicw · 2025-08-26T09:52:04Z

examples/c/src/snippets/datacapture/ocr.c

+        process_word(words[k]);
+    }
+
+    free(words);


words are not freed in case of early outs, there are no early outs now, but they can be added in future

updated to free inside cleanup:

cyrillicw · 2025-08-26T09:53:01Z

examples/c/src/snippets/datacapture/ocr.c

+        process_line(lines[j]);
+    }
+
+    free(lines);


same as words above

updated to free inside cleanup:

cyrillicw · 2025-08-26T09:53:27Z

examples/c/src/snippets/datacapture/ocr.c

+        process_block(blocks[i]);
+    }
+
+    free(blocks);


same as words above

updated to free inside cleanup:

cyrillicw · 2025-08-26T11:35:44Z

examples/c/src/snippets/document/analyse_multi_page.c

+
+    inner_cleanup:
+        scanbotsdk_document_quality_analyzer_result_free(analyse_result);
+        if (ec != SCANBOTSDK_OK) break;


if (ec != SCANBOTSDK_OK) { goto cleanup; }

replaced with proposed snippet

cyrillicw · 2025-08-26T11:44:00Z

examples/c/src/snippets/live/live_barcode.c

+        scanbotsdk_barcode_scanner_result_get_barcodes_size(result, &count);
+        fprintf(stdout, "%zu barcodes found in frame %zu\n", count, frame_number);
+
+        scanbotsdk_barcode_item_t **barcodes = malloc(count * sizeof(*barcodes));


We use calloc in other examples, let's use it here as well

replaced with calloc

cyrillicw · 2025-08-26T11:45:18Z

examples/c/src/snippets/datacapture/medical_certificate_scanner.c

+
+    size_t count = 0;
+    ec = scanbotsdk_medical_certificate_patient_info_box_get_fields_size(patient_info, &count);
+    if (ec != SCANBOTSDK_OK) { fprintf(stderr, "get_fields_size: %d: %s\n", ec, error_message(ec)); return ec; }


goto cleanup

replaced with goto cleanup

cyrillicw · 2025-08-26T11:47:14Z

examples/c/src/main.c

+    char *text_input = get_flag(argc, argv, "--text");
+    char *license_arg = get_flag(argc, argv, "--license");
+
+    // TODO Add your Scanbot SDK trial license key here.


Do we need this second option of specifying license directly in the file?

agreed that yes, it make sense

cyrillicw · 2025-08-26T11:50:24Z

examples/java/src/main/java/io/scanbot/sdk/snippets/barcode/DetectBarcodesSnippet.java

+public class DetectBarcodesSnippet {
+    public static void run(ImageRef image) throws Exception {
+        // Make sure you have a valid license
+        if(ScanbotSDK.getLicenseInfo().getStatus() != LicenseStatus.OKAY)


Why do you manually check it here? If there are problems with license, an exception will be thrown. Same for all other snippets

Removed license check in all the places (java snippets so far)

cyrillicw · 2025-08-26T11:50:53Z

examples/java/src/main/java/io/scanbot/sdk/snippets/barcode/DetectBarcodesSnippet.java

+        if(ScanbotSDK.getLicenseInfo().getStatus() != LicenseStatus.OKAY)
+            return;
+
+        BarcodeFormatCommonConfiguration formatConfig = new BarcodeFormatCommonConfiguration();


Why do we need specifically this config in the example? It's not passed anywhere

my bad, updated snippet with BarcodeFormatCommonConfiguration in use

cyrillicw · 2025-08-26T11:52:19Z

examples/java/src/main/java/io/scanbot/sdk/snippets/barcode/DetectBarcodesSnippet.java

+        try (
+            BarcodeScanner scanner = new BarcodeScanner(config)
+        ) {
+            BarcodeScannerResult result = scanner.run(image);


BarcodeScannerResult can contain images so should be within try-with-resources as well. You can have multiple objects created in the same try-with-resources clause

moved into try with resources

cyrillicw · 2025-08-26T11:53:57Z

examples/java/src/main/java/io/scanbot/sdk/snippets/datacapture/CheckScannerSnippet.java

+        try(
+            CheckScanner scanner = new CheckScanner(config)
+        ) {
+            CheckScanningResult result = scanner.run(image);


The result can contain images, should be in try-with-resources

moved into try with resources

cyrillicw · 2025-08-26T11:54:03Z

examples/java/src/main/java/io/scanbot/sdk/snippets/datacapture/CreditCardScannerSnippet.java

+        try(
+            CreditCardScanner scanner = new CreditCardScanner(config)
+        ) {
+            CreditCardScanningResult result = scanner.run(image);


The result can contain images, should be in try-with-resources

moved into try with resources

cyrillicw · 2025-08-26T12:16:50Z

examples/java/src/main/java/io/scanbot/sdk/snippets/license/FloatingLicenseSnippet.java

+            );
+        }
+
+        ScanbotSDK.deregisterDevice();


If you use DeviceSession, no need to call ScanbotSDK.deregisterDevice() and ScanbotSDK.waitForDeviceDeregistrationCompletion(15000); manually

replaced with comment to call such operations in case if DeviceSession no in use

cyrillicw · 2025-08-26T12:17:08Z

examples/java/src/main/java/io/scanbot/sdk/snippets/license/FloatingLicenseSnippet.java

+
+        ScanbotSDK.initialize(scanbotLicenseKey, System.getProperty("user.dir"));
+
+        try (DeviceSession deviceSession = new DeviceSession(15_000)) {


Let's add explanation why is it needed

Added comment on top of this operation

cyrillicw · 2025-08-26T12:19:41Z

examples/java/src/main/java/io/scanbot/sdk/utils/Utils.java

+            }
+        }
+
+        if (doc.getChildren() != null && !doc.getChildren().isEmpty()) {


No need to check lists for nullability

removed check for nullability

cyrillicw · 2025-08-26T12:19:44Z

examples/java/src/main/java/io/scanbot/sdk/utils/Utils.java

+        String typeFullName = (type != null) ? type.getFullName() : "—";
+        System.out.printf("Type: %s (%s)%n", typeName, typeFullName);
+
+        if (doc.getFields() != null && !doc.getFields().isEmpty()) {


No need to check lists for nullability

removed check for nullability

cyrillicw · 2025-08-26T12:22:19Z

examples/java/src/main/java/io/scanbot/sdk/ScanbotSDKExample.java

+            switch (category) {
+                case "scan": {
+                    if (file == null && resource == null) { ExampleUsage.print(); return; }
+                    try (ImageRef image = Utils.createImageRef(file, resource)) {


We can add calls to ImageRefProfiler after work is done to check if we properly set all the try-with-resources

Added profiler operations and a comment at the bottom

…d encodeImages comments

Kyrylo and others added 10 commits August 6, 2025 11:17

C Wrapper Barcode Live Example

2bda812

Use goto in c wrapper example

6086e0d

Readme files c wrapper

51420c7

Add tensorrt support

649cd88

Improve FindScanbotSDK.cmake

a13b192

refactor structure of java example. added new snippets

e021d63

refactor structure of python example

be1b02b

merge c wrapper example

4ae7a0a

fixed merge conflics c barcode examples

ed2aceb

restructure project and add scan/analyze/classify/parse snippets with…

a4573e2

… sync across Java/Python/C wrappers

yurii-scanbot changed the title ~~Prepare for stable RC~~ Prepare/restructure for stable RC Aug 18, 2025

yurii-scanbot requested review from cyrillicw and tailsu August 18, 2025 16:08

cyrillicw requested changes Aug 19, 2025

View reviewed changes

cyrillicw requested changes Aug 20, 2025

View reviewed changes

yurii-scanbot and others added 9 commits August 21, 2025 12:10

add snippets for nodejs wrapper

b88612a

Merge pull request #20 from doo/yk/snippets_nodejs

5afb93a

Add snippets for nodejs wrapper

replace magic constants

9aed4c2

remove function declarations from headers that aren't in use

14765af

refactor main.c, for early outs always goto cleanup

a155f75

refactor snippets cleanups and unnecessary condition under default cr…

984e928

…eate configs

refactored analyse sumcommand and floatin license snippets with clear…

01939df

… commens and separated functions

added optional param for --license in cli

c129240

updated nodejs snippets with better way to dispose unmanaged resource…

fbc934d

…s for scanner/result/etc.

yurii-scanbot requested a review from cyrillicw August 22, 2025 11:55

yurii-scanbot added 3 commits August 22, 2025 14:05

added --license key flag from cli to java and python examples

cd6045b

rename mrz parser snippet java

70ca861

separate live scanners snippets

308eaea

cyrillicw requested changes Aug 26, 2025

View reviewed changes

yurii-scanbot changed the title ~~Prepare/restructure for stable RC~~ [EPIC-6378] Prepare/restructure for stable RC Aug 26, 2025

yurii-scanbot added 3 commits August 26, 2025 16:46

refactor java snippets, improve comments

5c8bd8b

removed unnecessary license checks inside of code snippets and remove…

499dcc4

…d encodeImages comments

prepare image processing snippets

da1269d


		ScanbotSDK.initialize(scanbotLicenseKey, System.getProperty("user.dir"));

		try (DeviceSession deviceSession = new DeviceSession(15_000)) {

[EPIC-6378] Prepare/restructure for stable RC #19

Are you sure you want to change the base?

[EPIC-6378] Prepare/restructure for stable RC #19

Uh oh!

Conversation

yurii-scanbot commented Aug 18, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yurii-scanbot Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

yurii-scanbot Aug 26, 2025 •

edited

Loading