0.2

Full Changelog: 0.1.1...0.2

---

Release Notes

Improved Command-Line Interface and API Key Handling

The command-line interface has been enhanced using the clap crate, introducing a new --apikey option. This allows users to provide their OpenAI API key directly through the command line, offering more flexibility in how the key is supplied. The program now intelligently retrieves the API key, first checking for the command-line argument and then falling back to the OPENAI_API_KEY environment variable. If neither is available, a clear error message guides users on how to provide the key.

Enhanced Default Settings and User Experience

To streamline the user experience, default values have been introduced for key parameters. The TTS model now defaults to "tts-1-hd", and the voice setting defaults to "fable". These sensible defaults allow users to quickly get started while still providing the option to customize these settings as needed.

Refactored Code Structure and Improved Readability

The main function has undergone significant restructuring to improve clarity and maintainability. Clear section comments have been added to delineate different stages of the process, such as input file handling, text chunking, audio generation, and file combination. This restructuring makes the code flow more logical and easier to follow.

Optimized Audio File Handling

The audio file combination process has been refined. The sorting logic has been improved to ensure that audio chunks are combined in the correct order, crucial for maintaining the integrity of the final output. Additionally, the output file has been renamed from "combined.flac" to the more intuitive "output.flac".

Progress Tracking and Error Handling

A placeholder for a progress bar has been added during audio generation, laying the groundwork for better progress tracking. This will provide users with real-time feedback on the conversion process. Error handling has also been improved, particularly around API requests and responses, ensuring that users receive clear feedback if issues arise during the text-to-speech conversion.

Documentation and Code Cleanup

In an effort to streamline the codebase, redundant function-level documentation has been removed for several internal functions. This change reduces code verbosity while maintaining essential documentation where needed. The overall effect is a cleaner, more maintainable codebase that remains well-documented at critical points.

These updates collectively enhance the usability, flexibility, and maintainability of the text-to-speech conversion tool, providing a more robust and user-friendly experience for both new and experienced users.

0.1.1

ttsrs v0.1.1 - First Release

This release marks the first stable version of ttsrs (Text-to-Speech Reading System), representing a significant milestone in the project's development and offering a fully functional and user-friendly experience.

---

Highlights

• Audio File Combination: Successfully implemented the feature to combine multiple audio files, resolving a major previous issue.
• Renamed to ttsrs: The project has been officially renamed to ttsrs, reflecting its purpose and functionality more accurately.
• Code Cleanup: Extensive refactoring and optimization to improve overall code quality and maintainability.

Changes

Added

• Functionality to merge multiple audio files into a single output.

Changed

• Project name updated to ttsrs across all references.
• Improved code structure and organization for better readability and maintenance.

Fixed

• Resolved issues related to audio file combination.

Notes

Version 0.1.1 of ttsrs represents a significant milestone in the project's development cycle. Considerable effort has been dedicated to refining and enhancing the core functionality, with a particular focus on resolving the critical issue of audio file combination. This feature now allows users to seamlessly merge multiple audio outputs into a single, cohesive file, greatly improving the overall user experience.

In addition to functional improvements, the codebase has undergone extensive cleanup and optimization. This effort has resulted in enhanced readability, improved maintainability, and a more robust foundation for future development. These improvements are expected to facilitate easier contributions from the open-source community and enable more rapid feature development in subsequent releases.

The decision to rename the project to ttsrs was made to better reflect its core purpose as a Text-to-Speech Reading System. This name change is expected to improve discoverability and provide clearer communication about the project's functionality to potential users.

With this release, ttsrs is considered fully functional and ready for practical application. It is anticipated that ttsrs will prove to be a valuable tool for individuals and organizations seeking a reliable text-to-speech solution.

Users are encouraged to explore the capabilities of ttsrs and provide feedback to help guide future development efforts.

Full Changelog: 0.1...0.1.1

0.1

Full Changelog: https://github.com/alexjsteffen/aiv-rs/commits/0.1