Implement Custom Android SDK Callback Events With Delphi XE5 Firemonkey On Android

Developer Cristian Peta has a post up on the Embarcadero forum with some sample code showing how he implemented a bar code reader callback in the Android SDK for Delphi XE5 Firemonkey. Basically how Firemonkey applications work on Android is there is an Android SDK shim which is written in Java (and contained within the classes.dex file). This shim calls the actual Android NDK based Firemonkey application which is a .SO file (where your code is located). What Cristian Peta’s code does is implement some Java code and custom events in that Android SDK shim and those events make function calls into the Firemonkey application. This allowed him to implement a Honeywell SDK in Java and use it from Firemonkey. Brian Long pioneered this method in his CodeRage 8 sessions on the topic. Take a look at the BarCode and Menu demos in the AccessingTheAndroidAPI.7z download for complete examples of doing this. I am including Cristian Peta’s full post below with his implementation:

“My solution was to write some Java code then insert this code into classes.dex
Then I use this Java code from Delphi trough Java generic import and JNI.
You can read Brian Long blog about classes.dex

My starting point from Honeywell SDK examples was DecodeSampleActivity. There is ScanDemoMainActivity.java that I modified and merged into classes.dex
I extended com.embarcadero.firemonkey.FMXNativeActivity but I think now it should be enough to extend Activity. When you extend Activity you do not need to decompile classes.dex

The main Delphi part is here:”

[crayon-5ce46bac1c9fd940799973   jive-pre ]<code class="jive-code jive-java"><span style="color: darkgreen;">//This is called from the Java activity's onBarCodeComplete() method</span>
procedure onBarCodeCompleteNative(PEnv: PJNIEnv; This: JNIObject; BarCode: JNIString); cdecl;
begin
  Log.d(<span style="color: navy;">'+onBarCodeCompleteNative'</span>);
  Log.d(<span style="color: navy;">'Thread (Main: %.8x, Current: %.8x, Java:%.8d (%2:.8x), POSIX:%.8x)'</span>,
    [MainThreadID, TThread.CurrentThread.ThreadID, TJThread.JavaClass.currentThread.getId, GetCurrentThreadID]);
  ARNBarCode := JNIStringToString(PEnv, BarCode);
  Log.d(<span style="color: navy;">'Calling Synchronize'</span>);
  TThread.Synchronize(nil, onBarCodeCompleteThreadSwitcher);
  Log.d(<span style="color: navy;">'Synchronize is over'</span>);
  Log.d(<span style="color: navy;">'-onBarCodeCompleteNative'</span>);
end;
 
<span style="color: darkgreen;">//This is called from the Java activity's onBarCodeComplete() method</span>
procedure onBarCodeFailNative(PEnv: PJNIEnv; This: JNIObject); cdecl;
begin
  Log.d(<span style="color: navy;">'+onBarCodeFailNative'</span>);
  Log.d(<span style="color: navy;">'Thread (Main: %.8x, Current: %.8x, Java:%.8d (%2:.8x), POSIX:%.8x)'</span>,
    [MainThreadID, TThread.CurrentThread.ThreadID, TJThread.JavaClass.currentThread.getId, GetCurrentThreadID]);
  Log.d(<span style="color: navy;">'Calling Synchronize'</span>);
  TThread.Synchronize(nil, onBarCodeFailThreadSwitcher);
  Log.d(<span style="color: navy;">'Synchronize is over'</span>);
  Log.d(<span style="color: navy;">'-onBarCodeFailNative'</span>);
end;
 
procedure TFormMain.RegisterDelphiNativeMethods;
var
  PEnv: PJNIEnv;
  ActivityClass: JNIClass;
  NativeMethods: array[0..1] of JNINativeMethod;
begin
  Log.d(<span style="color: navy;">'Starting the registration JNI stuff'</span>);
 
  PEnv := TJNIResolver.GetJNIEnv;
 
  Log.d(<span style="color: navy;">'Registering interop methods'</span>);
 
  NativeMethods[0].Name := <span style="color: navy;">'onBarCodeCompleteNative'</span>;
  NativeMethods[0].Signature := <span style="color: navy;">'(Ljava/lang/String;)V'</span>;
  NativeMethods[0].FnPtr := @onBarCodeCompleteNative;
 
  NativeMethods[1].Name := <span style="color: navy;">'onBarCodeFailNative'</span>;
  NativeMethods[1].Signature := <span style="color: navy;">'()V'</span>;
  NativeMethods[1].FnPtr := @onBarCodeFailNative;
 
  ActivityClass := PEnv^.GetObjectClass(
    PEnv, PANativeActivity(System.DelphiActivity).clazz);
 
  PEnv^.RegisterNatives(PEnv, ActivityClass, @NativeMethods[0], 2);
 
  PEnv^.DeleteLocalRef(PEnv, ActivityClass);
