oximedia-metering 0.1.8

Professional broadcast audio metering: ITU-R BS.1770-4, EBU R128, ATSC A/85
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
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
//! Comprehensive metering reports and compliance documentation.
//!
//! Generates detailed reports for broadcast delivery, QC, and archival purposes.

use crate::{
    atsc::{AtscA85Compliance, ATSC_MAX_TRUEPEAK_DBTP, ATSC_TARGET_LKFS, ATSC_TOLERANCE_DB},
    ebu::{EbuR128Compliance, EBU_MAX_TRUEPEAK_DBTP, EBU_TARGET_LUFS, EBU_TOLERANCE_LU},
    ComplianceResult, LoudnessMetrics, Standard,
};
use std::fmt;

/// Comprehensive loudness report.
#[derive(Clone, Debug)]
pub struct LoudnessReport {
    /// Loudness metrics.
    pub metrics: LoudnessMetrics,
    /// Compliance result.
    pub compliance: ComplianceResult,
    /// Duration in seconds.
    pub duration_seconds: f64,
    /// Report timestamp.
    pub timestamp: String,
}

impl LoudnessReport {
    /// Create a new loudness report.
    pub fn new(
        metrics: LoudnessMetrics,
        compliance: ComplianceResult,
        duration_seconds: f64,
    ) -> Self {
        let timestamp = chrono::Local::now().format("%Y-%m-%d %H:%M:%S").to_string();

        Self {
            metrics,
            compliance,
            duration_seconds,
            timestamp,
        }
    }

