oximedia-cli 0.1.4

Command-line interface for OxiMedia
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
//! Metadata editing and management for media files.
//!
//! Provides functionality to read, edit, and manage metadata/tags
//! in media files including title, artist, album, cover art, etc.

use anyhow::{anyhow, Context, Result};
use colored::Colorize;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::path::{Path, PathBuf};
use tracing::{debug, info};

/// Options for metadata operations.
#[derive(Debug, Clone)]
pub struct MetadataOptions {
    pub input: PathBuf,
    pub output: Option<PathBuf>,
    pub operation: MetadataOperation,
    pub json_output: bool,
}

/// Type of metadata operation to perform.
#[derive(Debug, Clone)]
pub enum MetadataOperation {
    /// Show metadata
    Show,
    /// Set metadata fields
    Set { fields: HashMap<String, String> },
    /// Remove specific metadata fields
    Remove { fields: Vec<String> },
    /// Clear all metadata
    Clear,
    /// Copy metadata from another file
    Copy { source: PathBuf },
}

/// Metadata container for a media file.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MediaMetadata {
    /// Basic information
    pub title: Option<String>,
    pub artist: Option<String>,
    pub album: Option<String>,
    pub album_artist: Option<String>,
    pub genre: Option<String>,
    pub year: Option<u32>,
    pub track_number: Option<u32>,
    pub disc_number: Option<u32>,

    /// Extended information
    pub comment: Option<String>,
    pub composer: Option<String>,
    pub publisher: Option<String>,
    pub copyright: Option<String>,
    pub encoder: Option<String>,
    pub creation_time: Option<String>,

    /// Custom tags
    #[serde(skip_serializing_if = "HashMap::is_empty", default)]
    pub custom: HashMap<String, String>,
}

impl Default for MediaMetadata {
    fn default() -> Self {
        Self {
            title: None,
            artist: None,
            album: None,
            album_artist: None,
            genre: None,
            year: None,
            track_number: None,
            disc_number: None,
            comment: None,
            composer: None,
            publisher: None,
            copyright: None,
            encoder: None,
            creation_time: None,
            custom: HashMap::new(),
        }
    }
}

impl MediaMetadata {
    /// Set a metadata field by name.
    pub fn set_field(&mut self, key: &str, value: String) -> Result<()> {
        match key.to_lowercase().as_str() {
            "title" => self.title = Some(value),
            "artist" => self.artist = Some(value),
            "album" => self.album = Some(value),
            "album_artist" | "albumartist" => self.album_artist = Some(value),
            "genre" => self.genre = Some(value),
            "year" => {
                let year: u32 = value.parse().context("Invalid year value")?;
                self.year = Some(year);
            }
            "track" | "track_number" => {
                let track: u32 = value.parse().context("Invalid track number")?;
                self.track_number = Some(track);
            }
            "disc" | "disc_number" => {
                let disc: u32 = value.parse().context("Invalid disc number")?;
                self.disc_number = Some(disc);
            }
            "comment" => self.comment = Some(value),
            "composer" => self.composer = Some(value),
            "publisher" => self.publisher = Some(value),
            "copyright" => self.copyright = Some(value),
            "encoder" => self.encoder = Some(value),
            "creation_time" => self.creation_time = Some(value),
            _ => {
                // Custom field
                self.custom.insert(key.to_string(), value);
            }
        }
        Ok(())
    }

    /// Remove a metadata field by name.
    pub fn remove_field(&mut self, key: &str) {
        match key.to_lowercase().as_str() {
            "title" => self.title = None,
            "artist" => self.artist = None,
            "album" => self.album = None,
            "album_artist" | "albumartist" => self.album_artist = None,
            "genre" => self.genre = None,
            "year" => self.year = None,
            "track" | "track_number" => self.track_number = None,
            "disc" | "disc_number" => self.disc_number = None,
            "comment" => self.comment = None,
            "composer" => self.composer = None,
            "publisher" => self.publisher = None,
            "copyright" => self.copyright = None,
            "encoder" => self.encoder = None,
            "creation_time" => self.creation_time = None,
            _ => {
                self.custom.remove(key);
            }
        }
    }

