HenestrosaDev
commented
1 month ago Thank you for the thorough description of the feature! I can definitely see it being implemented into the project, so I'll add it to the roadmap and work on it whenever I have the time. However, I I'm not going to include the checkbox to let the user choose the extension of the file. What I'll do instead is save the .txt file by default if the checkbox is checked, and then also save the subtitle files automatically if the Generate subtitles checkbox is checked. I think it's more convenient this way.
As for transcribing multiple files, I'm not quite sure about how to include it in the program, as I originally planned to transcribe one file at a time. I'll have to figure out how to include the option according to the current structure of the project.
1angstrom
TienNM
pordeciralgo
Overview
I propose a checkbox that saves a srt, vrt, or txt file automatically in the directory (assuming it isn't overwriting an existing file with the same name) as soon as the transcription of a file is complete.
Motivation
The problem that this solves is not necessarily for one-off files. But if in the future a feature is added that allows transcription of multiple files at once this would be extremely useful.
Proposal
The way to implement this would likely be an additional checkbox on the GUI that asks the user if they want to autosave the transcript and in what formats they want autosaved. Before saving there should be a check to see if there is an existing file with the same name. An additional checkbox could be added to either always overwrite, with the default being to not overwrite any files with the same name.
Alternatives Considered
None. I'm open to hearing what others think of though
Additional Context
As stated above, I think that the greatest advantage of this feature would be if additional functionality gets added in the future that transcribes multiple files at once.
Next Steps
I am unfamiliar with how to go about executing the next steps myself but after messing around with chat GPT this is what it thinks the best next steps are:
Technical Implementation Details
Add Checkboxes to the GUI: Create a new checkbox labeled "Autosave Transcript" in the transcription settings panel. Add additional checkboxes or a dropdown menu for selecting the file formats (SRT, VRT, TXT) for autosaving. Add a checkbox labeled "Overwrite Existing Files" with a default setting of not overwriting existing files.
Pseudocode for GUI elements
autosave_checkbox = CheckBox("Autosave Transcript") format_checkbox_srt = CheckBox("Save as SRT") format_checkbox_vrt = CheckBox("Save as VRT") format_checkbox_txt = CheckBox("Save as TXT") overwrite_checkbox = CheckBox("Overwrite Existing Files", default=False)
settings_panel.add(autosave_checkbox) settings_panel.add(format_checkbox_srt) settings_panel.add(format_checkbox_vrt) settings_panel.add(format_checkbox_txt) settings_panel.add(overwrite_checkbox)
Determine File Path and Name: Construct the file path based on the directory where the original file is located and append the appropriate file extension for the selected formats.
Pseudocode
def get_file_path(original_file_path, extension): directory = os.path.dirname(original_file_path) base_name = os.path.splitext(os.path.basename(original_file_path))[0] return os.path.join(directory, f"{base_name}.{extension}") Check for Existing Files: Before saving, check if a file with the same name already exists in the directory. If the "Overwrite Existing Files" checkbox is not selected and a file exists, generate a new file name or skip saving. python
Pseudocode
def check_and_save_file(file_path, content, overwrite): if os.path.exists(file_path): if overwrite: save_file(file_path, content) else: new_file_path = generate_unique_filename(file_path) save_file(new_file_path, content) else: save_file(file_path, content)
def generate_unique_filename(file_path): base, extension = os.path.splitext(file_path) counter = 1 new_filepath = f"{base}{counter}{extension}" while os.path.exists(new_file_path): counter += 1 new_filepath = f"{base}{counter}{extension}" return new_file_path
3. Saving the Transcription:
Function to Save Files: Implement the logic to save the transcription content into the specified file formats.
Pseudocode
def save_file(file_path, content): with open(file_path, 'w') as file: file.write(content)
def autosave_transcription(original_file_path, transcript, formats, overwrite): for fmt in formats: file_path = get_file_path(original_file_path, fmt) check_and_save_file(file_path, transcript, overwrite)
Hook into the Transcription Process: Modify the transcription process to include a call to the autosave function when the transcription is complete.
Pseudocode
def on_transcription_complete(original_file_path, transcript): if autosave_checkbox.is_checked(): selected_formats = [] if format_checkbox_srt.is_checked(): selected_formats.append('srt') if format_checkbox_vrt.is_checked(): selected_formats.append('vrt') if format_checkbox_txt.is_checked(): selected_formats.append('txt')
Unit Tests: Write unit tests to validate the file saving logic, including scenarios with existing files and different user preferences for overwriting.
Pseudocode
def test_generate_unique_filename():
Add tests to validate unique file name generation
def test_check_and_save_file():
Add tests to validate file saving logic with and without overwriting
def test_autosave_transcription():
Add tests to validate the autosave functionality for different formats
Update User Guide: Include instructions and screenshots in the user guide to explain how to use the new autosave feature and configure the settings.