    /// Format as text report.
    pub fn to_text(&self) -> String {
        let mut report = String::new();

        report.push_str("═══════════════════════════════════════════════════════════\n");
        report.push_str("  LOUDNESS MEASUREMENT REPORT\n");
        report.push_str("═══════════════════════════════════════════════════════════\n");
        report.push('\n');
        report.push_str(&format!("Report Date: {}\n", self.timestamp));
        report.push_str(&format!("Standard: {}\n", self.compliance.standard.name()));
        report.push_str(&format!(
            "Duration: {:.2} seconds ({:.2} minutes)\n",
            self.duration_seconds,
            self.duration_seconds / 60.0
        ));
        report.push('\n');

        report.push_str("───────────────────────────────────────────────────────────\n");
        report.push_str("  LOUDNESS MEASUREMENTS\n");
        report.push_str("───────────────────────────────────────────────────────────\n");
        report.push('\n');

        report.push_str("Integrated Loudness:\n");
        report.push_str(&format!(
            "  Measured:  {:>7.1} LUFS\n",
            self.metrics.integrated_lufs
        ));
        report.push_str(&format!(
            "  Target:    {:>7.1} LUFS\n",
            self.compliance.target_lufs
        ));
        report.push_str(&format!(
            "  Deviation: {:>+7.1} LU\n",
            self.compliance.deviation_lu
        ));
        report.push_str(&format!(
            "  Status:    {}\n",
            if self.compliance.loudness_compliant {
                "✓ PASS"
            } else {
                "✗ FAIL"
            }
        ));
        report.push('\n');

        report.push_str("Momentary Loudness (400ms):\n");
        report.push_str(&format!(
            "  Current:   {:>7.1} LUFS\n",
            self.metrics.momentary_lufs
        ));
        report.push_str(&format!(
            "  Maximum:   {:>7.1} LUFS\n",
            self.metrics.max_momentary
        ));
        report.push('\n');

        report.push_str("Short-term Loudness (3s):\n");
        report.push_str(&format!(
            "  Current:   {:>7.1} LUFS\n",
            self.metrics.short_term_lufs
        ));
        report.push_str(&format!(
            "  Maximum:   {:>7.1} LUFS\n",
            self.metrics.max_short_term
        ));
        report.push('\n');

        report.push_str("Loudness Range (LRA):\n");
        report.push_str(&format!(
            "  Measured:  {:>7.1} LU\n",
            self.metrics.loudness_range
        ));
        report.push_str(&format!(
            "  Status:    {}\n",
            if self.compliance.lra_acceptable {
                "✓ PASS"
            } else {
                "⚠ WARNING"
            }
        ));
        report.push('\n');

        report.push_str("───────────────────────────────────────────────────────────\n");
        report.push_str("  TRUE PEAK MEASUREMENTS\n");
        report.push_str("───────────────────────────────────────────────────────────\n");
        report.push('\n');

        report.push_str("True Peak:\n");
        report.push_str(&format!(
            "  Measured:  {:>7.1} dBTP\n",
            self.metrics.true_peak_dbtp
        ));
        report.push_str(&format!(
            "  Maximum:   {:>7.1} dBTP\n",
            self.compliance.max_peak_dbtp
        ));
        report.push_str(&format!(
            "  Status:    {}\n",
            if self.compliance.peak_compliant {
                "✓ PASS"
            } else {
                "✗ FAIL"
            }
        ));
        report.push('\n');

        if !self.metrics.channel_peaks_dbtp.is_empty() {
            report.push_str("Per-Channel True Peaks:\n");
            for (ch, &peak) in self.metrics.channel_peaks_dbtp.iter().enumerate() {
                report.push_str(&format!("  Channel {}: {:>7.1} dBTP\n", ch + 1, peak));
            }
            report.push('\n');
        }

        report.push_str("───────────────────────────────────────────────────────────\n");
        report.push_str("  COMPLIANCE SUMMARY\n");
        report.push_str("───────────────────────────────────────────────────────────\n");
        report.push('\n');

        report.push_str(&format!(
            "Overall Status: {}\n",
            if self.compliance.is_compliant() {
                "✓ COMPLIANT"
            } else {
                "✗ NON-COMPLIANT"
            }
        ));
        report.push('\n');

        if !self.compliance.is_compliant() {
            report.push_str("Recommended Actions:\n");
            let gain = self.compliance.recommended_gain_db();
            if gain.abs() > 0.1 {
                report.push_str(&format!(
                    "  • Adjust gain by {gain:+.1} dB to meet target loudness\n"
                ));
            }
            if !self.compliance.peak_compliant {
                report.push_str("  • Apply limiting to reduce true peak\n");
            }
            if !self.compliance.lra_acceptable {
                report.push_str("  • Review dynamic range compression settings\n");
            }
            report.push('\n');
        }

        report.push_str("═══════════════════════════════════════════════════════════\n");
        report.push_str("  End of Report\n");
        report.push_str("═══════════════════════════════════════════════════════════\n");

        report
    }

