OLD | NEW |
1 /* | 1 /* |
2 * Copyright (c) 2015 The WebRTC project authors. All Rights Reserved. | 2 * Copyright (c) 2015 The WebRTC project authors. All Rights Reserved. |
3 * | 3 * |
4 * Use of this source code is governed by a BSD-style license | 4 * Use of this source code is governed by a BSD-style license |
5 * that can be found in the LICENSE file in the root of the source | 5 * that can be found in the LICENSE file in the root of the source |
6 * tree. An additional intellectual property rights grant can be found | 6 * tree. An additional intellectual property rights grant can be found |
7 * in the file PATENTS. All contributing project authors may | 7 * in the file PATENTS. All contributing project authors may |
8 * be found in the AUTHORS file in the root of the source tree. | 8 * be found in the AUTHORS file in the root of the source tree. |
9 */ | 9 */ |
10 | 10 |
11 #ifndef WEBRTC_MODULES_UTILITY_INCLUDE_JVM_ANDROID_H_ | 11 #ifndef WEBRTC_MODULES_UTILITY_INCLUDE_JVM_ANDROID_H_ |
12 #define WEBRTC_MODULES_UTILITY_INCLUDE_JVM_ANDROID_H_ | 12 #define WEBRTC_MODULES_UTILITY_INCLUDE_JVM_ANDROID_H_ |
13 | 13 |
14 #include <jni.h> | 14 #include <jni.h> |
| 15 |
| 16 #include <memory> |
15 #include <string> | 17 #include <string> |
16 | 18 |
17 #include "webrtc/base/scoped_ptr.h" | |
18 #include "webrtc/base/thread_checker.h" | 19 #include "webrtc/base/thread_checker.h" |
19 #include "webrtc/modules/utility/include/helpers_android.h" | 20 #include "webrtc/modules/utility/include/helpers_android.h" |
20 | 21 |
21 namespace webrtc { | 22 namespace webrtc { |
22 | 23 |
23 // The JNI interface pointer (JNIEnv) is valid only in the current thread. | 24 // The JNI interface pointer (JNIEnv) is valid only in the current thread. |
24 // Should another thread need to access the Java VM, it must first call | 25 // Should another thread need to access the Java VM, it must first call |
25 // AttachCurrentThread() to attach itself to the VM and obtain a JNI interface | 26 // AttachCurrentThread() to attach itself to the VM and obtain a JNI interface |
26 // pointer. The native thread remains attached to the VM until it calls | 27 // pointer. The native thread remains attached to the VM until it calls |
27 // DetachCurrentThread() to detach. | 28 // DetachCurrentThread() to detach. |
(...skipping 41 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
69 jclass const j_class_; | 70 jclass const j_class_; |
70 }; | 71 }; |
71 | 72 |
72 // Adds support of the NewObject factory method to the JavaClass class. | 73 // Adds support of the NewObject factory method to the JavaClass class. |
73 // See example in JVM for more details on how to use it. | 74 // See example in JVM for more details on how to use it. |
74 class NativeRegistration : public JavaClass { | 75 class NativeRegistration : public JavaClass { |
75 public: | 76 public: |
76 NativeRegistration(JNIEnv* jni, jclass clazz); | 77 NativeRegistration(JNIEnv* jni, jclass clazz); |
77 ~NativeRegistration(); | 78 ~NativeRegistration(); |
78 | 79 |
79 rtc::scoped_ptr<GlobalRef> NewObject( | 80 std::unique_ptr<GlobalRef> NewObject( |
80 const char* name, const char* signature, ...); | 81 const char* name, const char* signature, ...); |
81 | 82 |
82 private: | 83 private: |
83 JNIEnv* const jni_; | 84 JNIEnv* const jni_; |
84 }; | 85 }; |
85 | 86 |
86 // This class is created by the JVM class and is used to expose methods that | 87 // This class is created by the JVM class and is used to expose methods that |
87 // needs the JNI interface pointer but its main purpose is to create a | 88 // needs the JNI interface pointer but its main purpose is to create a |
88 // NativeRegistration object given name of a Java class and a list of native | 89 // NativeRegistration object given name of a Java class and a list of native |
89 // methods. See example in JVM for more details. | 90 // methods. See example in JVM for more details. |
90 class JNIEnvironment { | 91 class JNIEnvironment { |
91 public: | 92 public: |
92 explicit JNIEnvironment(JNIEnv* jni); | 93 explicit JNIEnvironment(JNIEnv* jni); |
93 ~JNIEnvironment(); | 94 ~JNIEnvironment(); |
94 | 95 |
95 // Registers native methods with the Java class specified by |name|. | 96 // Registers native methods with the Java class specified by |name|. |
96 // Note that the class name must be one of the names in the static | 97 // Note that the class name must be one of the names in the static |
97 // |loaded_classes| array defined in jvm_android.cc. | 98 // |loaded_classes| array defined in jvm_android.cc. |
98 // This method must be called on the construction thread. | 99 // This method must be called on the construction thread. |
99 rtc::scoped_ptr<NativeRegistration> RegisterNatives( | 100 std::unique_ptr<NativeRegistration> RegisterNatives( |
100 const char* name, const JNINativeMethod *methods, int num_methods); | 101 const char* name, const JNINativeMethod *methods, int num_methods); |
101 | 102 |
102 // Converts from Java string to std::string. | 103 // Converts from Java string to std::string. |
103 // This method must be called on the construction thread. | 104 // This method must be called on the construction thread. |
104 std::string JavaToStdString(const jstring& j_string); | 105 std::string JavaToStdString(const jstring& j_string); |
105 | 106 |
106 private: | 107 private: |
107 rtc::ThreadChecker thread_checker_; | 108 rtc::ThreadChecker thread_checker_; |
108 JNIEnv* const jni_; | 109 JNIEnv* const jni_; |
109 }; | 110 }; |
110 | 111 |
111 // Main class for working with Java from C++ using JNI in WebRTC. | 112 // Main class for working with Java from C++ using JNI in WebRTC. |
112 // | 113 // |
113 // Example usage: | 114 // Example usage: |
114 // | 115 // |
115 // // At initialization (e.g. in JNI_OnLoad), call JVM::Initialize. | 116 // // At initialization (e.g. in JNI_OnLoad), call JVM::Initialize. |
116 // JNIEnv* jni = ::base::android::AttachCurrentThread(); | 117 // JNIEnv* jni = ::base::android::AttachCurrentThread(); |
117 // JavaVM* jvm = NULL; | 118 // JavaVM* jvm = NULL; |
118 // jni->GetJavaVM(&jvm); | 119 // jni->GetJavaVM(&jvm); |
119 // jobject context = ::base::android::GetApplicationContext(); | 120 // jobject context = ::base::android::GetApplicationContext(); |
120 // webrtc::JVM::Initialize(jvm, context); | 121 // webrtc::JVM::Initialize(jvm, context); |
121 // | 122 // |
122 // // Header (.h) file of example class called User. | 123 // // Header (.h) file of example class called User. |
123 // rtc::scoped_ptr<JNIEnvironment> env; | 124 // std::unique_ptr<JNIEnvironment> env; |
124 // rtc::scoped_ptr<NativeRegistration> reg; | 125 // std::unique_ptr<NativeRegistration> reg; |
125 // rtc::scoped_ptr<GlobalRef> obj; | 126 // std::unique_ptr<GlobalRef> obj; |
126 // | 127 // |
127 // // Construction (in .cc file) of User class. | 128 // // Construction (in .cc file) of User class. |
128 // User::User() { | 129 // User::User() { |
129 // // Calling thread must be attached to the JVM. | 130 // // Calling thread must be attached to the JVM. |
130 // env = JVM::GetInstance()->environment(); | 131 // env = JVM::GetInstance()->environment(); |
131 // reg = env->RegisterNatives("org/webrtc/WebRtcTest", ,); | 132 // reg = env->RegisterNatives("org/webrtc/WebRtcTest", ,); |
132 // obj = reg->NewObject("<init>", ,); | 133 // obj = reg->NewObject("<init>", ,); |
133 // } | 134 // } |
134 // | 135 // |
135 // // Each User method can now use |reg| and |obj| and call Java functions | 136 // // Each User method can now use |reg| and |obj| and call Java functions |
(...skipping 13 matching lines...) Expand all Loading... |
149 // Clears handles stored in Initialize(). Must be called on same thread as | 150 // Clears handles stored in Initialize(). Must be called on same thread as |
150 // Initialize(). | 151 // Initialize(). |
151 static void Uninitialize(); | 152 static void Uninitialize(); |
152 // Gives access to the global Java VM interface pointer, which then can be | 153 // Gives access to the global Java VM interface pointer, which then can be |
153 // used to create a valid JNIEnvironment object or to get a JavaClass object. | 154 // used to create a valid JNIEnvironment object or to get a JavaClass object. |
154 static JVM* GetInstance(); | 155 static JVM* GetInstance(); |
155 | 156 |
156 // Creates a JNIEnvironment object. | 157 // Creates a JNIEnvironment object. |
157 // This method returns a NULL pointer if AttachCurrentThread() has not been | 158 // This method returns a NULL pointer if AttachCurrentThread() has not been |
158 // called successfully. Use the AttachCurrentThreadIfNeeded class if needed. | 159 // called successfully. Use the AttachCurrentThreadIfNeeded class if needed. |
159 rtc::scoped_ptr<JNIEnvironment> environment(); | 160 std::unique_ptr<JNIEnvironment> environment(); |
160 | 161 |
161 // Returns a JavaClass object given class |name|. | 162 // Returns a JavaClass object given class |name|. |
162 // Note that the class name must be one of the names in the static | 163 // Note that the class name must be one of the names in the static |
163 // |loaded_classes| array defined in jvm_android.cc. | 164 // |loaded_classes| array defined in jvm_android.cc. |
164 // This method must be called on the construction thread. | 165 // This method must be called on the construction thread. |
165 JavaClass GetClass(const char* name); | 166 JavaClass GetClass(const char* name); |
166 | 167 |
167 // TODO(henrika): can we make these private? | 168 // TODO(henrika): can we make these private? |
168 JavaVM* jvm() const { return jvm_; } | 169 JavaVM* jvm() const { return jvm_; } |
169 jobject context() const { return context_; } | 170 jobject context() const { return context_; } |
170 | 171 |
171 protected: | 172 protected: |
172 JVM(JavaVM* jvm, jobject context); | 173 JVM(JavaVM* jvm, jobject context); |
173 ~JVM(); | 174 ~JVM(); |
174 | 175 |
175 private: | 176 private: |
176 JNIEnv* jni() const { return GetEnv(jvm_); } | 177 JNIEnv* jni() const { return GetEnv(jvm_); } |
177 | 178 |
178 rtc::ThreadChecker thread_checker_; | 179 rtc::ThreadChecker thread_checker_; |
179 JavaVM* const jvm_; | 180 JavaVM* const jvm_; |
180 jobject context_; | 181 jobject context_; |
181 }; | 182 }; |
182 | 183 |
183 } // namespace webrtc | 184 } // namespace webrtc |
184 | 185 |
185 #endif // WEBRTC_MODULES_UTILITY_INCLUDE_JVM_ANDROID_H_ | 186 #endif // WEBRTC_MODULES_UTILITY_INCLUDE_JVM_ANDROID_H_ |
OLD | NEW |