rosu-pp 4.0.1

Difficulty and performance calculation for osu!
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
use std::cmp;

use rosu_map::section::hit_objects::hit_samples::HitSoundType;

use crate::{
    mania::{
        convert::{PrevValues, pattern::Pattern, pattern_type::PatternType},
        object::ManiaObject,
    },
    model::{
        beatmap::Beatmap,
        control_point::{EffectPoint, TimingPoint},
        hit_object::HitObject,
    },
    util::random::osu::Random,
};

use super::PatternGenerator;

pub struct HitObjectPatternGenerator<'h> {
    pub sample: HitSoundType,
    pub stair_type: PatternType,
    pub inner: PatternGenerator<'h>,
    convert_type: PatternType,
    prev_pattern: &'h Pattern,
}

impl<'h> HitObjectPatternGenerator<'h> {
    pub fn new(
        random: &'h mut Random,
        hit_object: &'h HitObject,
        sample: HitSoundType,
        total_columns: i32,
        prev: &'h PrevValues,
        density: f64,
        orig: &'h Beatmap,
    ) -> Self {
        let beat_len = orig
            .timing_point_at(hit_object.start_time)
            .map_or(TimingPoint::DEFAULT_BEAT_LEN, |point| point.beat_len);

        let pos_separation = (hit_object.pos - prev.pos).length();
        let time_separation = hit_object.start_time - prev.time;

        let mut convert_type = PatternType::default();

        if time_separation <= 80.0 {
            // * More than 187 BPM
            convert_type |= PatternType::FORCE_NOT_STACK | PatternType::KEEP_SINGLE;
        } else if time_separation <= 95.0 {
            // * More than 157 BPM
            convert_type |= PatternType::FORCE_NOT_STACK | PatternType::KEEP_SINGLE | prev.stair;
        } else if time_separation <= 105.0 {
            // * More than 140 BPM
            convert_type |= PatternType::FORCE_NOT_STACK | PatternType::LOW_PROBABILITY;
        } else if time_separation <= 125.0 {
            // * More than 120 BPM
            convert_type |= PatternType::FORCE_NOT_STACK;
        } else if time_separation <= 135.0 && pos_separation < 20.0 {
            // * More than 111 BPM stream
            convert_type |= PatternType::CYCLE | PatternType::KEEP_SINGLE;
        } else if time_separation <= 150.0 && pos_separation < 20.0 {
            // * More than 100 BPM stream
            convert_type |= PatternType::FORCE_STACK | PatternType::LOW_PROBABILITY;
        } else if pos_separation < 20.0 && density >= beat_len / 2.5 {
            // * Low density stream
            convert_type |= PatternType::REVERSE | PatternType::LOW_PROBABILITY;
        } else if density < beat_len / 2.5 {
            // * High density
        } else {
            let kiai = orig
                .effect_point_at(hit_object.start_time)
                .map_or(EffectPoint::DEFAULT_KIAI, |point| point.kiai);

            if kiai {
                // * High density
            } else {
                convert_type |= PatternType::LOW_PROBABILITY;
            }
        }

        if !convert_type.contains(PatternType::KEEP_SINGLE) {
            if sample.has_flag(HitSoundType::FINISH) && total_columns != 8 {
                convert_type |= PatternType::MIRROR;
            } else if sample.has_flag(HitSoundType::CLAP) {
                convert_type |= PatternType::GATHERED;
            }
        }

        let inner = PatternGenerator::new(hit_object, total_columns, random, orig);

        Self {
            stair_type: prev.stair,
            convert_type,
            sample,
            prev_pattern: &prev.pattern,
            inner,
        }
    }

    pub fn generate(&mut self) -> Pattern {
        let pattern = self.generate_core();

        for obj in pattern.hit_objects.iter() {
            let col = ManiaObject::column(obj.pos.x, self.inner.total_columns as f32) as i32;

            if self.convert_type.contains(PatternType::STAIR) && col == self.inner.total_columns - 1
            {
                self.stair_type = PatternType::REVERSE_STAIR;
            }

            if self.convert_type.contains(PatternType::REVERSE_STAIR)
                && col == self.inner.random_start()
            {
                self.stair_type = PatternType::STAIR;
            }
        }

        pattern
    }

