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
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

//! Named voice presets — specific individuals within a species.
//!
//! Presets provide ready-made `CreatureVoice` configurations for
//! recognizable individual characters (e.g., a large alpha wolf
//! vs. a small pup).

use alloc::borrow::Cow;
use serde::{Deserialize, Serialize};

use crate::species::Species;
use crate::voice::CreatureVoice;

/// A named creature voice preset.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[must_use]
pub struct VoicePreset {
    /// Display name for this preset.
    pub name: Cow<'static, str>,
    /// Species.
    pub species: Species,
    /// Size scale.
    pub size: f32,
    /// F0 offset from species default (Hz).
    pub f0_offset: f32,
    /// Breathiness override.
    pub breathiness: f32,
}

impl VoicePreset {
    /// Creates a `CreatureVoice` from this preset.
    #[must_use]
    pub fn build(&self) -> CreatureVoice {
        CreatureVoice::new(self.species)
            .with_size(self.size)
            .with_f0_offset(self.f0_offset)
            .with_breathiness(self.breathiness)
    }
}

/// Built-in voice presets.
pub mod presets {
    use super::*;

    /// Large alpha wolf — deep, resonant howl.
    pub const ALPHA_WOLF: VoicePreset = VoicePreset {
        name: Cow::Borrowed("Alpha Wolf"),
        species: Species::Wolf,
        size: 1.4,
        f0_offset: -80.0,
        breathiness: 0.03,
    };

    /// Wolf pup — high-pitched, breathy.
    pub const WOLF_PUP: VoicePreset = VoicePreset {
        name: Cow::Borrowed("Wolf Pup"),
        species: Species::Wolf,
        size: 0.4,
        f0_offset: 200.0,
        breathiness: 0.12,
    };

    /// House cat — typical domestic cat.
    pub const HOUSE_CAT: VoicePreset = VoicePreset {
        name: Cow::Borrowed("House Cat"),
        species: Species::Cat,
        size: 1.0,
        f0_offset: 0.0,
        breathiness: 0.08,
    };

    /// Kitten — small, high-pitched.
    pub const KITTEN: VoicePreset = VoicePreset {
        name: Cow::Borrowed("Kitten"),
        species: Species::Cat,
        size: 0.4,
        f0_offset: 150.0,
        breathiness: 0.15,
    };

    /// Male lion — deep, powerful roar.
    pub const MALE_LION: VoicePreset = VoicePreset {
        name: Cow::Borrowed("Male Lion"),
        species: Species::Lion,
        size: 1.3,
        f0_offset: -15.0,
        breathiness: 0.12,
    };

    /// Ancient dragon — massive, earth-shaking.
    pub const ANCIENT_DRAGON: VoicePreset = VoicePreset {
        name: Cow::Borrowed("Ancient Dragon"),
        species: Species::Dragon,
        size: 4.0,
        f0_offset: -30.0,
        breathiness: 0.25,
    };

    /// Young dragon — smaller, higher.
    pub const YOUNG_DRAGON: VoicePreset = VoicePreset {
        name: Cow::Borrowed("Young Dragon"),
        species: Species::Dragon,
        size: 0.8,
        f0_offset: 50.0,
        breathiness: 0.15,
    };

    /// Bald eagle — piercing screech.
    pub const BALD_EAGLE: VoicePreset = VoicePreset {
        name: Cow::Borrowed("Bald Eagle"),
        species: Species::Raptor,
        size: 1.2,
        f0_offset: -200.0,
        breathiness: 0.1,
    };

    /// Raven — deep, rough croak.
    pub const RAVEN: VoicePreset = VoicePreset {
        name: Cow::Borrowed("Raven"),
        species: Species::Crow,
        size: 1.3,
        f0_offset: -100.0,
        breathiness: 0.2,
    };

    /// Field cricket — steady chirping.
    pub const FIELD_CRICKET: VoicePreset = VoicePreset {
        name: Cow::Borrowed("Field Cricket"),
        species: Species::Cricket,
        size: 1.0,
        f0_offset: 0.0,
        breathiness: 0.0,
    };

    /// American alligator — deep bellow.
    pub const ALLIGATOR: VoicePreset = VoicePreset {
        name: Cow::Borrowed("American Alligator"),
        species: Species::Crocodilian,
        size: 1.5,
        f0_offset: -10.0,
        breathiness: 0.18,
    };

    /// Returns all built-in presets.
    #[must_use = "returns the list of all built-in voice presets"]
    pub fn all() -> &'static [VoicePreset] {
        &[
            ALPHA_WOLF,
            WOLF_PUP,
            HOUSE_CAT,
            KITTEN,
            MALE_LION,
            ANCIENT_DRAGON,
            YOUNG_DRAGON,
            BALD_EAGLE,
            RAVEN,
            FIELD_CRICKET,
            ALLIGATOR,
        ]
    }
}