Panoramica di RenderScript

RenderScript è un framework per l'esecuzione di attività ad alta intensità di calcolo e ad alte prestazioni su Android. RenderScript è orientato principalmente all'utilizzo con il calcolo parallelo dei dati, anche se possono essere utili anche i carichi di lavoro seriali. Il runtime RenderScript carica in contemporanea il lavoro tra i processori disponibili su un dispositivo, ad esempio CPU e GPU multi-core. In questo modo puoi concentrarti sull'espressione degli algoritmi piuttosto che sulla pianificazione del lavoro. RenderScript è particolarmente utile per applicazioni che eseguono l'elaborazione delle immagini, la fotografia computazionale o la visione artificiale.

Per iniziare con RenderScript, ci sono due concetti principali che devi comprendere:

  • Il linguaggio stesso è derivato da C99 per la scrittura di codice di computing ad alte prestazioni. Scrivere un kernel RenderScript descrive come utilizzarlo per scrivere kernel di computing.
  • L'API di controllo viene utilizzata per gestire la durata delle risorse RenderScript e controllare l'esecuzione del kernel. È disponibile in tre linguaggi diversi: Java, C++ in Android NDK e lo stesso linguaggio kernel C99. L'utilizzo di RenderScript da Java Code e di RenderScript a origine singola descrivono rispettivamente la prima e la terza opzione.

Scrittura di un kernel RenderScript

