דף זה תורגם על ידי Cloud Translation API.

Native MIDI API

ה-API של AMidi זמין ב-Android NDK r20b ואילך. הוא מספק לאפליקציה מפתחים את היכולת לשלוח ולקבל נתוני MIDI באמצעות קוד C/C++.

אפליקציות MIDI ל-Android בדרך כלל משתמשות ב-API‏ midi כדי לתקשר עם שירות ה-MIDI ל-Android. אפליקציות MIDI תלויות בעיקר MidiManager כדי לגלות, לפתוח, וסגירה של שדה אחד או יותר MidiDevice אובייקטים, וגם להעביר נתונים אל כל מכשיר וממנו דרך קלט MIDI ויציאות פלט:

כשמשתמשים ב-AMidi, מעבירים את הכתובת של MidiDevice לשכבת הקוד הילידים באמצעות קריאה ל-JNI. לאחר מכן, AMidi יוצרת הפניה ל-AMidiDevice שיש לו את רוב הפונקציונליות של MidiDevice. הקוד המקורי משתמש בפונקציות AMidi שמתקשרות ישירות עם AMidiDevice. ה-AMidiDevice מתחבר ישירות לשירות MIDI:

באמצעות קריאות AMidi, אפשר לשלב את הלוגיקה של האודיו או הבקרה של האפליקציה ב-C/C++ בצורה הדוקה עם העברת MIDI. יש פחות צורך בשיחות JNI או בהתקשרות חוזרת הצד של Java באפליקציה. לדוגמה, סינתיסייזר דיגיטלי שהוטמע בקוד C יכול לקבל אירועים מרכזיים ישירות מ-AMidiDevice, במקום לחכות ל-JNI לשלוח את האירועים מהצד של Java. לחלופין, תהליך כתיבה אלגוריתמי יכול לשלוח ביצועי MIDI ישירות ל-AMidiDevice בלי להפעיל קריאה חוזרת לצד Java כדי להעביר את אירועי המפתחות.

למרות ש-AMidi משפרת את החיבור הישיר למכשירי MIDI, אפליקציות עדיין צריכות להשתמש בMidiManager כדי לגלות ולפתוח אובייקטים של MidiDevice. AMidi יכול להמשיך משם.

לפעמים צריך להעביר מידע משכבת ממשק המשתמש אל הקוד המקורי. לדוגמה, כשאירועי MIDI נשלחים בתגובה ללחצנים במסך. כדי לעשות זאת, יוצרים קריאות JNI בהתאמה אישית ללוגיקת הקוד המקורי. אם צריך לשלוח נתונים בחזרה כדי לעדכן את ממשק המשתמש, אפשר להתקשר חזרה מהשכבה המקורית כרגיל.

במסמך הזה מוסבר איך להגדיר אפליקציה בקוד יליד של AMidi, עם דוגמאות לשליחה ולקבלה של פקודות MIDI. כדי לקבל דוגמה מלאה, אפשר לעיין NativeMidi אפליקציה לדוגמה.

שימוש ב-AMidi

לכל האפליקציות שמשתמשות ב-AMidi יש אותם שלבי הגדרה ושלבי סגירה, גם אם לשלוח או לקבל MIDI, או את שניהם.

התחלת AMidi

בצד Java, האפליקציה צריכה לזהות חומרת MIDI מחוברת, ליצור MidiDevice תואם ולהעביר אותו לקוד המקורי.

מידע על חומרה של MIDI באמצעות הכיתה MidiManager ב-Java.
מקבלים אובייקט Java MidiDevice שתואם לחומרת ה-MIDI.
מעבירים את MidiDevice של Java לקוד נייטיב באמצעות JNI.

חומרה ויציאות

האובייקטים של יציאת הקלט והפלט לא שייכים לאפליקציה. הם מייצגים יציאות במכשיר ה-midi. כדי לשלוח נתוני MIDI למכשיר, האפליקציה פותחת MIDIInputPort ומזינה בו נתונים. לעומת זאת, כדי לקבל נתונים, ייפתח MIDIOutputPort. כדי לפעול כראוי, האפליקציה צריכה לוודא שהיציאות שהיא פותחת הן מהסוג הנכון. זיהוי המכשירים והיציאות מתבצע בצד Java.

לפניכם שיטה שמאתרת כל מכשיר MIDI ובודקת את הפרטים יציאות. היא מחזירה רשימה של מכשירים עם יציאות פלט לקבלת נתונים, או רשימה של מכשירים עם יציאות לשליחת נתונים. מכשירי MIDI יכולים כוללים גם יציאות של קלט וגם יציאות של פלט.

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;
}

