Cómo realizar OCR en Android en .NET MAUI

Paquete IronOCR para Android

El paquete IronOcr.Android habilita funciones de OCR en dispositivos Android a través de proyectos multiplataforma de .NET. No se necesita el paquete IronOCR estándar.

Paquete de instalación IronOcr.Android

Instalar con NuGet

Paquete de instalación IronOcr.Android

nuget.org/packages/IronOcr.Android/

Crear un proyecto .NET MAUI

Abre Visual Studio y haz clic en "Crear un nuevo proyecto". Busca MAUI, selecciona .NET MAUI App y "Siguiente".

Incluir la biblioteca IronOcr.Android

La biblioteca se puede agregar de varias maneras. La más fácil es quizás usando NuGet.

1. Dentro de Visual Studio, haz clic derecho en "Dependencias" y selecciona "Gestionar paquetes NuGet ...".
2. Seleccione la pestaña "Examinar" y busque "IronOcr.Android".
3. Seleccione el paquete "IronOcr.Android" y haga clic en "Instalar".

Para evitar problemas con otras plataformas, modifica el archivo csproj para incluir el paquete solo cuando se apunte a la plataforma Android. Para hacerlo:

1. Haga clic derecho en el proyecto y seleccione "Editar archivo del proyecto".

2. Crea un nuevo elemento ItemGroup de la siguiente manera:

   <ItemGroup Condition="$(TargetFramework.Contains('android')) == true">
   </ItemGroup>

   <ItemGroup Condition="$(TargetFramework.Contains('android')) == true">
   </ItemGroup>

   XML
3. Mueva la referencia del paquete "IronOcr.Android" dentro del grupo de elementos que acabamos de crear.

Los pasos anteriores evitarán que el paquete "IronOcr.Android" se utilice en, por ejemplo, plataformas iOS (para eso, instale IronOCR.iOS en su lugar).

Editar "MainActivity.cs"

• Abra el archivo "MainActivity.cs" navegando a Plataformas -> Android.
• Añada el método MainActivity e invoque el método Initialize.

using Android.App;
using Android.Content.PM;
using Android.Runtime;
using Android.OS;
using IronOcr;

namespace MAUI IronOCRAndroidSample
{
    [Activity(Theme = "@style/Maui.SplashTheme", MainLauncher = true, ConfigurationChanges = ConfigChanges.ScreenSize | ConfigChanges.Orientation | ConfigChanges.UiMode | ConfigChanges.ScreenLayout | ConfigChanges.SmallestScreenSize | ConfigChanges.Density)]
    public class MainActivity : MauiAppCompatActivity
    {
        public MainActivity()
        {
            // Initialize IronTesseract for OCR purposes
            IronTesseract.Initialize(this);
        }
    }
}

using Android.App;
using Android.Content.PM;
using Android.Runtime;
using Android.OS;
using IronOcr;

namespace MAUI IronOCRAndroidSample
{
    [Activity(Theme = "@style/Maui.SplashTheme", MainLauncher = true, ConfigurationChanges = ConfigChanges.ScreenSize | ConfigChanges.Orientation | ConfigChanges.UiMode | ConfigChanges.ScreenLayout | ConfigChanges.SmallestScreenSize | ConfigChanges.Density)]
    public class MainActivity : MauiAppCompatActivity
    {
        public MainActivity()
        {
            // Initialize IronTesseract for OCR purposes
            IronTesseract.Initialize(this);
        }
    }
}

Imports Android.App
Imports Android.Content.PM
Imports Android.Runtime
Imports Android.OS
Imports IronOcr

Namespace MAUI_IronOCRAndroidSample

    <Activity(Theme:="@style/Maui.SplashTheme", MainLauncher:=True, ConfigurationChanges:=ConfigChanges.ScreenSize Or ConfigChanges.Orientation Or ConfigChanges.UiMode Or ConfigChanges.ScreenLayout Or ConfigChanges.SmallestScreenSize Or ConfigChanges.Density)>
    Public Class MainActivity
        Inherits MauiAppCompatActivity

        Public Sub New()
            ' Initialize IronTesseract for OCR purposes
            IronTesseract.Initialize(Me)
        End Sub
    End Class

End Namespace

Editar "MainPage.xaml"

Edite el archivo XAML para mostrar un botón y una etiqueta para mostrar el resultado del OCR. Por ejemplo:

<?xml version="1.0" encoding="utf-8" ?>
<ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             x:Class="MAUI IronOCRAndroidSample.MainPage">

    <Grid>
        <Grid.RowDefinitions>
            <RowDefinition Height="Auto"/>
            <RowDefinition Height="*"/>
        </Grid.RowDefinitions>
        <Button
            Text="Import File"
            Clicked="ReadFileOnImport"
            Grid.Row="0"
            HorizontalOptions="Center"
            Margin="20, 20, 20, 10"/>

        <ScrollView
            Grid.Row="1"
            BackgroundColor="LightGray"
            Padding="10"
            Margin="10, 10, 10, 30">
            <Label x:Name="OutputText"/>
        </ScrollView>
    </Grid>

</ContentPage>

<?xml version="1.0" encoding="utf-8" ?>
<ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             x:Class="MAUI IronOCRAndroidSample.MainPage">

    <Grid>
        <Grid.RowDefinitions>
            <RowDefinition Height="Auto"/>
            <RowDefinition Height="*"/>
        </Grid.RowDefinitions>
        <Button
            Text="Import File"
            Clicked="ReadFileOnImport"
            Grid.Row="0"
            HorizontalOptions="Center"
            Margin="20, 20, 20, 10"/>

        <ScrollView
            Grid.Row="1"
            BackgroundColor="LightGray"
            Padding="10"
            Margin="10, 10, 10, 30">
            <Label x:Name="OutputText"/>
        </ScrollView>
    </Grid>

</ContentPage>

Editar "MainPage.xaml.cs"

Primero, cree una instancia del objeto IronTesseract. Asegúrese de que IronTesseract se inicialice una vez dentro de la clase, como se muestra en el código a continuación. Instanciarlo dentro de un método puede ser ineficaz y puede causar errores inesperados.

Luego, utilice el método FilePicker.PickAsync para seleccionar un archivo, luego abra un flujo de lectura desde el FileResult. Cree un nuevo objeto OcrInput y cargue la imagen en él. Realiza OCR en la imagen usando la instancia Tesseract y recupera el texto. Finalmente, muestre el texto resultante en una etiqueta.

using IronOcr;
using Microsoft.Maui.Controls;
using System;
using System.Diagnostics;
using System.IO;
using System.Threading.Tasks;

namespace MAUI IronOCRAndroidSample
{
    public partial class MainPage : ContentPage
    {
        // Initialize IronTesseract once in a class
        private readonly IronTesseract ocrTesseract = new IronTesseract();

        public MainPage()
        {
            InitializeComponent();
            // Apply License key if required
            IronOcr.License.LicenseKey = "IRONOCR.MYLICENSE.KEY.1EF01";
        }

        private async void ReadFileOnImport(object sender, EventArgs e)
        {
            try
            {
                // Configure the file picker
                var options = new PickOptions
                {
                    PickerTitle = "Please select a file"
                };

                // Await user's file selection
                var result = await FilePicker.PickAsync(options);
                if (result != null)
                {
                    using var stream = await result.OpenReadAsync();
                    // Instantiate OcrInput
                    using var ocrInput = new OcrInput();
                    // Load image stream for OCR processing
                    ocrInput.AddImage(stream);
                    // Perform OCR
                    var ocrResult = ocrTesseract.Read(ocrInput);
                    // Display extracted text
                    OutputText.Text = ocrResult.Text;
                }
            }
            catch (Exception ex)
            {
                // Log and handle exceptions
                Debug.WriteLine(ex);
            }
        }
    }
}

using IronOcr;
using Microsoft.Maui.Controls;
using System;
using System.Diagnostics;
using System.IO;
using System.Threading.Tasks;

namespace MAUI IronOCRAndroidSample
{
    public partial class MainPage : ContentPage
    {
        // Initialize IronTesseract once in a class
        private readonly IronTesseract ocrTesseract = new IronTesseract();

        public MainPage()
        {
            InitializeComponent();
            // Apply License key if required
            IronOcr.License.LicenseKey = "IRONOCR.MYLICENSE.KEY.1EF01";
        }

        private async void ReadFileOnImport(object sender, EventArgs e)
        {
            try
            {
                // Configure the file picker
                var options = new PickOptions
                {
                    PickerTitle = "Please select a file"
                };

                // Await user's file selection
                var result = await FilePicker.PickAsync(options);
                if (result != null)
                {
                    using var stream = await result.OpenReadAsync();
                    // Instantiate OcrInput
                    using var ocrInput = new OcrInput();
                    // Load image stream for OCR processing
                    ocrInput.AddImage(stream);
                    // Perform OCR
                    var ocrResult = ocrTesseract.Read(ocrInput);
                    // Display extracted text
                    OutputText.Text = ocrResult.Text;
                }
            }
            catch (Exception ex)
            {
                // Log and handle exceptions
                Debug.WriteLine(ex);
            }
        }
    }
}