In genere, un kernel RenderScript risiede in un file .rs nella directory <project_root>/src/rs; ogni file .rs è chiamato script. Ogni script contiene il proprio set di kernel, funzioni e variabili. Uno script può contenere:

  • Una dichiarazione pragma (#pragma version(1)) che dichiara la versione del linguaggio kernel RenderScript utilizzato in questo script. Attualmente, l'unico valore valido è 1.
  • Una dichiarazione pragma (#pragma rs java_package_name(com.example.app)) che dichiara il nome del pacchetto delle classi Java riflesse in questo script. Tieni presente che il file .rs deve far parte del pacchetto dell'applicazione e non in un progetto di libreria.
  • Zero o più funzioni richiamabili. Una funzione evocabile è una funzione RenderScript a thread unico che puoi chiamare dal codice Java con argomenti arbitrari. Queste sono spesso utili per la configurazione iniziale o i calcoli seriali in una pipeline di elaborazione più grande.
  • Zero o più elementi globali di script. Uno script globale è simile a una variabile globale in C. Puoi accedere ai globali degli script dal codice Java e questi vengono spesso utilizzati per il passaggio di parametri ai kernel RenderScript. Gli script globali sono spiegati in modo più dettagliato qui.

  • Zero o più kernel di calcolo. Un kernel di computing è una funzione o una raccolta di funzioni che puoi indirizzare al runtime di RenderScript da eseguire in parallelo su una raccolta di dati. Esistono due tipi di kernel di computing: kernel di mappatura (chiamati anche kernel foreach) e kernel di riduzione.

    Un kernel di mappatura è una funzione parallela che opera su una raccolta di Allocations delle stesse dimensioni. Per impostazione predefinita, viene eseguita una volta per ogni coordinata in queste dimensioni. Di solito (ma non esclusivamente) viene utilizzato per trasformare una raccolta di input Allocations in un Allocation di output, un Element alla volta.

    • Ecco un esempio di un semplice kernel di mappatura:

      uchar4 RS_KERNEL invert(uchar4 in, uint32_t x, uint32_t y) {
        uchar4 out = in;
        out.r = 255 - in.r;
        out.g = 255 - in.g;
        out.b = 255 - in.b;
        return out;
      }

      Sotto molti aspetti, è identica a una funzione C standard. La proprietà RS_KERNEL applicata al prototipo della funzione specifica che la funzione è un kernel di mapping RenderScript invece che una funzione evocabile. L'argomento in viene compilato automaticamente in base all'input Allocation passato all'avvio del kernel. Gli argomenti x e y sono descritti di seguito. Il valore restituito dal kernel viene automaticamente scritto nella posizione appropriata nell'output Allocation. Per impostazione predefinita, questo kernel viene eseguito sull'intero input Allocation, con un'esecuzione della funzione del kernel per Element in Allocation.

      Un kernel di mapping può avere uno o più input Allocations, un singolo output Allocation o entrambi. Il runtime di RenderScript verifica che tutte le allocazioni di input e di output abbiano le stesse dimensioni e che i tipi Element delle allocazioni di input e output corrispondano al prototipo del kernel. Se uno di questi controlli ha esito negativo, RenderScript genera un'eccezione.

      NOTA: prima di Android 6.0 (livello API 23), un kernel di mappatura non può avere più di un Allocation di input.

      Se hai bisogno di più input o output Allocations rispetto a quello del kernel, questi oggetti devono essere associati a rs_allocation script globali e accedervi da un kernel o da una funzione evocabile tramite rsGetElementAt_type() o rsSetElementAt_type().

      NOTA:RS_KERNEL è una macro definita automaticamente da RenderScript per praticità:

      #define RS_KERNEL __attribute__((kernel))
      

    Un kernel di riduzione è una famiglia di funzioni che operano su una raccolta di Allocations di input delle stesse dimensioni. Per impostazione predefinita, la relativa funzione accumulatrice viene eseguita una volta per ogni coordinata in quelle dimensioni. In genere (ma non esclusivamente) viene utilizzato per "ridurre" una raccolta di input Allocations a un singolo valore.

    • Ecco un esempio di un semplice kernel di riduzione che somma la quota Elements dell'input:

      #pragma rs reduce(addint) accumulator(addintAccum)
      
      static void addintAccum(int *accum, int val) {
        *accum += val;
      }

      Un kernel di riduzione è costituito da una o più funzioni scritte dall'utente. #pragma rs reduce è utilizzato per definire il kernel specificandone il nome (addint, in questo esempio) ed i nomi e i ruoli delle funzioni che costituiscono il kernel (una funzione accumulator addintAccum, in questo esempio). Tutte queste funzioni devono essere static. Un kernel di riduzione richiede sempre una funzione accumulator; può avere anche altre funzioni, a seconda dell'azione che vuoi far eseguire al kernel.

      Una funzione di riduzione dell'accumulatore di kernel deve restituire void e deve avere almeno due argomenti. Il primo argomento (accum, in questo esempio) è un puntatore a un elemento di dati dell'accumulatore, mentre il secondo (val, in questo esempio) viene compilato automaticamente in base all'input Allocation passato all'avvio del kernel. L'elemento di dati dell'accumulatore viene creato dal runtime RenderScript; per impostazione predefinita, è inizializzato su zero. Per impostazione predefinita, questo kernel viene eseguito sull'intero input Allocation, con un'esecuzione della funzione accumulatore per Element in Allocation. Per impostazione predefinita, il valore finale dell'elemento di dati dell'accumulatore viene trattato come risultato della riduzione e restituito a Java. Il runtime RenderScript verifica che il tipo Element dell'allocazione di input corrisponda al prototipo della funzione accumulatore. In caso contrario, RenderScript genera un'eccezione.

      Un kernel di riduzione ha uno o più input Allocations, ma nessun output Allocations.

      I kernel di riduzione sono spiegati in maggiore dettaglio qui.

      I kernel di riduzione sono supportati in Android 7.0 (livello API 24) e versioni successive.

    Una funzione di mappatura del kernel o una funzione di riduzione dell'accumulatore di kernel può accedere alle coordinate dell'esecuzione corrente utilizzando gli argomenti speciali x, y e z, che devono essere di tipo int o uint32_t. Questi argomenti sono facoltativi.

    Una funzione di mappatura del kernel o una funzione di riduzione dell'accumulatore di kernel può anche utilizzare l'argomento speciale facoltativo context di tipo rs_kernel_context. È necessario per una famiglia di API di runtime utilizzate per eseguire query su determinate proprietà dell'esecuzione corrente, ad esempio rsGetDimX. L'argomento context è disponibile in Android 6.0 (livello API 23) e versioni successive.

  • Una funzione init() facoltativa. La funzione init() è un tipo speciale di funzione richiamabile che RenderScript esegue quando viene creata un'istanza dello script per la prima volta. Ciò consente di effettuare automaticamente un calcolo al momento della creazione dello script.
  • Zero o più funzioni e globali di script statici. Uno script statico globale è equivalente a uno script globale, ad eccezione del fatto che non è accessibile dal codice Java. Una funzione statica è una funzione C standard che può essere chiamata da qualsiasi kernel o funzione evocabile nello script, ma non è esposta all'API Java. Se non è necessario accedere a uno script globale o a una funzione dal codice Java, ti consigliamo vivamente di dichiararlo static.

Impostazione della precisione in virgola mobile

Puoi controllare il livello richiesto di precisione con rappresentazione in virgola mobile in uno script. Questa opzione è utile se non è necessario lo standard IEEE 754-2008 completo (utilizzato per impostazione predefinita). I seguenti pragma possono impostare un diverso livello di precisione in virgola mobile:

  • #pragma rs_fp_full (valore predefinito se non viene specificato nulla): per le app che richiedono la precisione con rappresentazione in virgola mobile, come indicato dallo standard IEEE 754-2008.
  • #pragma rs_fp_relaxed: per le app che non richiedono la rigida conformità allo standard IEEE 754-2008 e possono tollerare una precisione minore. Questa modalità consente lo svuotamento a zero per i denorm e il arrotondamento a zero.
  • #pragma rs_fp_imprecise: per le app che non hanno requisiti di precisione rigorosi. Questa modalità consente di attivare tutte le funzionalità di rs_fp_relaxed, oltre a quanto segue:
    • Le operazioni con un valore pari a -0,0 possono invece restituire +0,0.
    • Le operazioni su INF e NAN non sono definite.

La maggior parte delle applicazioni può utilizzare rs_fp_relaxed senza effetti collaterali. Questo può essere molto vantaggioso per alcune architetture grazie a ottimizzazioni aggiuntive disponibili solo con precisione rilassata (come le istruzioni per la CPU SIMD).

Accesso alle API RenderScript da Java

Durante lo sviluppo di un'applicazione Android che utilizza RenderScript, puoi accedere all'API da Java in uno dei due seguenti modi:

  • android.renderscript: le API in questo pacchetto di classe sono disponibili sui dispositivi con Android 3.0 (livello API 11) e versioni successive.
  • android.support.v8.renderscript: le API in questo pacchetto sono disponibili tramite una libreria di supporto, che consente di utilizzarle sui dispositivi con Android 2.3 (livello API 9) e versioni successive.

Ecco i pro e contro:

  • Se utilizzi le API Support Library, la parte RenderScript dell'applicazione sarà compatibile con i dispositivi con Android 2.3 (livello API 9) e versioni successive, indipendentemente dalle funzionalità di RenderScript utilizzate. In questo modo, la tua applicazione può funzionare su più dispositivi rispetto alle API native (android.renderscript).
  • Alcune funzionalità di RenderScript non sono disponibili tramite le API della libreria di supporto.
  • Se utilizzi le API Support Library, riceverai APK (probabilmente molto più grandi) di dimensioni superiori rispetto a quelli che utilizzi con le API native (android.renderscript).

Utilizzo delle API della libreria di supporto RenderScript

Per utilizzare le API RenderScript della libreria di supporto, devi configurare l'ambiente di sviluppo per potervi accedere. Per utilizzare queste API sono necessari i seguenti strumenti SDK per Android:

  • Android SDK Tools versione 22.2 o successiva
  • SDK Build-tools per Android versione 18.1.0 o successiva

Tieni presente che a partire da Android SDK Build-tools 24.0.0, Android 2.2 (livello API 8) non è più supportato.

Puoi controllare e aggiornare la versione installata di questi strumenti in Android SDK Manager.

Per utilizzare le API Support Library RenderScript:

  1. Assicurati che sia installata la versione dell'SDK Android richiesta.
  2. Aggiorna le impostazioni del processo di compilazione di Android in modo da includere le impostazioni di RenderScript:
    • Apri il file build.gradle nella cartella dell'app del modulo dell'applicazione.
    • Aggiungi le seguenti impostazioni RenderScript al file:

      trendy

              android {
                  compileSdkVersion 33
      
                  defaultConfig {
                      minSdkVersion 9
                      targetSdkVersion 19
      
                      renderscriptTargetApi 18
                      renderscriptSupportModeEnabled true
                  }
              }
              

      Kotlin

              android {
                  compileSdkVersion(33)
      
                  defaultConfig {
                      minSdkVersion(9)
                      targetSdkVersion(19)
      
                      renderscriptTargetApi = 18
                      renderscriptSupportModeEnabled = true
                  }
              }
              

      Le impostazioni elencate sopra controllano il comportamento specifico nel processo di compilazione di Android:

      • renderscriptTargetApi: specifica la versione in bytecode da generare. Ti consigliamo di impostare questo valore sul livello API più basso in grado di fornire tutte le funzionalità che utilizzi e di impostare renderscriptSupportModeEnabled su true. I valori validi per questa impostazione sono qualsiasi valore intero da 11 al livello API rilasciato più di recente. Se la versione minima dell'SDK specificata nel file manifest dell'applicazione è impostata su un valore diverso, questo valore viene ignorato e il valore target nel file di build viene utilizzato per impostare la versione minima dell'SDK.
      • renderscriptSupportModeEnabled: specifica che il bytecode generato deve ricorrere a una versione compatibile se il dispositivo su cui viene eseguito non supporta la versione di destinazione.
  3. Nelle classi dell'applicazione che utilizzano RenderScript, aggiungi un'importazione per le classi della libreria di supporto:

    Kotlin

    import android.support.v8.renderscript.*
    

    Java

    import android.support.v8.renderscript.*;
    

Utilizzo di RenderScript da codice Java o Kotlin

L'utilizzo di RenderScript da codice Java o Kotlin si basa sulle classi API presenti nel pacchetto android.renderscript o android.support.v8.renderscript. La maggior parte delle applicazioni segue lo stesso pattern di utilizzo di base:

  1. Inizializza un contesto RenderScript. Il contesto RenderScript, creato con create(Context), garantisce che sia possibile utilizzare RenderScript e fornisce un oggetto per controllare la durata di tutti gli oggetti RenderScript successivi. Dovresti considerare la creazione del contesto come un'operazione potenzialmente a lunga esecuzione, dato che potrebbe creare risorse su diversi componenti hardware; non dovrebbe trovarsi nel percorso critico di un'applicazione, se possibile. Di solito, un'applicazione ha un solo contesto RenderScript alla volta.
  2. Crea almeno un Allocation da passare a uno script. Un Allocation è un oggetto RenderScript che fornisce archiviazione per una quantità fissa di dati. I kernel negli script utilizzano gli oggetti Allocation come input e output e gli oggetti Allocation sono accessibili nei kernel utilizzando rsGetElementAt_type() e rsSetElementAt_type() se associati come elementi globali degli script. Gli oggetti Allocation consentono il trasferimento di array dal codice Java al codice RenderScript e viceversa. In genere, gli oggetti Allocation vengono creati utilizzando createTyped() o createFromBitmap().
  3. Crea gli script necessari. Quando utilizzi RenderScript, sono disponibili due tipi di script:
    • ScriptC: sono gli script definiti dall'utente come descritto in Scrittura di un kernel RenderScript sopra. Ogni script ha una classe Java riflessa dal compilatore RenderScript per semplificare l'accesso allo script dal codice Java; questa classe ha il nome ScriptC_filename. Ad esempio, se il kernel di mappatura riportato sopra fosse in invert.rs e un contesto RenderScript era già posizionato in mRenderScript, il codice Java o Kotlin per creare un'istanza dello script sarà:

      Kotlin

      val invert = ScriptC_invert(renderScript)
      

      Java

      ScriptC_invert invert = new ScriptC_invert(renderScript);
      
    • ScriptIntrinsic: si tratta di kernel RenderScript integrati per operazioni comuni, come la sfocatura, la convoluzione e la combinazione di immagini gaussiane. Per ulteriori informazioni, consulta le sottoclassi di ScriptIntrinsic.
  4. Completa le allocazioni con i dati. Ad eccezione delle allocazioni create con createFromBitmap(), un'allocazione viene compilata con dati vuoti quando viene creata per la prima volta. Per compilare un'allocazione, utilizza uno dei metodi "copy" in Allocation. I metodi di "copia" sono sincroni.
  5. Imposta tutti gli script globali necessari. Puoi impostare le impostazioni globali utilizzando i metodi nella stessa classe ScriptC_filename denominata set_globalname. Ad esempio, per impostare una variabile int denominata threshold, usa il metodo Java set_threshold(int); per impostare una variabile rs_allocation denominata lookup, utilizza il metodo Java set_lookup(Allocation). I metodi set sono asincroni.
  6. Avvia i kernel appropriati e le funzioni evocabili.

    I metodi per avviare un determinato kernel si riflettono nella stessa classe ScriptC_filename con i metodi denominati forEach_mappingKernelName() o reduce_reductionKernelName(). Questi lanci sono asincroni. A seconda degli argomenti del kernel, il metodo richiede una o più allocazioni, tutte devono avere le stesse dimensioni. Per impostazione predefinita, un kernel viene eseguito su ogni coordinata di quelle dimensioni. Per eseguire un kernel su un sottoinsieme di queste coordinate, passa un Script.LaunchOptions appropriato come ultimo argomento al metodo forEach o reduce.

    Avvia funzioni richiamabili utilizzando i metodi invoke_functionName riflessi nella stessa classe ScriptC_filename. Questi lanci sono asincroni.

  7. Recupera i dati da oggetti Allocation e oggetti javaFutureType. Per accedere ai dati di un Allocation da codice Java, devi copiare nuovamente i dati in Java utilizzando uno dei metodi di "copia" in Allocation. Per ottenere il risultato di un kernel di riduzione, devi usare il metodo javaFutureType.get(). I metodi "copy" e get() sono sincroni.
  8. Elimina il contesto RenderScript. Puoi eliminare il contesto RenderScript con destroy() o consentire la garbage collection dell'oggetto di contesto RenderScript. Ciò fa sì che qualsiasi ulteriore utilizzo di qualsiasi oggetto appartenente a quel contesto generi un'eccezione.

Modello di esecuzione asincrono

I metodi forEach, invoke, reduce e set sono asincroni: ognuno può tornare a Java prima di completare l'azione richiesta. Tuttavia, le singole azioni sono serializzate nell'ordine in cui sono state avviate.

La classe Allocation fornisce metodi "copy" per copiare i dati da e verso le allocazioni. Un metodo di "copia" è sincrono e serializzato in relazione a qualsiasi azione asincrona precedente che tocca la stessa allocazione.

Le classi javaFutureType riflesse forniscono un metodo get() per ottenere il risultato di una riduzione. get() è sincrono e serializzato in relazione alla riduzione (che è asincrona).

RenderScript a origine singola

Android 7.0 (livello API 24) introduce una nuova funzionalità di programmazione chiamata RenderScript Single-Source, in cui i kernel vengono avviati dallo script in cui sono definiti, anziché da Java. Questo approccio è attualmente limitato alla mappatura dei kernel, semplicemente denominati "kernel" in questa sezione per motivi di concisione. Questa nuova funzionalità supporta anche la creazione di allocazioni di tipo rs_allocation dall'interno dello script. Ora è possibile implementare un intero algoritmo esclusivamente all'interno di uno script, anche se sono necessari più lanci del kernel. Il vantaggio è duplice: codice più leggibile, perché mantiene l'implementazione di un algoritmo in un solo linguaggio e codice potenzialmente più veloce, grazie al minor numero di transizioni tra Java e RenderScript nell'ambito di più lanci del kernel.

In Single-Source RenderScript, si scrivono i kernel come descritto in Scrittura di un kernel RenderScript. Quindi scriverai una funzione evocabile che chiama rsForEach() per avviarla. L'API prende una funzione kernel come primo parametro, seguita dalle allocazioni di input e output. Un'API simile rsForEachWithOptions() richiede un argomento aggiuntivo di tipo rs_script_call_t, che specifica un sottoinsieme degli elementi delle allocazioni di input e output per l'elaborazione della funzione kernel.

Per avviare il calcolo di RenderScript, devi chiamare la funzione evocabile da Java. Segui i passaggi descritti in Utilizzo di RenderScript da Java Code. Nel passaggio avvia i kernel appropriati, chiama la funzione evocabile utilizzando invoke_function_name(), che avvierà l'intero calcolo, incluso l'avvio dei kernel.

Spesso sono necessarie allocazioni per salvare e passare i risultati intermedi da un lancio del kernel all'altro. Puoi crearle utilizzando rsCreateAllocation(). Una forma facile da usare di questa API è rsCreateAllocation_<T><W>(…), dove T è il tipo di dati per un elemento e W è la larghezza vettoriale dell'elemento. L'API prende le dimensioni nelle dimensioni X, Y e Z come argomenti. Per le allocazioni 1D o 2D, le dimensioni per le dimensioni Y o Z possono essere omesse. Ad esempio, rsCreateAllocation_uchar4(16384) crea un'allocazione 1D di 16384 elementi, ognuno dei quali è di tipo uchar4.

Le allocazioni vengono gestite automaticamente dal sistema. Non è necessario rilasciarli o liberarli esplicitamente. Tuttavia, puoi chiamare rsClearObject(rs_allocation* alloc) per indicare che non hai più bisogno dell'handle alloc per l'allocazione sottostante, in modo che il sistema possa liberare risorse il prima possibile.

La sezione Scrittura di un kernel RenderScript contiene un kernel di esempio che inverte un'immagine. L'esempio seguente espande questa funzionalità per applicare più di un effetto a un'immagine, utilizzando RenderScript a origine singola. Include un altro kernel, greyscale, che trasforma un'immagine a colori in bianco e nero. Una funzione evocabile process() applica quindi questi due kernel consecutivamente a un'immagine di input e produce un'immagine di output. Le allocazioni sia per l'input sia per l'output vengono passate come argomenti di tipo rs_allocation.

// File: singlesource.rs

#pragma version(1)
#pragma rs java_package_name(com.android.rssample)

static const float4 weight = {0.299f, 0.587f, 0.114f, 0.0f};

uchar4 RS_KERNEL invert(uchar4 in, uint32_t x, uint32_t y) {
  uchar4 out = in;
  out.r = 255 - in.r;
  out.g = 255 - in.g;
  out.b = 255 - in.b;
  return out;
}

uchar4 RS_KERNEL greyscale(uchar4 in) {
  const float4 inF = rsUnpackColor8888(in);
  const float4 outF = (float4){ dot(inF, weight) };
  return rsPackColorTo8888(outF);
}

void process(rs_allocation inputImage, rs_allocation outputImage) {
  const uint32_t imageWidth = rsAllocationGetDimX(inputImage);
  const uint32_t imageHeight = rsAllocationGetDimY(inputImage);
  rs_allocation tmp = rsCreateAllocation_uchar4(imageWidth, imageHeight);
  rsForEach(invert, inputImage, tmp);
  rsForEach(greyscale, tmp, outputImage);
}

Puoi chiamare la funzione process() da Java o Kotlin come segue:

Kotlin

val RS: RenderScript = RenderScript.create(context)
val script = ScriptC_singlesource(RS)
val inputAllocation: Allocation = Allocation.createFromBitmapResource(
        RS,
        resources,
        R.drawable.image
)
val outputAllocation: Allocation = Allocation.createTyped(
        RS,
        inputAllocation.type,
        Allocation.USAGE_SCRIPT or Allocation.USAGE_IO_OUTPUT
)
script.invoke_process(inputAllocation, outputAllocation)

Java

// File SingleSource.java

RenderScript RS = RenderScript.create(context);
ScriptC_singlesource script = new ScriptC_singlesource(RS);
Allocation inputAllocation = Allocation.createFromBitmapResource(
    RS, getResources(), R.drawable.image);
Allocation outputAllocation = Allocation.createTyped(
    RS, inputAllocation.getType(),
    Allocation.USAGE_SCRIPT | Allocation.USAGE_IO_OUTPUT);
script.invoke_process(inputAllocation, outputAllocation);

Questo esempio mostra come un algoritmo che prevede due lanci del kernel può essere implementato completamente nel linguaggio RenderScript. Senza RenderScript Single-Source, dovresti lanciare entrambi i kernel dal codice Java, separando i lanci del kernel dalle definizioni del kernel e rendendo più difficile la comprensione dell'intero algoritmo. Non solo il codice RenderScript single-source è più facile da leggere, ma elimina anche la transizione tra Java e lo script nell'avvio del kernel. Alcuni algoritmi iterativi possono lanciare kernel centinaia di volte, rendendo l'overhead di questa transizione considerevole.

Globale script

Uno script globale è una variabile globale nonstatic ordinaria in un file script (.rs). Per uno script globale denominato var definito nel file filename.rs, verrà riportato un metodo get_var nella classe ScriptC_filename. A meno che il valore globale non sia const, ci sarà anche un metodo set_var.

Un determinato script globale ha due valori separati: un valore Java e un valore script. Questi valori si comportano nel seguente modo:

  • Se var contiene un inizializzatore statico nello script, specifica il valore iniziale di var sia in Java sia nello script. In caso contrario, il valore iniziale è pari a zero.
  • Accede a var all'interno dello script legge e scrive il relativo valore di script.
  • Il metodo get_var legge il valore Java.
  • Il metodo set_var (se esistente) scrive il valore Java immediatamente e il valore dello script in modo asincrono.

NOTA: questo significa che, ad eccezione di eventuali inizializzatori statici nello script, i valori scritti in un elemento globale dall'interno di uno script non sono visibili a Java.

Kernel di riduzione in profondità

La riduzione è il processo di combinazione di una raccolta di dati in un singolo valore. Questa è una funzione primitiva utile nella programmazione parallela, con applicazioni come le seguenti:

  • calcolando la somma o il prodotto sulla base di tutti i dati
  • di calcolo di operazioni logiche (and, or, xor) su tutti i dati
  • individuare il valore minimo o massimo tra i dati
  • la ricerca di un valore specifico o della coordinata di un valore specifico all'interno dei dati

In Android 7.0 (livello API 24) e versioni successive, RenderScript supporta i kernel di riduzione per consentire algoritmi di riduzione efficienti e scritti dall'utente. Puoi avviare i kernel di riduzione su input con 1, 2 o 3 dimensioni.

Un esempio riportato sopra mostra un semplice kernel di riduzione addint. Ecco un kernel di riduzione findMinAndMax più complicato che trova le posizioni dei valori minimo e massimo di long in un Allocation monodimensionale:

#define LONG_MAX (long)((1UL << 63) - 1)
#define LONG_MIN (long)(1UL << 63)

#pragma rs reduce(findMinAndMax) \
  initializer(fMMInit) accumulator(fMMAccumulator) \
  combiner(fMMCombiner) outconverter(fMMOutConverter)

// Either a value and the location where it was found, or INITVAL.
typedef struct {
  long val;
  int idx;     // -1 indicates INITVAL
} IndexedVal;

typedef struct {
  IndexedVal min, max;
} MinAndMax;

// In discussion below, this initial value { { LONG_MAX, -1 }, { LONG_MIN, -1 } }
// is called INITVAL.
static void fMMInit(MinAndMax *accum) {
  accum->min.val = LONG_MAX;
  accum->min.idx = -1;
  accum->max.val = LONG_MIN;
  accum->max.idx = -1;
}

//----------------------------------------------------------------------
// In describing the behavior of the accumulator and combiner functions,
// it is helpful to describe hypothetical functions
//   IndexedVal min(IndexedVal a, IndexedVal b)
//   IndexedVal max(IndexedVal a, IndexedVal b)
//   MinAndMax  minmax(MinAndMax a, MinAndMax b)
//   MinAndMax  minmax(MinAndMax accum, IndexedVal val)
//
// The effect of
//   IndexedVal min(IndexedVal a, IndexedVal b)
// is to return the IndexedVal from among the two arguments
// whose val is lesser, except that when an IndexedVal
// has a negative index, that IndexedVal is never less than
// any other IndexedVal; therefore, if exactly one of the
// two arguments has a negative index, the min is the other
// argument. Like ordinary arithmetic min and max, this function
// is commutative and associative; that is,
//
//   min(A, B) == min(B, A)               // commutative
//   min(A, min(B, C)) == min((A, B), C)  // associative
//
// The effect of
//   IndexedVal max(IndexedVal a, IndexedVal b)
// is analogous (greater . . . never greater than).
//
// Then there is
//
//   MinAndMax minmax(MinAndMax a, MinAndMax b) {
//     return MinAndMax(min(a.min, b.min), max(a.max, b.max));
//   }
//
// Like ordinary arithmetic min and max, the above function
// is commutative and associative; that is:
//
//   minmax(A, B) == minmax(B, A)                  // commutative
//   minmax(A, minmax(B, C)) == minmax((A, B), C)  // associative
//
// Finally define
//
//   MinAndMax minmax(MinAndMax accum, IndexedVal val) {
//     return minmax(accum, MinAndMax(val, val));
//   }
//----------------------------------------------------------------------

// This function can be explained as doing:
//   *accum = minmax(*accum, IndexedVal(in, x))
//
// This function simply computes minimum and maximum values as if
// INITVAL.min were greater than any other minimum value and
// INITVAL.max were less than any other maximum value.  Note that if
// *accum is INITVAL, then this function sets
//   *accum = IndexedVal(in, x)
//
// After this function is called, both accum->min.idx and accum->max.idx
// will have nonnegative values:
// - x is always nonnegative, so if this function ever sets one of the
//   idx fields, it will set it to a nonnegative value
// - if one of the idx fields is negative, then the corresponding
//   val field must be LONG_MAX or LONG_MIN, so the function will always
//   set both the val and idx fields
static void fMMAccumulator(MinAndMax *accum, long in, int x) {
  IndexedVal me;
  me.val = in;
  me.idx = x;

  if (me.val <= accum->min.val)
    accum->min = me;
  if (me.val >= accum->max.val)
    accum->max = me;
}

// This function can be explained as doing:
//   *accum = minmax(*accum, *val)
//
// This function simply computes minimum and maximum values as if
// INITVAL.min were greater than any other minimum value and
// INITVAL.max were less than any other maximum value.  Note that if
// one of the two accumulator data items is INITVAL, then this
// function sets *accum to the other one.
static void fMMCombiner(MinAndMax *accum,
                        const MinAndMax *val) {
  if ((accum->min.idx < 0) || (val->min.val < accum->min.val))
    accum->min = val->min;
  if ((accum->max.idx < 0) || (val->max.val > accum->max.val))
    accum->max = val->max;
}

static void fMMOutConverter(int2 *result,
                            const MinAndMax *val) {
  result->x = val->min.idx;
  result->y = val->max.idx;
}

NOTA: qui sono disponibili altri kernel di riduzione di esempio.

Per eseguire un kernel di riduzione, il runtime RenderScript crea una o più variabili denominate elementi di dati dell'accumulatore per contenere lo stato del processo di riduzione. Il runtime RenderScript sceglie il numero di elementi di dati dell'accumulatore in modo da massimizzare le prestazioni. Il tipo degli elementi di dati dell'accumulatore (accumType) è determinato dalla funzione accumulatore del kernel. Il primo argomento di questa funzione è un puntatore a un elemento di dati dell'accumulatore. Per impostazione predefinita, ogni elemento di dati dell'accumulatore è inizializzato su zero (come se da memset); tuttavia, puoi scrivere una funzione di inizializzazione per fare qualcosa di diverso.

Esempio: nel kernel addint, gli elementi di dati dell'accumulatore (di tipo int) vengono utilizzati per sommare i valori di input. Non esiste una funzione di inizializzazione, pertanto ogni elemento di dati dell'accumulatore viene inizializzato su zero.

Esempio: nel kernel findMinAndMax, gli elementi di dati dell'accumulatore (di tipo MinAndMax) vengono utilizzati per tenere traccia dei valori minimo e massimo rilevati finora. Esiste una funzione di inizializzazione per impostarli rispettivamente su LONG_MAX e LONG_MIN e per impostare le posizioni di questi valori su -1, indicando che i valori non sono effettivamente presenti nella parte (vuota) dell'input che è stata elaborata.

RenderScript chiama la funzione accumulatore una volta per ogni coordinata negli input. In genere, la funzione dovrebbe aggiornare l'elemento di dati dell'accumulatore in qualche modo in base all'input.

Esempio: nel kernel addint, la funzione accumulatore aggiunge il valore di un elemento di input all'elemento di dati dell'accumulatore.

Esempio: nel kernel findMinAndMax, la funzione dell'accumulatore controlla se il valore di un elemento di input è inferiore o uguale al valore minimo registrato nell'elemento di dati dell'accumulatore e/o maggiore o uguale al valore massimo registrato nell'elemento di dati dell'accumulatore e aggiorna di conseguenza l'elemento di dati dell'accumulatore.

Dopo che la funzione accumulatore è stata richiamata una volta per ogni coordinata negli input, RenderScript deve combinare gli elementi di dati dell'accumulatore in un unico elemento di dati dell'accumulatore. Per farlo, puoi scrivere una funzione di combinazione. Se la funzione accumulatore ha un singolo input e nessun argomento speciale, non è necessario scrivere una funzione di combinazione; RenderScript utilizzerà la funzione accumulatore per combinare gli elementi di dati dell'accumulatore. Puoi comunque scrivere una funzione di combinazione se questo comportamento predefinito non è ciò che vuoi.

Esempio: nel kernel addint non esiste una funzione di combinazione, pertanto verrà utilizzata la funzione accumulatore. Questo è il comportamento corretto perché, se suddividiamo una raccolta di valori in due parti e sommiamo i valori in queste due parti separatamente, sommare queste due somme equivale a sommare l'intera raccolta.

Esempio: nel kernel findMinAndMax, la funzione di combinazione controlla se il valore minimo registrato nell'elemento di dati dell'accumulatore "source" *val è inferiore al valore minimo registrato nell'elemento di dati dell'accumulatore "destination" *accum e aggiorna *accum di conseguenza. Svolge una procedura simile per il valore massimo. L'operazione aggiorna *accum lo stato che avrebbe avuto se tutti i valori di input fossero stati accumulati in *accum anziché alcuni in *accum e altri in *val.

Dopo aver combinato tutti gli elementi di dati dell'accumulatore, RenderScript determina il risultato della riduzione per tornare a Java. A questo scopo, puoi scrivere una funzione di outconverter. Non è necessario scrivere una funzione di outconverter se vuoi che il valore finale degli elementi di dati dell'accumulatore combinato sia il risultato della riduzione.

Esempio: nel kernel addint non esiste una funzione di outconverter. Il valore finale degli elementi di dati combinati è la somma di tutti gli elementi dell'input, ovvero il valore che vogliamo restituire.

Esempio: nel kernel findMinAndMax, la funzione di outconverter inizializza un valore di risultato int2 per contenere le posizioni dei valori minimo e massimo risultanti dalla combinazione di tutti gli elementi di dati dell'accumulatore.

Scrittura di un kernel di riduzione

#pragma rs reduce definisce un kernel di riduzione specificandone il nome, nonché i nomi e i ruoli delle funzioni che compongono il kernel. Tutte queste funzioni devono essere static. Un kernel di riduzione richiede sempre una funzione accumulator; puoi omettere alcune o tutte le altre funzioni, a seconda dell'azione che vuoi far eseguire al kernel.

#pragma rs reduce(kernelName) \
  initializer(initializerName) \
  accumulator(accumulatorName) \
  combiner(combinerName) \
  outconverter(outconverterName)

Il significato degli elementi in #pragma è il seguente:

  • reduce(kernelName) (obbligatorio): specifica che viene definito un kernel di riduzione. Un metodo Java reduce_kernelName riportato avvierà il kernel.
  • initializer(initializerName) (facoltativo): specifica il nome della funzione di inizializzazione per il kernel di riduzione. Quando avvii il kernel, RenderScript chiama questa funzione una volta per ogni elemento di dati dell'accumulatore. La funzione deve essere definita come segue:

    static void initializerName(accumType *accum) { … }

    accum è un puntatore a un elemento di dati accumulatore per l'inizializzazione di questa funzione.

    Se non fornisci una funzione di inizializzazione, RenderScript inizializza ogni elemento di dati dell'accumulatore a zero (come se fosse effettuato da memset), comportandosi come se fosse presente una funzione di inizializzazione simile alla seguente:

    static void initializerName(accumType *accum) {
      memset(accum, 0, sizeof(*accum));
    }
  • accumulator(accumulatorName) (obbligatorio): specifica il nome della funzione accumulatore per questo ker di riduzione. Quando avvii il kernel, RenderScript chiama questa funzione una volta per ogni coordinata negli input per aggiornare in qualche modo un elemento di dati dell'accumulatore in base agli input. La funzione deve essere definita come segue:

    static void accumulatorName(accumType *accum,
                                in1Type in1, …, inNType inN
                                [, specialArguments]) { … }
    

    accum è un puntatore a un elemento di dati di un accumulatore da modificare con questa funzione. Da in1 a inN sono uno o più argomenti che vengono compilati automaticamente in base agli input passati all'avvio del kernel, un argomento per input. La funzione accumulatore può utilizzare uno qualsiasi degli argomenti speciali.

    Un kernel di esempio con più input è dotProduct.

  • combiner(combinerName)

    (Facoltativo): specifica il nome della funzione combinatore per questo kernel di riduzione. Dopo che RenderScript chiama la funzione accumulatore una volta per ogni coordinata negli input, la chiama tutte le volte necessarie per combinare tutti gli elementi di dati dell'accumulatore in un unico elemento di dati dell'accumulatore. La funzione deve essere definita nel seguente modo:

    static void combinerName(accumType *accum, const accumType *other) { … }

    accum è un puntatore a un elemento di dati di un accumulatore "destination" che questa funzione deve modificare. other è un puntatore a un elemento di dati accumulatore "di origine" per la "combinazione" di questa funzione in *accum.

    NOTA: è possibile che *accum, *other o entrambi siano stati inizializzati, ma che non siano mai stati passati alla funzione accumulatore. Ciò significa che una o entrambe non sono mai state aggiornate in base a dati di input. Ad esempio, nel kernel findMinAndMax, la funzione di combinazione fMMCombiner verifica esplicitamente la presenza di idx < 0 perché indica un elemento di dati di questo accumulatore, il cui valore è INITVAL.

    Se non fornisci una funzione di combinazione, RenderScript utilizza al suo posto la funzione accumulatore, che si comporta come se fosse presente una funzione di combinazione simile alla seguente:

    static void combinerName(accumType *accum, const accumType *other) {
      accumulatorName(accum, *other);
    }

    Una funzione di combinazione è obbligatoria se il kernel ha più input, se il tipo di dati di input non è uguale al tipo di dati dell'accumulatore o se la funzione accumulatore accetta uno o più argomenti speciali.

  • outconverter(outconverterName) (facoltativo): specifica il nome della funzione di outconverter per questo kernel di riduzione. Dopo che RenderScript ha combinato tutti gli elementi di dati dell'accumulatore, chiama questa funzione per determinare il risultato della riduzione per tornare a Java. La funzione deve essere definita nel seguente modo:

    static void outconverterName(resultType *result, const accumType *accum) { … }

    result è un puntatore a un elemento di dati risultato (allocato ma non inizializzato dal runtime RenderScript) affinché questa funzione venga inizializzata con il risultato della riduzione. resultType è il tipo di elemento di dati, che non deve necessariamente essere uguale a accumType. accum è un puntatore all'elemento di dati finale dell'accumulatore calcolato dalla funzione di combinazione.

    Se non fornisci una funzione di outconverter, RenderScript copia l'elemento di dati dell'accumulatore finale nell'elemento di dati del risultato, comportandosi come se fosse presente una funzione di outconverter simile alla seguente:

    static void outconverterName(accumType *result, const accumType *accum) {
      *result = *accum;
    }

    Se vuoi un tipo di risultato diverso rispetto al tipo di dati dell'accumulatore, la funzione di outconverter è obbligatoria.

Tieni presente che un kernel ha tipi di input, un tipo di elemento dati accumulatore e un tipo di risultato, nessuno dei quali deve essere uguale. Ad esempio, nel kernel findMinAndMax, il tipo di input long, il tipo di elemento dati dell'accumulatore MinAndMax e il tipo di risultato int2 sono tutti diversi.

Che cosa non puoi dare per scontato?

Non devi fare affidamento sul numero di elementi di dati dell'accumulatore creati da RenderScript per un determinato lancio del kernel. Non vi è alcuna garanzia che due lanci dello stesso kernel con gli stessi input creino lo stesso numero di elementi di dati dell'accumulatore.

Non devi fare affidamento sull'ordine in cui RenderScript chiama le funzioni di inizializzazione, accumulatore e combinatore; potrebbe persino chiamarne alcune in parallelo. Non c'è alcuna garanzia che due lanci dello stesso kernel con lo stesso input seguano lo stesso ordine. L'unica garanzia è che solo la funzione di inizializzazione vedrà un elemento di dati dell'accumulatore non inizializzato. Ecco alcuni esempi:

  • Non esiste alcuna garanzia che tutti gli elementi di dati dell'accumulatore vengano inizializzati prima della chiamata della funzione dell'accumulatore, anche se verranno richiamati solo su un elemento di dati dell'accumulatore inizializzato.
  • Non esiste alcuna garanzia nell'ordine in cui gli elementi di input vengono passati alla funzione accumulatore.
  • Non esiste alcuna garanzia che la funzione accumulatore sia stata chiamata per tutti gli elementi di input prima della chiamata della funzione di combinazione.

Una conseguenza di ciò è che il kernel findMinAndMax non è deterministico: se l'input contiene più di un'occorrenza dello stesso valore minimo o massimo, non hai modo di sapere quale occorrenza troverà il kernel.

Cosa devi garantire?

Dato che il sistema RenderScript può scegliere di eseguire un kernel in molti modi diversi, devi seguire determinate regole per assicurarti che il kernel si comporti nel modo che vuoi. Se non segui queste regole, potresti ricevere risultati errati, un comportamento non deterministico o errori di runtime.

Le regole riportate di seguito spesso indicano che due elementi di dati dell'accumulatore devono avere "lo stesso valore". Che cosa significa? Dipende da ciò che vuoi che faccia il kernel. Per una riduzione matematica come addint, di solito ha senso che "lo stesso" indichi l'uguaglianza matematica. Per una ricerca "scegli qualsiasi" come findMinAndMax ("trovare la posizione dei valori di input minimo e massimo"), in cui potrebbe esserci più di un'occorrenza di valori di input identici, tutte le posizioni di un determinato valore di input devono essere considerate "uguali". Potresti scrivere un kernel simile per "trovare la posizione dei valori di input minimo e massimo leftmost", dove (ad esempio) è preferibile un valore minimo nella posizione 100 rispetto a un valore minimo identico nella posizione 200; per questo kernel, "lo stesso" significherebbe una località identica, non semplicemente un valore identico, e le funzioni di accumulatore e combinatore dovrebbero essere diverse da quelle di MinfindAnd.

La funzione di inizializzazione deve creare un valore di identità. In altre parole, se I e A sono elementi di dati accumulatori inizializzati dalla funzione di inizializzazione e I non è mai stato passato alla funzione accumulatore (ma potrebbe esserlo A), allora
  • combinerName(&A, &I) deve lasciare A invariato
  • combinerName(&I, &A) deve lasciare I uguale a A

Esempio: nel kernel addint, un elemento di dati dell'accumulatore viene inizializzato su zero. La funzione combinata per questo kernel esegue l'aggiunta; zero è il valore dell'identità per l'aggiunta.

Esempio: nel kernel findMinAndMax, un elemento di dati dell'accumulatore viene inizializzato in INITVAL.

  • fMMCombiner(&A, &I) lascia A invariato, perché I è INITVAL.
  • fMMCombiner(&I, &A) imposta I su A, perché I è INITVAL.

Di conseguenza, INITVAL è effettivamente un valore di identità.

La funzione di combinazione deve essere commutativa. In altre parole, se A e B sono elementi di dati dell'accumulatore inizializzati dalla funzione di inizializzazione e che possono essere stati passati alla funzione accumulatore zero o più volte, combinerName(&A, &B) deve impostare A sullo stesso valore che combinerName(&B, &A) imposta B.

Esempio: nel kernel addint, la funzione di combinazione aggiunge i due valori degli elementi di dati dell'accumulatore; l'aggiunta è commutativa.

Esempio: nel kernel findMinAndMax, fMMCombiner(&A, &B) è uguale a A = minmax(A, B) e minmax è commutativo, quindi anche fMMCombiner lo è.

La funzione combinata deve essere associative. In altre parole, se A, B e C sono elementi di dati dell'accumulatore inizializzati dalla funzione di inizializzazione e che possono essere stati passati alla funzione accumulatore zero o più volte, le due sequenze di codice seguenti devono impostare A sullo stesso valore:

  • combinerName(&A, &B);
    combinerName(&A, &C);
    
  • combinerName(&B, &C);
    combinerName(&A, &B);
    

Esempio: nel kernel addint, la funzione di combinazione aggiunge i due valori degli elementi di dati dell'accumulatore:

  • A = A + B
    A = A + C
    // Same as
    //   A = (A + B) + C
    
  • B = B + C
    A = A + B
    // Same as
    //   A = A + (B + C)
    //   B = B + C
    

L'addizione è associativa, così come la funzione di combinazione.

Esempio: nel kernel findMinAndMax,

fMMCombiner(&A, &B)
è uguale a
A = minmax(A, B)
Le due sequenze vengono quindi

  • A = minmax(A, B)
    A = minmax(A, C)
    // Same as
    //   A = minmax(minmax(A, B), C)
    
  • B = minmax(B, C)
    A = minmax(A, B)
    // Same as
    //   A = minmax(A, minmax(B, C))
    //   B = minmax(B, C)
    

minmax è associativo, così come fMMCombiner lo è.

La funzione accumulatore e la funzione combinata devono rispettare la regola di piegatura di base. In altre parole, se A e B sono elementi di dati dell'accumulatore, A è stato inizializzato dalla funzione di inizializzazione e può essere stato passato alla funzione di inizializzazione dell'accumulatore zero o più volte, B non è stato inizializzato e args è l'elenco di argomenti di input e argomenti speciali per una chiamata specifica alla funzione dell'accumulatore, le seguenti due sequenze di codice devono impostare A sullo stesso valore:

  • accumulatorName(&A, args);  // statement 1
    
  • initializerName(&B);        // statement 2
    accumulatorName(&B, args);  // statement 3
    combinerName(&A, &B);       // statement 4
    

Esempio: nel kernel addint, per un valore di input V:

  • L'istruzione 1 è uguale a A += V
  • L'istruzione 2 è uguale a B = 0
  • L'istruzione 3 è uguale a B += V, che equivale a B = V
  • L'istruzione 4 è uguale a A += B, che equivale a A += V

Le istruzioni 1 e 4 impostano A sullo stesso valore, pertanto il kernel rispetta la regola di folding di base.

Esempio: nel kernel findMinAndMax, per un valore di input V alla coordinata X:

  • L'istruzione 1 è uguale a A = minmax(A, IndexedVal(V, X))
  • L'istruzione 2 è uguale a B = INITVAL
  • L'istruzione 3 è uguale a
    B = minmax(B, IndexedVal(V, X))
    
    che, poiché B è il valore iniziale, è uguale a
    B = IndexedVal(V, X)
    
  • L'istruzione 4 è uguale a
    A = minmax(A, B)
    
    che equivale a
    A = minmax(A, IndexedVal(V, X))
    

Le istruzioni 1 e 4 impostano A sullo stesso valore, pertanto il kernel rispetta la regola di folding di base.

Chiamata a un kernel di riduzione dal codice Java

Per un kernel di riduzione denominato kernelName definito nel file filename.rs, esistono tre metodi riflessi nella classe ScriptC_filename:

Kotlin

// Function 1
fun reduce_kernelName(ain1: Allocation, …,
                               ainN: Allocation): javaFutureType

// Function 2
fun reduce_kernelName(ain1: Allocation, …,
                               ainN: Allocation,
                               sc: Script.LaunchOptions): javaFutureType

// Function 3
fun reduce_kernelName(in1: Array<devecSiIn1Type>, …,
                               inN: Array<devecSiInNType>): javaFutureType

Java

// Method 1
public javaFutureType reduce_kernelName(Allocation ain1, …,
                                        Allocation ainN);

// Method 2
public javaFutureType reduce_kernelName(Allocation ain1, …,
                                        Allocation ainN,
                                        Script.LaunchOptions sc);

// Method 3
public javaFutureType reduce_kernelName(devecSiIn1Type[] in1, …,
                                        devecSiInNType[] inN);

Ecco alcuni esempi di chiamata del kernel addint:

Kotlin

val script = ScriptC_example(renderScript)

// 1D array
//   and obtain answer immediately
val input1 = intArrayOf()
val sum1: Int = script.reduce_addint(input1).get()  // Method 3

// 2D allocation
//   and do some additional work before obtaining answer
val typeBuilder = Type.Builder(RS, Element.I32(RS)).apply {
    setX()
    setY()
}
val input2: Allocation = Allocation.createTyped(RS, typeBuilder.create()).also {
    populateSomehow(it) // fill in input Allocation with data
}
val result2: ScriptC_example.result_int = script.reduce_addint(input2)  // Method 1
doSomeAdditionalWork() // might run at same time as reduction
val sum2: Int = result2.get()

Java

ScriptC_example script = new ScriptC_example(renderScript);

// 1D array
//   and obtain answer immediately
int input1[] = ;
int sum1 = script.reduce_addint(input1).get();  // Method 3

// 2D allocation
//   and do some additional work before obtaining answer
Type.Builder typeBuilder =
  new Type.Builder(RS, Element.I32(RS));
typeBuilder.setX();
typeBuilder.setY();
Allocation input2 = createTyped(RS, typeBuilder.create());
populateSomehow(input2);  // fill in input Allocation with data
ScriptC_example.result_int result2 = script.reduce_addint(input2);  // Method 1
doSomeAdditionalWork(); // might run at same time as reduction
int sum2 = result2.get();

Il metodo 1 ha un argomento Allocation di input per ogni argomento di input nella funzione accumulatrice del kernel. Il runtime RenderScript controlla che tutte le allocazioni di input abbiano le stesse dimensioni e che il tipo Element di ciascuna allocazioni di input corrisponda a quello dell'argomento di input corrispondente del prototipo della funzione accumulatore. Se uno o più di questi controlli hanno esito negativo, RenderScript genera un'eccezione. Il kernel viene eseguito su ogni coordinata in queste dimensioni.

Il Metodo 2 è uguale al Metodo 1, ad eccezione del fatto che il Metodo 2 richiede un argomento aggiuntivo sc che può essere utilizzato per limitare l'esecuzione del kernel a un sottoinsieme delle coordinate.

Method 3 è uguale al Method 1, solo che, invece di utilizzare input di allocazione, prende input di array Java. Questa è una comodità che ti evita di dover scrivere codice per creare esplicitamente un'allocazione e copiare dati da un array Java. Tuttavia, l'utilizzo del metodo 3 anziché del metodo 1 non aumenta le prestazioni del codice. Per ogni array di input, il metodo 3 crea un'allocazione monodimensionale temporanea con il tipo Element appropriato e setAutoPadding(boolean) abilitati e copia l'array nell'allocazione come se tramite il metodo copyFrom() appropriato di Allocation. Quindi chiama il metodo 1, passando le allocazioni temporanee.

NOTA: se la tua applicazione effettua più chiamate del kernel con lo stesso array o con array diversi delle stesse dimensioni e dello stesso tipo di elemento, puoi migliorare le prestazioni creando, compilando e riutilizzando le allocazioni in modo esplicito, anziché utilizzare il metodo 3.

javaFutureType, il tipo restituito dei metodi di riduzione riflessi, è una classe statica riflessa all'interno della classe ScriptC_filename. Rappresenta il risultato futuro dell'esecuzione del kernel di riduzione. Per ottenere il risultato effettivo dell'esecuzione, chiama il metodo get() di quella classe, che restituisce un valore di tipo javaResultType. get() è sincrona.

Kotlin

class ScriptC_filename(rs: RenderScript) : ScriptC(…) {
    object javaFutureType {
        fun get(): javaResultType { … }
    }
}

Java

public class ScriptC_filename extends ScriptC {
  public static class javaFutureType {
    public javaResultType get() { … }
  }
}

javaResultType è determinato da resultType della funzione outconverter. A meno che resultType non sia un tipo senza firma (scalar, vettoriale o array), javaResultType è il tipo Java direttamente corrispondente. Se resultType è un tipo non firmato ed esiste un tipo con firma Java più grande, javaResultType sarà il tipo con firma Java più grande, altrimenti sarà il tipo Java direttamente corrispondente. Ecco alcuni esempi:

  • Se resultType è int, int2 o int[15], javaResultType è int, Int2 o int[]. Tutti i valori di resultType possono essere rappresentati da javaResultType.
  • Se resultType è uint, uint2 o uint[15], javaResultType è long, Long2 o long[]. Tutti i valori di resultType possono essere rappresentati da javaResultType.
  • Se resultType è ulong, ulong2 o ulong[15], javaResultType sarà long, Long2 o long[]. Esistono alcuni valori di resultType che non possono essere rappresentati da javaResultType.

javaFutureType è il tipo di risultato futuro corrispondente al resultType della funzione outconverter.

  • Se resultType non è un tipo di array, javaFutureType è result_resultType.
  • Se resultType è un array di lunghezza Count con membri di tipo memberType, javaFutureType è resultArrayCount_memberType.

Ecco alcuni esempi:

Kotlin

class ScriptC_filename(rs: RenderScript) : ScriptC(…) {

    // for kernels with int result
    object result_int {
        fun get(): Int = …
    }

    // for kernels with int[10] result
    object resultArray10_int {
        fun get(): IntArray = …
    }

    // for kernels with int2 result
    //   note that the Kotlin type name "Int2" is not the same as the script type name "int2"
    object result_int2 {
        fun get(): Int2 = …
    }

    // for kernels with int2[10] result
    //   note that the Kotlin type name "Int2" is not the same as the script type name "int2"
    object resultArray10_int2 {
        fun get(): Array<Int2> = …
    }

    // for kernels with uint result
    //   note that the Kotlin type "long" is a wider signed type than the unsigned script type "uint"
    object result_uint {
        fun get(): Long = …
    }

    // for kernels with uint[10] result
    //   note that the Kotlin type "long" is a wider signed type than the unsigned script type "uint"
    object resultArray10_uint {
        fun get(): LongArray = …
    }

    // for kernels with uint2 result
    //   note that the Kotlin type "Long2" is a wider signed type than the unsigned script type "uint2"
    object result_uint2 {
        fun get(): Long2 = …
    }

    // for kernels with uint2[10] result
    //   note that the Kotlin type "Long2" is a wider signed type than the unsigned script type "uint2"
    object resultArray10_uint2 {
        fun get(): Array<Long2> = …
    }
}

Java

public class ScriptC_filename extends ScriptC {
  // for kernels with int result
  public static class result_int {
    public int get() { … }
  }

  // for kernels with int[10] result
  public static class resultArray10_int {
    public int[] get() { … }
  }

  // for kernels with int2 result
  //   note that the Java type name "Int2" is not the same as the script type name "int2"
  public static class result_int2 {
    public Int2 get() { … }
  }

  // for kernels with int2[10] result
  //   note that the Java type name "Int2" is not the same as the script type name "int2"
  public static class resultArray10_int2 {
    public Int2[] get() { … }
  }

  // for kernels with uint result
  //   note that the Java type "long" is a wider signed type than the unsigned script type "uint"
  public static class result_uint {
    public long get() { … }
  }

  // for kernels with uint[10] result
  //   note that the Java type "long" is a wider signed type than the unsigned script type "uint"
  public static class resultArray10_uint {
    public long[] get() { … }
  }

  // for kernels with uint2 result
  //   note that the Java type "Long2" is a wider signed type than the unsigned script type "uint2"
  public static class result_uint2 {
    public Long2 get() { … }
  }

  // for kernels with uint2[10] result
  //   note that the Java type "Long2" is a wider signed type than the unsigned script type "uint2"
  public static class resultArray10_uint2 {
    public Long2[] get() { … }
  }
}

Se javaResultType è un tipo di oggetto (incluso un tipo di array), ogni chiamata a javaFutureType.get() sulla stessa istanza restituirà lo stesso oggetto.

Se javaResultType non può rappresentare tutti i valori di tipo resultType e un kernel di riduzione produce un valore non rappresentabile, javaFutureType.get() genera un'eccezione.

Metodo 3 e devecSiInXType

devecSiInXType è il tipo Java corrispondente a inXType dell'argomento corrispondente della funzione accumulatore. A meno che inXType non sia un tipo senza firma o un tipo vettoriale, devecSiInXType è il tipo Java direttamente corrispondente. Se inXType è un tipo scalare senza segno, devecSiInXType è il tipo Java direttamente corrispondente al tipo scalare firmato della stessa dimensione. Se inXType è un tipo di vettore firmato, devecSiInXType è il tipo Java direttamente corrispondente al tipo di componente vettoriale. Se inXType è un tipo di vettore senza segno, devecSiInXType è il tipo Java direttamente corrispondente al tipo scalare firmato con le stesse dimensioni del tipo di componente vettoriale. Ecco alcuni esempi:

  • Se inXType è int, devecSiInXType è int.
  • Se inXType è int2, devecSiInXType è int. L'array è una rappresentazione appiattita: ha il doppio degli elementi scalari rispetto all'allocazione con elementi vettori a due componenti. Si tratta della stessa modalità di funzionamento dei metodi copyFrom() di Allocation.
  • Se inXType è uint, deviceSiInXType è int. Un valore firmato nell'array Java viene interpretato come un valore non firmato dello stesso modello di bit nell'allocazione. Si tratta dello stesso funzionamento dei metodi copyFrom() di Allocation.
  • Se inXType è uint2, deviceSiInXType è int. Questa è una combinazione del modo in cui vengono gestiti int2 e uint: l'array è una rappresentazione suddivisa e i valori con segno dell'array Java vengono interpretati come valori dell'elemento non firmato di RenderScript.

Tieni presente che per il metodo 3, i tipi di input vengono gestiti in modo diverso rispetto ai tipi di risultati:

  • L'input vettoriale di uno script è appiattito sul lato Java, mentre il risultato vettoriale di uno script no.
  • L'input non firmato di uno script è rappresentato come un input con segno delle stesse dimensioni sul lato Java, mentre il risultato senza firma di uno script è rappresentato come un tipo con segno ampliato sul lato Java (tranne nel caso di ulong).

Altri kernel di riduzione di esempio

#pragma rs reduce(dotProduct) \
  accumulator(dotProductAccum) combiner(dotProductSum)

// Note: No initializer function -- therefore,
// each accumulator data item is implicitly initialized to 0.0f.

static void dotProductAccum(float *accum, float in1, float in2) {
  *accum += in1*in2;
}

// combiner function
static void dotProductSum(float *accum, const float *val) {
  *accum += *val;
}
// Find a zero Element in a 2D allocation; return (-1, -1) if none
#pragma rs reduce(fz2) \
  initializer(fz2Init) \
  accumulator(fz2Accum) combiner(fz2Combine)

static void fz2Init(int2 *accum) { accum->x = accum->y = -1; }

static void fz2Accum(int2 *accum,
                     int inVal,
                     int x /* special arg */,
                     int y /* special arg */) {
  if (inVal==0) {
    accum->x = x;
    accum->y = y;
  }
}

static void fz2Combine(int2 *accum, const int2 *accum2) {
  if (accum2->x >= 0) *accum = *accum2;
}
// Note that this kernel returns an array to Java
#pragma rs reduce(histogram) \
  accumulator(hsgAccum) combiner(hsgCombine)

#define BUCKETS 256
typedef uint32_t Histogram[BUCKETS];

// Note: No initializer function --
// therefore, each bucket is implicitly initialized to 0.

static void hsgAccum(Histogram *h, uchar in) { ++(*h)[in]; }

static void hsgCombine(Histogram *accum,
                       const Histogram *addend) {
  for (int i = 0; i < BUCKETS; ++i)
    (*accum)[i] += (*addend)[i];
}

// Determines the mode (most frequently occurring value), and returns
// the value and the frequency.
//
// If multiple values have the same highest frequency, returns the lowest
// of those values.
//
// Shares functions with the histogram reduction kernel.
#pragma rs reduce(mode) \
  accumulator(hsgAccum) combiner(hsgCombine) \
  outconverter(modeOutConvert)

static void modeOutConvert(int2 *result, const Histogram *h) {
  uint32_t mode = 0;
  for (int i = 1; i < BUCKETS; ++i)
    if ((*h)[i] > (*h)[mode]) mode = i;
  result->x = mode;
  result->y = (*h)[mode];
}

Altri esempi di codice

Gli esempi BasicRenderScript, RenderScriptIntrinsic e Hello Compute dimostrano ulteriormente l'utilizzo delle API trattate in questa pagina.