    /// Clear all metadata.
    pub fn clear(&mut self) {
        *self = Self::default();
    }

    /// Check if metadata is empty.
    pub fn is_empty(&self) -> bool {
        self.title.is_none()
            && self.artist.is_none()
            && self.album.is_none()
            && self.album_artist.is_none()
            && self.genre.is_none()
            && self.year.is_none()
            && self.track_number.is_none()
            && self.disc_number.is_none()
            && self.comment.is_none()
            && self.composer.is_none()
            && self.publisher.is_none()
            && self.copyright.is_none()
            && self.encoder.is_none()
            && self.creation_time.is_none()
            && self.custom.is_empty()
    }
}

/// Main metadata management function.
pub async fn manage_metadata(options: MetadataOptions) -> Result<()> {
    info!("Starting metadata operation");
    debug!("Metadata options: {:?}", options);

    // Validate input
    validate_input(&options.input).await?;

    // Perform operation
    match &options.operation {
        MetadataOperation::Show => show_metadata(&options).await,
        MetadataOperation::Set { fields } => set_metadata(&options, fields).await,
        MetadataOperation::Remove { fields } => remove_metadata(&options, fields).await,
        MetadataOperation::Clear => clear_metadata(&options).await,
        MetadataOperation::Copy { source } => copy_metadata(&options, source).await,
    }
}

/// Validate input file exists and is readable.
async fn validate_input(path: &Path) -> Result<()> {
    if !path.exists() {
        return Err(anyhow!("Input file does not exist: {}", path.display()));
    }

    if !path.is_file() {
        return Err(anyhow!("Input path is not a file: {}", path.display()));
    }

    Ok(())
}

/// Show metadata from a file.
async fn show_metadata(options: &MetadataOptions) -> Result<()> {
    info!("Reading metadata from {}", options.input.display());

    let metadata = read_metadata(&options.input).await?;

    if options.json_output {
        println!("{}", serde_json::to_string_pretty(&metadata)?);
    } else {
        print_metadata_pretty(&metadata, &options.input);
    }

    Ok(())
}

/// Set metadata fields in a file.
async fn set_metadata(options: &MetadataOptions, fields: &HashMap<String, String>) -> Result<()> {
    info!("Setting metadata fields");

    let mut metadata = read_metadata(&options.input).await?;

    // Apply changes
    for (key, value) in fields {
        debug!("Setting {}: {}", key, value);
        metadata.set_field(key, value.clone())?;
    }

    // Write metadata
    let output = options.output.as_ref().unwrap_or(&options.input);
    write_metadata(output, &metadata).await?;

    if !options.json_output {
        println!("{}", "Metadata updated successfully".green().bold());
        println!("{:20} {}", "Output file:", output.display());
    }

    Ok(())
}

/// Remove metadata fields from a file.
async fn remove_metadata(options: &MetadataOptions, fields: &[String]) -> Result<()> {
    info!("Removing metadata fields");

    let mut metadata = read_metadata(&options.input).await?;

    // Remove fields
    for field in fields {
        debug!("Removing field: {}", field);
        metadata.remove_field(field);
    }

    // Write metadata
    let output = options.output.as_ref().unwrap_or(&options.input);
    write_metadata(output, &metadata).await?;

    if !options.json_output {
        println!("{}", "Metadata fields removed successfully".green().bold());
        println!("{:20} {}", "Output file:", output.display());
    }

    Ok(())
}

/// Clear all metadata from a file.
async fn clear_metadata(options: &MetadataOptions) -> Result<()> {
    info!("Clearing all metadata");

    let mut metadata = MediaMetadata::default();
    metadata.clear();

    let output = options.output.as_ref().unwrap_or(&options.input);
    write_metadata(output, &metadata).await?;

    if !options.json_output {
        println!("{}", "All metadata cleared".green().bold());
        println!("{:20} {}", "Output file:", output.display());
    }

    Ok(())
}

