diff options
| author | jacksonfu14 <jackson@fashionunited.com> | 2025-11-17 06:56:09 +0100 |
|---|---|---|
| committer | Jackson Moore <jacksonmoore@tuta.io> | 2025-11-17 06:56:09 +0100 |
| commit | a20f9a327c4d9e5ac8f42db4e2e9fb29770c3d37 (patch) | |
| tree | 568c2650e8bf015b896f86297176a485b9bb5c08 /morphology-img/src/render.rs | |
| parent | 3077c7af770b055804d5cf48994a4e4cf6d31146 (diff) | |
feature: generate and process ly files
Diffstat (limited to 'morphology-img/src/render.rs')
| -rw-r--r-- | morphology-img/src/render.rs | 180 |
1 files changed, 180 insertions, 0 deletions
diff --git a/morphology-img/src/render.rs b/morphology-img/src/render.rs index cd5b293..189dd61 100644 --- a/morphology-img/src/render.rs +++ b/morphology-img/src/render.rs @@ -1 +1,181 @@ // LilyPond CLI invocation for SVG generation + +use std::process::Command; +use std::path::{Path, PathBuf}; +use std::fs; +use crate::error::RenderError; + +/// Checks if LilyPond is available on the system. +/// +/// This function attempts to run `lilypond --version` to detect if LilyPond +/// is installed and accessible in the system PATH. +/// +/// # Returns +/// - `Ok(version_string)` if LilyPond is found and responds successfully +/// - `Err(RenderError::LilyPondNotFound)` if LilyPond is not found or fails to execute +/// +/// # Examples +/// ```no_run +/// use morphology_img::render::check_lilypond_available; +/// +/// match check_lilypond_available() { +/// Ok(version) => println!("LilyPond is available: {}", version), +/// Err(e) => eprintln!("LilyPond not found: {}", e), +/// } +/// ``` +/// +/// # Installation Instructions +/// If LilyPond is not found, install it from: +/// - **macOS**: `brew install lilypond` +/// - **Ubuntu/Debian**: `sudo apt-get install lilypond` +/// - **Windows**: Download from <https://lilypond.org/download.html> +pub fn check_lilypond_available() -> Result<String, RenderError> { + let output = Command::new("lilypond") + .arg("--version") + .output(); + + match output { + Ok(output) => { + if output.status.success() { + let version = String::from_utf8_lossy(&output.stdout); + Ok(version.lines().next().unwrap_or("Unknown version").to_string()) + } else { + Err(RenderError::LilyPondNotFound( + "LilyPond command failed".to_string() + )) + } + } + Err(e) => { + Err(RenderError::LilyPondNotFound( + format!("LilyPond not found in PATH: {}. Please install LilyPond from https://lilypond.org", e) + )) + } + } +} + +/// Renders a single .ly file to SVG using LilyPond. +/// +/// This function invokes the LilyPond CLI to convert a LilyPond source file +/// into an SVG image. The SVG file will be created in the specified output directory. +/// +/// # Arguments +/// - `ly_file`: Path to the .ly file to render +/// - `output_dir`: Directory where the SVG should be created +/// - `lilypond_binary`: Path to the LilyPond binary (typically "lilypond") +/// +/// # Returns +/// Path to the generated SVG file +/// +/// # Errors +/// - `RenderError::FileIO` if the output directory cannot be created +/// - `RenderError::LilyPondExecution` if LilyPond fails to execute or produce output +/// - `RenderError::Template` if the .ly filename is invalid +/// +/// # Examples +/// ```no_run +/// use morphology_img::render::render_ly_to_svg; +/// use std::path::Path; +/// +/// let ly_file = Path::new("/tmp/sequence-0.ly"); +/// let output_dir = Path::new("output"); +/// let lilypond = Path::new("lilypond"); +/// +/// let svg_path = render_ly_to_svg(ly_file, output_dir, lilypond).unwrap(); +/// println!("Generated SVG: {}", svg_path.display()); +/// ``` +/// +/// # Notes +/// - LilyPond creates `filename.svg` from `filename.ly` in the output directory +/// - The function verifies that the expected SVG file was actually created +/// - LilyPond must be installed and the binary must be accessible +pub fn render_ly_to_svg( + ly_file: &Path, + output_dir: &Path, + lilypond_binary: &Path, +) -> Result<PathBuf, RenderError> { + // Ensure output directory exists + fs::create_dir_all(output_dir)?; + + // Build the command: lilypond --svg -o output_dir ly_file + let output = Command::new(lilypond_binary) + .arg("--svg") + .arg("-o") + .arg(output_dir) + .arg(ly_file) + .output()?; + + if !output.status.success() { + let stderr = String::from_utf8_lossy(&output.stderr); + return Err(RenderError::LilyPondExecution(stderr.to_string())); + } + + // Determine the output SVG path + // LilyPond creates filename.svg from filename.ly + let svg_filename = ly_file + .file_stem() + .ok_or_else(|| RenderError::Template("Invalid .ly filename".to_string()))? + .to_string_lossy() + .to_string() + ".svg"; + + let svg_path = output_dir.join(svg_filename); + + // Verify the SVG was created + if !svg_path.exists() { + return Err(RenderError::LilyPondExecution( + format!("Expected SVG not created: {}", svg_path.display()) + )); + } + + Ok(svg_path) +} + +/// Renders multiple .ly files to SVGs using LilyPond. +/// +/// This function processes multiple LilyPond source files sequentially, +/// converting each to an SVG image in the specified output directory. +/// +/// # Arguments +/// - `ly_files`: Paths to the .ly files to render +/// - `output_dir`: Directory where SVGs should be created +/// - `lilypond_binary`: Path to the LilyPond binary +/// +/// # Returns +/// Vector of paths to generated SVG files, in the same order as input +/// +/// # Errors +/// Returns an error if any file fails to render. Processing stops at the first error. +/// +/// # Examples +/// ```no_run +/// use morphology_img::render::render_ly_files_to_svg; +/// use std::path::{Path, PathBuf}; +/// +/// let ly_files = vec![ +/// PathBuf::from("/tmp/sequence-0.ly"), +/// PathBuf::from("/tmp/sequence-1.ly"), +/// ]; +/// let output_dir = Path::new("output"); +/// let lilypond = Path::new("lilypond"); +/// +/// let svg_paths = render_ly_files_to_svg(&ly_files, output_dir, lilypond).unwrap(); +/// println!("Generated {} SVG files", svg_paths.len()); +/// ``` +/// +/// # Notes +/// - Files are processed sequentially (not in parallel) +/// - All SVGs are created in the same output directory +/// - If any file fails, an error is returned immediately +pub fn render_ly_files_to_svg( + ly_files: &[PathBuf], + output_dir: &Path, + lilypond_binary: &Path, +) -> Result<Vec<PathBuf>, RenderError> { + let mut svg_paths = Vec::with_capacity(ly_files.len()); + + for ly_file in ly_files { + let svg_path = render_ly_to_svg(ly_file, output_dir, lilypond_binary)?; + svg_paths.push(svg_path); + } + + Ok(svg_paths) +} |