    fn generate_core(&mut self) -> Pattern {
        if self.inner.total_columns == 1 {
            return Pattern::new_note(self, 0);
        }

        let last_column = self.prev_pattern.hit_objects.last().map_or(0, |h| {
            ManiaObject::column(h.pos.x, self.inner.total_columns as f32) as u8
        });

        let random_start = self.inner.random_start() as u8;

        if self.convert_type.contains(PatternType::REVERSE)
            && !self.prev_pattern.hit_objects.is_empty()
        {
            let mut pattern = Pattern::default();

            for i in random_start..self.inner.total_columns as u8 {
                if self.prev_pattern.column_has_obj(i) {
                    pattern.add_note(self, random_start + self.inner.total_columns as u8 - i - 1);
                }
            }

            return pattern;
        }

        if self.convert_type.contains(PatternType::CYCLE)
            && self.prev_pattern.hit_objects.len() == 1
            // * If we convert to 7K + 1, let's not overload the special key
            && (self.inner.total_columns != 8 || last_column != 0)
            // * Make sure the last column was not the centre column
            && (self.inner.total_columns % 2 == 0 || last_column != self.inner.total_columns as u8 / 2)
        {
            // * Generate a new pattern by cycling backwards (similar to Reverse but for only one hit object)
            let column = random_start + self.inner.total_columns as u8 - last_column - 1;

            return Pattern::new_note(self, column);
        }

        if self.convert_type.contains(PatternType::FORCE_STACK)
            && !self.prev_pattern.hit_objects.is_empty()
        {
            let mut pattern = Pattern::default();

            // * Generate a new pattern by placing on the already filled columns
            for i in random_start..self.inner.total_columns as u8 {
                if self.prev_pattern.column_has_obj(i) {
                    pattern.add_note(self, i);
                }
            }

            return pattern;
        }

        if self.prev_pattern.hit_objects.len() == 1 {
            if self.convert_type.contains(PatternType::STAIR) {
                // * Generate a new pattern by placing on the next column,
                // * cycling back to the start if there is no "next"
                let mut target_column = last_column + 1;

                if target_column == self.inner.total_columns as u8 {
                    target_column = random_start;
                }

                return Pattern::new_note(self, target_column);
            }

            if self.convert_type.contains(PatternType::REVERSE_STAIR) {
                // * Generate a new pattern by placing on the previous column,
                // * cycling back to the end if there is no "previous"
                let mut target_column = last_column as i8 - 1;

                if target_column == random_start as i8 - 1 {
                    target_column = self.inner.total_columns as i8 - 1;
                }

                return Pattern::new_note(self, target_column as u8);
            }
        }

        if self.convert_type.contains(PatternType::KEEP_SINGLE) {
            return self.generate_random_notes(1);
        }

        let conversion_diff = self.inner.conversion_difficulty();

        if self.convert_type.contains(PatternType::MIRROR) {
            if conversion_diff > 6.5 {
                self.generate_random_pattern_with_mirrored(0.12, 0.38, 0.12)
            } else if conversion_diff > 4.0 {
                self.generate_random_pattern_with_mirrored(0.12, 0.17, 0.0)
            } else {
                self.generate_random_pattern_with_mirrored(0.12, 0.0, 0.0)
            }
        } else if conversion_diff > 6.5 {
            if self.convert_type.contains(PatternType::LOW_PROBABILITY) {
                self.generate_random_pattern(0.78, 0.42, 0.0, 0.0)
            } else {
                self.generate_random_pattern(1.0, 0.62, 0.0, 0.0)
            }
        } else if conversion_diff > 4.0 {
            if self.convert_type.contains(PatternType::LOW_PROBABILITY) {
                self.generate_random_pattern(0.35, 0.08, 0.0, 0.0)
            } else {
                self.generate_random_pattern(0.52, 0.15, 0.0, 0.0)
            }
        } else if conversion_diff > 2.0 {
            if self.convert_type.contains(PatternType::LOW_PROBABILITY) {
                self.generate_random_pattern(0.18, 0.0, 0.0, 0.0)
            } else {
                self.generate_random_pattern(0.45, 0.0, 0.0, 0.0)
            }
        } else {
            self.generate_random_pattern(0.0, 0.0, 0.0, 0.0)
        }
    }