כדי להשתמש בפונקציות AMidi בקוד C/C++ צריך לכלול AMidi/AMidi.h וקישור לספרייה amidi. אפשר למצוא את שניהם ב-Android NDK.

בצד Java צריך להעביר אובייקט MidiDevice אחד או יותר ומספרי יציאות לשכבה המקורית באמצעות קריאה ל-JNI. לאחר מכן, השכבה המקורית צריכה לבצע את השלבים הבאים:

לכל MidiDevice של Java צריך לקבל AMidiDevice באמצעות AMidiDevice_fromJava().
מקבלים AMidiInputPort ו/או AMidiOutputPort מה-AMidiDevice באמצעות AMidiInputPort_open() ו/או AMidiOutputPort_open().
יש להשתמש ביציאות שהתקבלו כדי לשלוח או לקבל נתוני MIDI.

הפסקת AMidi

אפליקציית Java צריכה לאותת לשכבת הנייטיב כדי לשחרר משאבים כל עוד היא לא במכשיר ה-MIDI. יכול להיות שהסיבה לכך היא שהתקן ה-MIDI התנתק או שהאפליקציה יוצאת.

כדי לשחרר משאבי MIDI, הקוד צריך לבצע את המשימות הבאות:

הפסקת הקריאה ו/או הכתיבה ביציאות MIDI. אם השתמשתם בקריאה שרשור לסקר הקלט (ראו הטמעה של לולאת סקרים בהמשך), לסיים את השרשור.
סוגרים את כל האובייקטים הפתוחים מסוג AMidiInputPort ו/או AMidiOutputPort באמצעות הפונקציות AMidiInputPort_close() ו/או AMidiOutputPort_close().
משחררים את AMidiDevice באמצעות AMidiDevice_release().

קבלת נתוני MIDI

דוגמה אופיינית לאפליקציית MIDI שמקבלת MIDI היא 'סינתיסייזר וירטואלי'. שמקבל נתונים על ביצועים של MIDI כדי לשלוט בסינתזת האודיו.

נתוני MIDI נכנסים מתקבלים באופן אסינכרוני. לכן מומלץ לקרוא MIDI בשרשור נפרד שמבצע סקרים רצופיים ביציאה אחת או יותר של MIDI. הזה הוא יכול להיות שרשור ברקע או שרשור אודיו. אמידי לא חוסם את האפשרות לקרוא מיציאה, ולכן הוא בטוח לשימוש מבפנים התקשרות חזרה באודיו.

הגדרת MidiDevice ויציאות הפלט שלו

אפליקציה קוראת נתוני MIDI נכנסים משקעי הפלט של המכשיר. הצד של Java של האפליקציה חייבת לקבוע באיזה מכשיר ובאילו יציאות להשתמש.

קטע הקוד הזה יוצר את MidiManager משירות ה-MIDI של Android ופותח MidiDevice למכשיר הראשון שהוא מוצא. כשה-MidiDevice נפתח, מתקבלת קריאה חוזרת למופע של MidiManager.OnDeviceOpenedListener(). מתבצעת קריאה ל-method onDeviceOpened של מאזין זה, שמפעיל קריאה ל-startReadingMidi() כדי לפתוח את יציאת הפלט 0 במכשיר. זוהי פונקציית JNI שמוגדרת ב-AppMidiManager.cpp. הפונקציה הזו מוסברת בקטע הקוד הבא.

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);
    }
  }
}

הקוד המקורי מתרגם את מכשיר ה-MIDI בצד Java ואת היציאות שלו הפניות שמשמשות את פונקציות AMidi.

זוהי פונקציית JNI שיוצרת AMidiDevice באמצעות הפקודה AMidiDevice_fromJava(), ולאחר מכן התקשרות למספר AMidiOutputPort_open() כדי לפתוח יציאת פלט במכשיר:

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...

}

הטמעת לולאת סקרים

אפליקציות שמקבלות נתונים של MIDI חייבות לדגום את יציאת הפלט ולהגיב כאשר הפונקציה AMidiOutputPort_receive() מחזירה מספר גדול מאפס.

באפליקציות עם רוחב פס נמוך, כמו היקף של MIDI, אפשר לבצע סקרים בעדיפות נמוכה שרשור ברקע (עם שינה מתאימה).

