/**************************************************************************/ /* os_android.cpp */ /**************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /**************************************************************************/ /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ /* */ /* Permission is hereby granted, free of charge, to any person obtaining */ /* a copy of this software and associated documentation files (the */ /* "Software"), to deal in the Software without restriction, including */ /* without limitation the rights to use, copy, modify, merge, publish, */ /* distribute, sublicense, and/or sell copies of the Software, and to */ /* permit persons to whom the Software is furnished to do so, subject to */ /* the following conditions: */ /* */ /* The above copyright notice and this permission notice shall be */ /* included in all copies or substantial portions of the Software. */ /* */ /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */ /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /**************************************************************************/ #include "os_android.h" #include "core/array.h" #include "core/project_settings.h" #include "drivers/gles2/rasterizer_gles2.h" #include "drivers/gles3/rasterizer_gles3.h" #include "drivers/unix/dir_access_unix.h" #include "drivers/unix/file_access_unix.h" #include "main/main.h" #include "scene/main/scene_tree.h" #include "servers/visual/visual_server_raster.h" #include "servers/visual/visual_server_wrap_mt.h" #include "dir_access_jandroid.h" #include "file_access_android.h" #include "file_access_filesystem_jandroid.h" #include "net_socket_android.h" #include #include #include #include "java_godot_io_wrapper.h" #include "java_godot_wrapper.h" #include "tts_android.h" const char *OS_Android::ANDROID_EXEC_PATH = "apk"; static const int DEFAULT_WINDOW_WIDTH = 800; static const int DEFAULT_WINDOW_HEIGHT = 600; String _remove_symlink(const String &dir) { // Workaround for Android 6.0+ using a symlink. // Save the current directory. char current_dir_name[2048]; getcwd(current_dir_name, 2048); // Change directory to the external data directory. chdir(dir.utf8().get_data()); // Get the actual directory without the potential symlink. char dir_name_wihout_symlink[2048]; getcwd(dir_name_wihout_symlink, 2048); // Convert back to a String. String dir_without_symlink(dir_name_wihout_symlink); // Restore original current directory. chdir(current_dir_name); return dir_without_symlink; } class AndroidLogger : public Logger { public: virtual void logv(const char *p_format, va_list p_list, bool p_err) { __android_log_vprint(p_err ? ANDROID_LOG_ERROR : ANDROID_LOG_INFO, "godot", p_format, p_list); } virtual ~AndroidLogger() {} }; bool OS_Android::tts_is_speaking() const { return TTS_Android::is_speaking(); } bool OS_Android::tts_is_paused() const { return TTS_Android::is_paused(); } Array OS_Android::tts_get_voices() const { return TTS_Android::get_voices(); } void OS_Android::tts_speak(const String &p_text, const String &p_voice, int p_volume, float p_pitch, float p_rate, int p_utterance_id, bool p_interrupt) { TTS_Android::speak(p_text, p_voice, p_volume, p_pitch, p_rate, p_utterance_id, p_interrupt); } void OS_Android::tts_pause() { TTS_Android::pause(); } void OS_Android::tts_resume() { TTS_Android::resume(); } void OS_Android::tts_stop() { TTS_Android::stop(); } int OS_Android::get_video_driver_count() const { return 2; } const char *OS_Android::get_video_driver_name(int p_driver) const { switch (p_driver) { case VIDEO_DRIVER_GLES3: return "GLES3"; case VIDEO_DRIVER_GLES2: return "GLES2"; } ERR_FAIL_V_MSG(nullptr, "Invalid video driver index: " + itos(p_driver) + "."); } int OS_Android::get_audio_driver_count() const { return 1; } const char *OS_Android::get_audio_driver_name(int p_driver) const { return "Android"; } void OS_Android::initialize_core() { OS_Unix::initialize_core(); #ifdef TOOLS_ENABLED FileAccess::make_default(FileAccess::ACCESS_RESOURCES); #else if (use_apk_expansion) { FileAccess::make_default(FileAccess::ACCESS_RESOURCES); } else { FileAccess::make_default(FileAccess::ACCESS_RESOURCES); } #endif FileAccess::make_default(FileAccess::ACCESS_USERDATA); FileAccess::make_default(FileAccess::ACCESS_FILESYSTEM); #ifdef TOOLS_ENABLED DirAccess::make_default(DirAccess::ACCESS_RESOURCES); #else if (use_apk_expansion) { DirAccess::make_default(DirAccess::ACCESS_RESOURCES); } else { DirAccess::make_default(DirAccess::ACCESS_RESOURCES); } #endif DirAccess::make_default(DirAccess::ACCESS_USERDATA); DirAccess::make_default(DirAccess::ACCESS_FILESYSTEM); NetSocketAndroid::make_default(); } void OS_Android::set_opengl_extensions(const char *p_gl_extensions) { ERR_FAIL_NULL(p_gl_extensions); gl_extensions = p_gl_extensions; } int OS_Android::get_current_video_driver() const { return video_driver_index; } Error OS_Android::initialize(const VideoMode &p_desired, int p_video_driver, int p_audio_driver) { bool use_gl3 = godot_java->get_gles_version_code() >= 0x00030000; use_gl3 = use_gl3 && (GLOBAL_GET("rendering/quality/driver/driver_name") == "GLES3"); bool gl_initialization_error = false; while (true) { if (use_gl3) { if (RasterizerGLES3::is_viable() == OK) { RasterizerGLES3::register_config(); RasterizerGLES3::make_current(); break; } else { if (GLOBAL_GET("rendering/quality/driver/fallback_to_gles2")) { p_video_driver = VIDEO_DRIVER_GLES2; use_gl3 = false; continue; } else { gl_initialization_error = true; break; } } } else { if (RasterizerGLES2::is_viable() == OK) { RasterizerGLES2::register_config(); RasterizerGLES2::make_current(); break; } else { gl_initialization_error = true; break; } } } transparency_enabled = p_desired.layered; if (gl_initialization_error) { OS::get_singleton()->alert("Your device does not support any of the supported OpenGL versions.\n" "Please try updating your Android version.", "Unable to initialize Video driver"); return ERR_UNAVAILABLE; } video_driver_index = p_video_driver; visual_server = memnew(VisualServerRaster); if (get_render_thread_mode() != RENDER_THREAD_UNSAFE) { visual_server = memnew(VisualServerWrapMT(visual_server, false)); } visual_server->init(); AudioDriverManager::initialize(p_audio_driver); input = memnew(InputDefault); input->set_use_input_buffering(true); // Needed because events will come directly from the UI thread input->set_fallback_mapping(godot_java->get_input_fallback_mapping()); return OK; } void OS_Android::set_main_loop(MainLoop *p_main_loop) { main_loop = p_main_loop; input->set_main_loop(p_main_loop); } void OS_Android::delete_main_loop() { memdelete(main_loop); } void OS_Android::finalize() { memdelete(input); } GodotJavaWrapper *OS_Android::get_godot_java() { return godot_java; } GodotIOJavaWrapper *OS_Android::get_godot_io_java() { return godot_io_java; } void OS_Android::alert(const String &p_alert, const String &p_title) { godot_java->alert(p_alert, p_title); } bool OS_Android::request_permission(const String &p_name) { return godot_java->request_permission(p_name); } bool OS_Android::request_permissions() { return godot_java->request_permissions(); } Vector OS_Android::get_granted_permissions() const { return godot_java->get_granted_permissions(); } Error OS_Android::open_dynamic_library(const String p_path, void *&p_library_handle, bool p_also_set_library_path) { p_library_handle = dlopen(p_path.utf8().get_data(), RTLD_NOW); ERR_FAIL_NULL_V_MSG(p_library_handle, ERR_CANT_OPEN, "Can't open dynamic library: " + p_path + ", error: " + dlerror() + "."); return OK; } void OS_Android::set_mouse_mode(MouseMode p_mode) { if (!godot_java->get_godot_view()->can_update_pointer_icon() || !godot_java->get_godot_view()->can_capture_pointer()) { return; } if (mouse_mode == p_mode) { return; } if (p_mode == MouseMode::MOUSE_MODE_HIDDEN) { godot_java->get_godot_view()->set_pointer_icon(CURSOR_TYPE_NULL); } else { set_cursor_shape(cursor_shape); } if (p_mode == MouseMode::MOUSE_MODE_CAPTURED) { godot_java->get_godot_view()->request_pointer_capture(); } else { godot_java->get_godot_view()->release_pointer_capture(); } mouse_mode = p_mode; } OS::MouseMode OS_Android::get_mouse_mode() const { return mouse_mode; } void OS_Android::_set_cursor_shape_helper(CursorShape p_shape, bool force) { if (!godot_java->get_godot_view()->can_update_pointer_icon()) { return; } if (cursor_shape == p_shape && !force) { return; } cursor_shape = p_shape; if (mouse_mode == MouseMode::MOUSE_MODE_VISIBLE || mouse_mode == MouseMode::MOUSE_MODE_CONFINED) { godot_java->get_godot_view()->set_pointer_icon(android_cursors[cursor_shape]); } } void OS_Android::set_cursor_shape(CursorShape p_shape) { _set_cursor_shape_helper(p_shape); } void OS_Android::set_custom_mouse_cursor(const RES &p_cursor, CursorShape p_shape, const Vector2 &p_hotspot) { String cursor_path = p_cursor.is_valid() ? p_cursor->get_path() : ""; if (!cursor_path.empty()) { cursor_path = ProjectSettings::get_singleton()->globalize_path(cursor_path); } godot_java->get_godot_view()->configure_pointer_icon(android_cursors[cursor_shape], cursor_path, p_hotspot); _set_cursor_shape_helper(p_shape, true); } OS::CursorShape OS_Android::get_cursor_shape() const { return cursor_shape; } Point2 OS_Android::get_mouse_position() const { return input->get_mouse_position(); } int OS_Android::get_mouse_button_state() const { return input->get_mouse_button_mask(); } void OS_Android::set_window_title(const String &p_title) { //This queries/updates the currently connected devices/joypads //Set_window_title is called when initializing the main loop (main.cpp) //therefore this place is found to be suitable (I found no better). godot_java->init_input_devices(); } void OS_Android::set_video_mode(const VideoMode &p_video_mode, int p_screen) { } OS::VideoMode OS_Android::get_video_mode(int p_screen) const { return default_videomode; } void OS_Android::get_fullscreen_mode_list(List *p_list, int p_screen) const { p_list->push_back(default_videomode); } void OS_Android::set_keep_screen_on(bool p_enabled) { OS::set_keep_screen_on(p_enabled); godot_java->set_keep_screen_on(p_enabled); } Size2 OS_Android::get_window_size() const { return Vector2(default_videomode.width, default_videomode.height); } Rect2 OS_Android::get_window_safe_area() const { int xywh[4]; godot_io_java->get_window_safe_area(xywh); return Rect2(xywh[0], xywh[1], xywh[2], xywh[3]); } Array OS_Android::get_display_cutouts() const { return godot_io_java->get_display_cutouts(); } String OS_Android::get_name() const { return "Android"; } MainLoop *OS_Android::get_main_loop() const { return main_loop; } bool OS_Android::can_draw() const { return true; //always? } void OS_Android::main_loop_begin() { if (main_loop) { main_loop->init(); } } bool OS_Android::main_loop_iterate(bool *r_should_swap_buffers) { if (!main_loop) { return false; } uint64_t current_frames_drawn = Engine::get_singleton()->get_frames_drawn(); bool exit = Main::iteration(); if (r_should_swap_buffers) { *r_should_swap_buffers = !is_in_low_processor_usage_mode() || _update_pending || current_frames_drawn != Engine::get_singleton()->get_frames_drawn(); } return exit; } void OS_Android::main_loop_end() { if (main_loop) { SceneTree *scene_tree = Object::cast_to(main_loop); if (scene_tree) { scene_tree->quit(); } main_loop->finish(); } } void OS_Android::main_loop_focusout() { if (main_loop) { main_loop->notification(MainLoop::NOTIFICATION_WM_FOCUS_OUT); } audio_driver_android.set_pause(true); } void OS_Android::main_loop_focusin() { if (main_loop) { main_loop->notification(MainLoop::NOTIFICATION_WM_FOCUS_IN); } audio_driver_android.set_pause(false); } void OS_Android::process_accelerometer(const Vector3 &p_accelerometer) { input->set_accelerometer(p_accelerometer); } void OS_Android::process_gravity(const Vector3 &p_gravity) { input->set_gravity(p_gravity); } void OS_Android::process_magnetometer(const Vector3 &p_magnetometer) { input->set_magnetometer(p_magnetometer); } void OS_Android::process_gyroscope(const Vector3 &p_gyroscope) { input->set_gyroscope(p_gyroscope); } bool OS_Android::has_touchscreen_ui_hint() const { return true; } bool OS_Android::has_virtual_keyboard() const { return true; } int OS_Android::get_virtual_keyboard_height() const { return godot_io_java->get_vk_height(); } void OS_Android::show_virtual_keyboard(const String &p_existing_text, const Rect2 &p_screen_rect, VirtualKeyboardType p_type, int p_max_input_length, int p_cursor_start, int p_cursor_end) { if (godot_io_java->has_vk()) { godot_io_java->show_vk(p_existing_text, (int)p_type, p_max_input_length, p_cursor_start, p_cursor_end); } else { ERR_PRINT("Virtual keyboard not available"); } } void OS_Android::hide_virtual_keyboard() { if (godot_io_java->has_vk()) { godot_io_java->hide_vk(); } else { ERR_PRINT("Virtual keyboard not available"); } } void OS_Android::set_display_size(Size2 p_size) { default_videomode.width = p_size.x; default_videomode.height = p_size.y; } Error OS_Android::shell_open(String p_uri) { return godot_io_java->open_uri(p_uri); } String OS_Android::get_resource_dir() const { #ifdef TOOLS_ENABLED return OS_Unix::get_resource_dir(); #else return "/"; //android has its own filesystem for resources inside the APK #endif } String OS_Android::get_locale() const { String locale = godot_io_java->get_locale(); if (locale != "") { return locale; } return OS_Unix::get_locale(); } void OS_Android::set_clipboard(const String &p_text) { // DO we really need the fallback to OS_Unix here?! if (godot_java->has_set_clipboard()) { godot_java->set_clipboard(p_text); } else { OS_Unix::set_clipboard(p_text); } } String OS_Android::get_clipboard() const { // DO we really need the fallback to OS_Unix here?! if (godot_java->has_get_clipboard()) { return godot_java->get_clipboard(); } return OS_Unix::get_clipboard(); } bool OS_Android::has_clipboard() const { // DO we really need the fallback to OS_Unix here?! if (godot_java->has_has_clipboard()) { return godot_java->has_clipboard(); } return OS_Unix::has_clipboard(); } String OS_Android::get_model_name() const { String model = godot_io_java->get_model(); if (model != "") { return model; } return OS_Unix::get_model_name(); } int OS_Android::get_screen_dpi(int p_screen) const { return godot_io_java->get_screen_dpi(); } float OS_Android::get_screen_scale(int p_screen) const { float screen_scale = godot_io_java->get_scaled_density(); // Update the scale to avoid cropping. Vector2 screen_size = get_window_size(); if (screen_size != Vector2()) { float width_scale = screen_size.width / (float)DEFAULT_WINDOW_WIDTH; float height_scale = screen_size.height / (float)DEFAULT_WINDOW_HEIGHT; screen_scale = MIN(screen_scale, MIN(width_scale, height_scale)); } print_line("Selected screen scale: " + rtos(screen_scale)); return screen_scale; } float OS_Android::get_screen_max_scale() const { return get_screen_scale(); } float OS_Android::get_screen_refresh_rate(int p_screen) const { return godot_io_java->get_screen_refresh_rate(OS::get_singleton()->SCREEN_REFRESH_RATE_FALLBACK); } String OS_Android::get_data_path() const { return get_user_data_dir(); } String OS_Android::get_executable_path() const { // Since unix process creation is restricted on Android, we bypass // OS_Unix::get_executable_path() so we can return ANDROID_EXEC_PATH. // Detection of ANDROID_EXEC_PATH allows to handle process creation in an Android compliant // manner. return OS::get_executable_path(); } String OS_Android::get_user_data_dir() const { if (data_dir_cache != String()) { return data_dir_cache; } String data_dir = godot_io_java->get_user_data_dir(); if (data_dir != "") { data_dir_cache = _remove_symlink(data_dir); return data_dir_cache; } return "."; } String OS_Android::get_cache_path() const { if (cache_dir_cache != String()) { return cache_dir_cache; } String cache_dir = godot_io_java->get_cache_dir(); if (cache_dir != "") { cache_dir_cache = _remove_symlink(cache_dir); return cache_dir_cache; } return "."; } void OS_Android::set_screen_orientation(ScreenOrientation p_orientation) { godot_io_java->set_screen_orientation(p_orientation); } OS::ScreenOrientation OS_Android::get_screen_orientation() const { const int orientation = godot_io_java->get_screen_orientation(); ERR_FAIL_INDEX_V_MSG(orientation, 7, OS::ScreenOrientation(0), "Unrecognized screen orientation."); return OS::ScreenOrientation(orientation); } String OS_Android::get_unique_id() const { String unique_id = godot_io_java->get_unique_id(); if (unique_id != "") { return unique_id; } return OS::get_unique_id(); } String OS_Android::get_system_dir(SystemDir p_dir, bool p_shared_storage) const { return godot_io_java->get_system_dir(p_dir, p_shared_storage); } Error OS_Android::move_to_trash(const String &p_path) { DirAccessRef da_ref = DirAccess::create_for_path(p_path); if (!da_ref) { return FAILED; } // Check if it's a directory if (da_ref->dir_exists(p_path)) { Error err = da_ref->change_dir(p_path); if (err) { return err; } // This is directory, let's erase its contents err = da_ref->erase_contents_recursive(); if (err) { return err; } // Remove the top directory return da_ref->remove(p_path); } else if (da_ref->file_exists(p_path)) { // This is a file, let's remove it. return da_ref->remove(p_path); } else { return FAILED; } } void OS_Android::set_offscreen_gl_available(bool p_available) { secondary_gl_available = p_available; } bool OS_Android::is_offscreen_gl_available() const { return secondary_gl_available; } void OS_Android::set_offscreen_gl_current(bool p_current) { if (secondary_gl_available) { godot_java->set_offscreen_gl_current(nullptr, p_current); } } bool OS_Android::is_joy_known(int p_device) { return input->is_joy_mapped(p_device); } String OS_Android::get_joy_guid(int p_device) const { return input->get_joy_guid_remapped(p_device); } void OS_Android::vibrate_handheld(int p_duration_ms) { godot_java->vibrate(p_duration_ms); } String OS_Android::get_config_path() const { return get_user_data_dir().plus_file("config"); } void OS_Android::benchmark_begin_measure(const String &p_what) { #ifdef TOOLS_ENABLED godot_java->begin_benchmark_measure(p_what); #endif } void OS_Android::benchmark_end_measure(const String &p_what) { #ifdef TOOLS_ENABLED godot_java->end_benchmark_measure(p_what); #endif } void OS_Android::benchmark_dump() { #ifdef TOOLS_ENABLED if (!is_use_benchmark_set()) { return; } godot_java->dump_benchmark(get_benchmark_file()); #endif } bool OS_Android::_check_internal_feature_support(const String &p_feature) { if (p_feature == "mobile") { //TODO support etc2 only if GLES3 driver is selected return true; } #if defined(__aarch64__) if (p_feature == "arm64-v8a") { return true; } #elif defined(__ARM_ARCH_7A__) if (p_feature == "armeabi-v7a" || p_feature == "armeabi") { return true; } #elif defined(__arm__) if (p_feature == "armeabi") { return true; } #endif return false; } OS_Android::OS_Android(GodotJavaWrapper *p_godot_java, GodotIOJavaWrapper *p_godot_io_java, bool p_use_apk_expansion) { use_apk_expansion = p_use_apk_expansion; default_videomode.width = DEFAULT_WINDOW_WIDTH; default_videomode.height = DEFAULT_WINDOW_HEIGHT; default_videomode.fullscreen = true; default_videomode.resizable = false; godot_java = p_godot_java; godot_io_java = p_godot_io_java; Vector loggers; loggers.push_back(memnew(AndroidLogger)); _set_logger(memnew(CompositeLogger(loggers))); AudioDriverManager::add_driver(&audio_driver_android); } Error OS_Android::execute(const String &p_path, const List &p_arguments, bool p_blocking, ProcessID *r_child_id, String *r_pipe, int *r_exitcode, bool read_stderr, Mutex *p_pipe_mutex, bool p_open_console) { if (p_path == ANDROID_EXEC_PATH) { return create_instance(p_arguments, r_child_id); } else { return OS_Unix::execute(p_path, p_arguments, p_blocking, r_child_id, r_pipe, r_exitcode, read_stderr, p_pipe_mutex, p_open_console); } } Error OS_Android::create_instance(const List &p_arguments, ProcessID *r_child_id) { int instance_id = godot_java->create_new_godot_instance(p_arguments); if (r_child_id) { *r_child_id = instance_id; } return OK; } Error OS_Android::kill(const ProcessID &p_pid) { if (godot_java->force_quit(nullptr, p_pid)) { return OK; } return OS_Unix::kill(p_pid); } OS_Android::~OS_Android() { }