Prepare/restructure for stable RC #19

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

No description provided.

… sync across Java/Python/C wrappers

cyrillicw · 2025-08-19T13:14:32Z

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

+
+cleanup:
+    scanbotsdk_license_info_free(info);
+    scanbotsdk_deregister_device();


Deregistration is the most important part about floating license. We should add here comments that describe why should it be called and what are the consequences of not calling

updated with description for both calls

cyrillicw · 2025-08-19T13:14:58Z

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

+    if (ec != SCANBOTSDK_OK) { fprintf(stderr, "get_license_info (before wait): %d: %s\n", ec, error_message(ec)); goto cleanup; }
+
+    // Wait for the online license check to complete
+    ec = scanbotsdk_wait_for_online_license_check_completion(15000);


magic constant

replaced with constant

cyrillicw · 2025-08-19T13:15:04Z

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

+cleanup:
+    scanbotsdk_license_info_free(info);
+    scanbotsdk_deregister_device();
+    scanbotsdk_wait_for_device_deregistration_completion(15000);


magic constant

replaced with constant

cyrillicw · 2025-08-19T13:16:56Z

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

+    if (ec != SCANBOTSDK_OK) { fprintf(stderr, "wait_for_online_license_check_completion: %d: %s\n", ec, error_message(ec)); goto cleanup; }
+
+    // Query license info AFTER waiting for online check
+    ec = scanbotsdk_get_license_info(&info);


The info obtained above is leaked here as you no longer have a pointer to it. As we discussed, let's have to variables info_before_initialization and info_after_initialization and free both of them in the cleanup

separated as proposed into info_before_initialization and info_after_initialization

cyrillicw · 2025-08-19T13:20:30Z

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

+    ec = scanbotsdk_get_license_info(&info);
+    if (ec != SCANBOTSDK_OK) { fprintf(stderr, "get_license_info (before wait): %d: %s\n", ec, error_message(ec)); goto cleanup; }
+
+    // Wait for the online license check to complete


We should explain why this wait is needed - because initialize is a non-blocking operation which asynchrnously performs online license check

description on top was added

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?

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

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

+        return ec;
+    }
+
+    printf("Detection Status = %d\n", (int)status);


Why do we print the status twice? And is int representation of the status useful fot the user?

removed previous condition and print

cyrillicw · 2025-08-19T14:53:26Z

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

+
+cleanup:
+    if (blocks) free(blocks);
+    if (lines) free(lines);


double free for lines and words can occur

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?

cyrillicw · 2025-08-19T14:57:54Z

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

+    scanbotsdk_document_classifier_configuration_t *config = NULL;
+    scanbotsdk_document_classifier_result_t *result = NULL;
+    scanbotsdk_document_classifier_t *classifier = NULL;
+    scanbotsdk_document_scanning_result_t *scanning_result = NULL;


Why do we need scanning result here?

removed, no need

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

cyrillicw · 2025-08-20T07:55:37Z

examples/c/src/utils/utils.c

+    printf("Fields count: %zu\n", fields_count);
+
+    scanbotsdk_field_t **fields = calloc(fields_count, sizeof(*fields));
+    if (!fields) { fprintf(stderr, "alloc fields failed\n"); return SCANBOTSDK_ERROR_UNKNOWN_ERROR; }


When calloc returns 0, you sometimes return OUT_OF_MEMORY, sometimes UNKNOWN ERROR. Better to return the same status in all the places

goto cleanup

replaced with SCANBOTSDK_ERROR_OUT_OF_MEMORY

added goto cleanup

cyrillicw · 2025-08-20T07:58:35Z

examples/c/src/utils/utils.c

+            const char *text = NULL; 
+            double confidence = 0.0;
+            scanbotsdk_ocr_result_get_text(ocr, &text);
+            scanbotsdk_ocr_result_get_confidence(ocr, &confidence);


Let's avoid printing confidence. For non-ocred docuemnts it usually zero

removed confidence getter

cyrillicw · 2025-08-20T07:59:02Z

examples/c/src/utils/utils.c

+        const char *type_name = NULL;
+        scanbotsdk_field_type_get_name(field_type, &type_name);
+
+        scanbotsdk_ocr_result_t *ocr = NULL;


Let's not call the variable ocr as this info doesn't always come from ocr

replaced with ocr_result

cyrillicw · 2025-08-20T08:00:58Z

examples/c/src/utils/utils.c

+            printf("Field[%zu]: type=%s, value=\"%s\", confidence=%f\n",
+                i, type_name, text ? text : "", confidence);
+        } else {
+            printf("Field[%zu]: type=%s, value=(n/a)\n", i, type_name);


Better "text value n/a", this will usually be the case from such filds as photo

updated text

cyrillicw · 2025-08-20T14:49:14Z

examples/c/src/main.c

+
+    // TODO Add your Scanbot SDK trial license key here.
+    // The SDK and a trial license are available on request via [email protected]
+    char *scanbot_license_key = "<SCANBOTSDK-LICENSE>";


Let's read license from console

cyrillicw · 2025-08-20T14:49:36Z

examples/c/src/main.c

+    scanbotsdk_error_code_t ec = scanbotsdk_initialize(&params);
+    if (ec != SCANBOTSDK_OK) { fprintf(stderr, "initialize: %d: %s\n", ec, error_message(ec)); return 1; }
+
+    ec = scanbotsdk_wait_for_online_license_check_completion(15000);


magic constant

replaced with constant

cyrillicw · 2025-08-20T14:49:46Z

examples/c/src/main.c

+
+cleanup:
+    scanbotsdk_deregister_device();
+    scanbotsdk_wait_for_device_deregistration_completion(15000);


magic constant

replaced with constant

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

examples/c/src/main.c

+    if (ec != SCANBOTSDK_OK) { fprintf(stderr, "license_wait: %d: %s\n", ec, error_message(ec)); goto cleanup; }
+
+     if (strcmp(category, "scan") == 0) {
+        if (!file_path) { print_usage(argv[0]); return 1; }


No deregistration occurs in case of early outs. Should be goto cleanup. And image should also be freed there. Same for all ealy outs

refactored every place with goto cleanup

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

Add snippets for nodejs wrapper

…eate configs

… commens and separated functions

…s for scanner/result/etc.

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 2 commits August 22, 2025 14:05

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

cd6045b

rename mrz parser snippet java

70ca861

Prepare/restructure for stable RC #19

Are you sure you want to change the base?

Prepare/restructure for stable RC #19

Conversation

yurii-scanbot commented Aug 18, 2025

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!

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!