API MIDI nativa

L'API AMidi è disponibile in Android NDK r20b e versioni successive. Offre agli sviluppatori di app la possibilità di inviare e ricevere dati MIDI con codice C/C++.

Le app MIDI per Android in genere utilizzano l'API midi per comunicare con il servizio MIDI per Android. Le app MIDI dipendono principalmente da MidiManager per rilevare, aprire e chiudere uno o più oggetti MidiDevice e trasmettere dati a e da ciascun dispositivo tramite le porte MIDI di input e output:

Quando utilizzi AMidi, passi l'indirizzo di un MidiDevice al livello di codice nativo con una chiamata JNI. Da qui, AMidi crea un riferimento a un AMidiDevice che ha la maggior parte delle funzionalità di un MidiDevice. Il codice nativo utilizza funzioni AMidi che comunicano direttamente con un AMidiDevice. AMidiDevice si connette direttamente al servizio MIDI:

Utilizzando le chiamate AMidi, puoi integrare strettamente la logica di controllo/audio C/C++ della tua app con la trasmissione MIDI. È necessaria una minore quantità di chiamate JNI o di callback al lato Java dell'app. Ad esempio, un sintetizzatore digitale implementato in codice C potrebbe ricevere eventi chiave direttamente da un AMidiDevice, anziché attendere una chiamata JNI per inviare gli eventi dal lato Java. In alternativa, un processo di composizione algoritmica potrebbe inviare una performance MIDI direttamente a un AMidiDevice senza richiamare il codice Java per trasmettere gli eventi chiave.

Sebbene AMidi migliori la connessione diretta ai dispositivi MIDI, le app devono comunque utilizzare MidiManager per rilevare e aprire gli oggetti MidiDevice. AMidi può proseguire da lì.

A volte potresti dover passare informazioni dal livello dell'interfaccia utente al codice nativo. Ad esempio, quando gli eventi MIDI vengono inviati in risposta ai pulsanti sullo schermo. Per farlo, crea chiamate JNI personalizzate alla logica nativa. Se devi inviare nuovamente i dati per aggiornare l'interfaccia utente, puoi richiamare dal livello nativo come di consueto.

Questo documento mostra come configurare un'app di codice nativo AMidi, fornendo esempi di invio e ricezione di comandi MIDI. Per un esempio completo funzionante, consulta l'app di esempio NativeMidi.

Utilizzare AMidi

Tutte le app che utilizzano AMidi hanno gli stessi passaggi di configurazione e chiusura, indipendentemente dal fatto che inviino o ricevano MIDI o entrambi.

Avvia AMidi

Sul lato Java, l'app deve rilevare un componente hardware MIDI allegato, creare un elemento MidiDevice corrispondente e passarlo al codice nativo.

  1. Scopri l'hardware MIDI con la classe Java MidiManager.
  2. Ottieni un oggetto MidiDevice Java corrispondente all'hardware MIDI.
  3. Passa MidiDevice Java al codice nativo con JNI.

Scopri l'hardware e le porte

Gli oggetti delle porte di input e output non appartengono all'app. Rappresentano le porte sul dispositivo MIDI. Per inviare dati MIDI a un dispositivo, un'app apre un MIDIInputPort e poi vi scrive i dati. Al contrario, per ricevere dati, un'app apre un MIDIOutputPort. Per funzionare correttamente, l'app deve assicurarsi che le porte che apre siano del tipo corretto. La rilevamento dei dispositivi e delle porte viene eseguita lato Java.

Ecco un metodo che rileva ogni dispositivo MIDI e ne esamina le porte. Restituisce un elenco di dispositivi con porte di uscita per la ricezione di dati o un elenco di dispositivi con porte di input per l'invio di dati. Un dispositivo MIDI può avere sia porte di input che porte di output.

Kotlin

private fun getMidiDevices(isOutput: Boolean) : List {
    if (isOutput) {
        return mMidiManager.devices.filter { it.outputPortCount > 0 }
    } else {
        return mMidiManager.devices.filter { it.inputPortCount > 0 }
    }
}

Java

private List getMidiDevices(boolean isOutput){
  ArrayList filteredMidiDevices = new ArrayList<>();

  for (MidiDeviceInfo midiDevice : mMidiManager.getDevices()){
    if (isOutput){
      if (midiDevice.getOutputPortCount() > 0) filteredMidiDevices.add(midiDevice);
    } else {
      if (midiDevice.getInputPortCount() > 0) filteredMidiDevices.add(midiDevice);
    }
  }
  return filteredMidiDevices;
}

Per utilizzare le funzioni AMidi nel codice C/C++, devi includere AMidi/AMidi.h e creare un collegamento alla libreria amidi. Entrambi sono disponibili nel NDK Android.

