इस पेज का अनुवाद Cloud Translation API से किया गया है.

नेटिव MIDI API

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

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

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

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

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

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

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

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

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

AMidi शुरू करना

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

Java MidiManager क्लास की मदद से, MIDI हार्डवेयर के बारे में जानें.
एमआईडीआई हार्डवेयर से जुड़ा Java MidiDevice ऑब्जेक्ट पाएं.
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 साइड को एक या उससे ज़्यादा MidiDevice ऑब्जेक्ट और पोर्ट नंबर को नेटिव लेयर को जेएनआई कॉल से रिकॉर्ड करता है. इसके बाद, नेटिव लेयर को इसके लिए, नीचे दिया गया तरीका अपनाएं:

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

Amidi को बंद करें

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

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

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

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

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

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

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

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

यह स्निपेट Android की एमआईडीआई की सेवा से MidiManager और इस सेवा को खोलता है मिलने वाले पहले डिवाइस के लिए MidiDevice. जब MidiDevice जब कॉलबैक किया जाता है, तो MidiManager.OnDeviceOpenedListener(). इसका onDeviceOpened तरीका लिसनर को कॉल किया जाता है, जो आउटपुट पोर्ट 0 खोलने के लिए startReadingMidi() को कॉल करता है डिवाइस पर. यह एक 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);
    }
  }
}

नेटिव कोड, Java-साइड एमआईडीआई डिवाइस और उसके पोर्ट का अनुवाद AMidi फ़ंक्शन में इस्तेमाल किए गए रेफ़रंस.

यह रहा जेएनआई फ़ंक्शन, जो कॉल करके 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...

}

पोल लूप लागू करना

जिन ऐप्लिकेशन को एमआईडीआई डेटा मिलता है उन्हें आउटपुट पोर्ट को पोल करना होगा और तब जवाब देना होगा, जब 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 या A Audio), इस तरह से ऑडियो जनरेट करने वाले कॉलबैक में 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 में JNI कॉल तय किया गया. फ़ंक्शन के बारे में यहां बताया गया है अगला स्निपेट.

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 ऐप्लिकेशन के मुख्य थ्रेड में किया जा सकता है. हालांकि, परफ़ॉर्मेंस की वजहों (जैसा कि सीक्वेंसर में होता है) से, जनरेशन और एमआईडीआई का ट्रांसमिशन एक अलग थ्रेड में किया जा सकता है.

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

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

यहां 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);
            }
        });
}

यहां 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);
}

अन्य संसाधन

AMidi के लिए रेफ़रंस
GitHub पर पूरा नेटिव एमआईडीआई सैंपल ऐप्लिकेशन देखें.