नेटिव MIDI API

AMidi एपीआई, Android एनडीके (NDK) r20b और उसके बाद के वर्शन में उपलब्ध है. इससे ऐप्लिकेशन डेवलपर, C/C++ कोड की मदद से MIDI डेटा भेज और पा सकते हैं.

Android एमआईडीआई ऐप्लिकेशन, आम तौर पर Android एमआईडीआई सेवा के साथ बातचीत करने के लिए, midi एपीआई का इस्तेमाल करते हैं. एमआईडीआई ऐप्लिकेशन, एक या उससे ज़्यादा MidiDevice ऑब्जेक्ट को खोजने, खोलने, और बंद करने के लिए मुख्य रूप से MidiManager पर निर्भर करते हैं. साथ ही, ये डिवाइस के एमआईडीआई इनपुट और आउटपुट पोर्ट के ज़रिए, हर डिवाइस से डेटा भेजते और पाते हैं:

AMidi का इस्तेमाल करने पर, JNI कॉल की मदद से किसी MidiDevice का पता, नेटिव कोड लेयर को भेजा जाता है. इसके बाद, AMidi AMidiDevice का रेफ़रंस बनाता है, जिसमें MidiDevice की ज़्यादातर सुविधाएं होती हैं. आपका नेटिव कोड, AMidi फ़ंक्शन का इस्तेमाल करता है, जो सीधे AMidiDevice से संपर्क करता है. AMidiDevice सीधे MIDI सेवा से कनेक्ट होता है:

AMidi कॉल का इस्तेमाल करके, अपने ऐप्लिकेशन के C/C++ ऑडियो/कंट्रोल लॉजिक को एमआईडीआई ट्रांसमिशन के साथ बारीकी से इंटिग्रेट किया जा सकता है. आपके ऐप्लिकेशन के Java साइड के लिए, JNI कॉल या कॉलबैक की ज़रूरत कम होती है. उदाहरण के लिए, C कोड में लागू किए गए डिजिटल सिंथेसाइज़र को, Java साइड से इवेंट भेजने के लिए JNI कॉल का इंतज़ार करने के बजाय, सीधे AMidiDevice से मुख्य इवेंट मिल सकते हैं. इसके अलावा, एल्गोरिदम के हिसाब से संगीत बनाने की प्रोसेस, मुख्य इवेंट भेजने के लिए Java साइड को कॉल किए बिना, सीधे AMidiDevice पर MIDI परफ़ॉर्मेंस भेज सकती है.

AMidi, एमआईडीआई डिवाइसों से सीधे कनेक्ट होने की सुविधा को बेहतर बनाता है. हालांकि, ऐप्लिकेशन को अब भी MidiDevice ऑब्जेक्ट खोजने और खोलने के लिए, MidiManager का इस्तेमाल करना होगा. AMidi इसे वहां से आगे बढ़ा सकता है.

कभी-कभी, आपको यूज़र इंटरफ़ेस (यूआई) लेयर से नेटिव कोड में जानकारी भेजनी पड़ सकती है. उदाहरण के लिए, जब स्क्रीन पर मौजूद बटन के जवाब में MIDI इवेंट भेजे जाते हैं. इसके लिए, अपने नेटिव लॉजिक के लिए कस्टम JNI कॉल बनाएं. अगर आपको यूज़र इंटरफ़ेस (यूआई) को अपडेट करने के लिए, डेटा वापस भेजना है, तो नेटिव लेयर से हमेशा की तरह कॉल बैक किया जा सकता है.

इस दस्तावेज़ में, AMidi नेटिव कोड ऐप्लिकेशन को सेट अप करने का तरीका बताया गया है. साथ ही, MIDI निर्देश भेजने और पाने, दोनों के उदाहरण दिए गए हैं. काम करने वाले उदाहरण के लिए, NativeMidi सैंपल ऐप्लिकेशन देखें.

AMidi का इस्तेमाल करना

AMidi का इस्तेमाल करने वाले सभी ऐप्लिकेशन के सेटअप और बंद करने का तरीका एक जैसा होता है. भले ही, वे MIDI भेजते हों, पाते हों या दोनों करते हों.

AMidi शुरू करना

Java साइड पर, ऐप्लिकेशन को MIDI हार्डवेयर से जुड़े डिवाइस का पता लगाना होगा, उससे जुड़ा MidiDevice बनाना होगा, और उसे नेटिव कोड को पास करना होगा.

  1. Java MidiManager क्लास की मदद से, MIDI हार्डवेयर के बारे में जानें.
  2. एमआईडीआई हार्डवेयर से जुड़ा Java MidiDevice ऑब्जेक्ट पाएं.
  3. JNI की मदद से, Java MidiDevice को नेटिव कोड में पास करें.