    /// Format as JSON.
    pub fn to_json(&self) -> String {
        format!(
            r#"{{
  "timestamp": "{}",
  "standard": "{}",
  "duration_seconds": {:.2},
  "measurements": {{
    "integrated_lufs": {:.2},
    "momentary_lufs": {:.2},
    "short_term_lufs": {:.2},
    "loudness_range": {:.2},
    "true_peak_dbtp": {:.2},
    "max_momentary": {:.2},
    "max_short_term": {:.2}
  }},
  "compliance": {{
    "compliant": {},
    "target_lufs": {:.1},
    "max_peak_dbtp": {:.1},
    "deviation_lu": {:.2},
    "loudness_compliant": {},
    "peak_compliant": {},
    "lra_acceptable": {},
    "recommended_gain_db": {:.2}
  }}
}}"#,
            self.timestamp,
            self.compliance.standard.name(),
            self.duration_seconds,
            self.metrics.integrated_lufs,
            self.metrics.momentary_lufs,
            self.metrics.short_term_lufs,
            self.metrics.loudness_range,
            self.metrics.true_peak_dbtp,
            self.metrics.max_momentary,
            self.metrics.max_short_term,
            self.compliance.is_compliant(),
            self.compliance.target_lufs,
            self.compliance.max_peak_dbtp,
            self.compliance.deviation_lu,
            self.compliance.loudness_compliant,
            self.compliance.peak_compliant,
            self.compliance.lra_acceptable,
            self.compliance.recommended_gain_db(),
        )
    }

    /// Format as CSV.
    pub fn to_csv(&self) -> String {
        let mut csv = String::new();

        // Header
        csv.push_str("Metric,Value,Unit\n");

        // Measurements
        csv.push_str(&format!("Timestamp,{},\n", self.timestamp));
        csv.push_str(&format!("Standard,{},\n", self.compliance.standard.name()));
        csv.push_str(&format!("Duration,{:.2},seconds\n", self.duration_seconds));
        csv.push_str(&format!(
            "Integrated Loudness,{:.2},LUFS\n",
            self.metrics.integrated_lufs
        ));
        csv.push_str(&format!(
            "Momentary Loudness,{:.2},LUFS\n",
            self.metrics.momentary_lufs
        ));
        csv.push_str(&format!(
            "Short-term Loudness,{:.2},LUFS\n",
            self.metrics.short_term_lufs
        ));
        csv.push_str(&format!(
            "Loudness Range,{:.2},LU\n",
            self.metrics.loudness_range
        ));
        csv.push_str(&format!(
            "True Peak,{:.2},dBTP\n",
            self.metrics.true_peak_dbtp
        ));
        csv.push_str(&format!(
            "Max Momentary,{:.2},LUFS\n",
            self.metrics.max_momentary
        ));
        csv.push_str(&format!(
            "Max Short-term,{:.2},LUFS\n",
            self.metrics.max_short_term
        ));
        csv.push_str(&format!(
            "Target Loudness,{:.1},LUFS\n",
            self.compliance.target_lufs
        ));
        csv.push_str(&format!(
            "Deviation,{:.2},LU\n",
            self.compliance.deviation_lu
        ));
        csv.push_str(&format!("Compliant,{},\n", self.compliance.is_compliant()));

        csv
    }
}

impl fmt::Display for LoudnessReport {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.to_text())
    }
}

/// Detailed compliance report with recommendations.
#[derive(Clone, Debug)]
pub struct ComplianceReport {
    /// Standard being checked.
    pub standard: Standard,
    /// Is compliant?
    pub compliant: bool,
    /// Detailed findings.
    pub findings: Vec<String>,
    /// Recommendations.
    pub recommendations: Vec<String>,
}

impl ComplianceReport {
    /// Create EBU R128 compliance report.
    pub fn from_ebu(compliance: &EbuR128Compliance) -> Self {
        let mut findings = Vec::new();
        let mut recommendations = Vec::new();

        // Integrated loudness findings
        findings.push(format!(
            "Integrated Loudness: {:.1} LUFS (Target: {:.1} LUFS ±{:.1} LU)",
            compliance.integrated_lufs, EBU_TARGET_LUFS, EBU_TOLERANCE_LU
        ));

        if !compliance.loudness_ok {
            if compliance.deviation_lu > 0.0 {
                findings.push(format!(
                    "⚠ Programme is {:.1} LU too loud",
                    compliance.deviation_lu
                ));
                recommendations.push(format!("Reduce gain by {:.1} dB", -compliance.deviation_lu));
            } else {
                findings.push(format!(
                    "⚠ Programme is {:.1} LU too quiet",
                    -compliance.deviation_lu
                ));
                recommendations.push(format!(
                    "Increase gain by {:.1} dB",
                    -compliance.deviation_lu
                ));
            }
        }

        // True peak findings
        findings.push(format!(
            "True Peak: {:.1} dBTP (Maximum: {:.1} dBTP)",
            compliance.true_peak_dbtp, EBU_MAX_TRUEPEAK_DBTP
        ));

        if !compliance.peak_ok {
            findings.push(format!(
                "⚠ True peak exceeds limit by {:.1} dB",
                compliance.true_peak_dbtp - EBU_MAX_TRUEPEAK_DBTP
            ));
            recommendations.push("Apply true peak limiting".to_string());
        }

        // LRA findings
        findings.push(format!(
            "Loudness Range: {:.1} LU",
            compliance.loudness_range
        ));

        if !compliance.lra_ok {
            if compliance.loudness_range < 1.0 {
                findings.push("⚠ Very limited dynamic range".to_string());
                recommendations.push("Review compression/limiting settings".to_string());
            } else {
                findings.push("⚠ Excessive dynamic range variation".to_string());
                recommendations.push("Consider applying moderate compression".to_string());
            }
        }

        Self {
            standard: Standard::EbuR128,
            compliant: compliance.status.is_compliant(),
            findings,
            recommendations,
        }
    }