end;

[crayon-5ce46bac1c9fd940799973 jive-pre ]<code class="jive-code jive-java">//This is called from the Java activity's onBarCodeComplete() method

procedure onBarCodeCompleteNative(PEnv: PJNIEnv; This: JNIObject; BarCode: JNIString); cdecl;

begin

Log.d('+onBarCodeCompleteNative');

Log.d('Thread (Main: %.8x, Current: %.8x, Java:%.8d (%2:.8x), POSIX:%.8x)',

[MainThreadID, TThread.CurrentThread.ThreadID, TJThread.JavaClass.currentThread.getId, GetCurrentThreadID]);

ARNBarCode := JNIStringToString(PEnv, BarCode);

Log.d('Calling Synchronize');

TThread.Synchronize(nil, onBarCodeCompleteThreadSwitcher);

Log.d('Synchronize is over');

Log.d('-onBarCodeCompleteNative');

end;

//This is called from the Java activity's onBarCodeComplete() method

procedure onBarCodeFailNative(PEnv: PJNIEnv; This: JNIObject); cdecl;

begin

Log.d('+onBarCodeFailNative');

Log.d('Thread (Main: %.8x, Current: %.8x, Java:%.8d (%2:.8x), POSIX:%.8x)',

[MainThreadID, TThread.CurrentThread.ThreadID, TJThread.JavaClass.currentThread.getId, GetCurrentThreadID]);

Log.d('Calling Synchronize');

TThread.Synchronize(nil, onBarCodeFailThreadSwitcher);

Log.d('Synchronize is over');

Log.d('-onBarCodeFailNative');

end;

procedure TFormMain.RegisterDelphiNativeMethods;

var

PEnv: PJNIEnv;

ActivityClass: JNIClass;

NativeMethods: array[0..1] of JNINativeMethod;

begin

Log.d('Starting the registration JNI stuff');

PEnv := TJNIResolver.GetJNIEnv;

Log.d('Registering interop methods');

NativeMethods[0].Name := 'onBarCodeCompleteNative';

NativeMethods[0].Signature := '(Ljava/lang/String;)V';

NativeMethods[0].FnPtr := @onBarCodeCompleteNative;

NativeMethods[1].Name := 'onBarCodeFailNative';

NativeMethods[1].Signature := '()V';

NativeMethods[1].FnPtr := @onBarCodeFailNative;

ActivityClass := PEnv^.GetObjectClass(

PEnv, PANativeActivity(System.DelphiActivity).clazz);

PEnv^.RegisterNatives(PEnv, ActivityClass, @NativeMethods[0], 2);

PEnv^.DeleteLocalRef(PEnv, ActivityClass);

end;

[/crayon]

“And Java code:”

[crayon-5ce46bac1ca06168569238   jive-pre ]<code class="jive-code jive-java"><span style="color: navy;"><b>package</b></span> com.winarhi.nativeactivitysubclass;
 
<span style="color: navy;"><b>import</b></span> android.os.Build;
<span style="color: navy;"><b>import</b></span> android.os.Handler;
<span style="color: navy;"><b>import</b></span> android.os.Message;
<span style="color: navy;"><b>import</b></span> android.os.RemoteException;
 
<span style="color: navy;"><b>import</b></span> java.io.IOException;
 
<span style="color: navy;"><b>import</b></span> com.honeywell.decodemanager.DecodeManager;
<span style="color: navy;"><b>import</b></span> com.honeywell.decodemanager.barcode.DecodeResult;
 