हार्डवेयर और पोर्ट के बारे में जानकारी

इनपुट और आउटपुट पोर्ट ऑब्जेक्ट, ऐप्लिकेशन से जुड़े नहीं होते. ये मीडी डिवाइस पर मौजूद पोर्ट दिखाते हैं. किसी डिवाइस पर MIDI डेटा भेजने के लिए, ऐप्लिकेशन एक MIDIInputPort खोलता है और फिर उसमें डेटा लिखता है. इसके उलट, डेटा पाने के लिए कोई ऐप्लिकेशन एक MIDIOutputPort खोलता है. ठीक से काम करने के लिए, ऐप्लिकेशन को यह पक्का करना होगा कि वह जो पोर्ट खोलता है वे सही टाइप के हों. डिवाइस और पोर्ट की खोज, Java साइड पर की जाती है.

यहां एक ऐसा तरीका बताया गया है जिससे हर 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;
}

अपने C/C++ कोड में AMidi फ़ंक्शन का इस्तेमाल करने के लिए, आपको AMidi/AMidi.h को शामिल करना होगा और amidi लाइब्रेरी से लिंक करना होगा. ये दोनों Android NDK में मिल सकते हैं.

Java साइड को JNI कॉल के ज़रिए, नेटिव लेयर को एक या एक से ज़्यादा MidiDevice ऑब्जेक्ट और पोर्ट नंबर पास करने चाहिए. इसके बाद, नेटिव लेयर को ये काम करने चाहिए:

  1. हर Java MidiDevice के लिए, AMidiDevice_fromJava() का इस्तेमाल करके AMidiDevice पाएं.
  2. AMidiInputPort_open() और/या AMidiOutputPort_open() की मदद से, AMidiDevice से AMidiInputPort और/या AMidiOutputPort पाएं.
  3. एमआईडीआई डेटा भेजने और/या पाने के लिए, मिले पोर्ट का इस्तेमाल करें.

AMidi को बंद करना

जब Java ऐप्लिकेशन एमआईडीआई डिवाइस का इस्तेमाल करना बंद कर दे, तो उसे नेटिव लेयर को संसाधनों को रिलीज़ करने का सिग्नल देना चाहिए. ऐसा इसलिए हो सकता है, क्योंकि एमआईडीआई डिवाइस डिसकनेक्ट हो गया था या ऐप्लिकेशन बंद हो रहा है.

एमआईडीआई संसाधनों को रिलीज़ करने के लिए, आपके कोड को ये काम करने चाहिए:

  1. एमआईडीआई पोर्ट को पढ़ना और/या उनमें डेटा डालना बंद करें. अगर इनपुट के लिए पोल करने के लिए, रीडिंग थ्रेड का इस्तेमाल किया जा रहा था, तो थ्रेड को बंद करें. इसके लिए, नीचे पोल करने वाला लूप लागू करना लेख पढ़ें.
  2. AMidiInputPort_close() और/या AMidiOutputPort_close() फ़ंक्शन की मदद से, खुले हुए सभी AMidiInputPort और/या AMidiOutputPort ऑब्जेक्ट बंद करें.
  3. AMidiDevice को AMidiDevice_release() से रिलीज़ करें.

एमआईडीआई डेटा पाना

एमआईडीआई ऐप्लिकेशन का एक सामान्य उदाहरण "वर्चुअल सिंथेसाइज़र" है. यह ऑडियो सिंथेसिस को कंट्रोल करने के लिए, एमआईडीआई की परफ़ॉर्मेंस का डेटा पाता है.

इनकमिंग MIDI डेटा, असिंक्रोनस तरीके से मिलता है. इसलिए, एमआईडीआई को एक अलग थ्रेड में पढ़ना सबसे अच्छा होता है, जो लगातार एक या एमआईडीआई आउटपुट पोर्ट को पोल करता है. यह बैकग्राउंड थ्रेड या ऑडियो थ्रेड हो सकता है. AMidi, किसी पोर्ट से पढ़ते समय ब्लॉक नहीं होता. इसलिए, ऑडियो कॉलबैक में इसका इस्तेमाल करना सुरक्षित है.

MidiDevice और उसके आउटपुट पोर्ट सेट अप करना

ऐप्लिकेशन, डिवाइस के आउटपुट पोर्ट से आने वाला एमआईडीआई डेटा पढ़ता है. आपके ऐप्लिकेशन के Java साइड को यह तय करना होगा कि किस डिवाइस और पोर्ट का इस्तेमाल करना है.

