karaoke-dev / osu-framework-font Goto Github PK

Because karaoke text(or lyric text) is based on SpriteText, which will cause error after sprite text support localization
The main solution might create it's own sprite text, not use exist one.

if change the ComputeScreenSpaceDrawQuad in the LyricSpriteText

-            var newRectangle = DrawRectangle.Scale(2);
+            var newRectangle = DrawRectangle.Scale(1.2f);

Fix ruby/romaji not in the text center.

Apply this method to prevent color change.
Need to check in every shader.

Should check the state the will recycle buffer frame (Ctrl+F3)

Separate issue #159

Because it might only have single shader in the karaoke project, so it should be OK to use SingleShaderBufferedDrawNode as default in the karaoke sprite text and lyric sprite text.
Also, it can solve the FrameBuffer recycle issue.

https://youtu.be/pWcRg7PnedE?t=97

Some karaoke software might have those behaviors.

Fix the case that might let position text cannot get the position:

• has no main text.
• text in the position text is null or empty.
• start and end index is out of range.
• end index is larger than start index.
• text with ...

How to fix that:

• Move GetFixedPositionText into PositionTextFormatter.
• GetFixedPositionTexts should only fix the duplicated value and move it inside applyPositionTextToBuilder.

Where to add the test:

• maybe TestSceneLyricSpriteTextCharacterPosition -> rename is required

something like this

should be able to have those properties:

• texture
• spacing (two vector)
• direction
• speed
• (optional)customized easing and base size

See:
https://www.geeks3d.com/20101029/shader-library-pixelation-post-processing-effect-glsl/

Sync some setting from osu-framework.
Also remember to change license header to MIT license.

lowp vec4 outline(sampler2D tex, int radius, mediump vec2 texCoord, mediump vec2 texSize, mediump vec4 colour)
{
	float angle = 0.0;
	float outlineAlpha = 0.0;
	
	for (int i = 0; i < SAMPLES; i++)
	{
		angle += 1.0 / (float(SAMPLES) / 2.0) * PI;

		// todo: might need to adjust step samples amount to fill the inner side.
		// but it will cause lots of performance issue if make step samples larger.
		// so should find a better algorithm to fill inner colour.
		for (int j = 1; j <= STEP_SAMPLES; j++)
		{
			vec2 testPoint = texCoord - vec2(sin(angle), cos(angle)) * (float(radius) * (1.0 / j)) / texSize;
			float sampledAlpha = texture2D(tex, testPoint).a;
			outlineAlpha = max(outlineAlpha, sampledAlpha);
		}
	}

	mediump vec4 ogCol = texture2D(tex, texCoord);
	vec4 outlineCol = mix(vec4(0.0), colour, outlineAlpha);

	return mix(outlineCol, ogCol, ogCol.a);
}

Here's the shader and it can see that sin(angle), cos(angle)) runs lots of time on every frame (maybe run draw_width * draw_height * SAMPLES(2) * STEP_SAMPLES(128) times in each frame)
Maybe it can be calculated at the beginning.
Not really sure has someting like void init(void) before void main(void) and only run one time.

What's should be clean-up:

• remove unneed param or include in shader.
• make internal shader test separate, one shader one test class.
• param prefix name should be same, e.g: should named g_size or m_size.

Those things might need shader support:

• sprite text.
• karaoke text.

also notice that should be able to support multi shader eventually.

See the right side of the text.

See how https://github.com/karaoke-dev/karaoke works.

Should be able to make lots of (or customize) blur effect, and is able to apply multi with order on sprite text.

Also should has flag to mark this effect is for:

• Text
• Shadow.

IDK why the looking alpha are not same, but they have assigned same alpha value.

See: https://github.com/ppy/osu-framework/pull/5241/commits

Found in #200 and #203

It's caused by GetCharacterRectangle in the TextBuilderGlyphUtils.
Should define what is the full size of a char

Might fix the height calculation.

Inspired from #182
Because more and more functions will be use in this repo.
So not really sure will it be suitable to move the function into here?

It's the root cause of karaoke-dev/karaoke#1318

We use IReadOnlyDictionary<TextIndex, double> TimeTags for passing the time-tags to the karaoke sprite text.
But the transform will need to sort by time.
.
So the interface might be IReadOnlyDictionary<double, TextIndex> TimeTags or IReadOnlyList<TimeTag>
Maybe the first one might be better because it will prevent the duplicated time.

Follow the issue in the karaoke-dev/karaoke#1318

All exist shader:

• Outline
• Pixel
• Rainbow
• Repeat moving background
• Shadow

Also need to check:

• Step shader.
• CRT effect

Because should not be possible to let the lyric crash.
Also for supporting some cool effect(like reversing).
So there's no need to sort by time and index, should just need to sort by time. in the RefreshStateTransforms.

Error:

osu.Framework.Graphics.Shaders.Shader+PartCompilationFailedException: A osu.Framework.Graphics.Shaders.ShaderPart failed to compile: sh_CRT.fs:
ERROR: 0:58: 'f' : syntax error: syntax error
   at osu.Framework.Graphics.Shaders.ShaderPart.Compile()
   at osu.Framework.Graphics.Shaders.Shader.CompileInternal()
   at osu.Framework.Graphics.Shaders.Shader.compile()
   at osu.Framework.Threading.ScheduledDelegate.RunTaskInternal()
   at osu.Framework.Threading.ScheduledDelegate.RunTask()
   at osu.Framework.Graphics.OpenGL.GLWrapper.Reset(Vector2 size)
   at osu.Framework.Platform.GameHost.DrawFrame()
   at osu.Framework.Threading.GameThread.processFrame()
