prani 1.1.0

prani — Creature and animal vocal synthesis: species-specific voice models, call patterns, non-human vocal tracts
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

//! Vocalization types and call intent mapping.
//!
//! Defines the patterns and shapes of creature calls: howls, growls, chirps,
//! roars, hisses, and more. Each vocalization has a characteristic f0 contour,
//! amplitude envelope, and duration profile.

use serde::{Deserialize, Serialize};

/// A vocalization pattern — the shape and character of a creature call.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[non_exhaustive]
pub enum Vocalization {
    /// Long sustained call with pitch rise then fall (wolves, dogs).
    Howl,
    /// Short, sharp burst (dogs, seals).
    Bark,
    /// Low-frequency sustained vibration (cats, bears).
    Growl,
    /// Very loud, powerful sustained call (lions, dragons).
    Roar,
    /// Breathy turbulent noise (snakes, cats).
    Hiss,
    /// High-pitched short call (birds, small mammals).
    Chirp,
    /// Rapid frequency modulation (songbirds).
    Trill,
    /// Ascending pitch call (dogs, wolves).
    Whine,
    /// Low rumbling (crocodilians, elephants).
    Rumble,
    /// Steady low-frequency vibration with amplitude modulation (cats).
    Purr,
    /// Very short sharp call (small dogs, rodents).
    Yelp,
    /// High-pitched descending scream (raptors).
    Screech,
    /// Rhythmic stridulation (crickets, cicadas).
    Stridulate,
    /// Wing-based tonal vibration (bees, flies).
    Buzz,
}

/// The behavioral intent behind a vocalization.
///
/// Maps to prosodic modifications: alarm calls are louder and higher-pitched,
/// mating calls are longer and more melodic, etc.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[non_exhaustive]
pub enum CallIntent {
    /// Warning of danger — high urgency, elevated pitch, sharp onset.
    Alarm,
    /// Claiming territory — loud, sustained, assertive.
    Territorial,
    /// Attracting a mate — melodic, varied, extended duration.
    Mating,
    /// Expressing pain or distress — high pitch, irregular, urgent.
    Distress,
    /// Neutral/background vocalization — relaxed, low effort.
    Idle,
    /// Aggression/threat — loud, low pitch, growling quality.
    Threat,
    /// Social bonding/communication — moderate, varied.
    Social,
}

/// Parameters that modify a vocalization based on intent.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[must_use]
pub struct IntentModifiers {
    /// Pitch multiplier (1.0 = species default).
    pub pitch_scale: f32,
    /// Amplitude multiplier.
    pub amplitude_scale: f32,
    /// Duration multiplier.
    pub duration_scale: f32,
    /// Urgency: affects jitter and onset sharpness (0.0-1.0).
    pub urgency: f32,
}

impl CallIntent {
    /// Returns the prosodic modifiers for this intent.
    #[must_use = "returns intent modifiers that should be applied to synthesis"]
    pub fn modifiers(self) -> IntentModifiers {
        match self {
            Self::Alarm => IntentModifiers {
                pitch_scale: 1.4,
                amplitude_scale: 1.5,
                duration_scale: 0.7,
                urgency: 0.9,
            },
            Self::Territorial => IntentModifiers {
                pitch_scale: 0.9,
                amplitude_scale: 1.3,
                duration_scale: 1.5,
                urgency: 0.5,
            },
            Self::Mating => IntentModifiers {
                pitch_scale: 1.1,
                amplitude_scale: 1.0,
                duration_scale: 2.0,
                urgency: 0.2,
            },
            Self::Distress => IntentModifiers {
                pitch_scale: 1.5,
                amplitude_scale: 1.4,
                duration_scale: 0.8,
                urgency: 1.0,
            },
            Self::Idle => IntentModifiers {
                pitch_scale: 1.0,
                amplitude_scale: 0.5,
                duration_scale: 1.0,
                urgency: 0.0,
            },
            Self::Threat => IntentModifiers {
                pitch_scale: 0.7,
                amplitude_scale: 1.4,
                duration_scale: 1.2,
                urgency: 0.7,
            },
            Self::Social => IntentModifiers {
                pitch_scale: 1.0,
                amplitude_scale: 0.8,
                duration_scale: 1.0,
                urgency: 0.3,
            },
        }
    }
}