    fn generate_random_notes(&mut self, mut note_count: i32) -> Pattern {
        let mut pattern = Pattern::default();

        let allow_stacking = !self.convert_type.contains(PatternType::FORCE_NOT_STACK);

        if !allow_stacking {
            note_count = cmp::min(
                self.inner.total_columns
                    - self.inner.random_start()
                    - self.prev_pattern.column_with_objs(),
                note_count,
            );
        }

        let mut next_column = self.inner.get_column(Some(true));

        for _ in 0..note_count {
            next_column = if allow_stacking {
                self.find_available_column(
                    next_column,
                    None,
                    Some(Self::get_next_column),
                    &[&pattern],
                )
            } else {
                self.find_available_column(
                    next_column,
                    None,
                    Some(Self::get_next_column),
                    &[&pattern, self.prev_pattern],
                )
            };

            pattern.add_note(self, next_column);
        }

        pattern
    }

    fn get_next_column(&mut self, mut last: u8) -> u8 {
        if self.convert_type.contains(PatternType::GATHERED) {
            last += 1;

            if last == self.inner.total_columns as u8 {
                last = self.inner.random_start() as u8;
            }
        } else {
            last = self.inner.get_random_column(None, None);
        }

        last
    }

    const fn has_special_column(&self) -> bool {
        self.sample.has_flag(HitSoundType::CLAP) && self.sample.has_flag(HitSoundType::FINISH)
    }

    fn generate_random_pattern(&mut self, p2: f64, p3: f64, p4: f64, p5: f64) -> Pattern {
        let random_note_count = self.get_random_note_count(p2, p3, p4, p5);
        let mut pattern = self.generate_random_notes(random_note_count);

        if self.inner.random_start() > 0 && self.has_special_column() {
            pattern.add_note(self, 0);
        }

        pattern
    }

    fn get_random_note_count(&mut self, mut p2: f64, mut p3: f64, mut p4: f64, mut p5: f64) -> i32 {
        match self.inner.total_columns {
            2 => {
                p2 = 0.0;
                p3 = 0.0;
                p4 = 0.0;
                p5 = 0.0;
            }
            3 => {
                p2 = p2.min(0.1);
                p3 = 0.0;
                p4 = 0.0;
                p5 = 0.0;
            }
            4 => {
                p2 = p2.min(0.23);
                p3 = p3.min(0.04);
                p4 = 0.0;
                p5 = 0.0;
            }
            5 => {
                p3 = p3.min(0.15);
                p4 = p4.min(0.03);
                p5 = 0.0;
            }
            _ => {}
        }

        if self.sample.has_flag(HitSoundType::CLAP) {
            p2 = 1.0;
        }

        self.inner
            .get_random_note_count(p2, p3, Some(p4), Some(p5), None)
    }