/// Copy metadata from one file to another.
async fn copy_metadata(options: &MetadataOptions, source: &Path) -> Result<()> {
    info!(
        "Copying metadata from {} to {}",
        source.display(),
        options.input.display()
    );

    validate_input(source).await?;

    let metadata = read_metadata(source).await?;
    let output = options.output.as_ref().unwrap_or(&options.input);
    write_metadata(output, &metadata).await?;

    if !options.json_output {
        println!("{}", "Metadata copied successfully".green().bold());
        println!("{:20} {}", "Source:", source.display());
        println!("{:20} {}", "Destination:", output.display());
    }

    Ok(())
}

/// Sidecar file extension used to persist metadata alongside media files.
const METADATA_SIDECAR_EXT: &str = "oxmeta";

/// Derive the path of the JSON sidecar file for a given media path.
fn sidecar_path(media_path: &Path) -> PathBuf {
    let mut p = media_path.to_path_buf();
    p.set_extension(METADATA_SIDECAR_EXT);
    p
}

/// Read metadata from a file.
///
/// If a JSON sidecar file (`.oxmeta`) exists alongside the media file it is
/// deserialised and returned.  Otherwise a default `MediaMetadata` struct is
/// returned, pre-populated with information that can be derived purely from
/// the filesystem (filename → title, file modification time → creation_time).
async fn read_metadata(path: &Path) -> Result<MediaMetadata> {
    debug!("Reading metadata from {}", path.display());

    // Check for a sidecar JSON file written by a previous `set` operation
    let sidecar = sidecar_path(path);
    if sidecar.exists() {
        debug!("Found metadata sidecar: {}", sidecar.display());
        let json = tokio::fs::read_to_string(&sidecar)
            .await
            .with_context(|| format!("Failed to read metadata sidecar {}", sidecar.display()))?;
        let metadata: MediaMetadata =
            serde_json::from_str(&json).context("Failed to parse metadata sidecar")?;
        return Ok(metadata);
    }

    // No sidecar: synthesise basic metadata from filesystem information
    let mut metadata = MediaMetadata::default();

    // Use the file stem as a default title
    if let Some(stem) = path.file_stem().and_then(|s| s.to_str()) {
        metadata.title = Some(stem.to_string());
    }

    // Record the encoder / tool that produced this metadata
    metadata.encoder = Some("OxiMedia".to_string());

    // Use the file's last-modified time as a creation_time hint
    if let Ok(fs_meta) = tokio::fs::metadata(path).await {
        if let Ok(modified) = fs_meta.modified() {
            // Convert SystemTime to a simple RFC-3339-ish string without extra deps
            let duration_since_epoch = modified
                .duration_since(std::time::UNIX_EPOCH)
                .unwrap_or_default();
            let secs = duration_since_epoch.as_secs();
            // Format as seconds-since-epoch (a real implementation would use chrono)
            metadata.creation_time = Some(format!("{}", secs));
        }
    }

    info!(
        "Metadata synthesised from filesystem for {}",
        path.display()
    );
    Ok(metadata)
}

/// Write metadata to a file.
///
/// Serialises `metadata` to a JSON sidecar file (`.oxmeta`) placed next to the
/// target media file.  This is a non-destructive approach that avoids modifying
/// the original container while still persisting edits across CLI invocations.
async fn write_metadata(path: &Path, metadata: &MediaMetadata) -> Result<()> {
    debug!("Writing metadata to {}", path.display());

    // Ensure parent directory exists
    if let Some(parent) = path.parent() {
        if !parent.as_os_str().is_empty() && !parent.exists() {
            tokio::fs::create_dir_all(parent)
                .await
                .context("Failed to create output directory")?;
        }
    }

    // Serialise metadata to JSON sidecar
    let sidecar = sidecar_path(path);
    let json =
        serde_json::to_string_pretty(metadata).context("Failed to serialise metadata to JSON")?;
    tokio::fs::write(&sidecar, json)
        .await
        .with_context(|| format!("Failed to write metadata sidecar {}", sidecar.display()))?;

    debug!("Metadata written to sidecar: {}", sidecar.display());
    Ok(())
}

