Skip to content

README.md

Latest commit

 

History

History
102 lines (76 loc) · 2.69 KB

README.md

File metadata and controls

102 lines (76 loc) · 2.69 KB

📁 Sample Files Directory

This directory contains sample audio and video files for testing the AI Subtitle Generator.

🎯 Purpose

Sample files in this directory are tracked by Git and can be used to:

  • Test the application functionality
  • Demonstrate usage examples
  • Provide quick test cases for development
  • Show expected output formats

📝 Supported File Types

Audio Formats

  • .mp3 - MPEG Audio Layer 3
  • .wav - Waveform Audio File
  • .m4a - MPEG-4 Audio
  • .flac - Free Lossless Audio Codec
  • .ogg - Ogg Vorbis
  • .wma - Windows Media Audio
  • .aac - Advanced Audio Coding

Video Formats

  • .mp4 - MPEG-4 Video (audio will be extracted)
  • .avi - Audio Video Interleave
  • .mov - QuickTime Movie
  • .mkv - Matroska Video

🚀 Usage Examples

Test with Sample Audio

# Using command line
python main.py samples/sample_audio.wav

# Using desktop app
python app.py
# Then drag samples/sample_audio.wav into the app

Test with Sample Video

# Using command line
python main.py samples/sample_video.mp4

# Using desktop app
python app.py
# Then drag samples/sample_video.mp4 into the app

📦 Adding Sample Files

Recommended Sample Files

  1. Short audio clips (30-60 seconds)

    • Clear speech
    • Minimal background noise
    • English language

  2. Sample video files (for MP4 testing)

    • Short videos with clear audio
    • Test MP4 conversion functionality

  3. Example output files (optional)

    • .srt files showing expected subtitle format
    • .txt files showing expected text format

🔍 Where to Get Sample Files

Free Sources

Create Your Own

  • Windows Voice Recorder: Built-in Windows app
  • FFmpeg: Extract audio from videos
  • Online converters: Convert between formats

⚠️ Important Notes

  • File Size: Keep sample files small (< 10 MB recommended)
  • License: Ensure sample files are free to use/distribute
  • Content: Use appropriate, non-copyrighted content
  • Git Tracking: Files in samples/ are tracked (unlike media files elsewhere)

📋 Example Structure

samples/
├── README.md (this file)
├── sample_audio.wav          # Short audio sample
├── sample_video.mp4         # Video sample for testing
├── example_output.srt       # Example subtitle output
└── example_output.txt       # Example text output

Note: Files in this directory are tracked by Git, while media files elsewhere in the project are ignored.