TTS: Add setSpeechRate, setLanguage APIs. Update .gitignore

[tuancoltech]

Text to Speech: Add setSpeechRate, setLanguage APIs. Update .gitignore

Summary by CodeRabbit

• New Features
  • Enhanced text-to-speech functionality now offers customizable speech rate settings for a smoother audio experience.
  • Users can now select their preferred language for voice output, providing a more personalized interaction with the text-to-speech feature.

[coderabbitai]

Walkthrough

This pull request extends text-to-speech functionality by adding methods to adjust speech parameters. New methods to set the speech rate and language have been introduced across multiple layers, including repository, local data source, and view model interfaces and implementations. Additionally, an entry to ignore macOS-generated .DS_Store files has been appended to the .gitignore.

Changes

File(s)	Change Summary
.gitignore	Added an entry to ignore .DS_Store files.
utils/.../TextToSpeechRepository.kt utils/.../TextToSpeechRepositoryImpl.kt	Added setSpeechRate(Float): Int and setLanguage(Locale?): Int methods in the interface and implementation, delegating calls to the local data source.
utils/.../LocalTextToSpeechDataSource.kt utils/.../LocalTextToSpeechDataSourceImpl.kt	Introduced setSpeechRate(Float): Int and setLanguage(Locale?): Int methods in the interface and its implementation, incorporating calls to adjust the text-to-speech engine.
utils/.../TextToSpeechViewModel.kt utils/.../TextToSpeechViewModelImpl.kt	Added methods for setting speech rate and language, with the implementation delegating these calls to the repository layer.

Sequence Diagram(s)

sequenceDiagram
  participant VM as TextToSpeechViewModelImpl
  participant Repo as TextToSpeechRepositoryImpl
  participant LS as LocalTextToSpeechDataSourceImpl
  participant TTS as TextToSpeech Engine
  VM->>Repo: setSpeechRate(speechRate)
  Repo->>LS: setSpeechRate(speechRate)
  LS->>TTS: adjust speech rate
  TTS-->>LS: return result
  LS-->>Repo: return result
  Repo-->>VM: return result

Loading

sequenceDiagram
  participant VM as TextToSpeechViewModelImpl
  participant Repo as TextToSpeechRepositoryImpl
  participant LS as LocalTextToSpeechDataSourceImpl
  participant TTS as TextToSpeech Engine
  VM->>Repo: setLanguage(locale)
  Repo->>LS: setLanguage(locale)
  LS->>TTS: update language
  TTS-->>LS: return result
  LS-->>Repo: return result
  Repo-->>VM: return result

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3208293 and 617c988.

📒 Files selected for processing (7)