    /// Create ATSC A/85 compliance report.
    pub fn from_atsc(compliance: &AtscA85Compliance) -> Self {
        let mut findings = Vec::new();
        let mut recommendations = Vec::new();

        // Integrated loudness findings
        findings.push(format!(
            "Integrated Loudness: {:.1} LKFS (Target: {:.1} LKFS ±{:.1} dB)",
            compliance.integrated_lkfs, ATSC_TARGET_LKFS, ATSC_TOLERANCE_DB
        ));

        if !compliance.loudness_ok {
            if compliance.deviation_db > 0.0 {
                findings.push(format!(
                    "⚠ Programme is {:.1} dB too loud",
                    compliance.deviation_db
                ));
                recommendations.push(format!("Reduce gain by {:.1} dB", -compliance.deviation_db));
            } else {
                findings.push(format!(
                    "⚠ Programme is {:.1} dB too quiet",
                    -compliance.deviation_db
                ));
                recommendations.push(format!(
                    "Increase gain by {:.1} dB",
                    -compliance.deviation_db
                ));
            }
        }

        // True peak findings
        findings.push(format!(
            "True Peak: {:.1} dBTP (Maximum: {:.1} dBTP)",
            compliance.true_peak_dbtp, ATSC_MAX_TRUEPEAK_DBTP
        ));

        if !compliance.peak_ok {
            findings.push(format!(
                "⚠ True peak exceeds limit by {:.1} dB",
                compliance.true_peak_dbtp - ATSC_MAX_TRUEPEAK_DBTP
            ));
            recommendations.push("Apply true peak limiting with -2 dBTP ceiling".to_string());
        }

        // LRA
        findings.push(format!(
            "Loudness Range: {:.1} LU",
            compliance.loudness_range
        ));

        Self {
            standard: Standard::AtscA85,
            compliant: compliance.status.is_compliant(),
            findings,
            recommendations,
        }
    }

    /// Format as text.
    pub fn to_text(&self) -> String {
        let mut report = String::new();

        report.push_str(&format!("COMPLIANCE REPORT: {}\n", self.standard.name()));
        report.push_str("═══════════════════════════════════════\n\n");

        report.push_str(&format!(
            "Status: {}\n\n",
            if self.compliant {
                "✓ COMPLIANT"
            } else {
                "✗ NON-COMPLIANT"
            }
        ));

        report.push_str("Findings:\n");
        for finding in &self.findings {
            report.push_str(&format!("{finding}\n"));
        }

        if !self.recommendations.is_empty() {
            report.push_str("\nRecommendations:\n");
            for rec in &self.recommendations {
                report.push_str(&format!("{rec}\n"));
            }
        }

        report
    }
}

impl fmt::Display for ComplianceReport {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.to_text())
    }
}

/// Complete metering report with all measurements and compliance checks.
#[derive(Clone, Debug)]
pub struct MeteringReport {
    /// Loudness report.
    pub loudness: LoudnessReport,
    /// Compliance report.
    pub compliance: ComplianceReport,
}

impl MeteringReport {
    /// Create a complete metering report.
    pub fn new(loudness: LoudnessReport, compliance: ComplianceReport) -> Self {
        Self {
            loudness,
            compliance,
        }
    }

