[GSoC 2017] Retroplayer: Video Shaders #86

VelocityRa · 2017-08-27T19:15:14Z

Description

This PR adds support for rendering multi-pass shader presets, as defined in this libretro spec.
The spec essentially introduces shader “preset” files: a standardized file format which allow for multi-pass shader configurations to achieve advanced filtering, without manually copying and pasting shader code all over the place.

They have other features too, but this is their core functionality and reason of existence. The biggest advantage of implementing this would be the vast library of pre-existing shaders written in this format, both for OpenGL (ES), and Direct3D.

Not all can be used yet because they porting to HLSL (thankfully the libretro/RetroArch team is on board with helping us port them), but there are hundreds of presets available.

Here's RetroArch's page on shader presets.

Here's a few other examples.

Motivation and Context

Shaders can be used to:

Smartly scale retro games for higher resolutions using pixel art scaling algorithms. Here's Zelda in 4K.
Emulate the look of old CRT or NTSC monitors for a retro feel.
Provide an easy way to apply borders to the screen.
Remove dithering artifacts
Provide anti-aliasing and smooth scaling

Adjust everything about the colour of the image in a robust way without changing application-wide settings. These including gamma, luminance, contrast, saturation.
These are just a few examples, there can be more applications that I haven’t thought of.
If I end up not implementing support for libretro’s shaders, I aim to develop/port a few shaders that will be provided by default, but shader developers can extend this by providing more.

How Has This Been Tested?

TODO

Screenshots Video:

Link

Types of change

Bug fix (non-breaking change which fixes an issue)
Improvement (non-breaking change which improves existing functionality)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

TODO

My code follows the Code guidelines of this project
My change requires a change to the documentation, either Doxygen or wiki
I have updated the documentation accordingly
I have read the CONTRIBUTING document
I have added tests to cover my change
All new and existing tests passed

garbear · 2017-08-28T19:10:31Z

xbmc/cores/RetroPlayer/rendering/VideoRenderers/RPWinRenderer.cpp

