refactor: move Sound.kt out of libanki

The equivalent to `sound.py` at Anki Desktop is actually SoundKt.kt, so there is no reason to keep `Sound.kt` at libanki
BrayanDSO · Dec 8, 2023 · 292490d · 292490d
1 parent 1747ac9
commit 292490d
Show file tree

Hide file tree

Showing 11 changed files with 21 additions and 26 deletions.
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/AbstractFlashcardViewer.kt b/AnkiDroid/src/main/java/com/ichi2/anki/AbstractFlashcardViewer.kt
@@ -56,6 +56,7 @@ import com.ichi2.anim.ActivityTransitionAnimation
 import com.ichi2.anim.ActivityTransitionAnimation.getInverseTransition
 import com.ichi2.anki.CollectionManager.TR
 import com.ichi2.anki.CollectionManager.withCol
+import com.ichi2.anki.Sound.OnErrorListener.ErrorHandling
 import com.ichi2.anki.UIUtils.showThemedToast
 import com.ichi2.anki.cardviewer.*
 import com.ichi2.anki.cardviewer.CardHtml.Companion.legacyGetTtsTags
@@ -87,9 +88,6 @@ import com.ichi2.compat.ResolveInfoFlagsCompat
 import com.ichi2.libanki.*
 import com.ichi2.libanki.Collection
 import com.ichi2.libanki.Consts.BUTTON_TYPE
-import com.ichi2.libanki.Sound.OnErrorListener.ErrorHandling
-import com.ichi2.libanki.Sound.SingleSoundSide
-import com.ichi2.libanki.Sound.SoundSide
 import com.ichi2.themes.Themes
 import com.ichi2.themes.Themes.getResFromAttr
 import com.ichi2.ui.FixedEditText

diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/MetaDB.kt b/AnkiDroid/src/main/java/com/ichi2/anki/MetaDB.kt
@@ -9,7 +9,6 @@ import androidx.annotation.WorkerThread
 import com.ichi2.anki.model.WhiteboardPenColor
 import com.ichi2.anki.model.WhiteboardPenColor.Companion.default
 import com.ichi2.libanki.DeckId
-import com.ichi2.libanki.Sound.SoundSide
 import com.ichi2.utils.KotlinCleanup
 import com.ichi2.widget.SmallWidgetStatus
 import timber.log.Timber

diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/ReadText.kt b/AnkiDroid/src/main/java/com/ichi2/anki/ReadText.kt
@@ -24,11 +24,11 @@ import android.speech.tts.UtteranceProgressListener
 import android.view.WindowManager.BadTokenException
 import androidx.annotation.VisibleForTesting
 import androidx.appcompat.app.AlertDialog
+import com.ichi2.anki.Sound.SoundSide
 import com.ichi2.anki.UIUtils.showThemedToast
 import com.ichi2.anki.snackbar.showSnackbar
 import com.ichi2.annotations.NeedsTest
 import com.ichi2.libanki.DeckId
-import com.ichi2.libanki.Sound.SoundSide
 import com.ichi2.libanki.TTSTag
 import com.ichi2.utils.HandlerUtils.postDelayedOnNewHandler
 import com.ichi2.utils.message

diff --git a/.../src/main/java/com/ichi2/libanki/Sound.kt → ...oid/src/main/java/com/ichi2/anki/Sound.kt b/.../src/main/java/com/ichi2/libanki/Sound.kt → ...oid/src/main/java/com/ichi2/anki/Sound.kt
@@ -15,7 +15,7 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.                           *
  ****************************************************************************************/
 
-package com.ichi2.libanki
+package com.ichi2.anki
 
 import android.content.Context
 import android.media.*
@@ -26,10 +26,8 @@ import androidx.annotation.CheckResult
 import androidx.annotation.VisibleForTesting
 import androidx.media.AudioFocusRequestCompat
 import androidx.media.AudioManagerCompat