Il lato Java deve passare uno o più oggetti MidiDevice e numeri di porta al livello nativo tramite una chiamata JNI. Il livello nativo deve quindi eseguire i seguenti passaggi:

  1. Per ogni MidiDevice Java, ottieni un AMidiDevice utilizzando AMidiDevice_fromJava().
  2. Ottieni un AMidiInputPort e/o un AMidiOutputPort dal AMidiDevice con AMidiInputPort_open() e/o AMidiOutputPort_open().
  3. Utilizza le porte ottenute per inviare e/o ricevere dati MIDI.

Interrompi AMidi

L'app Java deve segnalare al livello nativo di rilasciare le risorse quando non utilizza più il dispositivo MIDI. Il motivo potrebbe essere che il dispositivo MIDI è stato scollegato o che l'app sta per uscire.

Per rilasciare risorse MIDI, il codice deve eseguire queste attività:

  1. Interrompi la lettura e/o la scrittura nelle porte MIDI. Se utilizzavi un thread di lettura per eseguire il polling per l'input (vedi Implementare un ciclo di polling di seguito), interrompilo.
  2. Chiudi tutti gli oggetti AMidiInputPort e/o AMidiOutputPort aperti con le funzioni AMidiInputPort_close() e/o AMidiOutputPort_close().
  3. Rilascia AMidiDevice con AMidiDevice_release().

Ricevere dati MIDI

Un esempio tipico di un'app MIDI che riceve MIDI è un "sintetizzatore virtuale" che riceve dati di esecuzione MIDI per controllare la sintesi audio.

I dati MIDI in entrata vengono ricevuti in modo asincrono. Pertanto, è meglio leggere il MIDI in un thread separato che esegue continuamente il polling di una o più porte di uscita MIDI. Potrebbe essere un thread di sottofondo o un thread audio. AMidi non si blocca durante la lettura da una porta ed è quindi sicuro da utilizzare all'interno di un callback audio.

Configurare un MidiDevice e le relative porte di output

Un'app legge i dati MIDI in arrivo dalle porte di uscita di un dispositivo. Il lato Java della tua app deve determinare quale dispositivo e quali porte utilizzare.

Questo snippet crea il MidiManager dal servizio MIDI di Android e apre un MidiDevice per il primo dispositivo trovato. Quando MidiDevice è stato aperto, viene ricevuto un callback in un'istanza di MidiManager.OnDeviceOpenedListener(). Viene chiamato il metodo onDeviceOpened di questo ascoltatore, che a sua volta chiama startReadingMidi() per aprire la porta di uscita 0 sul dispositivo. Si tratta di una funzione JNI definita in AppMidiManager.cpp. Questa funzione è illustrata nello snippet successivo.

Kotlin

//AppMidiManager.kt
class AppMidiManager(context : Context) {
  private external fun startReadingMidi(midiDevice: MidiDevice,
  portNumber: Int)
  val mMidiManager : MidiManager = context.getSystemService(Context.MIDI_SERVICE) as MidiManager

  init {
    val midiDevices = getMidiDevices(true) // method defined in snippet above
    if (midiDevices.isNotEmpty()){
      midiManager.openDevice(midiDevices[0], {
        startReadingMidi(it, 0)
      }, null)
    }
  }
}

Java

//AppMidiManager.java
public class AppMidiManager {
  private native void startReadingMidi(MidiDevice device, int portNumber);
  private MidiManager mMidiManager;
  AppMidiManager(Context context){
    mMidiManager = (MidiManager)
      context.getSystemService(Context.MIDI_SERVICE);
    List midiDevices = getMidiDevices(true); // method defined in snippet above
    if (midiDevices.size() > 0){
      mMidiManager.openDevice(midiDevices.get(0),
        new MidiManager.OnDeviceOpenedListener() {
        @Override
        public void onDeviceOpened(MidiDevice device) {
          startReadingMidi(device, 0);
        }
      },null);
    }
  }
}

Il codice nativo traduce il dispositivo MIDI lato Java e le relative porte in riferimenti utilizzati dalle funzioni AMidi.

Ecco la funzione JNI che crea un AMidiDevice chiamando AMidiDevice_fromJava() e poi chiama AMidiOutputPort_open() per aprire una porta di uscita sul dispositivo:

AppMidiManager.cpp

AMidiDevice midiDevice;
static pthread_t readThread;

static const AMidiDevice* midiDevice = AMIDI_INVALID_HANDLE;
static std::atomic<AMidiOutputPort*> midiOutputPort(AMIDI_INVALID_HANDLE);

void Java_com_nativemidiapp_AppMidiManager_startReadingMidi(
        JNIEnv* env, jobject, jobject deviceObj, jint portNumber) {
    AMidiDevice_fromJava(j_env, deviceObj, &midiDevice);

    AMidiOutputPort* outputPort;
    int32_t result =
      AMidiOutputPort_open(midiDevice, portNumber, &outputPort);
    // check for errors...

    // Start read thread
    int pthread_result =
      pthread_create(&readThread, NULL, readThreadRoutine, NULL);
    // check for errors...

}

Implementare un ciclo di polling

Le app che ricevono dati MIDI devono eseguire il polling della porta di uscita e rispondere quando AMidiOutputPort_receive() restituisce un numero maggiore di zero.

Per le app a bassa larghezza di banda, come un ambito MIDI, puoi eseguire il polling in un thread in background di bassa priorità (con sospensioni appropriate).

Per le app che generano audio e hanno requisiti di prestazioni in tempo reale più rigorosi, puoi eseguire il polling nel callback principale di generazione dell'audio (il callback BufferQueue per OpenSL ES, il callback dei dati AudioStream in AAudio). Poiché AMidiOutputPort_receive() non è bloccante, l'impatto sulle prestazioni è molto ridotto.

La funzione readThreadRoutine() chiamata dalla funzione startReadingMidi() sopra potrebbe avere il seguente aspetto:

void* readThreadRoutine(void * /*context*/) {
    uint8_t inDataBuffer[SIZE_DATABUFFER];
    int32_t numMessages;
    uint32_t opCode;
    uint64_t timestamp;
    reading = true;
    while (reading) {
        AMidiOutputPort* outputPort = midiOutputPort.load();
        numMessages =
              AMidiOutputPort_receive(outputPort, &opCode, inDataBuffer,
                                sizeof(inDataBuffer), &timestamp);
        if (numMessages >= 0) {
            if (opCode == AMIDI_OPCODE_DATA) {
                // Dispatch the MIDI data….
            }
        } else {
            // some error occurred, the negative numMessages is the error code
            int32_t errorCode = numMessages;
        }
  }
}

Un'app che utilizza un'API audio nativa (come OpenSL ES o AAudio) può aggiungere codice di ricezione MIDI al callback di generazione audio come segue:

void bqPlayerCallback(SLAndroidSimpleBufferQueueItf bq, void */*context*/)
{
    uint8_t inDataBuffer[SIZE_DATABUFFER];
    int32_t numMessages;
    uint32_t opCode;
    uint64_t timestamp;

    // Read MIDI Data
    numMessages = AMidiOutputPort_receive(outputPort, &opCode, inDataBuffer,
        sizeof(inDataBuffer), &timestamp);
    if (numMessages >= 0 && opCode == AMIDI_OPCODE_DATA) {
        // Parse and respond to MIDI data
        // ...
    }

    // Generate Audio…
    // ...
}

Il seguente diagramma illustra il flusso di un'app di lettura MIDI:

Invia dati MIDI

Un esempio tipico di app di scrittura MIDI è un controller o un sequencer MIDI.

Configurare un MidiDevice e le relative porte di input

Un'app scrive i dati MIDI in uscita nelle porte di input di un dispositivo MIDI. Il lato Java della tua app deve determinare quale dispositivo MIDI e porte utilizzare.

Il codice di configurazione riportato di seguito è una variante dell'esempio di ricezione riportato sopra. Crea il MidiManager dal servizio MIDI di Android. Quindi apre la primaMidiDevice che trova e chiama startWritingMidi() per aprire la prima porta di input del dispositivo. Questa è una chiamata JNI definita in AppMidiManager.cpp. La funzione è spiegata nel snippet successivo.

Kotlin

//AppMidiManager.kt
class AppMidiManager(context : Context) {
  private external fun startWritingMidi(midiDevice: MidiDevice,
  portNumber: Int)
  val mMidiManager : MidiManager = context.getSystemService(Context.MIDI_SERVICE) as MidiManager

  init {
    val midiDevices = getMidiDevices(false) // method defined in snippet above
    if (midiDevices.isNotEmpty()){
      midiManager.openDevice(midiDevices[0], {
        startWritingMidi(it, 0)
      }, null)
    }
  }
}

Java

//AppMidiManager.java
public class AppMidiManager {
  private native void startWritingMidi(MidiDevice device, int portNumber);
  private MidiManager mMidiManager;

  AppMidiManager(Context context){
    mMidiManager = (MidiManager)
      context.getSystemService(Context.MIDI_SERVICE);
    List midiDevices = getMidiDevices(false); // method defined in snippet above
    if (midiDevices.size() > 0){
      mMidiManager.openDevice(midiDevices.get(0),
        new MidiManager.OnDeviceOpenedListener() {
        @Override
        public void onDeviceOpened(MidiDevice device) {
          startWritingMidi(device, 0);
        }
      },null);
    }
  }
}

