Guía de incorporación de imágenes para iOS

La tarea de incorporación de imágenes de MediaPipe te permite convertir datos de imagen en una representación numérica para realizar tareas de procesamiento de imágenes relacionadas con el AA, como comparar la similitud de dos imágenes.

La muestra de código que se describe en estas instrucciones está disponible en GitHub. Puedes ver esta tarea en acción en esta demo web. Para obtener más información sobre las funciones, los modelos y las opciones de configuración de esta tarea, consulta la descripción general.

Ejemplo de código

El código de ejemplo de MediaPipe Tasks es una implementación básica de una app de Image Embedder para iOS. En el ejemplo, se usa la cámara de un dispositivo iOS físico para incorporar imágenes de forma continua. También se puede ejecutar la incorporación en archivos de imagen de la galería del dispositivo.

Puedes usar la app como punto de partida para tu propia app para iOS o consultarla cuando modifiques una app existente. El código de ejemplo de Image Embedder se aloja en GitHub.

Descarga el código

En las siguientes instrucciones, se muestra cómo crear una copia local del código de ejemplo con la herramienta de línea de comandos git.

Para descargar el código de ejemplo, sigue estos pasos:

1. Clona el repositorio de git con el siguiente comando:

   git clone https://github.com/google-ai-edge/mediapipe-samples
   

2. De manera opcional, configura tu instancia de git para usar el control de revisión disperso, de modo que solo tengas los archivos de la app de ejemplo de Image Embedder:

   cd mediapipe
   git sparse-checkout init --cone
   git sparse-checkout set examples/image_embedder/ios
   

Después de crear una versión local del código de ejemplo, puedes instalar la biblioteca de tareas MediaPipe, abrir el proyecto con Xcode y ejecutar la app. Para obtener instrucciones, consulta la Guía de configuración para iOS.

Componentes clave

Los siguientes archivos contienen el código fundamental de la aplicación de ejemplo de Image Embedder:

• ImageEmbedderService.swift: Inicializa el Image Embedder, controla la selección del modelo y ejecuta la inferencia en los datos de entrada.
• CameraViewController.swift: Implementa la IU para el modo de entrada de feed de cámara en vivo y visualiza los resultados.
• MediaLibraryViewController.swift: Implementa la IU para el modo de entrada de imágenes fijas y visualiza los resultados.

Configuración

En esta sección, se describen los pasos clave para configurar tu entorno de desarrollo y tus proyectos de código para usar Image Embedder. Si deseas obtener información general sobre cómo configurar tu entorno de desarrollo para usar tareas de MediaPipe, incluidos los requisitos de la versión de la plataforma, consulta la Guía de configuración para iOS.

Dependencias

Image Embedder usa la biblioteca MediaPipeTasksVision, que se debe instalar con CocoaPods. La biblioteca es compatible con apps de Swift y Objective-C, y no requiere ninguna configuración adicional específica del lenguaje.

Para obtener instrucciones para instalar CocoaPods en macOS, consulta la guía de instalación de CocoaPods. Para obtener instrucciones sobre cómo crear un Podfile con los pods necesarios para tu app, consulta Cómo usar CocoaPods.

Agrega el pod MediaPipeTasksVision en Podfile con el siguiente código:

target 'MyImageEmbedderApp' do
  use_frameworks!
  pod 'MediaPipeTasksVision'
end

Si tu app incluye destinos de pruebas de unidades, consulta la Guía de configuración para iOS para obtener información adicional sobre cómo configurar tu Podfile.

Modelo

La tarea de MediaPipe Image Embedder requiere un modelo entrenado que sea compatible con esta tarea. Para obtener más información sobre los modelos entrenados disponibles para el incorporador de imágenes, consulta la sección Modelos.

Selecciona y descarga un modelo, y agrégalo al directorio de tu proyecto con Xcode. Para obtener instrucciones sobre cómo agregar archivos a tu proyecto de Xcode, consulta Cómo administrar archivos y carpetas en tu proyecto de Xcode.

Usa la propiedad BaseOptions.modelAssetPath para especificar la ruta de acceso al modelo en tu paquete de aplicación.

Crea la tarea

Puedes crear la tarea de Incorporación de imágenes llamando a uno de sus inicializadores. El inicializador ImageEmbedder(options:) acepta valores para las opciones de configuración.

Si no necesitas un incorporador de imágenes inicializado con opciones de configuración personalizadas, puedes usar el inicializador ImageEmbedder(modelPath:) para crear un incorporador de imágenes con las opciones predeterminadas. Para obtener más información sobre las opciones de configuración, consulta Descripción general de la configuración.