    /// Format as text.
    pub fn to_text(&self) -> String {
        let mut report = String::new();
        report.push_str(&self.loudness.to_text());
        report.push_str("\n\n");
        report.push_str(&self.compliance.to_text());
        report
    }
}

impl fmt::Display for MeteringReport {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.to_text())
    }
}

// Note: chrono is not in dependencies, so we'll use a simple timestamp
mod chrono {
    pub struct Local;
    impl Local {
        pub fn now() -> DateTime {
            DateTime
        }
    }

    pub struct DateTime;
    impl DateTime {
        pub fn format(&self, _fmt: &str) -> FormattedDateTime {
            FormattedDateTime
        }
    }

    pub struct FormattedDateTime;
    impl std::fmt::Display for FormattedDateTime {
        fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
            // Simple timestamp without chrono dependency
            write!(f, "2024-01-01 00:00:00")
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{ComplianceResult, LoudnessMetrics, Standard};

    #[test]
    fn test_loudness_report_creates() {
        let metrics = LoudnessMetrics::default();
        let compliance = ComplianceResult {
            standard: Standard::EbuR128,
            loudness_compliant: true,
            peak_compliant: true,
            lra_acceptable: true,
            integrated_lufs: -23.0,
            true_peak_dbtp: -2.0,
            loudness_range: 10.0,
            target_lufs: -23.0,
            max_peak_dbtp: -1.0,
            deviation_lu: 0.0,
        };

        let report = LoudnessReport::new(metrics, compliance, 100.0);
        assert_eq!(report.duration_seconds, 100.0);
    }

    #[test]
    fn test_loudness_report_to_text() {
        let metrics = LoudnessMetrics {
            integrated_lufs: -23.0,
            true_peak_dbtp: -2.0,
            loudness_range: 10.0,
            ..Default::default()
        };

        let compliance = ComplianceResult {
            standard: Standard::EbuR128,
            loudness_compliant: true,
            peak_compliant: true,
            lra_acceptable: true,
            integrated_lufs: -23.0,
            true_peak_dbtp: -2.0,
            loudness_range: 10.0,
            target_lufs: -23.0,
            max_peak_dbtp: -1.0,
            deviation_lu: 0.0,
        };

        let report = LoudnessReport::new(metrics, compliance, 120.0);
        let text = report.to_text();

        assert!(text.contains("LOUDNESS MEASUREMENT REPORT"));
        assert!(text.contains("EBU R128"));
        assert!(text.contains("-23.0 LUFS"));
    }

    #[test]
    fn test_loudness_report_to_json() {
        let metrics = LoudnessMetrics::default();
        let compliance = ComplianceResult {
            standard: Standard::EbuR128,
            loudness_compliant: true,
            peak_compliant: true,
            lra_acceptable: true,
            integrated_lufs: -23.0,
            true_peak_dbtp: -2.0,
            loudness_range: 10.0,
            target_lufs: -23.0,
            max_peak_dbtp: -1.0,
            deviation_lu: 0.0,
        };

        let report = LoudnessReport::new(metrics, compliance, 100.0);
        let json = report.to_json();

        assert!(json.contains("\"standard\""));
        assert!(json.contains("\"measurements\""));
        assert!(json.contains("\"compliance\""));
    }

    #[test]
    fn test_loudness_report_to_csv() {
        let metrics = LoudnessMetrics::default();
        let compliance = ComplianceResult {
            standard: Standard::EbuR128,
            loudness_compliant: true,
            peak_compliant: true,
            lra_acceptable: true,
            integrated_lufs: -23.0,
            true_peak_dbtp: -2.0,
            loudness_range: 10.0,
            target_lufs: -23.0,
            max_peak_dbtp: -1.0,
            deviation_lu: 0.0,
        };

        let report = LoudnessReport::new(metrics, compliance, 100.0);
        let csv = report.to_csv();

        assert!(csv.contains("Metric,Value,Unit"));
        assert!(csv.contains("Integrated Loudness"));
    }
}