• .gitignore (1 hunks)
• utils/src/main/java/ai/elimu/common/utils/data/repository/TextToSpeechRepository.kt (1 hunks)
• utils/src/main/java/ai/elimu/common/utils/data/repository/TextToSpeechRepositoryImpl.kt (2 hunks)
• utils/src/main/java/ai/elimu/common/utils/data/repository/local/LocalTextToSpeechDataSource.kt (2 hunks)
• utils/src/main/java/ai/elimu/common/utils/data/repository/local/LocalTextToSpeechDataSourceImpl.kt (2 hunks)
• utils/src/main/java/ai/elimu/common/utils/viewmodel/TextToSpeechViewModel.kt (2 hunks)
• utils/src/main/java/ai/elimu/common/utils/viewmodel/TextToSpeechViewModelImpl.kt (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: build (windows-latest, 21)
• GitHub Check: build (windows-latest, 17)
• GitHub Check: build (macos-latest, 17)

🔇 Additional comments (16)

.gitignore (1)

34-35: Approval: Correctly Added .DS_Store Ignore Entry

The addition of the .DS_Store line ensures that macOS system files are not tracked by Git, which is a standard best practice for cross-platform projects. This change integrates seamlessly with the existing ignore rules.

utils/src/main/java/ai/elimu/common/utils/data/repository/TextToSpeechRepository.kt (2)

5-5: Appropriate Locale import added.

The import for java.util.Locale is correctly added to support the new setLanguage method.

---

13-14: New TTS configuration methods added as expected.

The addition of setSpeechRate and setLanguage methods properly extends the interface to support the new functionality described in the PR objectives. The method signatures align with Android's TTS API conventions, using appropriate parameter types and returning an integer status code.

utils/src/main/java/ai/elimu/common/utils/viewmodel/TextToSpeechViewModel.kt (2)

5-5: Appropriate Locale import added.

The import for java.util.Locale is correctly added to support the new setLanguage method.

---

16-17: ViewModel interface properly extended with new TTS methods.

The addition of setSpeechRate and setLanguage methods correctly extends the ViewModel interface, maintaining architectural consistency with the corresponding repository layer. The method signatures match those defined in the repository interface.

utils/src/main/java/ai/elimu/common/utils/data/repository/local/LocalTextToSpeechDataSource.kt (2)

5-5: Appropriate Locale import added.

The import for java.util.Locale is correctly added to support the new setLanguage method.

---

16-17: Data source interface properly extended with new TTS methods.

The addition of setSpeechRate and setLanguage methods correctly extends the data source interface, maintaining consistency with the repository layer. The method signatures follow Android's TTS API conventions.

utils/src/main/java/ai/elimu/common/utils/data/repository/TextToSpeechRepositoryImpl.kt (3)

6-6: Appropriate Locale import added.

The import for java.util.Locale is correctly added to support the new setLanguage method implementation.

---

37-39: Well-implemented setSpeechRate method.

The setSpeechRate implementation correctly delegates to the local data source, following the established pattern in this class.

---

41-43: Well-implemented setLanguage method.

The setLanguage implementation correctly delegates to the local data source, maintaining consistency with other methods in this class.

utils/src/main/java/ai/elimu/common/utils/data/repository/local/LocalTextToSpeechDataSourceImpl.kt (3)

8-8: Import added correctly for Locale.

The addition of the java.util.Locale import is necessary for the new setLanguage method that accepts a Locale parameter.

---

39-41: Implementation of speech rate control looks good.

The implementation correctly delegates to the Android TextToSpeech API's setSpeechRate method and returns its result code.

Note that valid speech rate values in Android are typically between 0.0 and 2.0, with 1.0 being the normal rate. Consider documenting this range in a comment or validating the input parameter to ensure it falls within acceptable bounds.

---

43-45: Language setting implementation is appropriate.

The method correctly delegates to the Android TextToSpeech API's setLanguage method.

The return value from Android's setLanguage method indicates language availability status (like TextToSpeech.LANG_AVAILABLE, TextToSpeech.LANG_NOT_SUPPORTED, etc.). Consider documenting what these return codes mean or adding error handling for unsupported languages to improve the robustness of the implementation.

utils/src/main/java/ai/elimu/common/utils/viewmodel/TextToSpeechViewModelImpl.kt (3)

11-11: Import added correctly for Locale.

The addition of the java.util.Locale import is necessary for the new setLanguage method parameter.

---

99-101: Speech rate setter implementation is correct.

The implementation correctly delegates to the repository layer, maintaining the separation of concerns in the architecture.

Consider adding documentation comments for this method similar to the other methods in this class. The documentation should explain the purpose of the method, the expected parameter range (typically 0.0 to 2.0), and the meaning of the return value.

---

103-105: Language setter implementation is correct.

The implementation correctly delegates to the repository layer's setLanguage method.

Consider adding documentation comments for this method similar to the other methods in this class. The documentation should explain:

1. The purpose of the method
2. What happens when a null locale is passed
3. The meaning of the return codes (LANG_AVAILABLE, LANG_NOT_SUPPORTED, etc.)
4. Possible error scenarios when setting unsupported languages

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.