<span style="color: navy;"><b>public</b></span> <span style="color: navy;"><b>class</b></span> NativeActivitySubclass <span style="color: navy;"><b>extends</b></span> com.embarcadero.firemonkey.FMXNativeActivity<span style="color: navy;">{</span>
 
    <span style="color: darkgreen;">//private final int ID_SCANSETTING = 0x12;</span>
    <span style="color: darkgreen;">//private final int ID_CLEAR_SCREEN = 0x13;</span>
 
    <span style="color: navy;"><b>private</b></span> DecodeManager mDecodeManager = <span style="color: navy;"><b>null</b></span>;
    <span style="color: navy;"><b>public</b></span> String strDecodeResult = <span style="color: red;">""</span>;
    <span style="color: navy;"><b>private</b></span> <span style="color: navy;"><b>final</b></span> <span style="color: navy;"><b>int</b></span> WA_SCANTIMEOUT = 5000;
    <span style="color: navy;"><b>long</b></span> WA_mScanAccount = 0;
 
    <span style="color: navy;"><b>private</b></span> <span style="color: navy;"><b>void</b></span> WA_CreateDecodeManager() <span style="color: navy;">{</span>
        <span style="color: navy;"><b>if</b></span> (mDecodeManager == <span style="color: navy;"><b>null</b></span>)
            mDecodeManager = <span style="color: navy;"><b>new</b></span> DecodeManager(this, ScanResultHandler);
    <span style="color: navy;">}</span>
 
    <span style="color: navy;"><b>private</b></span> <span style="color: navy;"><b>void</b></span> WA_DestroyDecodeManager() <span style="color: navy;">{</span>
        <span style="color: navy;"><b>if</b></span> (mDecodeManager != <span style="color: navy;"><b>null</b></span>) <span style="color: navy;">{</span>
            <span style="color: navy;"><b>try</b></span> <span style="color: navy;">{</span>
                mDecodeManager.release();
                mDecodeManager = <span style="color: navy;"><b>null</b></span>;
            <span style="color: navy;">}</span> <span style="color: navy;"><b>catch</b></span> (IOException e) <span style="color: navy;">{</span>
                <span style="color: darkgreen;">// TODO Auto-generated catch block</span>
                e.printStackTrace();
            <span style="color: navy;">}</span>
        <span style="color: navy;">}</span>
    <span style="color: navy;">}</span>
 
    <span style="color: navy;"><b>private</b></span> <span style="color: navy;"><b>void</b></span> WA_DoScan() <span style="color: navy;"><b>throws</b></span> Exception <span style="color: navy;">{</span>
        <span style="color: navy;"><b>if</b></span> (mDecodeManager != <span style="color: navy;"><b>null</b></span>) <span style="color: navy;">{</span>
            <span style="color: navy;"><b>try</b></span> <span style="color: navy;">{</span>
                strDecodeResult = <span style="color: red;">""</span>;
                mDecodeManager.doDecode(WA_SCANTIMEOUT);
            <span style="color: navy;">}</span> <span style="color: navy;"><b>catch</b></span> (RemoteException e) <span style="color: navy;">{</span>
                <span style="color: darkgreen;">// TODO Auto-generated catch block</span>
                e.printStackTrace();
            <span style="color: navy;">}</span>
        <span style="color: navy;">}</span>
    <span style="color: navy;">}</span>
 
    <span style="color: navy;"><b>public</b></span> <span style="color: navy;"><b>native</b></span> <span style="color: navy;"><b>void</b></span> onBarCodeCompleteNative(String BarCode);
    <span style="color: navy;"><b>public</b></span> <span style="color: navy;"><b>native</b></span> <span style="color: navy;"><b>void</b></span> onBarCodeFailNative();
 
    <span style="color: navy;"><b>private</b></span> Handler ScanResultHandler = <span style="color: navy;"><b>new</b></span> Handler() <span style="color: navy;">{</span>
        <span style="color: navy;"><b>public</b></span> <span style="color: navy;"><b>void</b></span> handleMessage(Message msg) <span style="color: navy;">{</span>
            <span style="color: navy;"><b>switch</b></span> (msg.what) <span style="color: navy;">{</span>
                <span style="color: navy;"><b>case</b></span> DecodeManager.MESSAGE_DECODER_COMPLETE:
                    WA_mScanAccount++;
                    DecodeResult decodeResult = (DecodeResult) msg.obj;
 
                    <span style="color: darkgreen;">//byte codeid = decodeResult.codeId;</span>
                    <span style="color: darkgreen;">//byte aimid = decodeResult.aimId;</span>
                    <span style="color: darkgreen;">//int iLength = decodeResult.length;</span>
 
                    strDecodeResult = decodeResult.barcodeData;
                    onBarCodeCompleteNative(strDecodeResult);
                    <span style="color: navy;"><b>break</b></span>;
 
                <span style="color: navy;"><b>case</b></span> DecodeManager.MESSAGE_DECODER_FAIL: <span style="color: navy;">{</span>
                    strDecodeResult = <span style="color: red;">""</span>;
                    onBarCodeFailNative();
                <span style="color: navy;">}</span>
                <span style="color: navy;"><b>break</b></span>;
                <span style="color: navy;"><b>case</b></span> DecodeManager.MESSAGE_DECODER_READY:
                <span style="color: navy;">{</span>
                <span style="color: navy;">}</span>
                <span style="color: navy;"><b>break</b></span>;
                <span style="color: navy;"><b>default</b></span>:
                    super.handleMessage(msg);
                    <span style="color: navy;"><b>break</b></span>;
            <span style="color: navy;">}</span>
        <span style="color: navy;">}</span>
    <span style="color: navy;">}</span>;
    <span style="color: navy;"><b>private</b></span> <span style="color: navy;"><b>void</b></span> WA_cancelScan() <span style="color: navy;"><b>throws</b></span> Exception <span style="color: navy;">{</span>
        mDecodeManager.cancelDecode();
    <span style="color: navy;">}</span>
<span style="color: navy;">}</span>