La tarea de Incorporación de imágenes admite 3 tipos de datos de entrada: imágenes fijas, archivos de video y transmisiones de video en vivo. De forma predeterminada, ImageEmbedder(modelPath:) inicializa una tarea para imágenes estáticas. Si deseas que tu tarea se inicialice para procesar archivos de video o transmisiones de video en vivo, usa ImageEmbedder(options:) para especificar el modo de ejecución del video o la transmisión en vivo. El modo de transmisión en vivo también requiere la opción de configuración adicional imageEmbedderLiveStreamDelegate, que permite que el incorporador de imágenes entregue resultados de incorporación de imágenes al delegado de forma asíncrona.

Elige la pestaña correspondiente a tu modo de ejecución para ver cómo crear la tarea y ejecutar la inferencia.

Swift

import MediaPipeTasksVision

let modelPath = Bundle.main.path(
  forResource: "model",
  ofType: "tflite")

let options = ImageEmbedderOptions()
options.baseOptions.modelAssetPath = modelPath
options.quantize = true
options.l2Normalize = true

let imageEmbedder = try ImageEmbedder(options: options)
    

import MediaPipeTasksVision

let modelPath = Bundle.main.path(
  forResource: "model",
  ofType: "tflite")

let options = ImageEmbedderOptions()
options.baseOptions.modelAssetPath = modelPath
options.runningMode = .video
options.quantize = true
options.l2Normalize = true

let imageEmbedder = try ImageEmbedder(options: options)
    

import MediaPipeTasksVision

// Class that conforms to the `ImageEmbedderLiveStreamDelegate` protocol and
// implements the method that the image embedder calls once it finishes
// embedding each input frame.
class ImageEmbedderResultProcessor: NSObject, ImageEmbedderLiveStreamDelegate {

  func imageEmbedder(
    _ imageEmbedder: ImageEmbedder,
    didFinishEmbedding result: ImageEmbedderResult?,
    timestampInMilliseconds: Int,
    error: Error?) {

    // Process the image embedder result or errors here.

  }
}

let modelPath = Bundle.main.path(
  forResource: "model",
  ofType: "tflite")

let options = ImageEmbedderOptions()
options.baseOptions.modelAssetPath = modelPath
options.runningMode = .liveStream
options.quantize = true
options.l2Normalize = true

// Assign an object of the class to the `imageEmbedderLiveStreamDelegate`
// property.
let processor = ImageEmbedderResultProcessor()
options.imageEmbedderLiveStreamDelegate = processor

let imageEmbedder = try ImageEmbedder(options: options)
    

Objective-C

@import MediaPipeTasksVision;

NSString *modelPath = [[NSBundle mainBundle] pathForResource:@"model"
                                                      ofType:@"tflite"];

MPPImageEmbedderOptions *options = [[MPPImageEmbedderOptions alloc] init];
options.baseOptions.modelAssetPath = modelPath;
options.runningMode = MPPRunningModeImage;
options.quantize = YES;
options.l2Normalize = YES;

MPPImageEmbedder *imageEmbedder =
  [[MPPImageEmbedder alloc] initWithOptions:options error:nil];
    

@import MediaPipeTasksVision;

NSString *modelPath = [[NSBundle mainBundle] pathForResource:@"model"
                                                      ofType:@"tflite"];

MPPImageEmbedderOptions *options = [[MPPImageEmbedderOptions alloc] init];
options.baseOptions.modelAssetPath = modelPath;
options.runningMode = MPPRunningModeVideo;
options.quantize = YES;
options.l2Normalize = YES;

MPPImageEmbedder *imageEmbedder =
  [[MPPImageEmbedder alloc] initWithOptions:options error:nil];
    

@import MediaPipeTasksVision;

// Class that conforms to the `MPPImageEmbedderLiveStreamDelegate` protocol
// and implements the method that the image embedder calls once it finishes
// embedding each input frame.
@interface APPImageEmbedderResultProcessor : NSObject 

@end

@implementation APPImageEmbedderResultProcessor

-   (void)imageEmbedder:(MPPImageEmbedder *)imageEmbedder
    didFinishEmbeddingWithResult:(MPPImageEmbedderResult *)imageEmbedderResult
         timestampInMilliseconds:(NSInteger)timestampInMilliseconds
                           error:(NSError *)error {

    // Process the image embedder result or errors here.

}

@end

NSString *modelPath = [[NSBundle mainBundle] pathForResource:@"model"
                                                      ofType:@"tflite"];

MPPImageEmbedderOptions *options = [[MPPImageEmbedderOptions alloc] init];
options.baseOptions.modelAssetPath = modelPath;
options.runningMode = MPPRunningModeLiveStream;
options.quantize = YES;
options.l2Normalize = YES;