Ecco la funzione JNI che crea un AMidiDevice chiamando AMidiDevice_fromJava(), quindi chiama AMidiInputPort_open() per aprire una porta di input sul dispositivo:

AppMidiManager.cpp

void Java_com_nativemidiapp_AppMidiManager_startWritingMidi(
       JNIEnv* env, jobject, jobject midiDeviceObj, jint portNumber) {
   media_status_t status;
   status = AMidiDevice_fromJava(
     env, midiDeviceObj, &sNativeSendDevice);
   AMidiInputPort *inputPort;
   status = AMidiInputPort_open(
     sNativeSendDevice, portNumber, &inputPort);

   // store it in a global
   sMidiInputPort = inputPort;
}

Invia dati MIDI

Poiché la sincronizzazione dei dati MIDI in uscita è ben compresa e controllata dall'app stessa, la trasmissione dei dati può essere eseguita nel thread principale dell'app MIDI. Tuttavia, per motivi di prestazioni (come in un sequencer), la generazione e la trasmissione del MIDI possono essere eseguite in un thread separato.

Le app possono inviare dati MIDI in qualsiasi momento. Tieni presente che AMidi si blocca durante la scrittura dei dati.

Ecco un esempio di metodo JNI che riceve un buffer di comandi MIDI e lo scrive:

void Java_com_nativemidiapp_TBMidiManager_writeMidi(
JNIEnv* env, jobject, jbyteArray data, jint numBytes) {
   jbyte* bufferPtr = env->GetByteArrayElements(data, NULL);
   AMidiInputPort_send(sMidiInputPort, (uint8_t*)bufferPtr, numBytes);
   env->ReleaseByteArrayElements(data, bufferPtr, JNI_ABORT);
}

Il seguente diagramma illustra il flusso di un'app di scrittura MIDI:

Callback

Sebbene non sia strettamente una funzionalità di AMidi, il codice nativo potrebbe dover ritrasmettere i dati al lato Java (ad esempio per aggiornare l'interfaccia utente). Per farlo, devi scrivere codice lato Java e nel livello nativo:

  • Crea un metodo di callback lato Java.
  • Scrivi una funzione JNI che memorizzi le informazioni necessarie per invocare il callback.

Quando è il momento di richiamare, il codice nativo può creare

Ecco il metodo di callback lato Java, onNativeMessageReceive():

Kotlin

//MainActivity.kt
private fun onNativeMessageReceive(message: ByteArray) {
  // Messages are received on some other thread, so switch to the UI thread
  // before attempting to access the UI
  runOnUiThread { showReceivedMessage(message) }
}

Java

//MainActivity.java
private void onNativeMessageReceive(final byte[] message) {
        // Messages are received on some other thread, so switch to the UI thread
        // before attempting to access the UI
        runOnUiThread(new Runnable() {
            public void run() {
                showReceivedMessage(message);
            }
        });
}

Di seguito è riportato il codice C per la funzione JNI che configura un callback per MainActivity.onNativeMessageReceive(). Chiamate MainActivity Java initNative() all'avvio:

MainActivity.cpp

/**
 * Initializes JNI interface stuff, specifically the info needed to call back into the Java
 * layer when MIDI data is received.
 */
JNICALL void Java_com_example_nativemidi_MainActivity_initNative(JNIEnv * env, jobject instance) {
    env->GetJavaVM(&theJvm);

    // Setup the receive data callback (into Java)
    jclass clsMainActivity = env->FindClass("com/example/nativemidi/MainActivity");
    dataCallbackObj = env->NewGlobalRef(instance);
    midDataCallback = env->GetMethodID(clsMainActivity, "onNativeMessageReceive", "([B)V");
}

Quando è il momento di inviare i dati a Java, il codice nativo recupera i puntatori di callback e crea il callback:

AppMidiManager.cpp

// The Data Callback
extern JavaVM* theJvm;              // Need this for allocating data buffer for...
extern jobject dataCallbackObj;     // This is the (Java) object that implements...
extern jmethodID midDataCallback;   // ...this callback routine

static void SendTheReceivedData(uint8_t* data, int numBytes) {
    JNIEnv* env;
    theJvm->AttachCurrentThread(&env, NULL);
    if (env == NULL) {
        LOGE("Error retrieving JNI Env");
    }

    // Allocate the Java array and fill with received data
    jbyteArray ret = env->NewByteArray(numBytes);
    env->SetByteArrayRegion (ret, 0, numBytes, (jbyte*)data);

    // send it to the (Java) callback
    env->CallVoidMethod(dataCallbackObj, midDataCallback, ret);
}

Risorse aggiuntive