यह स्निपेट, Android की MIDI सेवा से MidiManager बनाता है और सबसे पहले मिले डिवाइस के लिए MidiDevice खोलता है. MidiDevice खोलने पर, MidiManager.OnDeviceOpenedListener() के किसी इंस्टेंस पर कॉलबैक मिलता है. इस लिसनर के onDeviceOpened तरीके को कॉल किया जाता है, जो डिवाइस पर आउटपुट पोर्ट 0 खोलने के लिए startReadingMidi() को कॉल करता है. यह AppMidiManager.cpp में तय किया गया JNI फ़ंक्शन है. इस फ़ंक्शन के बारे में अगले स्निपेट में बताया गया है.

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

नेटिव कोड, Java-side MIDI डिवाइस और उसके पोर्ट को AMidi फ़ंक्शन के इस्तेमाल किए जाने वाले रेफ़रंस में बदल देता है.

यहां JNI फ़ंक्शन दिया गया है, जो AMidiDevice_fromJava() को कॉल करके AMidiDevice बनाता है. इसके बाद, डिवाइस पर आउटपुट पोर्ट खोलने के लिए 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 स्कोप के लिए, कम प्राथमिकता वाली बैकग्राउंड थ्रेड में पोल किया जा सकता है. इसके लिए, ज़रूरत के हिसाब से स्लीप का इस्तेमाल किया जा सकता है.

ऑडियो जनरेट करने वाले और रीयल टाइम में परफ़ॉर्मेंस से जुड़ी ज़्यादा सख्त ज़रूरी शर्तें रखने वाले ऐप्लिकेशन के लिए, ऑडियो जनरेशन के मुख्य कॉलबैक (OpenSL ES के लिए BufferQueue कॉलबैक, AAudio में AudioStream डेटा कॉलबैक) में पोल किया जा सकता है. AMidiOutputPort_receive(), ब्लॉकिंग नहीं करता है. इसलिए, पेज की परफ़ॉर्मेंस पर इसका बहुत कम असर पड़ता है.

ऊपर दिए गए startReadingMidi() फ़ंक्शन से कॉल किया गया readThreadRoutine() फ़ंक्शन ऐसा दिख सकता है:

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

OpenSL ES या AAudio जैसे नेटिव ऑडियो एपीआई का इस्तेमाल करने वाला ऐप्लिकेशन, ऑडियो जनरेशन कॉलबैक में MIDI रीसीव कोड जोड़ सकता है. ऐसा करने के लिए, यह तरीका अपनाएं:

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 रीडिंग ऐप्लिकेशन के फ़्लो को दिखाया गया है:

एमआईडीआई डेटा भेजना

एमआईडीआई लिखने वाले ऐप्लिकेशन का एक सामान्य उदाहरण, एमआईडीआई कंट्रोलर या सीक्वेंसर है.

MidiDevice और उसके इनपुट पोर्ट सेट अप करना

कोई ऐप्लिकेशन, एमआईडीआई डिवाइस के इनपुट पोर्ट में आउटगोइंग एमआईडीआई डेटा लिखता है. आपके ऐप्लिकेशन के Java साइड को यह तय करना होगा कि किस एमआईडीआई डिवाइस और पोर्ट का इस्तेमाल करना है.

नीचे दिया गया सेटअप कोड, ऊपर दिए गए उदाहरण से अलग है. यह Android की MIDI सेवा से MidiManager बनाता है. इसके बाद, यह डिवाइस पर पहला इनपुट पोर्ट खोलने के लिए, startWritingMidi() को कॉल करता है और MidiDevice को खोलता है. यह AppMidiManager.cpp में बताया गया JDK कॉल है. अगले स्निपेट में, फ़ंक्शन के बारे में बताया गया है.

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_fromJava() को कॉल करके AMidiDevice बनाता है. इसके बाद, डिवाइस पर इनपुट पोर्ट खोलने के लिए 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 को जनरेट और ट्रांसमिट करने के लिए, एक अलग थ्रेड का इस्तेमाल किया जा सकता है.

ऐप्लिकेशन, ज़रूरत पड़ने पर एमआईडीआई डेटा भेज सकते हैं. ध्यान दें कि डेटा लिखते समय 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 साइड और नेटिव लेयर में कोड लिखना होगा:

  • Java साइड पर कॉलबैक तरीका बनाएं.
  • एक JNI फ़ंक्शन लिखें, जो कॉलबैक को ट्रिगर करने के लिए ज़रूरी जानकारी सेव करता है.

कॉलबैक का समय आने पर, आपका नेटिव कोड

Java-side कॉलबैक का तरीका, 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);
            }
        });
}

यहां JNI फ़ंक्शन के लिए C कोड दिया गया है, जो 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 में भेजने का समय आता है, तो नेटिव कोड कॉलबैक पॉइंटर को वापस लाता है और कॉलबैक बनाता है:

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

अन्य संसाधन