באפליקציות שיוצרות אודיו ויש להן דרישות ביצועים מחמירות יותר בזמן אמת, אפשר לבצע סקירה חוזרת (poll) ב-callback הראשי ליצירת אודיו (ה-callback‏ BufferQueue ל-OpenSL ES, ה-callback לנתוני AudioStream ב-AAudio). מכיוון שאין חסימה של AMidiOutputPort_receive(), יש מעט מאוד על הביצועים.

הפונקציה readThreadRoutine() שנקראת מהפונקציה startReadingMidi() שלמעלה עשויה להיראות כך:

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;
        }
  }
}

אפליקציה שמשתמשת ב-API אודיו מקומי (כמו OpenSL ES או AAudio) יכולה להוסיף קוד לקבלת MIDI ל-callback ליצירת אודיו באופן הבא:

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…
    // ...
}

התרשים הבא מדגים את התהליך של אפליקציית קריאת MIDI:

שליחת נתוני MIDI

דוגמה טיפוסית לאפליקציה לכתיבה ב-MIDI היא בקר MIDI או סנקטור MIDI.

הגדרת MidiDevice ויציאות הקלט שלו

אפליקציה כותבת נתונים יוצאים של MIDI ביציאות הקלט של מכשירי MIDI. הצד של Java של האפליקציה שלך צריך לקבוע באילו מכשירי MIDI ויציאות להשתמש.

קוד ההגדרה הבא הוא וריאנט של הדוגמה לצד המקבל שלמעלה. הפעולה הזו יוצרת את MidiManager משירות ה-MIDI של Android. לאחר מכן, המערכת פותחת את MidiDevice הראשון שהיא מוצאת ומפעילה את startWritingMidi() כדי לפתוח את יציאת הקלט הראשונה במכשיר. זהו קריאת JNI הוגדרה ב-AppMidiManager.cpp. הפונקציה מוסברת בקטע הקוד הבא.

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);
    }
  }
}

זוהי פונקציית JNI שיוצרת AMidiDevice באמצעות הפקודה AMidiDevice_fromJava(), ולאחר מכן מתקשרת למספר AMidiInputPort_open() כדי לפתוח יציאת קלט במכשיר:

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;
}

שליחת נתוני MIDI

מכיוון שהאפליקציה עצמה מבינה היטב את התזמון של נתוני ה-MIDI היוצאים ושולטת בהם, העברת הנתונים יכולה להתבצע בשרשור הראשי של אפליקציית ה-MIDI. עם זאת, מסיבות של ביצועים (כמו בסכינר) אפשר ליצור ולשלוח MIDI בשרשור נפרד.

אפליקציות יכולות לשלוח נתוני MIDI בכל שלב. שימו לב ש-AMidi חוסם כשכותבים נתונים.

זוהי דוגמה לשיטת JNI שמקבלת מאגר של פקודות MIDI ומפיקה אותו:

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);
}

בתרשים הבא ממחישה את התהליך באפליקציה לכתיבה באמצעות MIDI:

קריאות חזרה

אמנם זו לא תכונה של AMidi, אבל יכול להיות שהקוד המקורי יצטרך להעביר נתונים בחזרה לצד Java (למשל, כדי לעדכן את ממשק המשתמש). כדי לעשות את זה, צריך לכתוב קוד בצד Java ובשכבת ה-Native:

יוצרים שיטה לקריאה חוזרת בצד Java.
כותבים פונקציית JNI שמאחסנת את המידע שנדרש להפעלת הקריאה החוזרת.

כשמגיע הזמן לקרוא חזרה, קוד ה-Native שלך יכול ליצור

זוהי שיטת הקריאה החוזרת בצד 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);
            }
        });
}

זהו קוד ה-C של פונקציית ה-JNI שמגדירה את הקריאה החוזרת ל-MainActivity.onNativeMessageReceive(). קריאות Java MainActivity initNative() בזמן ההפעלה:

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");
}

כשמגיע הזמן לשלוח נתונים חזרה ל-Java, הקוד המקורי מאחזר את הקריאה החוזרת (callback) ויוצר את הקריאה החוזרת (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);
}

Native MIDI API

שימוש ב-AMidi

התחלת AMidi

חומרה ויציאות

Kotlin

Java

הפסקת AMidi

קבלת נתוני MIDI

הגדרת MidiDevice ויציאות הפלט שלו

Kotlin

Java

הטמעת לולאת סקרים

שליחת נתוני MIDI

הגדרת MidiDevice ויציאות הקלט שלו

Kotlin

Java

שליחת נתוני MIDI

קריאות חזרה

Kotlin

Java

מקורות מידע נוספים