-import com.ichi2.anki.AnkiDroidApp
-import com.ichi2.anki.ReadText
-import com.ichi2.libanki.Sound.OnErrorListener.ErrorHandling.CONTINUE_AUDIO
-import com.ichi2.libanki.Sound.SoundSide.*
+import com.ichi2.libanki.SoundOrVideoTag
+import com.ichi2.libanki.addPlayIcons
 import timber.log.Timber
 import java.util.*
 import java.util.regex.Pattern
@@ -80,8 +78,8 @@ class Sound(private val soundPlayer: SoundPlayer, private val soundDir: String)
     }
 
     private fun getSoundList(side: SoundSide): List<SoundPath> {
-        if (side == QUESTION_AND_ANSWER) {
-            return getSoundList(QUESTION) + getSoundList(ANSWER)
+        if (side == SoundSide.QUESTION_AND_ANSWER) {
+            return getSoundList(SoundSide.QUESTION) + getSoundList(SoundSide.ANSWER)
         }
         return soundPaths[side] ?: emptyList()
     }
@@ -178,9 +176,9 @@ class Sound(private val soundPlayer: SoundPlayer, private val soundDir: String)
         ReadText.stopTts() // TODO: Reconsider design
     }
 
-    fun hasQuestion(): Boolean = getSounds(QUESTION) != null
+    fun hasQuestion(): Boolean = getSounds(SoundSide.QUESTION) != null
 
