Adding Voice Commands Feature #897

WailB · 2017-06-16T13:51:46Z

These changes are adding voice commands button to the app. Current
commands are found under voice_commands.xml. This can be expanded to add
commands to audio control or change settings as well. A microphone button can be found on top of the main screen.

Many people have complained about not being to import. This patch adds an actual import preference, which just fires off an ACTION_GET_CONTENT intent. On Kitkat and above, the Storage Access Framework gives people the option to import from applications that are document providers (ex Dropbox, Google Drive, etc). On older devices, this usually offers a file picker as an option. Fixes quran#634.

Make the headers for "Current Page", "Page Bookmarks", and "Not Tagged" not clickable (since they do nothing when clicked or long clicked). Clean up some code.

Most of these LTR hardcodes are needed for supporting pre-api 17. To fix this, split out layout-ar and layout-ar-v17, with the latter being an exact copy of the respective files from layout. Some of the other cases (the various ViewPager indicators) actually always receive data in the correct order, so they need to be LTR. These cases have been placed in the code instead. It should be possible to remove some of these explicit layout direction attributes in the future after some additional work.

In cases when the calculated dropdown width is less than the width of the actual spinner, use that width as the dropdown width. This stops certain sura names from being cut off.

adding an .editorconfig file to the repo so that new contributors will automatically have their formatting setup correctly. It's built into Android Studio. Settings->Editor->Code Style then Check "Enable EditorConfig".

The .editorconfig used to adress .java and .sh solely. Since the code style guide says that 2 spaces is used throughout the project. I've changed .editorconfig to use 2 spaces throughout the project.

This also makes "missing translations" a warning instead of an error.

.editorconfig

Fixes quran#434.

This is supported by Android Studio and IntelliJ and is important for keeping consistency with the existing code style.

This implements recent pages for Quran (using similar behavior to Quran for iOS). A table of recent pages now exists within the bookmarks database. Whenever a Quran page is selected, it is added to the table. When the page changes, the new page replaces the old one in recents. The recents table currently maintains a maximum of 3 items. Fixes quran#691.

RxPreferences was used for listening to changes on the last page. Now that this code has changes, this is no longer needed. Will consider adding it back in the future if needed insha'Allah.

…and clean up all calsses

This removes the 150 search limit when doing a search (though the limit intentionally remains for suggestions). Fixes quran#791.

The api contains a languageCode as of version 4. Store this in the database as it can help optimize search queries.

Since we know when a query is or isn't Arabic, we can use this information to skip databases that are Arabic when the query isn't Arabic (or that aren't Arabic when the query is Arabic).

This patch returns results from the first database that has results. This is done for performance and to avoid having to sort the results.

In translation mode, long pressing an ayah now shows a toolbar (similar to the one in the images screen), but with the share menu. Choosing to copy or share will copy the verse in Arabic (if it is not disabled in the settings) followed by all currently enabled translations as text, and then copy or share.

Many people complain that they are asked to redownload images on every start of the app. This adds some logging to help identify the problem.

To account for the arabic database, i starts at -1 if it's present. Consequently, there shouldn't be an additional 1 added to the total count, because that results in a clear out of bounds case.

May Allah reward brother Mohamed Omar for preparing these 4 sets. These are sets for sheikh Saad al Ghamidi, sheikh Bandar Baleela, sheikh Mahmoud Ali al Bana, and sheikh Abdulrahman Al Shahat.

These changes are adding voice commands button to the app. Current commands are found under voice_commands.xml. This can be expanded to add commands to audio control or change settings as well.

Adding microphone icon to fix the error

To fix the error

ozbek · 2017-06-18T12:37:59Z

app/src/main/java/com/quran/labs/androidquran/ui/QuranActivity.java

@@ -21,7 +22,12 @@
 import android.view.Menu;
 import android.view.MenuInflater;
 import android.view.MenuItem;
-
+/////////////////////////////////////////////
+//voice commands imports


Please remove this comment

ozbek · 2017-06-18T12:38:14Z

app/src/main/java/com/quran/labs/androidquran/ui/QuranActivity.java

@@ -65,6 +71,12 @@
      R.string.quran_juz2,
      R.string.quran_sura };

+  ///////////////////////////////////////////////////
+  //Used for Voice Commands


Please remove this comment

ozbek · 2017-06-18T12:41:48Z

app/src/main/java/com/quran/labs/androidquran/util/VoiceCommandsUtil.java