// Assign an object of the class to the `imageEmbedderLiveStreamDelegate`
// property.
APPImageEmbedderResultProcessor *processor =
  [APPImageEmbedderResultProcessor new];
options.imageEmbedderLiveStreamDelegate = processor;

MPPImageEmbedder *imageEmbedder =
  [[MPPImageEmbedder alloc] initWithOptions:options error:nil];
    

Opciones de configuración

Esta tarea tiene las siguientes opciones de configuración para apps para iOS:

Cuando el modo de ejecución se establece en transmisión en vivo, el incorporador de imágenes requiere la opción de configuración adicional imageEmbedderLiveStreamDelegate, que le permite entregar resultados de incorporación de imágenes de forma asíncrona. El delegado debe implementar el método imageEmbedder(_:didFinishEmbedding:timestampInMilliseconds:error:), al que llama el incorporador de imágenes después de procesar los resultados de la incorporación de cada fotograma de imagen de entrada.

Preparar los datos

Debes convertir la imagen o el fotograma de entrada en un objeto MPImage antes de pasarlo al incorporador de imágenes. MPImage admite diferentes tipos de formatos de imagen de iOS y puede usarlos en cualquier modo de ejecución para la inferencia. Para obtener más información sobre MPImage, consulta la API de MPImage.

Elige un formato de imagen de iOS según tu caso de uso y el modo de ejecución que requiere tu aplicación.MPImage acepta los formatos de imagen de iOS UIImage, CVPixelBuffer y CMSampleBuffer.

UIImage

El formato UIImage es adecuado para los siguientes modos de ejecución:

• Imágenes: Las imágenes de un paquete de aplicación, una galería de usuario o un sistema de archivos con formato de imagen UIImage se pueden convertir en un objeto MPImage.

• Videos: Usa AVAssetImageGenerator para extraer fotogramas de video al formato CGImage y, luego, conviértelos en imágenes UIImage.

// Load an image on the user's device as an iOS `UIImage` object.

// Convert the `UIImage` object to a MediaPipe's Image object having the default
// orientation `UIImage.Orientation.up`.
let image = try MPImage(uiImage: image)
    

// Load an image on the user's device as an iOS `UIImage` object.

// Convert the `UIImage` object to a MediaPipe's Image object having the default
// orientation `UIImageOrientationUp`.
MPImage *image = [[MPPImage alloc] initWithUIImage:image error:nil];
    

En el ejemplo, se inicializa un MPImage con la orientación predeterminada UIImage.Orientation.Up. Puedes inicializar un MPImage con cualquiera de los valores de UIImage.Orientation compatibles. El incorporador de imágenes no admite orientaciones reflejadas como .upMirrored, .downMirrored, .leftMirrored ni .rightMirrored.

Para obtener más información sobre UIImage, consulta la documentación para desarrolladores de Apple sobre UIImage.

CVPixelBuffer

El formato CVPixelBuffer es adecuado para aplicaciones que generan fotogramas y usan el framework CoreImage de iOS para el procesamiento.

El formato CVPixelBuffer es adecuado para los siguientes modos de ejecución:

• Imágenes: las apps que generan imágenes CVPixelBuffer después de cierto procesamiento con el framework CoreImage de iOS se pueden enviar al Incorporador de imágenes en el modo de ejecución de imágenes.

• Videos: Los fotogramas de video se pueden convertir al formato CVPixelBuffer para su procesamiento y, luego, enviarse al Insertador de imágenes en modo de video.

• transmisión en vivo: Es posible que las apps que usan una cámara para iOS para generar fotogramas se conviertan al formato CVPixelBuffer para su procesamiento antes de enviarlas al incorporador de imágenes en modo de transmisión en vivo.

// Obtain a CVPixelBuffer.

// Convert the `CVPixelBuffer` object to a MediaPipe's Image object having the default
// orientation `UIImage.Orientation.up`.
let image = try MPImage(pixelBuffer: pixelBuffer)
    

// Obtain a CVPixelBuffer.

// Convert the `CVPixelBuffer` object to a MediaPipe's Image object having the
// default orientation `UIImageOrientationUp`.
MPImage *image = [[MPPImage alloc] initWithUIImage:image error:nil];
    

Para obtener más información sobre CVPixelBuffer, consulta la Documentación para desarrolladores de Apple CVPixelBuffer.

CMSampleBuffer

El formato CMSampleBuffer almacena muestras de contenido multimedia de un tipo de contenido multimedia uniforme y es adecuado para el modo de ejecución de transmisiones en vivo. AVCaptureVideoDataOutput de iOS entrega de forma asíncrona los fotogramas en vivo de las cámaras de iOS en el formato CMSampleBuffer.