-    fun hasAnswer(): Boolean = getSounds(ANSWER) != null
+    fun hasAnswer(): Boolean = getSounds(SoundSide.ANSWER) != null
 
     fun interface OnErrorListener {
         fun onError(mp: MediaPlayer?, which: Int, extra: Int, path: String?): ErrorHandling
@@ -294,7 +292,7 @@ open class SoundPlayer {
         val errorHandler = errorListener
             ?: Sound.OnErrorListener { _: MediaPlayer?, what: Int, extra: Int, _: String? ->
                 Timber.w("Media Error: (%d, %d). Calling OnCompletionListener", what, extra)
-                CONTINUE_AUDIO
+                Sound.OnErrorListener.ErrorHandling.CONTINUE_AUDIO
             }
         playSoundInternal(soundPath, completionListener, errorHandler)
     }
@@ -333,7 +331,7 @@ open class SoundPlayer {
                     )
                     // returning false calls onComplete()
                     return@setOnErrorListener when (errorHandling) {
-                        CONTINUE_AUDIO -> false
+                        Sound.OnErrorListener.ErrorHandling.CONTINUE_AUDIO -> false
                         Sound.OnErrorListener.ErrorHandling.RETRY_AUDIO -> {
                             playMedia()
                             true
@@ -370,7 +368,7 @@ open class SoundPlayer {
                         soundPath
                     )
                 ) {
-                    CONTINUE_AUDIO -> {
+                    Sound.OnErrorListener.ErrorHandling.CONTINUE_AUDIO -> {
                         Timber.d("Force playing next sound.")
                         completionListener.onCompletion(mMediaPlayer)
                     }

diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/cardviewer/CardHtml.kt b/AnkiDroid/src/main/java/com/ichi2/anki/cardviewer/CardHtml.kt
@@ -18,12 +18,13 @@ package com.ichi2.anki.cardviewer
 
 import android.content.Context
 import com.ichi2.anki.R
+import com.ichi2.anki.Sound
+import com.ichi2.anki.Sound.SingleSoundSide
+import com.ichi2.anki.Sound.SingleSoundSide.ANSWER
+import com.ichi2.anki.Sound.SingleSoundSide.QUESTION
 import com.ichi2.anki.TtsParser
 import com.ichi2.anki.cardviewer.CardAppearance.Companion.hasUserDefinedNightMode
 import com.ichi2.libanki.*
-import com.ichi2.libanki.Sound.SingleSoundSide
-import com.ichi2.libanki.Sound.SingleSoundSide.ANSWER
-import com.ichi2.libanki.Sound.SingleSoundSide.QUESTION
 import com.ichi2.libanki.template.MathJax
 import com.ichi2.themes.HtmlColors
 import com.ichi2.themes.Themes.currentTheme

diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/cardviewer/HtmlGenerator.kt b/AnkiDroid/src/main/java/com/ichi2/anki/cardviewer/HtmlGenerator.kt
@@ -20,11 +20,11 @@ import android.content.Context
 import android.content.res.Resources
 import androidx.annotation.CheckResult
 import anki.config.ConfigKey
+import com.ichi2.anki.Sound
 import com.ichi2.anki.preferences.sharedPrefs
 import com.ichi2.anki.reviewer.ReviewerCustomFonts
 import com.ichi2.libanki.Card
 import com.ichi2.libanki.Collection
-import com.ichi2.libanki.Sound
 import com.ichi2.libanki.stripAvRefs
 import timber.log.Timber
 import java.io.BufferedReader

diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/cardviewer/TTS.kt b/AnkiDroid/src/main/java/com/ichi2/anki/cardviewer/TTS.kt
@@ -22,8 +22,8 @@ import android.content.Context
 import com.ichi2.anki.CardUtils
 import com.ichi2.anki.R
 import com.ichi2.anki.ReadText
+import com.ichi2.anki.Sound.SoundSide
 import com.ichi2.libanki.Card
-import com.ichi2.libanki.Sound.SoundSide
 import com.ichi2.libanki.TTSTag
 import com.ichi2.libanki.Utils
 import com.ichi2.libanki.template.TemplateFilters

diff --git a/AnkiDroid/src/main/java/com/ichi2/libanki/TemplateManager.kt b/AnkiDroid/src/main/java/com/ichi2/libanki/TemplateManager.kt
@@ -22,7 +22,8 @@
 
 package com.ichi2.libanki
 
-import com.ichi2.libanki.Sound.Companion.SOUND_RE
+import com.ichi2.anki.Sound.Companion.SOUND_RE
+import com.ichi2.anki.VIDEO_EXTENSIONS
 import com.ichi2.libanki.TemplateManager.PartiallyRenderedCard.Companion.avTagsToNative
 import com.ichi2.libanki.backend.BackendUtils
 import com.ichi2.libanki.backend.model.toBackendNote

diff --git a/AnkiDroid/src/test/java/com/ichi2/anki/AbstractFlashcardViewerSoundRenderTest.kt b/AnkiDroid/src/test/java/com/ichi2/anki/AbstractFlashcardViewerSoundRenderTest.kt
@@ -18,7 +18,6 @@ package com.ichi2.anki
 
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import com.ichi2.anki.cardviewer.ViewerCommand
-import com.ichi2.libanki.Sound
 import net.ankiweb.rsdroid.RustCleanup
 import org.hamcrest.CoreMatchers.equalTo
 import org.hamcrest.MatcherAssert.assertThat

diff --git a/AnkiDroid/src/test/java/com/ichi2/anki/CardTemplatePreviewerTest.kt b/AnkiDroid/src/test/java/com/ichi2/anki/CardTemplatePreviewerTest.kt
@@ -23,7 +23,6 @@ import com.ichi2.anki.servicelayer.NoteService
 import com.ichi2.anki.servicelayer.NoteService.getFieldsAsBundleForPreview
 import com.ichi2.libanki.Card
 import com.ichi2.libanki.NotetypeJson
-import com.ichi2.libanki.Sound
 import com.ichi2.utils.KotlinCleanup
 import com.ichi2.utils.stringIterable
 import org.hamcrest.CoreMatchers.*

diff --git a/AnkiDroid/src/test/java/com/ichi2/anki/ReadTextTest.kt b/AnkiDroid/src/test/java/com/ichi2/anki/ReadTextTest.kt
@@ -21,7 +21,7 @@ import com.ichi2.anki.ReadText.closeForTests
 import com.ichi2.anki.ReadText.initializeTts
 import com.ichi2.anki.ReadText.releaseTts
 import com.ichi2.anki.ReadText.textToSpeech
-import com.ichi2.libanki.Sound.SoundSide.*
+import com.ichi2.anki.Sound.SoundSide.*
 import org.hamcrest.MatcherAssert.*
 import org.hamcrest.Matchers.*
 import org.junit.Before