[crayon-5ce46bac1ca06168569238 jive-pre ]<code class="jive-code jive-java">package com.winarhi.nativeactivitysubclass;

import android.os.Build;

import android.os.Handler;

import android.os.Message;

import android.os.RemoteException;

import java.io.IOException;

import com.honeywell.decodemanager.DecodeManager;

import com.honeywell.decodemanager.barcode.DecodeResult;

public class NativeActivitySubclass extends com.embarcadero.firemonkey.FMXNativeActivity{

//private final int ID_SCANSETTING = 0x12;

//private final int ID_CLEAR_SCREEN = 0x13;

private DecodeManager mDecodeManager = null;

public String strDecodeResult = "";

private final int WA_SCANTIMEOUT = 5000;

long WA_mScanAccount = 0;

private void WA_CreateDecodeManager() {

if (mDecodeManager == null)

mDecodeManager = new DecodeManager(this, ScanResultHandler);

}

private void WA_DestroyDecodeManager() {

if (mDecodeManager != null) {

try {

mDecodeManager.release();

mDecodeManager = null;

} catch (IOException e) {

// TODO Auto-generated catch block

e.printStackTrace();

}

private void WA_DoScan() throws Exception {

if (mDecodeManager != null) {

try {

strDecodeResult = "";

mDecodeManager.doDecode(WA_SCANTIMEOUT);

} catch (RemoteException e) {

// TODO Auto-generated catch block

e.printStackTrace();

}

public native void onBarCodeCompleteNative(String BarCode);

public native void onBarCodeFailNative();

private Handler ScanResultHandler = new Handler() {

public void handleMessage(Message msg) {

switch (msg.what) {

case DecodeManager.MESSAGE_DECODER_COMPLETE:

WA_mScanAccount++;

DecodeResult decodeResult = (DecodeResult) msg.obj;

//byte codeid = decodeResult.codeId;

//byte aimid = decodeResult.aimId;

//int iLength = decodeResult.length;

strDecodeResult = decodeResult.barcodeData;

onBarCodeCompleteNative(strDecodeResult);

break;

case DecodeManager.MESSAGE_DECODER_FAIL: {

strDecodeResult = "";

onBarCodeFailNative();

}

break;

case DecodeManager.MESSAGE_DECODER_READY:

{

}

break;

default:

super.handleMessage(msg);

break;

}

};

private void WA_cancelScan() throws Exception {

mDecodeManager.cancelDecode();

}

[/crayon]

One more thing (Java generic import):

[crayon-5ce46bac1ca12588218720   jive-pre ]<code class="jive-code jive-java">uses
  Androidapi.JNIBridge,
  Androidapi.JNI.App;
 
type
  JNativeActivitySubclassClass = <span style="color: navy;"><b>interface</b></span>(JNativeActivityClass)
  [<span style="color: navy;">'{829C77FB-08F1-4D19-9782-3C58EECAAAAA}'</span>]
    <span style="color: navy;">{</span>Methods<span style="color: navy;">}</span>
    <span style="color: darkgreen;">//function init: JFMXNativeActivity; cdecl;</span>
  end;
 
  [JavaSignature(<span style="color: navy;">'com/winarhi/nativeactivitysubclass/NativeActivitySubclass'</span>)]
  JNativeActivitySubclass = <span style="color: navy;"><b>interface</b></span>(JNativeActivity)
  [<span style="color: navy;">'{2FA559EC-D1D7-46AA-9C52-FEFC6B3AAAAA}'</span>]
    <span style="color: navy;">{</span>Methods<span style="color: navy;">}</span>
    procedure WA_DoScan;
    procedure WA_CreateDecodeManager;
    procedure WA_DestroyDecodeManager;
  end;
  TJNativeActivitySubclass = <span style="color: navy;"><b>class</b></span>(TJavaGenericImport&lt;JNativeActivitySubclassClass, JNativeActivitySubclass&gt;) end;

[crayon-5ce46bac1ca12588218720 jive-pre ]<code class="jive-code jive-java">uses

Androidapi.JNIBridge,

Androidapi.JNI.App;

type

JNativeActivitySubclassClass = interface(JNativeActivityClass)

['{829C77FB-08F1-4D19-9782-3C58EECAAAAA}']

{Methods}

//function init: JFMXNativeActivity; cdecl;

end;

[JavaSignature('com/winarhi/nativeactivitysubclass/NativeActivitySubclass')]

JNativeActivitySubclass = interface(JNativeActivity)

['{2FA559EC-D1D7-46AA-9C52-FEFC6B3AAAAA}']

{Methods}

procedure WA_DoScan;

procedure WA_CreateDecodeManager;

procedure WA_DestroyDecodeManager;

end;

TJNativeActivitySubclass = class(TJavaGenericImport<JNativeActivitySubclassClass, JNativeActivitySubclass>) end;

[/crayon]

Best Regards,
Cristian Peta

For implementing existing third party SDKs like MoPub, TapJoy, Millennial Media, Google Play Services, Flurry, Chartboost, Upsight, or even new Bluetooth functionality for Android in Delphi XE5, Delphi XE6, and AppMethod this may be the fastest way.

Head over and download the samples from Brian Long on customizing your Firemonkey classes.dex file.

Have Delphi Firemonkey questions? Ask and get answers on StackOverflow.

3 Responses to Implement Custom Android SDK Callback Events With Delphi XE5 Firemonkey On Android

Pingback: Customize The Classes.dex File To Access Third Party Android JAR Libraries In Delphi XE6 Firemonkey | Delphi XE5 XE6 Firemonkey, Delphi Android, Delphi IOS
Pingback: Implement A Dynamic Broadcast Receiver In Delphi XE6 & XE7 Firemonkey On Android | Delphi XE5 XE6 XE7 Firemonkey, Delphi Android, Delphi IOS
Cody says:

December 28, 2015 at 12:05 am

Hi, can anyone provide a Code Sample here without the faulty HTML-Stuff? Thanks

Implement Custom Android SDK Callback Events With Delphi XE5 Firemonkey On Android

Have Delphi Firemonkey questions? Ask and get answers on StackOverflow.

Electronic Medical Record CRUD REST API Client And Server For Delphi 10.3 Rio On Android And IOS

Anatomy Of A Delphi 10.3 Rio Firemonkey App On #Android, #IOS, #Windows, And #macOS

Auto Tables Logger REST Client And RAD Server Sample For Delphi 10.2 Tokyo On Android And IOS

3 Responses to Implement Custom Android SDK Callback Events With Delphi XE5 Firemonkey On Android

Leave a Reply Cancel reply

Categories

Recent Posts

Read previous post:

Polygon Morphing And Line Intersection With Delphi XE6 Firemonkey On Windows And OSX

Have Delphi Firemonkey questions? Ask and get answers on StackOverflow.

Related Posts

Electronic Medical Record CRUD REST API Client And Server For Delphi 10.3 Rio On Android And IOS

Anatomy Of A Delphi 10.3 Rio Firemonkey App On #Android, #IOS, #Windows, And #macOS

Auto Tables Logger REST Client And RAD Server Sample For Delphi 10.2 Tokyo On Android And IOS

3 Responses to Implement Custom Android SDK Callback Events With Delphi XE5 Firemonkey On Android

Leave a Reply Cancel reply

Categories

Recent Posts

Read previous post:

Polygon Morphing And Line Intersection With Delphi XE6 Firemonkey On Windows And OSX