// Obtain a CMSampleBuffer.

// Convert the `CMSampleBuffer` object to a MediaPipe's Image object having the default
// orientation `UIImage.Orientation.up`.
let image = try MPImage(sampleBuffer: sampleBuffer)
    

// Obtain a `CMSampleBuffer`.

// Convert the `CMSampleBuffer` object to a MediaPipe's Image object having the
// default orientation `UIImageOrientationUp`.
MPImage *image = [[MPPImage alloc] initWithSampleBuffer:sampleBuffer error:nil];
    

Si quieres obtener más información sobre CMSampleBuffer, consulta la Documentación para desarrolladores de Apple sobre CMSampleBuffer.

Ejecuta la tarea

Para ejecutar el incorporador de imágenes, usa el método embed() específico del modo de ejecución asignado:

• Imagen fija: embed(image:)
• Video: embed(videoFrame:timestampInMilliseconds:)
• Transmisión en vivo: embedAsync(image:timestampInMilliseconds:)

En las siguientes muestras de código, se muestran ejemplos básicos de cómo ejecutar Image Embedder en estos diferentes modos de ejecución:

Swift

let result = try imageEmbedder.embed(image: image)
    

let result = try imageEmbedder.embed(
  videoFrame: image,
  timestampInMilliseconds: timestamp)
    

try imageEmbedder.embedAsync(
  image: image,
  timestampInMilliseconds: timestamp)
    

Objective-C

MPPImageEmbedderResult *result =
  [imageEmbedder embedImage:image error:nil];
    

MPPImageEmbedderResult *result =
  [imageEmbedder embedVideoFrame:image
           timestampInMilliseconds:timestamp
                             error:nil];
    

BOOL success =
  [imageEmbedder embedAsyncImage:image
           timestampInMilliseconds:timestamp
                             error:nil];
    

En el ejemplo de código del incorporador de imágenes, se muestran las implementaciones de cada uno de estos modos con más detalle: embed(image:), embed(videoFrame:timestampInMilliseconds:) y embedAsync(image:timestampInMilliseconds:). El código de ejemplo permite al usuario cambiar entre modos de procesamiento, lo que puede no ser necesario para tu caso de uso.

Ten en cuenta lo siguiente:

• Cuando se ejecuta en modo de video o de transmisión en vivo, también debes proporcionar la marca de tiempo del fotograma de entrada a la tarea de Image Embedder.

• Cuando se ejecuta en modo de imagen o video, la tarea del Incorporador de imágenes bloquea el subproceso actual hasta que termina de procesar la imagen o el fotograma de entrada. Para evitar bloquear el subproceso actual, ejecuta el procesamiento en un subproceso en segundo plano con los frameworks Dispatch o NSOperation de iOS. Si tu app se creó con Swift, también puedes usar Swift Concurrency para la ejecución de subprocesos en segundo plano.

• Cuando se ejecuta en el modo de transmisión en vivo, la tarea del incorporador de imágenes se muestra de inmediato y no bloquea el subproceso actual. Invoca el método imageEmbedder(_:didFinishEmbedding:timestampInMilliseconds:error:) con los resultados después de incorporar cada fotograma de entrada. El incorporador de imágenes invoca este método de forma asíncrona en una cola de envío en serie dedicada. Para mostrar los resultados en la interfaz de usuario, envía los resultados a la fila principal después de procesarlos. Si se llama a la función embedAsync cuando la tarea del incorporador de imágenes está ocupada procesando otro fotograma, el incorporador de imágenes ignora el nuevo fotograma de entrada.

Cómo controlar y mostrar resultados

Cuando se ejecuta la inferencia, el incorporador de imágenes muestra un objeto ImageEmbedderResult que contiene una lista de incorporaciones (ya sea de punto flotante o cuantificadas por escalar) para la imagen de entrada.

A continuación, se muestra un ejemplo de los datos de resultado de esta tarea:

ImageEmbedderResult:
  Embedding #0 (sole embedding head):
    float_embedding: {0.0, 0.0, ..., 0.0, 1.0, 0.0, 0.0, 2.0}
    head_index: 0

Este resultado se obtuvo incorporando la siguiente imagen:

Puedes comparar la similitud de dos incorporaciones con la función ImageEmbedder.cosineSimilarity.

let similarity = try ImageEmbedder.cosineSimilarity(
  embedding1: result.embeddingResult.embeddings[0],
  embedding2: otherResult.embeddingResult.embeddings[0])
    

NSNumber *similarity = [MPPImageEmbedder
      cosineSimilarityBetweenEmbedding1:result.embeddingResult.embeddings[0]
                          andEmbedding2:otherResult.embeddingResult.embeddings[0]
                                  error:nil];