+    else {
+      CharSequence text = "";
+      if(language.equals("ar-SA"))
+        text = " لا يوجد الامر " + S + " الرجاء الاعادة ";


Please do not use hard coded text, use text from strings.xml

Modified the code to include recommended changes.

ozbek

Overall, "voice commands" looks immature and not suitable for production in its current logic and implementation. You may need to put more thought on its core logic.

ozbek · 2017-06-23T01:53:43Z

app/src/main/java/com/quran/labs/androidquran/ui/QuranActivity.java

@@ -22,6 +23,10 @@
 import android.view.MenuInflater;
 import android.view.MenuItem;

+import android.speech.RecognizerIntent;


Please organize imports. Current order is alphabetic.

ozbek · 2017-06-23T01:54:11Z

app/src/main/java/com/quran/labs/androidquran/ui/QuranActivity.java

+  private static final int SPEECH_REQUEST_CODE = 0;
+  private VoiceCommandsUtil voiceCom;
+
+


Redundant empty line, please remove.

ozbek · 2017-06-23T01:54:37Z

app/src/main/java/com/quran/labs/androidquran/ui/QuranActivity.java

@@ -118,6 +127,10 @@ public void onCreate(Bundle savedInstanceState) {
        (SlidingTabLayout) findViewById(R.id.indicator);
    indicator.setViewPager(pager);

+


ozbek · 2017-06-23T01:54:47Z

app/src/main/java/com/quran/labs/androidquran/ui/QuranActivity.java

@@ -118,6 +127,10 @@ public void onCreate(Bundle savedInstanceState) {
        (SlidingTabLayout) findViewById(R.id.indicator);
    indicator.setViewPager(pager);

+
+    voiceCom = new VoiceCommandsUtil(QuranActivity.this);
+


ozbek · 2017-06-23T01:56:16Z

app/src/main/java/com/quran/labs/androidquran/ui/QuranActivity.java

@@ -265,7 +283,34 @@ protected void onSaveInstanceState(Bundle outState) {
    super.onSaveInstanceState(outState);
  }

-  private void jumpToLastPage() {
+  public void startVoiceRecognition() {
+    final String language = QuranSettings.getInstance(this).isArabicNames() ? "ar-SA" : "en-US";


You are essentially limiting voice recognition to Arabic and US English. Both Google voice recognition and the Qur'an app supports more locales. Please consider taking that into account.

ozbek · 2017-06-23T02:03:30Z

app/src/main/java/com/quran/labs/androidquran/util/VoiceCommandsUtil.java

+          myContext.startActivity(i);
+          return true;
+        case 5:
+          sura = 2;


I am having hard time understanding the logic here. Why are we jumping to Surah Baqarah here?

The voice command is to go to Sura Al-Bagarah. However, I missed adding it in the english xml file. It is in the arabic file. The intention is to make it easy for the user to jump to the required Sura through voice instead of having to type the name in the "Jump" option or scroll to it.

ozbek · 2017-06-23T02:06:46Z

app/src/main/res/values-ar/strings.xml

@@ -286,4 +286,7 @@
  </plurals>
  <string name="undo">تراجع</string>

+  <!-- voice Commands strings -->
+  <string name="commandNotFound">جرب مرة أخرى. الأمر التالي غير موجود = </string>


<string name="command_not_found">

What is the comment here?

@WailB naming convention of string

ozbek · 2017-06-23T02:07:33Z

app/src/main/res/values-ar/voice_commands.xml

@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='utf-8'?>
+<resources>
+  <string name="vChoice">اذكر الامر المطلوب</string>


vChoice <--- please make it more descriptive.

ozbek · 2017-06-23T02:07:55Z

app/src/main/res/values-ar/voice_commands.xml

+<?xml version='1.0' encoding='utf-8'?>
+<resources>
+  <string name="vChoice">اذكر الامر المطلوب</string>
+  <string-array name="voiceCommandsList">


<string-array name="voice_commands_list">

What is the comment here?

Avoid using camel case in the markup attributes, 'voiceCommandsList' should be 'voice_commands_list'.

ozbek · 2017-06-23T02:08:52Z

build.gradle

@@ -5,7 +5,7 @@ buildscript {
  }

  dependencies {
-    classpath 'com.android.tools.build:gradle:2.3.0'
+    classpath 'com.android.tools.build:gradle:2.3.3'


I'd suggest you make an independent PR for the changes in build.gradle

WailB · 2017-06-23T23:23:20Z

Thank you for your comments. I just want to clarify, this is just a basic code just to show that it works. The core code is there, all is needed is to add "features" to it by adding to the case function in VoiceCommandsUtil.java. I might eluded in my previous posts and probably can be seen in my slow progress, I don't have that much time to work on this to make it a full fledged feature. I am hoping that with this code someone can work on it to add more features to it to make it useful for people. If not, I'll keep working on it as time permits until it is completed.

Also, I will make the code cleaner with more descriptive comments. But you have raised a very good issue, its hard for someone new like myself to read the master code and understand the different functions since there is almost no comments or explanations. Even the order of imports being alphabetical is not clear. So, I suggest an effort to be made to add comments to help new collaborators hit the ground running.

This is a major overhaul of the code to comply with comments received and add additional features such as going to specific pages both in arabic and english. Currently this codes allows to go to suras in arabic and english (only english translated names, also 2 suras are not currently working Qaf and Jinn). You can change the voice commands language as well.

returning gradle build to 2.3.0 as per ozbek comment

WailB · 2017-07-03T23:06:34Z

Please let me know if there are any additional comments or feel free to work on the code yourself. Just a few items to clarify:

I understand the comment about not hard coding strings. However, I had to do it for 2 special cases for an English sura search. This is the best way I could think of to make it easy to search without complicated sentences since the translated sura names are longer than one word. I couldn't use the Arabic version of the English names because google recognition software had difficulty capturing many of the name.
Two of the English translated sura names (Qaf and Jinn) couldn't be found by the voice recognition software. The rest can be identified according to my own testing. I am open to suggestions on how to handle those 2 suras.
The list of voice commands both in Arabic and English can be found in strings voice_commands.xml (the default one) as well as the strings used for searching. The reason I didn't separate them is because of the system language locale issue. The localized xml files can be only accessed if the system language is changed. This limits the functionality of the software if someone wants to use the Arabic voice recognition while the system language is English (such as in my case). The other option was to play around with the configuration locale by changing it back and forth but I read that it is not recommended to do that.
The command to go to specific page is "page 7" for example.
The command to go to specific sura is "go to the opener" for example. No need to say sura/surat. In fact to avoid bad recognition of words, the code will only care about the last word (except for the two special cases mentioned in the code)
The command to change the language to Arabic is "language arabic" then you can immediately start giving commands in Arabic the next time you click the microphone.
There are also commands "settings", "help" and "about"
The possibilities are endless. Additional features can be added such as changing settings directly without opening the settings page (similar to changing the language of the recognition software) or opening translation or tafseers, or searching for specific words, or start audio recitations, etc. This will require a lot more time from me because I still haven't figured out the rest of the code. It is difficult to understand without any comments.

Made some optimization to the code to make it cleaner and added arabic root word code to help make the commands more flexible. For example, the user can say ذهب او اذهب او ذهاب as a command to go to a sura.

sanginovs · 2021-07-24T05:56:24Z

@ahmedre what is the update on this PR?
Can someone else take over? If yes, can you please describe the voice command feature in more detail. thanks

Ahmed Abdelaal and others added 30 commits October 3, 2016 22:10

Viewing new rub3 permenantly instead of just poping it up (quran#687)

415569b

Update to Android plugin 2.2.0

f70a60f

Cleanup nonexistent/untranslatable strings (quran#690)

3434a3f

Build against Android Nougat MR1

0108af8

Fix indentation of some xml files

65f7c37

Update sdk and build tools for Travis

55642dc

Update sdk and build tools for Travis (quran#703)

1429289

Make certain headers not clickable and cleanup

03e0313

Make the headers for "Current Page", "Page Bookmarks", and "Not Tagged" not clickable (since they do nothing when clicked or long clicked). Clean up some code.

Minor code cleanup for bookmarks

54ea278

Cleanup and some lint fixes

a6f6f36

More lint fixes

a7fd642

Fix QuranSpinner dropdown width

376360f

In cases when the calculated dropdown width is less than the width of the actual spinner, use that width as the dropdown width. This stops certain sura names from being cut off.

editorconfig

b721c07

adding an .editorconfig file to the repo so that new contributors will automatically have their formatting setup correctly. It's built into Android Studio. Settings->Editor->Code Style then Check "Enable EditorConfig".

[f] .editorconfig to use spaces on all files

e90bfa3

The .editorconfig used to adress .java and .sh solely. Since the code style guide says that 2 spaces is used throughout the project. I've changed .editorconfig to use 2 spaces throughout the project.

Fix more lint warnings (strings, ax, images, etc)

ec85297

Indentation and hungarian notation

e8d1f26

Re-enable lint for ci and release

7dfaf10

This also makes "missing translations" a warning instead of an error.

Cleanup README

8316798

Merge pull request quran#706 from hafah/patch-1

0e39439

.editorconfig

License code under GPLv3

694d81f

Fixes quran#434.

Support continuous indentation in editorconfig

3f27a74

This is supported by Android Studio and IntelliJ and is important for keeping consistency with the existing code style.

Make @VisibleForTesting be "otherwise private"

c389dd8

Minor code cleanup

9133548

Split the setting advanced options into a new preferences screen

45c3f56

Remove RxPreferences

4bb1a29

RxPreferences was used for listening to changes on the last page. Now that this code has changes, this is no longer needed. Will consider adding it back in the future if needed insha'Allah.

Use recent pages size to correctly get quantity string

18b7820

Split advanced setting options into a new activity with new fragment …

11a6213

…and clean up all calsses

ahmedre and others added 19 commits May 20, 2017 01:26

Remove search results limit

316aae5

This removes the 150 search limit when doing a search (though the limit intentionally remains for suggestions). Fixes quran#791.

Cleanup unneeded active translation related code

4320f1a

Store languageCode in the database

d69d62c

The api contains a languageCode as of version 4. Store this in the database as it can help optimize search queries.

Slightly improve what databases are searched

5870984

Since we know when a query is or isn't Arabic, we can use this information to skip databases that are Arabic when the query isn't Arabic (or that aren't Arabic when the query is Arabic).

Return results from the first db that has results

7873500

This patch returns results from the first database that has results. This is done for performance and to avoid having to sort the results.

Wrap translator name in parentheses

d64bbe9

Slightly improve the jump dialog's behavior

71afde2

Minor cleanup for QuranDataActivity

2a69465

Add logging to know when images disappear

0f4c849

Many people complain that they are asked to redownload images on every start of the app. This adds some logging to help identify the problem.

Bump version to 2.7.5 (and 1.0.8)

2d7d55a

Fix an index out of bounds in search

c393a79

To account for the arabic database, i starts at -1 if it's present. Consequently, there shouldn't be an additional 1 added to the total count, because that results in a clear out of bounds case.

Fix a crash when the translation view is scrolling

fec37d5

Bump version for patch release

48e33f3

Fix indentation of readers.xml

fbcb820

Add 4 gapless qaris

c511fb2

May Allah reward brother Mohamed Omar for preparing these 4 sets. These are sets for sheikh Saad al Ghamidi, sheikh Bandar Baleela, sheikh Mahmoud Ali al Bana, and sheikh Abdulrahman Al Shahat.

Adding Voice Commands Feature

b1ed42a

These changes are adding voice commands button to the app. Current commands are found under voice_commands.xml. This can be expanded to add commands to audio control or change settings as well.

Adding microphone icon

a3006fd

Adding microphone icon to fix the error

Adding missing strings

fc13482

To fix the error

ozbek suggested changes Jun 18, 2017

View reviewed changes

Changes requested by collaborator

be8c0e5

Modified the code to include recommended changes.

ozbek suggested changes Jun 23, 2017

View reviewed changes

WailB added 2 commits July 4, 2017 01:26

Fixing build.gradle version

f9f17a2

returning gradle build to 2.3.0 as per ozbek comment

Optimization to the code

0e0e9ba

Made some optimization to the code to make it cleaner and added arabic root word code to help make the commands more flexible. For example, the user can say ذهب او اذهب او ذهاب as a command to go to a sura.

ahmedre force-pushed the master branch 2 times, most recently from acf48be to f4d3065 Compare October 14, 2017 19:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding Voice Commands Feature #897

Adding Voice Commands Feature #897

WailB commented Jun 16, 2017 •

edited

Loading

ozbek Jun 18, 2017

ozbek Jun 18, 2017

ozbek Jun 18, 2017

ozbek left a comment

ozbek Jun 23, 2017

ozbek Jun 23, 2017

ozbek Jun 23, 2017

ozbek Jun 23, 2017

ozbek Jun 23, 2017

ozbek Jun 23, 2017

WailB Jun 24, 2017

ozbek Jun 23, 2017

WailB Jun 23, 2017

MahmoudMabrok Dec 13, 2024

ozbek Jun 23, 2017

ozbek Jun 23, 2017

WailB Jun 23, 2017

mubashirhanif Jul 3, 2017

ozbek Jun 23, 2017

WailB commented Jun 23, 2017

WailB commented Jul 3, 2017

sanginovs commented Jul 24, 2021

		private static final int SPEECH_REQUEST_CODE = 0;
		private VoiceCommandsUtil voiceCom;

		@@ -118,6 +127,10 @@ public void onCreate(Bundle savedInstanceState) {
		(SlidingTabLayout) findViewById(R.id.indicator);
		indicator.setViewPager(pager);

Adding Voice Commands Feature #897

Are you sure you want to change the base?

Adding Voice Commands Feature #897

Conversation

WailB commented Jun 16, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ozbek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WailB commented Jun 23, 2017

WailB commented Jul 3, 2017

sanginovs commented Jul 24, 2021

WailB commented Jun 16, 2017 •

edited

Loading