28 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
• Apply NRT to osu.Game.Betamaps.Formats namespace
  Dean Herbert · 2023-08-16 19:37:24 +09:00
  49fc9655d2
• Use new ArgumentNullException.ThrowIfNull throw-helper API
  Berkan Diler · 2022-12-22 21:27:59 +01:00
  08d2fbeb8e
• Silence exception and provide more log output when import fails due to empty .osu files
  Dean Herbert · 2022-06-20 16:07:10 +09:00
  d38defada4
• Automated #nullable processing
  Dan Balasescu · 2022-06-17 16:37:17 +09:00
  f8830c6850
• Disallow registering a null RulesetStore
  Dean Herbert · 2022-02-18 16:52:34 +09:00
  cf1dd1ebd3
• Add static RulesetStore to LegacyBeatmapDecoder
  Dean Herbert · 2022-02-16 17:13:54 +09:00
  13086541f0
• fix(?) InspectCode warnings
  Will Kennedy · 2020-04-02 21:36:31 -04:00
  57944bd335
• Fix GetDecoder getting fallback decoder too often
  Will Kennedy · 2020-04-02 20:43:54 -04:00
  c042e709a5
• Use typeparamref.
  Huo Yaoyuan · 2019-11-17 20:48:23 +08:00
  f05b83d7d4
• Allow fallback decoder overwrite

  To fix the runtime crashes in difficulty calculation components, remove
  the check for pre-existing fallback registration along with
  the exception. The xmldoc for the registration function has been
  extended to make users aware of possible consequences of calling it.

  Bartłomiej Dach · 2019-10-04 18:20:20 +02:00
  7c2c537bc9
• Fix misleading xmldoc
  Bartłomiej Dach · 2019-09-15 01:28:07 +02:00
  dd9f620c23
• Implement fallback decoder registration

  After the preparatory introduction of LineBufferedReader, it is now
  possible to introduce registration of fallback decoders that won't drop
  input supplied in the first line of the file.
  
  A fallback decoder is used when the magic in the first line of the file
  does not match any of the other known decoders. In such a case,
  the fallback decoder is constructed and provided a LineBufferedReader
  instance. The process of matching magic only peeks the first non-empty
  line, so it is available for re-reading in Decode() using ReadLine().
  
  There can be only one fallback decoder per type; a second attempt of
  registering a fallback will result in an exception to avoid bugs.
  
  To address the issue of parsing failing on badly or non-headered files,
  set the legacy decoders for Beatmaps and Storyboards as the fallbacks.
  
  Due to non-trivial logic, several new, passing unit tests with possible
  edge cases also included.

  Bartłomiej Dach · 2019-09-15 01:28:07 +02:00
  86588778b1
• Migrate decoding to line-buffered reader

  Migrate all usages of StreamReader in the context of decoding beatmaps,
  storyboards or skins to the new LineBufferedReader.

  Bartłomiej Dach · 2019-09-15 01:28:07 +02:00
  11eda44d34
• Apply newline additions
  Dean Herbert · 2019-04-01 12:16:32 +09:00
  612db31c38
• Update licence header (and remove year)
  Dean Herbert · 2019-01-24 17:43:03 +09:00
  8617aaa2a7
• Compare with invariant culture
  smoogipoo · 2018-08-24 10:12:30 +09:00
  55370165c0
• Log the format line when a decoder isn't found
  smoogipoo · 2018-08-24 10:03:56 +09:00
  407968bb7e
• Add error handling on a per-line level in LegacyDecoder

  Resolves #2306.

  Dean Herbert · 2018-04-20 18:32:24 +09:00
  b16e25c3e9
• Normalize all the line endings
  Dean Herbert · 2018-04-13 18:26:38 +09:00
  32a74f95a5
• Use Linq.Append and Prepend.
  Huo Yaoyuan · 2018-04-02 12:06:34 +08:00
  b842f682eb
• Initial push for better decoders
  Dean Herbert · 2018-03-09 21:24:15 +09:00
  217dd2ecdc
• Remove extra braces
  Dan Balasescu · 2018-01-11 17:02:09 +09:00
  86581b6451
• fix load storyboard in osu file
  james58899 · 2018-01-10 18:55:04 +08:00
  fbffc8bb89
• Update licence headers
  Dean Herbert · 2018-01-05 20:21:19 +09:00
  37d393bca0
• Rework registration/instantiation of decoders to not rely on reflection
  smoogipoo · 2017-12-21 15:34:00 +09:00
  58859f2ffb
• reverted split at Decoder, moved logic down

  I'm done experimenting, sorry
  - `Decoder` only returns a "Beatmap"`Decoder` now
  - "Storyboard"`Decoder` is retrieved from a "Beatmap"`Decoder`
  - moved parse methods down in the hierarchy where I forgot to do that
  - renamed `OsuLegacyDecoderTest` to `LegacyDecoderTest`

  Aergwyn · 2017-12-01 22:05:01 +01:00
  c466296b14
• Split retrieving of beatmap and storyboard decoder

  Storyboard works again. Not satisfied with the solution though.

  Aergwyn · 2017-12-01 19:11:52 +01:00
  a49f3479a2