/// Print metadata in a human-readable format.
fn print_metadata_pretty(metadata: &MediaMetadata, path: &Path) {
    println!("{}", "Media Metadata".cyan().bold());
    println!("{}", "=".repeat(60));
    println!("{:20} {}", "File:", path.display());
    println!();

    if metadata.is_empty() {
        println!("{}", "No metadata found".yellow());
    } else {
        println!("{}", "Basic Information:".green().bold());
        print_field("Title", &metadata.title);
        print_field("Artist", &metadata.artist);
        print_field("Album", &metadata.album);
        print_field("Album Artist", &metadata.album_artist);
        print_field("Genre", &metadata.genre);

        if let Some(year) = metadata.year {
            println!("{:20} {}", "Year:", year);
        }
        if let Some(track) = metadata.track_number {
            println!("{:20} {}", "Track Number:", track);
        }
        if let Some(disc) = metadata.disc_number {
            println!("{:20} {}", "Disc Number:", disc);
        }

        let has_extended = metadata.comment.is_some()
            || metadata.composer.is_some()
            || metadata.publisher.is_some()
            || metadata.copyright.is_some()
            || metadata.encoder.is_some()
            || metadata.creation_time.is_some();

        if has_extended {
            println!();
            println!("{}", "Extended Information:".green().bold());
            print_field("Comment", &metadata.comment);
            print_field("Composer", &metadata.composer);
            print_field("Publisher", &metadata.publisher);
            print_field("Copyright", &metadata.copyright);
            print_field("Encoder", &metadata.encoder);
            print_field("Creation Time", &metadata.creation_time);
        }

        if !metadata.custom.is_empty() {
            println!();
            println!("{}", "Custom Tags:".green().bold());
            for (key, value) in &metadata.custom {
                println!("{:20} {}", format!("{}:", key), value);
            }
        }
    }

    println!("{}", "=".repeat(60));
}

/// Helper function to print optional metadata field.
fn print_field(label: &str, value: &Option<String>) {
    if let Some(v) = value {
        println!("{:20} {}", format!("{}:", label), v);
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_set_field() {
        let mut metadata = MediaMetadata::default();

        metadata
            .set_field("title", "Test Title".to_string())
            .expect("set_field should succeed");
        assert_eq!(metadata.title, Some("Test Title".to_string()));

        metadata
            .set_field("year", "2024".to_string())
            .expect("set_field should succeed");
        assert_eq!(metadata.year, Some(2024));

        metadata
            .set_field("custom_tag", "Custom Value".to_string())
            .expect("set_field should succeed");
        assert_eq!(
            metadata.custom.get("custom_tag"),
            Some(&"Custom Value".to_string())
        );
    }

    #[test]
    fn test_remove_field() {
        let mut metadata = MediaMetadata::default();
        metadata.title = Some("Title".to_string());
        metadata.artist = Some("Artist".to_string());

        metadata.remove_field("title");
        assert_eq!(metadata.title, None);
        assert_eq!(metadata.artist, Some("Artist".to_string()));
    }

    #[test]
    fn test_clear() {
        let mut metadata = MediaMetadata::default();
        metadata.title = Some("Title".to_string());
        metadata.artist = Some("Artist".to_string());

        metadata.clear();
        assert!(metadata.is_empty());
    }

    #[test]
    fn test_is_empty() {
        let metadata = MediaMetadata::default();
        assert!(metadata.is_empty());

        let mut metadata_with_data = MediaMetadata::default();
        metadata_with_data.title = Some("Title".to_string());
        assert!(!metadata_with_data.is_empty());
    }
}