+    }
+    else
+    {
+      CRect destRect = g_graphicsContext.StereoCorrection(m_destRect);


Can you move some globals out of this class? Calling globals reduces the modularity of code.

This is copied and pasted from WinRenderer.
How would I move it out of this class? Pass it as an arg from RPRenderManager to RenderUpdate -> Render? Could do the same thing for g_Windowing.GetBackBuffer() below but I'm not sure if it would make sense for the other renderers too.

Any global depending on DX shouldn't be moved to the base class, so those can stay. geometry functions should definitely be moved up the class hierarchy

Of course, it just seemed weird that the existing Kodi code wasn't written this way.

garbear · 2017-08-28T22:50:34Z

xbmc/games/dialogs/osd/DialogGameVideoFilter.cpp

@@ -118,6 +118,9 @@ void CDialogGameVideoFilter::InitVideoFilters()
  {
    VideoFilterProperties videoFilter;

+    if (child->FirstChild() == nullptr)
+      continue;


Can you also add nullptr checks to the FirstChild() calls below?

Yea. There's an XMLUtils library that might cut down on some of the code.

I didn't use it so that we can move the parsing code to the add-on at some point.

OK, then we should add the nullptr checks to the code as it is

garbear · 2017-08-29T19:13:44Z

xbmc/games/dialogs/osd/DialogGameVideoFilter.cpp

+      videoFilter.categoryIndex = atoi(categoryIndexNode->Value());
+    TiXmlNode* descriptionNode;
+    if (((descriptionNode = child->FirstChild("description"))) && ((descriptionNode = descriptionNode->FirstChild())))
+      videoFilter.descriptionIndex = atoi(descriptionNode->Value());


Can you expand this a bit? It's hard to debug when so many things happen on one line. This will probably be a lot of code, tinyXML is rather verbose.

Yeah I was trying to avoid the horrible verboseness, but this way does make it harder to debug parsing.

garbear · 2017-08-29T19:14:51Z

xbmc/cores/RetroPlayer/rendering/VideoShaders/IVideoShaderPreset.h

    virtual VideoShaderPasses& GetPasses() = 0;
  };
+
+  inline void IVideoShaderPreset::SetVideoSize(const unsigned videoWidth, const unsigned videoHeight)


Why is this here?

Whoops, leftovers from ReSharper, I'll take care of it later today.

garbear · 2017-08-30T01:52:30Z

xbmc/games/dialogs/osd/DialogGameVideoFilter.cpp

@@ -127,17 +127,21 @@ void CDialogGameVideoFilter::InitVideoFilters()
      continue;

    TiXmlNode* pathNode;
-    if(((pathNode = child->FirstChild("path"))) && ((pathNode = pathNode->FirstChild())))
-      videoFilter.path = URIUtils::AddFileToFolder(basePath, pathNode->Value());
+    if((pathNode = child->FirstChild("path")))


Minor, but if statements are missing spaces

garbear · 2017-08-30T01:54:21Z

xbmc/cores/RetroPlayer/rendering/VideoRenderers/RPBaseRenderer.cpp

@@ -19,14 +19,15 @@
 */

 #include "RPBaseRenderer.h"
+#include "ServiceBroker.h"


Directories before files

oh I thought you had said the opposite

garbear · 2017-08-30T21:23:21Z

xbmc/cores/RetroPlayer/rendering/VideoRenderers/RPBaseRenderer.cpp

+    g_graphicsContext.Clear(g_Windowing.UseLimitedColor() ? 0x101010 : 0);
+
+  // Set alpha blend state
+  g_Windowing.SetAlphaBlendEnable(alpha < 255);


This function is only available on Windows. Can you move it and the other use of g_Windowing back to the windows renderer?

I'll remove this one but ApplyStateBlock() is fine, it's defined in CRenderSystemBase.

UseLimitedColor isn't so I'll move that one

...Oh it's in CWinSystemBase, which is not Windows specific.

garbear · 2017-08-30T21:58:22Z

xbmc/cores/RetroPlayer/rendering/VideoRenderers/RPWinRenderer.cpp

@@ -34,8 +34,6 @@ extern "C" {
 #include "libswscale/swscale.h"
 }

-#include <cstring>


This is required by std::memcpy

sorry. damnit msvc

FernetMenta · 2017-12-21T07:59:23Z

xbmc/cores/RetroPlayer/rendering/VideoShaders/windows/VideoShaderDX.cpp

+  // TODO: Doesn't work. Investigate calling this in Execute or binding the SRV first
+  //g_Windowing.Get3D11Context()->PSSetSamplers(2, 1, &m_pSampler);
+  SetShaderParameters( *sourceDX->GetPointer() );
+  Execute({ targetDX->GetPointer() }, 4);


please elaborate on this. What is Execute and what does your comment mean?

The shader spec I'm implementing allows for specifying either linear, or nearest sampling for each pass. This line was supposed to set the sampler state to the appropriate ones we've read from the shader preset file with PSSetSamplers right before rendering each pass/shader, but it didn't work.

This wasn't a huge problem as these samplers were often hardcoded in the shaders after we started porting them from Cg to HLSL/FX, instead of relying on the implementation reading the shader preset files. Ideally it'd work though, as some shaders files are re-used by different presets with different sampling.

Anyway, I think Execute refered to CWinShader::Execute, you may as well disregard that because:
Upon further inspection with the Graphics Debugger (after making the comment) it became apparent that the reason this didn't work was because the FX11 framework was applying its own samplers right before rendering, thereby overwriting whatever sampler I was setting here. I couldn't find a way to set the sampler with FX11 or overwrite, so I left it at that as it was good enough for now.

garbear · 2020-03-05T00:45:17Z

@VelocityRa I rebased this branch on 18.6 (for safety, old commit was e3ddbc4). Ready for you to squash against it

This imports several shader presets from libretro common at commit 187c161 (https://github.com/libretro/common-shaders/tree/187c161).

Hedda · 2020-09-04T08:26:22Z

Are these Video Shaders for RetroPlayer gaming still on the roadmap?

VelocityRa · 2020-09-04T09:37:09Z

The code is probably PR-ready but I still haven't gotten around to resolving the distribution issue for shaders/presets.

Hedda · 2020-09-04T12:07:12Z

The code is probably PR-ready but I still haven't gotten around to resolving the distribution issue for shaders/presets.

Are you thinking about distributing them as Add-ons for Kodi so that the user can install only if they really want to have them?

VelocityRa · 2020-09-05T13:23:00Z

I'm not sure. I don't plan on working on it for the foreseeable future, sorry.

garbear reviewed Aug 28, 2017

View reviewed changes

VelocityRa force-pushed the retroplayer-shaders branch from 961b661 to 0a9d748 Compare August 29, 2017 18:47

garbear reviewed Aug 29, 2017

View reviewed changes

VelocityRa force-pushed the retroplayer-shaders branch from 823ced1 to b44ed3f Compare August 30, 2017 00:29

garbear reviewed Aug 30, 2017

View reviewed changes

garbear mentioned this pull request Sep 14, 2017

RetroPlayer: Add renderer for Windows, OpenGL, OpenGLES and MMAL xbmc/xbmc#12715

Merged

4 tasks

garbear mentioned this pull request Sep 28, 2017

Game OSD: Video filter dialog updates xbmc/xbmc#12852

Merged

4 tasks

VelocityRa mentioned this pull request Oct 15, 2017

RetroPlayer: Cache/pre-compile output shaders xbmc/xbmc#12929

Merged

10 tasks

FernetMenta reviewed Dec 21, 2017

View reviewed changes

VelocityRa force-pushed the retroplayer-shaders branch 3 times, most recently from 20cc976 to e9c0c30 Compare October 11, 2018 00:11

garbear force-pushed the feature_shaders branch from daf0011 to e3ddbc4 Compare August 23, 2019 18:28

gusandrianos mentioned this pull request Aug 24, 2019

[GSoC 2019] RetroPlayer: OpenGL back-end for shaders #114

Draft

13 tasks

VelocityRa force-pushed the retroplayer-shaders branch from 6bfce09 to 0953483 Compare January 27, 2020 03:31

garbear force-pushed the feature_shaders branch from e3ddbc4 to 12f3bc7 Compare March 5, 2020 00:44

VelocityRa force-pushed the retroplayer-shaders branch 2 times, most recently from e9c0c30 to 7368539 Compare March 22, 2020 07:15

VelocityRa closed this Mar 22, 2020

VelocityRa force-pushed the retroplayer-shaders branch from 7368539 to 12f3bc7 Compare March 22, 2020 07:16

VelocityRa and others added 4 commits March 22, 2020 09:18

Win64 build for binary addons

33dc971

Import shader presets from libretro-common

dfe9637

This imports several shader presets from libretro common at commit 187c161 (https://github.com/libretro/common-shaders/tree/187c161).

RetroPlayer: Video Shaders

69e7021

Change video filter dialog to use imported shader preset strings

98b7055

VelocityRa reopened this Mar 22, 2020

garbear mentioned this pull request Aug 31, 2020

Update for Matrix and add CI kodi-game/game.shader.presets#2

Merged

garbear mentioned this pull request Oct 28, 2020

Clang-format our Game/Input code xbmc/xbmc#18660

Merged

7 tasks

garbear mentioned this pull request Aug 22, 2021

GSoC fixes xbmc/xbmc#20075

Merged

7 tasks

garbear mentioned this pull request Oct 9, 2021

[Backport] GSoC fixes xbmc/xbmc#20287

Merged

7 tasks

garbear mentioned this pull request Oct 22, 2021

[addons][audiodecoder] rework about audiodecoder addon system xbmc/xbmc#20317

Merged

13 tasks

garbear changed the title ~~Retroplayer: Video Shaders~~ [GSoC 2017] Retroplayer: Video Shaders May 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[GSoC 2017] Retroplayer: Video Shaders #86

[GSoC 2017] Retroplayer: Video Shaders #86

VelocityRa commented Aug 27, 2017 •

edited

Loading

garbear Aug 28, 2017

VelocityRa Aug 29, 2017

garbear Aug 29, 2017

VelocityRa Aug 29, 2017

garbear Aug 28, 2017

VelocityRa Aug 28, 2017

garbear Aug 29, 2017

VelocityRa Aug 29, 2017

garbear Aug 29, 2017

VelocityRa Aug 29, 2017

garbear Aug 29, 2017

VelocityRa Aug 29, 2017

garbear Aug 29, 2017

VelocityRa Aug 29, 2017

garbear Aug 30, 2017

garbear Aug 30, 2017

VelocityRa Aug 30, 2017

garbear Aug 30, 2017

VelocityRa Aug 30, 2017

VelocityRa Aug 30, 2017

VelocityRa Aug 30, 2017

garbear Aug 30, 2017

VelocityRa Aug 30, 2017

FernetMenta Dec 21, 2017

VelocityRa Dec 21, 2017

garbear commented Mar 5, 2020

Hedda commented Sep 4, 2020

VelocityRa commented Sep 4, 2020

Hedda commented Sep 4, 2020 •

edited

Loading

VelocityRa commented Sep 5, 2020

[GSoC 2017] Retroplayer: Video Shaders #86

Are you sure you want to change the base?

[GSoC 2017] Retroplayer: Video Shaders #86

Conversation

VelocityRa commented Aug 27, 2017 • edited Loading

Description

Here's RetroArch's page on shader presets.

Motivation and Context

How Has This Been Tested?

Screenshots Video:

Types of change

Checklist:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

garbear commented Mar 5, 2020

Hedda commented Sep 4, 2020

VelocityRa commented Sep 4, 2020

Hedda commented Sep 4, 2020 • edited Loading

VelocityRa commented Sep 5, 2020

VelocityRa commented Aug 27, 2017 •

edited

Loading

Hedda commented Sep 4, 2020 •

edited

Loading