Aspose.OCR for C++ 23.3.0 - Release Notes

Deprecation warning

What was changed

Public API changes and backwards compatibility

This section lists all public API changes introduced in Aspose.OCR for C++ 23.3.0 that may affect the code of existing applications.

Added public APIs:

The following public APIs have been introduced in this release:

AsposeOCRInput structure

A universal structure for providing any type of data (images, PDF documents, archives, folders, arrays, and so on) to the new image recognition functions.

AsposeOCRRawDataType enumerator

Color models of an image provided as an array of pixels:

This enumerator is used as a replacement for the channels_size member of the ImageDescriptor structure.

asposeocr_recognize function

Recognize one or more files provided as AsposeOCRInput structure. It is a universal replacement for the following recognition functions:

AsposeOCRRecognitionArea structure

Describes the detected text area and the text extracted from it.

AsposeOCRRecognizedPage structure

Describes the result of single image recognition. Contains all detected text areas, represented by AsposeOCRRecognitionArea structures.

AsposeOCRRecognitionResult structure

Describes the result of multiple images recognition. Contains all detected images, represented by AsposeOCRRecognizedPage structures.

This structure is returned from asposeocr_recognize function, regardless of the source data type.

asposeocr_serialize_result function

Converts AsposeOCRRecognitionResult structure into plain text, JSON or XML.

asposeocr_free_result function

Releases the memory allocated by the asposeocr_recognize function.

AsposeOCRLogSettings structure

Describes logging options.

ASPOSE_OCR_LOG_LEVEL enumerator

Logging severity levels:

asposeocr_configure_logging function

Apply logging parameters, provided as AsposeOCRLogSettings structure.

asposeocr_set_progress_tracker function

Assign the custom function that will be called when the recognition progress is updated.

AsposeOCRProgress structure

Describes recognition progress, reported to the custom tracking function.

ASPOSE_OCR_IMAGE_PROCESSING_STATE enumerator

Recognition process stages:

Updated public APIs:

No changes.

Removed public APIs:

No changes.

Deprecated APIs

The following public APIs have been marked as deprecated and will be removed in 24.1.0 (January 2024) release:

ImageDescriptor structure

Replaced by a universal and more versatile AsposeOCRInput structure.

asposeocr_page() function

Replaced with an universal asposeocr_recognize function.

asposeocr_page_settings() function

Replaced with an universal asposeocr_recognize function.

asposeocr_page_all() function

Replaced with an universal asposeocr_recognize function.

asposeocr_page_abc() function

Replaced with an universal asposeocr_recognize function.

asposeocr_page_abc_all() function

Replaced with an universal asposeocr_recognize function.

asposeocr_page_tiff() function

Replaced with an universal asposeocr_recognize function.

asposeocr_page_from_uri() function

Replaced with an universal asposeocr_recognize function.

asposeocr_pages_multi() function

Replaced with an universal asposeocr_recognize function.

asposeocr_page_from_raw_bytes() function

Replaced with an universal asposeocr_recognize function.

asposeocr_page_settings_from_raw_bytes() function

Replaced with an universal asposeocr_recognize function.

asposeocr_page_all_from_raw_bytes() function

Replaced with an universal asposeocr_recognize function.

asposeocr_page_abc_from_raw_bytes() function

Replaced with an universal asposeocr_recognize function.

asposeocr_page_abc_all_from_raw_bytes() function

Replaced with an universal asposeocr_recognize function.

asposeocr_page_rect() function

Replaced with an universal asposeocr_recognize function.

asposeocr_page_rect_from_raw_bytes() function

Replaced with an universal asposeocr_recognize function.

asposeocr_page_rect_abc() function

Replaced with an universal asposeocr_recognize function.

asposeocr_page_rect_abc_from_raw_bytes() function

Replaced with an universal asposeocr_recognize function.

Usage examples

The examples below illustrates the changes introduced in this release:

Migrating to the new API

Original code (Aspose.OCR for C++ 23.2.0 and below):

// Provide the image
string file = current_dir + "/source.png";
const size_t len = 4096;
wchar_t buffer[len] = { 0 };
// Set recognition language
RecognitionSettings settings;
settings.language_alphabet = language::eng;
// Extract text from the image
size_t result = asposeocr_page_all(file.c_str(), buffer, len, settings);
// Output the recognized text
std::wcout << buffer;

New code (Aspose.OCR for C++ 23.3.0 and above):

// Provide the image
string file = current_dir + "/source.png";
AsposeOCRInput source;
source.url = file.c_str();
std::vector<AsposeOCRInput> content = { source };
// Set recognition language
RecognitionSettings settings;
settings.language_alphabet = language::eng;
// Extract text from the image
auto result = asposeocr_recognize(content.data(), content.size(), settings);
// Output the recognized text
wchar_t* buffer = asposeocr_serialize_result(result, buffer_size, export_format::text);
std::wcout << std::wstring(buffer) << std::endl;
// Release the resources
asposeocr_free_result(result);

Log errors to a file

AsposeOCRLogSettings log_settings;
log_settings.console_output_enabled = false;
log_settings.logging_level = ASPOSE_OCR_LOG_ERROR;
log_settings.output_path = "errors.log";
asposeocr_set_log_settings(log_settings);

Track recognition progress

void progress_tracker(const AsposeOCRProgress& input)
{
	std::cout << "Number of images: " << input.images_amount
		<< " current image: " << input.current_image_number
		<< " current state: " << input.current_state << std::endl;
}

<...>

asposeocr_set_progress_tracker(&progress_tracker);