--- End of stack trace from previous location ---
   at osu.Framework.Platform.GameHost.<>c__DisplayClass120_0.<abortExecutionFromException>b__0()
   at osu.Framework.Threading.ScheduledDelegate.RunTaskInternal()
   at osu.Framework.Threading.Scheduler.Update()
   at osu.Framework.Threading.GameThread.processFrame()
   at osu.Framework.Threading.GameThread.RunSingleFrame()
   at osu.Framework.Platform.ThreadRunner.RunMainLoop()
   at osu.Framework.Platform.GameHost.windowUpdate()
   at osu.Framework.Platform.SDL2DesktopWindow.Run()
   at osu.Framework.Platform.GameHost.Run(Game game)
   at osu.Framework.Font.Tests.Program.Main(String[] args) in /Volumes/Data/Github/karaoke-dev/osu-framework-font/osu.Framework.Font.Tests/Program.cs:line 21

It might by caused by "compile error", not "file not found"

karaoke-dev/karaoke#1312
This issue should be fixed in the framework.

Something like this, not really sure how to name that in english 🤔

https://www.google.com/url?sa=i&url=https%3A%2F%2Fwww.shutterstock.com%2Fvideo%2Fsearch%2Feat-sleep-repeat&psig=AOvVaw32spqiV4MIbuXpoxQKwQUF&ust=1633613518112000&source=images&cd=vfe&ved=0CAoQjhxqFwoTCKDGwuDytfMCFQAAAAAdAAAAABAL

Might be able to affect every character position like the image

1. make a check why this shit happens, might be DrawWidth equal to 0?
2. add a test case for just testing the time property in karaoke sprite text, also this test case should be able to adjust the time.

See mixed texture deleted before, not really sure will be implemented by shader 🤔
https://github.com/karaoke-dev/osu-framework-font/blob/2021.0708.0/osu.Framework.Font/Graphics/Sprites/ILyricTexture.cs

What's should be modified after #45 merged:

• outline and shadow shader should not need to render the original texture.
• create a shader to render origin texture (or add a property in outline shader)?
• fix all the shader test cases.

Notice that not deal with this issue before.
Because already filter the duplicated time-tag in the karaoke project.

Inspired from #157
Because still have some spacing in the first lyric's left side if contains draw extra spacing.
So should add delta with that.

We should deal with those extra sizing.

• It might be available if apply the shadow effect.
• Extra sizing does not include outline.

Sometimes ruby/romaji not change after set value.

Able to apply extra texture in fonts.

The easy way to fix that is make sure that this.Rubies should not be null in the GetRomajiTagPosition()

Because:

• Draw rectangle is not able to be assigned in the TextBuilderGlyph.
• Some of the params might not be use in the TextBuilder.

The safety way is to calculate outline texture, not in render.
See how this demo works.
.
Edit :
oops this demo seems cannot use because it's slow and not perfect.

Remain issue in the #157
Found in the karaoke-dev/karaoke#1293

Should re-calculate the transforms if change the shader in the karaoke sprite text.

Should not show the yellow area.
.
What's should be fixed:

• write something like IHasExtraSize or IAffectRelativePosition to let KaraokeSpriteText able to adjust the position.'
• Add this property to OutlineShader only. Maybe will added in the StepShader also(for able to sum the outline)
• Not really sure is there any way to change the lyric sprite size? Or is there any way to change the draw size?

Also, should write a test scene:

• Maybe named TestSceneKaraokeSpriteTextWithTimeTags
• Show the lyric with single or multi outline.
• Able to change the clock time.
• Should prevent clear the expired transformers.
• Able to adjust the scale.

Inspired from #157
Should make something like the image below:

If not add the end time-tag before the next time-tag, will let the lyric effect moving faster because moving position will include that spacing.
This issue might be noticed if the character spacing become larger.

How to implement:

• Make internal static function to calculate the value that need to be insert between every input time-tag.
• Write a test case to check calculating result.

As title, missing the calculation in the KaraokeSpriteText

protected override Quad ComputeScreenSpaceDrawQuad()
{
    // make draw size become bigger (for not masking the shader).
    var newRectangle = DrawRectangle.Scale(2);
    return ToScreenSpace(newRectangle);
}

It should be the union value of:

• Shaders
• LeftLyricTextShaders
• RightLyricTextShaders

Found in karaoke-dev/karaoke#339
Need to make a fix.

In this demo implemented in the #172
It's easy to show that border size is not same as what render result is.

It's caused because osu!framework is not pixel perfect framework.
Means size 10 is not means 10 pixel in the screen.

So there's two way to fix that.

• all sizing-related params in the shade should be converted as what osu-framework using.
• should adjust the size in the ComputeCharacterDrawRectangle. here's the sample to get the size matching to the render size: originalCharacterDrawRectangle.Inflate(Math.Max(Radius * 88f / 256f, 0));

What's needed in this issue:

• able to get all prarms in internal shader.
• able to apply value from to internal shader.

Fix the case that DrawableNode and DrawCells frequency changed if need to update shader in every frame.

That calculation can be very simple if using transform.
Might add some test also?