121 Commits

• Add legacy storyboard encoder (#37790)

  - Closes https://github.com/ppy/osu/issues/37757
  
  Commit-by-commit reading is recommended. Commits will be split to PRs on
  request but I consider this to be the minimal viable functional
  increment.
  
  ## Done
  
  - This adds a first version of a full storyboard encoder
  (a66dc406f498e35d4e0c8f2a462e946a9a1aeccc). I expect there to be hiccups
  due to weird corners of the `.osb` format; this is only intended to be
  somewhat correct as a start to build upon. Storyboarders are asked to
  file issues as necessary.
  - Due to the fact that storyboard definitions can reside both in the
  `.osu` and the `.osb`, b60698a95c4de1bfeb36fbb159fd5a6028920832 adds the
  required storage to be able to tell which storyboard element lives
  where, so that it can be decoded properly later.
  - In c9d3e04a4135886b5b0943c85f3cc6f4fe99c84c, the storyboard decoder is
  weaved into the beatmap decoder to handle the `.osu` part of the
  storyboard, via the
  `LegacyStoryboardEncoder.Encode{General,Events}ToBeatmap()` methods. For
  `.osb`s, `LegacyStoryboardEncoder.EncodeStandaloneStoryboard()` is
  intended, but for now is not used outside tests.
  - Because of the above, dd1c4e43dc51154cd67860f096712f8b4f229661 removes
  `Beatmap.UnhandledEventLines` as no longer required.
  - 26ac417ed98a8937c42e5f52c4e15ef065a48902 adds tests. They are mostly
  handwritten to ensure basic encode-decode roundtripping. Using existing
  storyboards is difficult, see "Known issues" section as to why.
  - 5cc542366db7caac38eb0729260d884905a2c0d5 fixes a bug in the storyboard
  decoder where the trigger group number was not properly negated on
  decode (see inline comment reference to relevant stable code).
  
  ## Known issues
  
  - Any and all variables in the `[Variables]` section are inlined into
  their usages by `LegacyStoryboardDecoder`, and as such
  `LegacyStoryboardEncoder` will end up inlining them and discarding the
  `[Variables]` section. As far as I can tell stable will also do this.
  - `LegacyStoryboardDecoder` splits all `M` (move) commands into
  `MX`/`MY` commands. Therefore, `LegacyStoryboardEncoder` will write out
  things in the same split way. I did not put in effort to attempt to
  reconcile this, for reasons of part laziness, part not wanting to bloat
  this already-large diff.
  - Ordering of storyboard samples on decode may not match the order on
  decode. I'm crossing fingers this doesn't matter.

  Bartłomiej Dach · 2026-05-20 17:46:51 +09:00
  0e443b1c47
• Add note about LATEST_VERSION cross-project usage
  Dean Herbert · 2025-07-01 19:19:18 +09:00
  68ab89a8f1
• Limit beatmap encoder & decoder to at most 8 combo colours
  Bartłomiej Dach · 2025-02-26 11:13:57 +01:00
  2167c7b8d5
• Fix hit object coordinates being truncated to int values

  Closes https://github.com/ppy/osu/issues/29340.

  Dean Herbert · 2024-08-09 16:34:39 +09:00
  d072c6a743
• Simplify input overlay text colour decode (and fix incorrect default)
  Bartłomiej Dach · 2024-07-24 14:53:01 +02:00
  3c28c116ca
• Fix code quality
  normalid · 2024-07-24 12:57:30 +08:00
  b24be96d04
• Support custom input overlay color
  normalid · 2024-07-23 23:35:25 +08:00
  c52a993607
• Remove all usage of LegacyDifficultyControlPoint
  Dean Herbert · 2023-09-07 17:41:57 +09:00
  b34a36f6ce
• Make HitSampleInfo.Bank non-nullable
  Dean Herbert · 2023-05-16 18:12:56 +09:00
  83dcd78826
• Use StringSplitOptions.TrimEntries for string.Split() when possible
  Berkan Diler · 2022-12-27 09:41:58 +01:00
  182f36c434
• Add support for storyboards with incorrect path specifications (\\ instead of \)

  Closes https://github.com/ppy/osu/issues/21204.

  Dean Herbert · 2022-11-21 16:12:01 +09:00
  3da21e596a
• Don't trim whitespace from variable keys / values
  Dean Herbert · 2022-11-08 13:30:11 +09:00
  064a245c50
• Move check to LegacyDifficultyControlPoint
  Dan Balasescu · 2022-10-13 15:05:15 +09:00
  338115ff6a
• Introduce BpmMultiplierMania, remove after the fact clamps
  sw1tchbl4d3 · 2022-10-12 11:14:01 +02:00
  df0501235d
• Move clamps directly to the usages in the conversion algorithm
  sw1tchbl4d3 · 2022-10-10 09:36:18 +02:00
  f8036658c7
• Fix legacy BpmMultiplier clamp value
  sw1tchbl4d3 · 2022-10-09 11:25:47 +02:00
  e0904e263f
• Disable alpha component parsing in beatmap / skin colour sections
  Dean Herbert · 2022-09-21 16:11:41 +09:00
  992441b9de
• Fix test failures
  Khang · 2022-08-24 03:37:33 -04:00
  adea29c106
• Move GenerateTicks to LegacyDifficultyControlPoint and remove support for NaN slider velocity support for other rulesets (at least for now)
  Khang · 2022-08-23 14:07:18 -04:00
  c1ced85b5e
• Enable NRT and simplify LineBufferedReader
  Dean Herbert · 2022-07-06 14:57:56 +09:00
  a52ea3cabe
• Properly annotate method to allow null
  Dan Balasescu · 2022-06-20 16:56:19 +09:00
  16281f4a48
• Implement IEquatable on ControlPoint
  Dan Balasescu · 2022-06-20 15:27:43 +09:00
  03ab6fc141
• Merge branch 'master' into editor-controlpoint-undo-redo
  Dan Balasescu · 2022-06-20 13:47:01 +09:00
  468e5fcbed
• Automated #nullable processing
  Dan Balasescu · 2022-06-17 16:37:17 +09:00
  f8830c6850
• Support undo/redo for control points
  Dan Balasescu · 2022-06-13 15:45:08 +09:00
  7e7716f942
• Don't output beatmap parse failures in a visible manner

  The user can't do much about this. When a user reports a beatmap issue,
  the logs will still contain this useful information. Should be fine I
  think.
  
  As mentioned in
  
  https://github.com/ppy/osu/discussions/18426
  https://github.com/ppy/osu/issues/750
  https://github.com/ppy/osu/issues/18372
  
  etc.

  Dean Herbert · 2022-05-27 19:18:38 +09:00
  e53c8518de
• Remove no longer used Section.None
  Dean Herbert · 2021-11-02 14:01:41 +09:00
  15c770e155
• Default legacy decoder to General section, rather than none

  This is mainly to reach parity with how stable handles such cases for
  skins specifically. It was brought to our attention after finding a skin
  with a malformed `\[General]` tag which did not break further parsing of
  the file on stable, but did on lazer.
  
  Note that stable defaults to an "unknown" section for beatmaps, but
  functionally I can't think of a regression case from changing this to a
  "general" default.

  Dean Herbert · 2021-11-02 13:59:13 +09:00
  ab28948744
• Apply batch fixing of built-in types using var
  Dean Herbert · 2021-10-27 13:04:41 +09:00
  6944151486
• Move approach rate to EffectControlPoint
  Dean Herbert · 2021-09-03 16:58:16 +09:00
  a3d9ab1e2e
• Add a way to change custom combo colours via IHasComboColours

  `IHasComboColours` was already mutable (via a strange
  `AddComboColours()` method) and exposing a straight list is easier to
  work with. `IHasCustomColours` is also similarly externally mutable (in
  a way which is not easily removable).

  Bartłomiej Dach · 2021-08-15 20:06:06 +02:00
  7c88a1c6de
• Don't strip comments from metadata during parsin
  Dean Herbert · 2021-03-25 13:35:54 +09:00
  4f8edcd336
• Only trim trailing spaces to avoid breakage in storyboard parsing
  Dean Herbert · 2021-03-18 16:30:30 +09:00
  5b0d75ee56
• Fix skin parser not stripping whitespace before parsing
  Dean Herbert · 2021-03-18 15:36:11 +09:00
  bb3c3f302a
• Fix BPM multiplier not working in all cases
  smoogipoo · 2021-01-12 17:50:22 +09:00
  9a22df2b88
• Make legacy control point's BpmMultiplier setter private again
  Dean Herbert · 2021-01-07 19:06:52 +09:00
  00dc98e3ab
• Fix missing copy implementation in LegacySampleControlPiont
  Dean Herbert · 2021-01-05 13:41:31 +09:00
  afab35a31a
• Clone and copy ControlPointInfo when retrieving a playable beatmap
  Dean Herbert · 2021-01-04 16:37:07 +09:00
  ba4e411422
• Rename parameters
  smoogipoo · 2020-12-02 10:55:48 +09:00
  2150cf1c52
• Make HitSampleInfo immutable
  smoogipoo · 2020-12-01 15:37:51 +09:00
  5760e1c1fc
• Fix storyboard animations of very old beatmaps playing too slow

  Closes https://github.com/ppy/osu/issues/10772.

  Dean Herbert · 2020-11-12 17:03:43 +09:00
  25af091409
• Add missing string function ordinal specifications
  Dean Herbert · 2020-10-16 12:49:31 +09:00
  cc41845f56
• Remove alpha mangling from LegacyDecoder
  smoogipoo · 2020-08-22 00:15:37 +09:00
  88d50b6c47
• Introduce legacy timing point fp errors
  smoogipoo · 2020-07-13 17:06:00 +09:00
  0ea13dea55
• Adjust at parse time instead
  smoogipoo · 2020-06-25 14:15:26 +09:00
  4ff9a91012
• Merge branch 'master' into catch-hyperdash-fruit-colouring
  Dean Herbert · 2020-04-19 21:48:41 +09:00
  48cf7becd1
• Merge branch 'master' into timing-equivalence
  Dan Balasescu · 2020-04-17 17:12:38 +09:00
  4e22e569f5
• Remove unnecessary time property
  smoogipoo · 2020-04-17 17:06:12 +09:00
  9aac98664c
• Remove EquivalentTo() and Equals()
  smoogipoo · 2020-04-17 17:04:09 +09:00
  69fb984e71
• Improve logic for CSB transfer
  smoogipoo · 2020-04-14 21:05:07 +09:00
  6935221463