    fn generate_random_pattern_with_mirrored(
        &mut self,
        centre_probability: f64,
        p2: f64,
        p3: f64,
    ) -> Pattern {
        if self.convert_type.contains(PatternType::FORCE_NOT_STACK) {
            return self.generate_random_pattern(1.0 / 2.0 + p2 / 2.0, p2, (p2 + p3) / 2.0, p3);
        }

        let mut pattern = Pattern::default();

        let (note_count, add_to_centre) =
            self.get_random_note_count_mirrored(centre_probability, p2, p3);

        let column_limit = if self.inner.total_columns % 2 == 0 {
            self.inner.total_columns / 2
        } else {
            (self.inner.total_columns - 1) / 2
        };

        let mut next_column = self.inner.get_random_column(None, Some(column_limit));

        for _ in 0..note_count {
            next_column =
                self.find_available_column(next_column, Some(column_limit), None, &[&pattern]);

            // * Add normal note
            pattern.add_note(self, next_column);

            // * Add mirrored note
            let column =
                (self.inner.random_start() + self.inner.total_columns) as u8 - next_column - 1;
            pattern.add_note(self, column);
        }

        if add_to_centre {
            pattern.add_note(self, self.inner.total_columns as u8 / 2);
        }

        if self.inner.random_start() > 0 && self.has_special_column() {
            pattern.add_note(self, 0);
        }

        pattern
    }

    fn get_random_note_count_mirrored(
        &mut self,
        mut centre_probability: f64,
        mut p2: f64,
        mut p3: f64,
    ) -> (i32, bool) {
        match self.inner.total_columns {
            2 => {
                centre_probability = 0.0;
                p2 = 0.0;
                p3 = 0.0;
            }
            3 => {
                centre_probability = centre_probability.min(0.03);
                p2 = 0.0;
                p3 = 0.0;
            }
            4 => {
                centre_probability = 0.0;

                // * Stable requires rngValue > x, which is an inverse-probability. Lazer uses true probability (1 - x).
                // * But multiplying this value by 2 (stable) is not the same operation as dividing it by 2 (lazer),
                // * so it needs to be converted to from a probability and then back after the multiplication.
                p2 = 1.0 - ((1.0 - p2) * 2.0).max(0.8);
                p3 = 0.0;
            }
            5 => {
                centre_probability = centre_probability.min(0.03);
                p3 = 0.0;
            }
            6 => {
                centre_probability = 0.0;

                // * Stable requires rngValue > x, which is an inverse-probability. Lazer uses true probability (1 - x).
                // * But multiplying this value by 2 (stable) is not the same operation as dividing it by 2 (lazer),
                // * so it needs to be converted to from a probability and then back after the multiplication.
                p2 = 1.0 - ((1.0 - p2) * 2.0).max(0.05);
                p3 = 1.0 - ((1.0 - p3) * 2.0).max(0.85);
            }
            _ => {}
        }

        // * The stable values were allowed to exceed 1, which indicate <0% probability.
        // * These values needs to be clamped otherwise GetRandomNoteCount() will throw an exception.
        p2 = p2.clamp(0.0, 1.0);
        p3 = p3.clamp(0.0, 1.0);

        let centre_val = self.inner.random.next_double();
        let note_count = self.inner.get_random_note_count(p2, p3, None, None, None);
        let add_to_centre = self.inner.total_columns % 2 != 0
            && note_count != 3
            && centre_val > 1.0 - centre_probability;

        (note_count, add_to_centre)
    }

    fn find_available_column(
        &mut self,
        mut initial_column: u8,
        upper: Option<i32>,
        next_column: Option<fn(&mut Self, u8) -> u8>,
        patterns: &[&Pattern],
    ) -> u8 {
        let lower = self.inner.random_start();
        let upper = upper.unwrap_or(self.inner.total_columns);

        let is_valid = |column: i32| {
            let column = column as u8;

            patterns
                .iter()
                .all(|pattern| !pattern.column_has_obj(column))
        };

        // * Check for the initial column
        if is_valid(i32::from(initial_column)) {
            return initial_column;
        }

        // * Ensure that we have at least one free column, so that an endless loop is avoided
        let has_valid_column = (lower..upper).any(is_valid);
        assert!(has_valid_column);

        // * Iterate until a valid column is found. This is a random iteration in the default case.
        while {
            initial_column = if let Some(fun) = next_column {
                (fun)(self, initial_column)
            } else {
                self.inner.get_random_column(Some(lower), Some(upper))
            };

            !is_valid(i32::from(initial_column))
        } {}

        initial_column
    }
}