Imports IronOcr
Imports Microsoft.Maui.Controls
Imports System
Imports System.Diagnostics
Imports System.IO
Imports System.Threading.Tasks

Namespace MAUI_IronOCRAndroidSample
    Public Partial Class MainPage
        Inherits ContentPage

        ' Initialize IronTesseract once in a class
        Private ReadOnly ocrTesseract As New IronTesseract()

        Public Sub New()
            InitializeComponent()
            ' Apply License key if required
            IronOcr.License.LicenseKey = "IRONOCR.MYLICENSE.KEY.1EF01"
        End Sub

        Private Async Sub ReadFileOnImport(sender As Object, e As EventArgs)
            Try
                ' Configure the file picker
                Dim options As New PickOptions With {
                    .PickerTitle = "Please select a file"
                }

                ' Await user's file selection
                Dim result = Await FilePicker.PickAsync(options)
                If result IsNot Nothing Then
                    Using stream = Await result.OpenReadAsync()
                        ' Instantiate OcrInput
                        Using ocrInput As New OcrInput()
                            ' Load image stream for OCR processing
                            ocrInput.AddImage(stream)
                            ' Perform OCR
                            Dim ocrResult = ocrTesseract.Read(ocrInput)
                            ' Display extracted text
                            OutputText.Text = ocrResult.Text
                        End Using
                    End Using
                End If
            Catch ex As Exception
                ' Log and handle exceptions
                Debug.WriteLine(ex)
            End Try
        End Sub
    End Class
End Namespace

$vbLabelText   $csharpLabel

Por último, en el archivo .csproj, asegúrese de que solo está compilando el proyecto para Android. Dado que el paquete que agregamos es solo para Android, compilar el proyecto para todas las plataformas fallará.

Ejecutar el proyecto

Esto le mostrará cómo ejecutar el proyecto y realizar OCR.

Descargar proyecto de aplicación .NET MAUI

Puede descargar el código completo de esta guía. Viene como un archivo comprimido que puede abrir en Visual Studio como un proyecto de aplicación .NET MAUI.

[Haga clic aquí para descargar el proyecto.](/static-assets/ocr/how-to/setup-android/MAUI IronOCRAndroidSample.zip)

Consideraciones de cumplimiento para aplicaciones Android en España

Al distribuir tu aplicación Android con OCR en el mercado español, ten en cuenta los siguientes requisitos regulatorios:

Permisos Android y LOPDGDD: los permisos CAMERA y READ_EXTERNAL_STORAGE que requiere IronOCR deben solicitarse con una explicación clara de la finalidad del tratamiento conforme a la LOPDGDD. Si la aplicación escanea documentos de identidad (DNI, NIE, TIE), el aviso debe indicar explícitamente que las imágenes no se transmiten a ningún servidor.

DNI, NIE y TIE: IronOCR Android puede leer la Zona de Lectura Mecánica (MRZ) de documentos de identidad españoles (DNI, NIE, TIE — Tarjeta de Identidad de Extranjero) aprovechando el modo de reconocimiento optimizado para documentos de identidad. Los datos extraídos de la MRZ incluyen número de documento, fecha de nacimiento, fecha de caducidad y nacionalidad.

TicketBAI en punto de venta móvil: las aplicaciones de TPV (Terminal Punto de Venta) para el País Vasco deben leer el código QR de TicketBAI de los tickets emitidos. IronOCR Android gestiona esta lectura de forma nativa mediante su funcionalidad de detección de códigos de barras (ReadBarCodes = true).

Facturae en movilidad: los comerciales y autónomos que necesitan capturar facturas de proveedor desde su teléfono Android pueden utilizar IronOCR para extraer los campos fiscales clave (NIF del proveedor, base imponible, tipo y cuota de IVA) directamente en el dispositivo, sin enviar la imagen a la nube, cumpliendo así con los principios de minimización de datos de la LOPDGDD.

Uso de IronOcr.Android en Avalonia

Similar a MAUI, IronOcr.Android se puede usar en un proyecto Avalonia con la misma configuración descrita anteriormente.

Si desea realizar OCR en iOS, navegue al siguiente artículo para obtener más información: "Cómo realizar OCR en iOS en .NET MAUI"