Merge pull request #63 from what3words/staging

Integrate OCR component 2.0.0

Author: phpduy

multi-component-sample/build.gradle

@@ -89,13 +89,13 @@ android {
 
 dependencies {
     // W3W API Map Lib
-    implementation "com.what3words:w3w-android-map-components:1.0.6"
+    implementation "com.what3words:w3w-android-map-components:1.0.7"
 
     // W3W Component Lib
     implementation "com.what3words:w3w-android-components:3.2.5"
 
     // W3W OCR Lib
-    implementation "com.what3words:w3w-android-ocr-components:1.1.1"
+    implementation "com.what3words:w3w-android-ocr-components:2.0.0"
 
     // Compose
     implementation platform("androidx.compose:compose-bom:2024.06.00")

multi-component-sample/src/main/java/com/what3words/samples/multiple/MultiComponentsActivity.kt

@@ -6,31 +6,40 @@ import androidx.activity.compose.setContent
 import androidx.activity.viewModels
 import androidx.compose.runtime.collectAsState
 import androidx.compose.runtime.getValue
+import com.google.mlkit.vision.text.TextRecognizerOptionsInterface.LATIN
 import com.what3words.androidwrapper.What3WordsV3
-import com.what3words.ocr.components.models.W3WOcrMLKitWrapper
-import com.what3words.ocr.components.models.W3WOcrWrapper
+import com.what3words.androidwrapper.datasource.text.W3WApiTextDataSource
+import com.what3words.core.datasource.image.W3WImageDataSource
+import com.what3words.core.datasource.text.W3WTextDataSource
+import com.what3words.ocr.components.datasource.W3WMLKitImageDataSource
 import com.what3words.samples.multiple.ui.screen.MainAppScreen
 
 class MultiComponentsActivity : ComponentActivity() {
     private val viewModel: MultiComponentsViewModel by viewModels()
-    private lateinit var ocrWrapper: W3WOcrWrapper
-    private val dataProvider by lazy {
-        What3WordsV3(
-            BuildConfig.W3W_API_KEY,
-            this
-        )
-    }
+    private lateinit var w3WImageDataSource: W3WImageDataSource
+    private lateinit var w3WTextDataSource: W3WTextDataSource
+    private lateinit var dataProvider: What3WordsV3
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
-        ocrWrapper = W3WOcrMLKitWrapper(context = this@MultiComponentsActivity)
+
+        w3WTextDataSource = W3WApiTextDataSource.create(this, BuildConfig.W3W_API_KEY)
+        w3WImageDataSource = W3WMLKitImageDataSource.create(
+            context = this,
+            recognizerOptions = LATIN
+        )
+        dataProvider = What3WordsV3(
+            BuildConfig.W3W_API_KEY,
+            this
+        )
 
         setContent {
             val selectedSuggestion by viewModel.selectedSuggestion.collectAsState()
 
             MainAppScreen(
+                w3WTextDataSource,
+                w3WImageDataSource,
                 dataProvider,
-                ocrWrapper,
                 true,
                 selectedSuggestion = selectedSuggestion,
                 onSuggestionChanged = {
@@ -39,9 +48,4 @@ class MultiComponentsActivity : ComponentActivity() {
             )
         }
     }
-
-    override fun onDestroy() {
-        super.onDestroy()
-        if (::ocrWrapper.isInitialized) ocrWrapper.stop()
-    }
 }

multi-component-sample/src/main/java/com/what3words/samples/multiple/ui/screen/MainAppScreen.kt

@@ -25,18 +25,21 @@ import androidx.constraintlayout.compose.Dimension
 import com.what3words.androidwrapper.What3WordsAndroidWrapper
 import com.what3words.components.maps.models.W3WMarkerColor
 import com.what3words.components.maps.wrappers.W3WMapWrapper
+import com.what3words.core.datasource.image.W3WImageDataSource
+import com.what3words.core.datasource.text.W3WTextDataSource
 import com.what3words.design.library.ui.theme.W3WTheme
 import com.what3words.javawrapper.response.SuggestionWithCoordinates
-import com.what3words.ocr.components.models.W3WOcrWrapper
 import com.what3words.samples.multiple.ui.screen.view.AutoTextField
 import com.what3words.samples.multiple.ui.screen.view.AutoTextFieldUIState
 import com.what3words.samples.multiple.ui.screen.view.MapWrapperView
 import com.what3words.samples.multiple.ui.screen.view.OcrView
+import com.what3words.samples.multiple.util.toSuggestionWithCoordinates
 
 @Composable
 fun MainAppScreen(
+    w3WTextDataSource: W3WTextDataSource,
+    w3WImageDataSource: W3WImageDataSource,
     dataProvider: What3WordsAndroidWrapper,
-    ocrWrapper: W3WOcrWrapper,
     isGoogleMapType: Boolean,
     selectedSuggestion: SuggestionWithCoordinates?,
     onSuggestionChanged: (SuggestionWithCoordinates?) -> (Unit)
@@ -75,11 +78,13 @@ fun MainAppScreen(
                 val (w3wTextFieldRef, mapRef, ocrRef, mapTypeRef, addMarkerRef) = createRefs()
 
                 OcrView(
-                    ocrWrapper,
-                    dataProvider,
+                    w3WTextDataSource = w3WTextDataSource,
+                    w3WImageDataSource = w3WImageDataSource,
                     scanScreenVisible = scanScreenVisible,
                     onScanScreenVisibleChange = { scanScreenVisible = it },
-                    onSuggestionScanned = onSuggestionChanged
+                    onSuggestionScanned = { w3wSuggestion ->
+                        onSuggestionChanged(w3wSuggestion.toSuggestionWithCoordinates())
+                    }
                 )
 
                 MapWrapperView(

multi-component-sample/src/main/java/com/what3words/samples/multiple/ui/screen/view/OCRView.kt

@@ -6,34 +6,29 @@ import androidx.compose.animation.expandVertically
 import androidx.compose.animation.shrinkVertically
 import androidx.compose.material3.MaterialTheme
 import androidx.compose.runtime.Composable
-import androidx.compose.runtime.remember
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.zIndex
-import com.what3words.androidwrapper.What3WordsAndroidWrapper
+import com.what3words.core.datasource.image.W3WImageDataSource
+import com.what3words.core.datasource.text.W3WTextDataSource
+import com.what3words.core.types.domain.W3WSuggestion
+import com.what3words.core.types.geometry.W3WCoordinates
+import com.what3words.core.types.options.W3WAutosuggestOptions
 import com.what3words.design.library.ui.components.What3wordsAddressListItemDefaults
 import com.what3words.design.library.ui.theme.w3wTypography
-import com.what3words.javawrapper.request.AutosuggestOptions
-import com.what3words.javawrapper.request.Coordinates
-import com.what3words.javawrapper.response.SuggestionWithCoordinates
 import com.what3words.ocr.components.R
-import com.what3words.ocr.components.models.W3WOcrWrapper
 import com.what3words.ocr.components.ui.W3WOcrScanner
 import com.what3words.ocr.components.ui.W3WOcrScannerDefaults
+import com.what3words.ocr.components.ui.rememberOcrScanManager
 
 
 @Composable
 fun OcrView(
-    ocrWrapper: W3WOcrWrapper,
-    dataProvider: What3WordsAndroidWrapper,
+    w3WImageDataSource: W3WImageDataSource,
+    w3WTextDataSource: W3WTextDataSource,
     scanScreenVisible: Boolean, onScanScreenVisibleChange: (Boolean) -> Unit,
-    onSuggestionScanned: (SuggestionWithCoordinates) -> (Unit)
+    onSuggestionScanned: (W3WSuggestion) -> (Unit)
 ) {
-    val options = remember {
-        AutosuggestOptions().apply {
-            focus = Coordinates(51.520847, -0.195521)
-        }
-    }
 
     AnimatedVisibility(
         visible = scanScreenVisible,
@@ -50,10 +45,24 @@ fun OcrView(
         )
     ) {
         W3WOcrScanner(
-            ocrWrapper,
-            dataProvider = dataProvider,
-            options = options,
-            returnCoordinates = true,
+            ocrScanManager = rememberOcrScanManager(
+                w3wImageDataSource = w3WImageDataSource,
+                w3wTextDataSource = w3WTextDataSource,
+                options = W3WAutosuggestOptions.Builder()
+                    .focus(W3WCoordinates(51.520847, -0.195521))
+                    .includeCoordinates(true)
+                    .build(),
+            ),
+            onDismiss = {
+                onScanScreenVisibleChange(false)
+            },
+            onSuggestionSelected = {
+                onSuggestionScanned(it)
+                onScanScreenVisibleChange(false)
+            },
+            onError = {
+                onScanScreenVisibleChange(false)
+            },
             //optional if you want to override any string of the scanner composable, to allow localisation and accessibility.
             scannerStrings = W3WOcrScannerDefaults.defaultStrings(
                 scanStateFoundTitle = stringResource(id = R.string.scan_state_found),
@@ -74,15 +83,6 @@ fun OcrView(
             suggestionTextStyles = What3wordsAddressListItemDefaults.defaultTextStyles(
                 wordsTextStyle = MaterialTheme.w3wTypography.titleMediumSemibold
             ),
-            onError = {
-                onScanScreenVisibleChange(false)
-            },
-            onDismiss = {
-                onScanScreenVisibleChange(false)
-            },
-            onSuggestionSelected = {
-                onSuggestionScanned(it)
-                onScanScreenVisibleChange(false)
-            })
+        )
     }
 }

multi-component-sample/src/main/java/com/what3words/samples/multiple/util/Mapper.kt

@@ -0,0 +1,37 @@
+package com.what3words.samples.multiple.util
+
+import com.what3words.core.types.domain.W3WSuggestion
+import com.what3words.core.types.geometry.km
+import com.what3words.javawrapper.response.Suggestion
+import com.what3words.javawrapper.response.SuggestionWithCoordinates
+
+/**
+ * Mapper from [W3WSuggestion] to [SuggestionWithCoordinates]. Throws an [IllegalArgumentException] if
+ * [W3WSuggestion] does not have coordinates
+ */
+@Throws(IllegalArgumentException::class)
+fun W3WSuggestion.toSuggestionWithCoordinates(): SuggestionWithCoordinates {
+    val w3wAddress = this.w3wAddress
+    val center = w3wAddress.center
+        ?: throw IllegalArgumentException("W3WSuggestion does not have coordinates")
+    val square = w3wAddress.square
+        ?: throw IllegalArgumentException("W3WSuggestion does not have coordinates")
+
+    return SuggestionWithCoordinates(
+        Suggestion(
+            w3wAddress.words,
+            w3wAddress.nearestPlace,
+            w3wAddress.country.twoLetterCode,
+            this.distanceToFocus?.km()?.toInt() ?: 0,
+            this.rank,
+            w3wAddress.language.w3wCode
+        ),
+        center.lat,
+        center.lng,
+        square.northeast.lat,
+        square.northeast.lng,
+        square.southwest.lat,
+        square.southwest.lng,
+    )
+}
+

ocr-sample/build.gradle

@@ -67,18 +67,24 @@ android {
 dependencies {
     // compose
     implementation platform("androidx.compose:compose-bom:2024.06.00")
-
     implementation "androidx.activity:activity-compose:1.9.1"
     implementation "androidx.compose.material3:material3"
     implementation "androidx.compose.ui:ui"
 
     // W3W API OCR Lib
-    implementation "com.what3words:w3w-android-ocr-components:1.1.1"
+    implementation "com.what3words:w3w-android-ocr-components:2.0.0-SNAPSHOT"
 
     // mlkit
-    implementation "com.google.android.gms:play-services-mlkit-text-recognition:19.0.0"
-    implementation "com.google.android.gms:play-services-mlkit-text-recognition-chinese:16.0.0"
-    implementation "com.google.android.gms:play-services-mlkit-text-recognition-devanagari:16.0.0"
-    implementation "com.google.android.gms:play-services-mlkit-text-recognition-japanese:16.0.0"
-    implementation "com.google.android.gms:play-services-mlkit-text-recognition-korean:16.0.0"
+    implementation "com.google.android.gms:play-services-mlkit-text-recognition:19.0.1"
+    implementation "com.google.android.gms:play-services-mlkit-text-recognition-chinese:16.0.1"
+    implementation "com.google.android.gms:play-services-mlkit-text-recognition-devanagari:16.0.1"
+    implementation "com.google.android.gms:play-services-mlkit-text-recognition-japanese:16.0.1"
+    implementation "com.google.android.gms:play-services-mlkit-text-recognition-korean:16.0.1"
+    implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.8.6'
+    implementation 'androidx.compose.ui:ui-graphics'
+    implementation 'androidx.compose.ui:ui-tooling-preview'
+    androidTestImplementation platform('androidx.compose:compose-bom:2024.04.01')
+    androidTestImplementation 'androidx.compose.ui:ui-test-junit4'
+    debugImplementation 'androidx.compose.ui:ui-tooling'
+    debugImplementation 'androidx.compose.ui:ui-test-manifest'
 }

ocr-sample/src/main/AndroidManifest.xml

@@ -15,9 +15,10 @@
         android:theme="@style/Theme.Ocrcomponentssample"
         tools:targetApi="31">
         <activity
-            android:name="com.what3words.samples.ocr.ComposeOcrScanPopupSampleActivity"
+            android:name=".OcrSampleActivity"
             android:exported="true"
-            android:label="@string/title_activity_main2" >
+            android:label="@string/title_activity_w3w_ocr_sample"
+            android:theme="@style/Theme.Ocrcomponentssample">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />