├── .github └── workflows │ ├── dotnet-core.yml │ └── latest-otd.yml ├── .gitignore ├── .gitmodules ├── AbstractOTDPlugins.sln ├── BezierInterpolator ├── BezierInterp.cs └── BezierInterpolator.csproj ├── LICENSE ├── README.md ├── RadialFollow ├── README.md ├── RadialFollow.csproj ├── RadialFollowCore.cs ├── RadialFollowGraphs.ggb ├── RadialFollowSmoothingScreenSpace.cs └── RadialFollowSmoothingTabletSpace.cs ├── SinCursor ├── SinCursor.cs └── SinCursor.csproj ├── TouchTapping ├── TouchTapping.cs └── TouchTapping.csproj └── build.ps1 /.github/workflows/dotnet-core.yml: -------------------------------------------------------------------------------- 1 | name: .NET Core 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | 8 | jobs: 9 | Build: 10 | strategy: 11 | matrix: 12 | include: 13 | - plugin: BezierInterpolator 14 | - plugin: RadialFollow 15 | - plugin: TouchTapping 16 | - plugin: SinCursor 17 | 18 | runs-on: ubuntu-latest 19 | steps: 20 | - name: Checkout 21 | uses: actions/checkout@main 22 | with: 23 | submodules: recursive 24 | 25 | - name: Setup dotnet 26 | uses: actions/setup-dotnet@main 27 | with: 28 | dotnet-version: '6.0.x' 29 | 30 | - name: Publish 31 | env: 32 | plugin: ${{ matrix.plugin }} 33 | run: dotnet publish $plugin --configuration Release -f net6.0 -p:DebugType=embedded -o ./build/ 34 | 35 | - name: Upload binaries 36 | uses: actions/upload-artifact@main 37 | with: 38 | name: ${{ matrix.plugin }} 39 | path: | 40 | ./build/*.dll 41 | !./build/*.json 42 | !./build/OpenTabletDriver.Plugin.dll 43 | -------------------------------------------------------------------------------- /.github/workflows/latest-otd.yml: -------------------------------------------------------------------------------- 1 | name: Latest OTD build 2 | 3 | on: 4 | # schedule: 5 | # - cron: '0 5 * * 1' 6 | workflow_dispatch: 7 | 8 | jobs: 9 | Build: 10 | strategy: 11 | matrix: 12 | include: 13 | - plugin: BezierInterpolator 14 | - plugin: RadialFollow 15 | - plugin: TouchTapping 16 | - plugin: SinCursor 17 | 18 | runs-on: ubuntu-latest 19 | steps: 20 | - name: Checkout 21 | uses: actions/checkout@main 22 | 23 | - name: Get latest OTD 24 | run: | 25 | git submodule update --init --force --remote --merge 26 | echo "OTD_sha=$(git submodule status | cut -c 2-8)" >> $GITHUB_ENV 27 | 28 | - name: Setup dotnet 29 | uses: actions/setup-dotnet@main 30 | with: 31 | dotnet-version: '6.0.x' 32 | 33 | - name: Publish 34 | env: 35 | plugin: ${{ matrix.plugin }} 36 | run: dotnet publish $plugin --configuration Release -f net6.0 -p:DebugType=embedded -o ./build/ 37 | 38 | - name: Upload binaries 39 | uses: actions/upload-artifact@main 40 | with: 41 | name: ${{ format('{0} OTD_{1}', matrix.plugin, env.OTD_sha) }} 42 | path: | 43 | ./build/*.dll 44 | !./build/*.json 45 | !./build/OpenTabletDriver.Plugin.dll 46 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.rsuser 8 | *.suo 9 | *.user 10 | *.userosscache 11 | *.sln.docstates 12 | 13 | # User-specific files (MonoDevelop/Xamarin Studio) 14 | *.userprefs 15 | 16 | # Mono auto generated files 17 | mono_crash.* 18 | 19 | # Build results 20 | [Dd]ebug/ 21 | [Dd]ebugPublic/ 22 | [Rr]elease/ 23 | [Rr]eleases/ 24 | x64/ 25 | x86/ 26 | [Aa][Rr][Mm]/ 27 | [Aa][Rr][Mm]64/ 28 | bld/ 29 | [Bb]in/ 30 | [Oo]bj/ 31 | [Ll]og/ 32 | [Ll]ogs/ 33 | 34 | # Visual Studio 2015/2017 cache/options directory 35 | .vs/ 36 | # Uncomment if you have tasks that create the project's static files in wwwroot 37 | #wwwroot/ 38 | 39 | # Visual Studio 2017 auto generated files 40 | Generated\ Files/ 41 | 42 | # MSTest test Results 43 | [Tt]est[Rr]esult*/ 44 | [Bb]uild[Ll]og.* 45 | 46 | # NUnit 47 | *.VisualState.xml 48 | TestResult.xml 49 | nunit-*.xml 50 | 51 | # Build Results of an ATL Project 52 | [Dd]ebugPS/ 53 | [Rr]eleasePS/ 54 | dlldata.c 55 | 56 | # Benchmark Results 57 | BenchmarkDotNet.Artifacts/ 58 | 59 | # .NET Core 60 | project.lock.json 61 | project.fragment.lock.json 62 | artifacts/ 63 | 64 | # StyleCop 65 | StyleCopReport.xml 66 | 67 | # Files built by Visual Studio 68 | *_i.c 69 | *_p.c 70 | *_h.h 71 | *.ilk 72 | *.meta 73 | *.obj 74 | *.iobj 75 | *.pch 76 | *.pdb 77 | *.ipdb 78 | *.pgc 79 | *.pgd 80 | *.rsp 81 | *.sbr 82 | *.tlb 83 | *.tli 84 | *.tlh 85 | *.tmp 86 | *.tmp_proj 87 | *_wpftmp.csproj 88 | *.log 89 | *.vspscc 90 | *.vssscc 91 | .builds 92 | *.pidb 93 | *.svclog 94 | *.scc 95 | 96 | # Chutzpah Test files 97 | _Chutzpah* 98 | 99 | # Visual C++ cache files 100 | ipch/ 101 | *.aps 102 | *.ncb 103 | *.opendb 104 | *.opensdf 105 | *.sdf 106 | *.cachefile 107 | *.VC.db 108 | *.VC.VC.opendb 109 | 110 | # Visual Studio profiler 111 | *.psess 112 | *.vsp 113 | *.vspx 114 | *.sap 115 | 116 | # Visual Studio Trace Files 117 | *.e2e 118 | 119 | # TFS 2012 Local Workspace 120 | $tf/ 121 | 122 | # Guidance Automation Toolkit 123 | *.gpState 124 | 125 | # ReSharper is a .NET coding add-in 126 | _ReSharper*/ 127 | *.[Rr]e[Ss]harper 128 | *.DotSettings.user 129 | 130 | # TeamCity is a build add-in 131 | _TeamCity* 132 | 133 | # DotCover is a Code Coverage Tool 134 | *.dotCover 135 | 136 | # AxoCover is a Code Coverage Tool 137 | .axoCover/* 138 | !.axoCover/settings.json 139 | 140 | # Visual Studio code coverage results 141 | *.coverage 142 | *.coveragexml 143 | 144 | # NCrunch 145 | _NCrunch_* 146 | .*crunch*.local.xml 147 | nCrunchTemp_* 148 | 149 | # MightyMoose 150 | *.mm.* 151 | AutoTest.Net/ 152 | 153 | # Web workbench (sass) 154 | .sass-cache/ 155 | 156 | # Installshield output folder 157 | [Ee]xpress/ 158 | 159 | # DocProject is a documentation generator add-in 160 | DocProject/buildhelp/ 161 | DocProject/Help/*.HxT 162 | DocProject/Help/*.HxC 163 | DocProject/Help/*.hhc 164 | DocProject/Help/*.hhk 165 | DocProject/Help/*.hhp 166 | DocProject/Help/Html2 167 | DocProject/Help/html 168 | 169 | # Click-Once directory 170 | publish/ 171 | 172 | # Publish Web Output 173 | *.[Pp]ublish.xml 174 | *.azurePubxml 175 | # Note: Comment the next line if you want to checkin your web deploy settings, 176 | # but database connection strings (with potential passwords) will be unencrypted 177 | *.pubxml 178 | *.publishproj 179 | 180 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 181 | # checkin your Azure Web App publish settings, but sensitive information contained 182 | # in these scripts will be unencrypted 183 | PublishScripts/ 184 | 185 | # NuGet Packages 186 | *.nupkg 187 | # NuGet Symbol Packages 188 | *.snupkg 189 | # The packages folder can be ignored because of Package Restore 190 | **/[Pp]ackages/* 191 | # except build/, which is used as an MSBuild target. 192 | !**/[Pp]ackages/build/ 193 | # Uncomment if necessary however generally it will be regenerated when needed 194 | #!**/[Pp]ackages/repositories.config 195 | # NuGet v3's project.json files produces more ignorable files 196 | *.nuget.props 197 | *.nuget.targets 198 | 199 | # Microsoft Azure Build Output 200 | csx/ 201 | *.build.csdef 202 | 203 | # Microsoft Azure Emulator 204 | ecf/ 205 | rcf/ 206 | 207 | # Windows Store app package directories and files 208 | AppPackages/ 209 | BundleArtifacts/ 210 | Package.StoreAssociation.xml 211 | _pkginfo.txt 212 | *.appx 213 | *.appxbundle 214 | *.appxupload 215 | 216 | # Visual Studio cache files 217 | # files ending in .cache can be ignored 218 | *.[Cc]ache 219 | # but keep track of directories ending in .cache 220 | !?*.[Cc]ache/ 221 | 222 | # Others 223 | ClientBin/ 224 | ~$* 225 | *~ 226 | *.dbmdl 227 | *.dbproj.schemaview 228 | *.jfm 229 | *.pfx 230 | *.publishsettings 231 | orleans.codegen.cs 232 | 233 | # Including strong name files can present a security risk 234 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 235 | #*.snk 236 | 237 | # Since there are multiple workflows, uncomment next line to ignore bower_components 238 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 239 | #bower_components/ 240 | 241 | # RIA/Silverlight projects 242 | Generated_Code/ 243 | 244 | # Backup & report files from converting an old project file 245 | # to a newer Visual Studio version. Backup files are not needed, 246 | # because we have git ;-) 247 | _UpgradeReport_Files/ 248 | Backup*/ 249 | UpgradeLog*.XML 250 | UpgradeLog*.htm 251 | ServiceFabricBackup/ 252 | *.rptproj.bak 253 | 254 | # SQL Server files 255 | *.mdf 256 | *.ldf 257 | *.ndf 258 | 259 | # Business Intelligence projects 260 | *.rdl.data 261 | *.bim.layout 262 | *.bim_*.settings 263 | *.rptproj.rsuser 264 | *- [Bb]ackup.rdl 265 | *- [Bb]ackup ([0-9]).rdl 266 | *- [Bb]ackup ([0-9][0-9]).rdl 267 | 268 | # Microsoft Fakes 269 | FakesAssemblies/ 270 | 271 | # GhostDoc plugin setting file 272 | *.GhostDoc.xml 273 | 274 | # Node.js Tools for Visual Studio 275 | .ntvs_analysis.dat 276 | node_modules/ 277 | 278 | # Visual Studio 6 build log 279 | *.plg 280 | 281 | # Visual Studio 6 workspace options file 282 | *.opt 283 | 284 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 285 | *.vbw 286 | 287 | # Visual Studio LightSwitch build output 288 | **/*.HTMLClient/GeneratedArtifacts 289 | **/*.DesktopClient/GeneratedArtifacts 290 | **/*.DesktopClient/ModelManifest.xml 291 | **/*.Server/GeneratedArtifacts 292 | **/*.Server/ModelManifest.xml 293 | _Pvt_Extensions 294 | 295 | # Paket dependency manager 296 | .paket/paket.exe 297 | paket-files/ 298 | 299 | # FAKE - F# Make 300 | .fake/ 301 | 302 | # CodeRush personal settings 303 | .cr/personal 304 | 305 | # Python Tools for Visual Studio (PTVS) 306 | __pycache__/ 307 | *.pyc 308 | 309 | # Cake - Uncomment if you are using it 310 | # tools/** 311 | # !tools/packages.config 312 | 313 | # Tabs Studio 314 | *.tss 315 | 316 | # Telerik's JustMock configuration file 317 | *.jmconfig 318 | 319 | # BizTalk build output 320 | *.btp.cs 321 | *.btm.cs 322 | *.odx.cs 323 | *.xsd.cs 324 | 325 | # OpenCover UI analysis results 326 | OpenCover/ 327 | 328 | # Azure Stream Analytics local run output 329 | ASALocalRun/ 330 | 331 | # MSBuild Binary and Structured Log 332 | *.binlog 333 | 334 | # NVidia Nsight GPU debugger configuration file 335 | *.nvuser 336 | 337 | # MFractors (Xamarin productivity tool) working folder 338 | .mfractor/ 339 | 340 | # Local History for Visual Studio 341 | .localhistory/ 342 | 343 | # BeatPulse healthcheck temp database 344 | healthchecksdb 345 | 346 | # Backup folder for Package Reference Convert tool in Visual Studio 2017 347 | MigrationBackup/ 348 | 349 | # Ionide (cross platform F# VS Code tools) working folder 350 | .ionide/ 351 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule ".modules/OpenTabletDriver"] 2 | path = .modules/OpenTabletDriver 3 | url = https://github.com/OpenTabletDriver/OpenTabletDriver.git 4 | branch = master 5 | -------------------------------------------------------------------------------- /AbstractOTDPlugins.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 16 4 | VisualStudioVersion = 16.0.30615.102 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTabletDriver.Plugin", ".modules\OpenTabletDriver\OpenTabletDriver.Plugin\OpenTabletDriver.Plugin.csproj", "{49359233-BAF9-4D4B-A61E-8211256DBE7B}" 7 | EndProject 8 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "BezierInterpolator", "BezierInterpolator\BezierInterpolator.csproj", "{205D626F-299D-4BC1-906A-707700E7C7ED}" 9 | EndProject 10 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RadialFollow", "RadialFollow\RadialFollow.csproj", "{1A38AD2D-E0EB-4B1A-92F9-250F2CCA222E}" 11 | EndProject 12 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TouchTapping", "TouchTapping\TouchTapping.csproj", "{E0439839-9F9D-4DAD-8A7E-1ED0A027555C}" 13 | EndProject 14 | Project("{9A19103F-16F7-4668-BE54-9A1E7A2F7556}") = "SinCursor", "SinCursor\SinCursor.csproj", "{E0439839-9F9D-4DAD-8A7E-1ED0A022555C}" 15 | EndProject 16 | Global 17 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 18 | Debug|Any CPU = Debug|Any CPU 19 | Release|Any CPU = Release|Any CPU 20 | EndGlobalSection 21 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 22 | {49359233-BAF9-4D4B-A61E-8211256DBE7B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 23 | {49359233-BAF9-4D4B-A61E-8211256DBE7B}.Debug|Any CPU.Build.0 = Debug|Any CPU 24 | {49359233-BAF9-4D4B-A61E-8211256DBE7B}.Release|Any CPU.ActiveCfg = Release|Any CPU 25 | {49359233-BAF9-4D4B-A61E-8211256DBE7B}.Release|Any CPU.Build.0 = Release|Any CPU 26 | {205D626F-299D-4BC1-906A-707700E7C7ED}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 27 | {205D626F-299D-4BC1-906A-707700E7C7ED}.Debug|Any CPU.Build.0 = Debug|Any CPU 28 | {205D626F-299D-4BC1-906A-707700E7C7ED}.Release|Any CPU.ActiveCfg = Release|Any CPU 29 | {205D626F-299D-4BC1-906A-707700E7C7ED}.Release|Any CPU.Build.0 = Release|Any CPU 30 | {1A38AD2D-E0EB-4B1A-92F9-250F2CCA222E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 31 | {1A38AD2D-E0EB-4B1A-92F9-250F2CCA222E}.Debug|Any CPU.Build.0 = Debug|Any CPU 32 | {1A38AD2D-E0EB-4B1A-92F9-250F2CCA222E}.Release|Any CPU.ActiveCfg = Release|Any CPU 33 | {1A38AD2D-E0EB-4B1A-92F9-250F2CCA222E}.Release|Any CPU.Build.0 = Release|Any CPU 34 | EndGlobalSection 35 | GlobalSection(SolutionProperties) = preSolution 36 | HideSolutionNode = FALSE 37 | EndGlobalSection 38 | GlobalSection(ExtensibilityGlobals) = postSolution 39 | SolutionGuid = {DBC31C15-D8CD-4EF7-A3E6-20B77D84CB55} 40 | EndGlobalSection 41 | EndGlobal 42 | -------------------------------------------------------------------------------- /BezierInterpolator/BezierInterp.cs: -------------------------------------------------------------------------------- 1 | using System.Numerics; 2 | using OpenTabletDriver.Plugin.Attributes; 3 | using OpenTabletDriver.Plugin.Output; 4 | using OpenTabletDriver.Plugin.Tablet; 5 | using OpenTabletDriver.Plugin.Timing; 6 | 7 | namespace BezierInterpolator 8 | { 9 | [PluginName("BezierInterpolator")] 10 | public class BezierInterp : AsyncPositionedPipelineElement 11 | { 12 | public BezierInterp() : base() 13 | { 14 | } 15 | 16 | public override PipelinePosition Position => PipelinePosition.PostTransform; 17 | 18 | [Property("Pre-interpolation smoothing factor"), DefaultPropertyValue(1.0f), ToolTip 19 | ( 20 | "Sets the factor of pre-interpolation simple exponential smoothing (aka EMA weight).\n\n" + 21 | "Possible values are 0.01 .. 1\n" + 22 | "Factor of 1 means no smoothing is applied, smaller values add smoothing." 23 | )] 24 | public float SmoothingFactor 25 | { 26 | get { return emaWeight; } 27 | set { emaWeight = System.Math.Clamp(value, 0.0f, 1.0f); } 28 | } 29 | private float emaWeight; 30 | 31 | [Property("Tilt smoothing factor"), DefaultPropertyValue(1.0f), ToolTip 32 | ( 33 | "For tablets that report tilt, sets the factor of simple exponential smoothing (aka EMA weight) for tilt values.\n\n" + 34 | "Possible values are 0.01 .. 1\n" + 35 | "Factor of 1 means no smoothing is applied, smaller values add smoothing." 36 | )] 37 | public float TiltSmoothingFactor 38 | { 39 | get { return tiltWeight; } 40 | set { tiltWeight = System.Math.Clamp(value, 0.0f, 1.0f); } 41 | } 42 | private float tiltWeight; 43 | 44 | protected override void UpdateState() 45 | { 46 | float alpha = (float)(reportStopwatch.Elapsed.TotalSeconds * Frequency / reportMsAvg); 47 | 48 | if (State is ITiltReport tiltReport) 49 | { 50 | tiltReport.Tilt = Vector2.Lerp(previousTiltTraget, tiltTraget, alpha); 51 | State = tiltReport; 52 | } 53 | 54 | if (State is ITabletReport report && PenIsInRange()) 55 | { 56 | var lerp1 = Vector3.Lerp(previousTarget, controlPoint, alpha); 57 | var lerp2 = Vector3.Lerp(controlPoint, target, alpha); 58 | var res = Vector3.Lerp(lerp1, lerp2, alpha); 59 | report.Position = new Vector2(res.X, res.Y); 60 | report.Pressure = report.Pressure == 0 ? 0 : (uint)(res.Z); 61 | State = report; 62 | OnEmit(); 63 | } 64 | } 65 | 66 | protected override void ConsumeState() 67 | { 68 | if (State is ITiltReport tiltReport) 69 | { 70 | if (!vec2IsFinite(tiltTraget)) tiltTraget = tiltReport.Tilt; 71 | previousTiltTraget = tiltTraget; 72 | tiltTraget += tiltWeight * (tiltReport.Tilt - tiltTraget); 73 | } 74 | 75 | if (State is ITabletReport report) 76 | { 77 | var consumeDelta = (float)reportStopwatch.Restart().TotalMilliseconds; 78 | if (consumeDelta < 150) 79 | reportMsAvg += ((consumeDelta - reportMsAvg) * 0.1f); 80 | 81 | emaTarget = vec2IsFinite(emaTarget) ? emaTarget : report.Position; 82 | emaTarget += emaWeight * (report.Position - emaTarget); 83 | 84 | controlPoint = controlPointNext; 85 | controlPointNext = new Vector3(emaTarget, report.Pressure); 86 | 87 | previousTarget = target; 88 | target = Vector3.Lerp(controlPoint, controlPointNext, 0.5f); 89 | } 90 | else OnEmit(); 91 | } 92 | 93 | private Vector2 emaTarget, tiltTraget, previousTiltTraget; 94 | private Vector3 controlPointNext, controlPoint, target, previousTarget; 95 | private HPETDeltaStopwatch reportStopwatch = new HPETDeltaStopwatch(); 96 | private float reportMsAvg = 5; 97 | 98 | private bool vec2IsFinite(Vector2 vec) => float.IsFinite(vec.X) & float.IsFinite(vec.Y); 99 | } 100 | } 101 | -------------------------------------------------------------------------------- /BezierInterpolator/BezierInterpolator.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | net6.0 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # AbstractOTDPlugins [![Total Download Count](https://img.shields.io/github/downloads/AbstractQbit/AbstractOTDPlugins/total.svg)](https://github.com/AbstractQbit/AbstractOTDPlugins/releases) 2 | A set of plugins for [OpenTabletDriver](https://github.com/OpenTabletDriver/OpenTabletDriver). 3 | 4 | 5 | ## Bezier interpolator 6 | Interpolator that spatially smoothes out drawn lines by interpreting pen path as a continuous spline. Raw data points work as control points and midpoints between them work as end points of each curve. 7 | 8 | 9 | ## [Radial Follow Smoothing](RadialFollow/README.md) 10 | The Ultimate Smoothing Plugin, providing cursor stability while still allowing to hit fast jumps with ease. 11 | To view how different parameters affect the operating curve, open [RadialFollow/RadialFollowGraphs.ggb](RadialFollow/RadialFollowGraphs.ggb) in a [GeoGebra calculator](https://www.geogebra.org/calculator). 12 | 13 | ## Touch Tapping 14 | Allows using tablets with touch sensitivity as a two key tapping pad. 15 | 16 | 17 | ## sin(cursor) 18 | Makes the cursor wiggle in a sine wave. 19 | 20 | 21 | ## License 22 | This software is licensed under `GPL-3.0-only` license. 23 | Portions of this software are licensed under `MPL-2.0` license where specified in the file header. 24 | -------------------------------------------------------------------------------- /RadialFollow/README.md: -------------------------------------------------------------------------------- 1 | # Radial Follow Smoothing 2 | The Ultimate Smoothing Plugin, providing cursor stability while still allowing to hit fast jumps with ease. 3 | To view how different parameters affect the operating curve, open [RadialFollow/RadialFollowGraphs.ggb](RadialFollowGraphs.ggb) in a [GeoGebra calculator](https://www.geogebra.org/calculator). 4 | 5 | ## Outer Radius 6 | Outer radius defines the max distance the cursor can lag behind the actual reading. 7 | 8 | Unit of measurement is pixels or millimetres (screen space and tablet space modes respectively). 9 | The value should be >= 0 and inner radius. 10 | If smoothing leak is used, defines the point at which smoothing will be reduced, 11 | instead of hard clamping the max distance between the tablet position and a cursor. 12 | 13 | Default value is 5.0 px / 1.0 mm 14 | 15 | ## Inner Radius 16 | Inner radius defines the max distance the tablet reading can deviate from the cursor without moving it. 17 | 18 | This effectively creates a deadzone in which no movement is produced. 19 | Unit of measurement is pixels or millimetres (screen space and tablet space modes respectively). 20 | The value should be >= 0 and <= outer radius. 21 | 22 | Default value is 0.0 px / 0.0 mm 23 | 24 | ## Smoothing Coefficient 25 | Smoothing coefficient determines how fast or slow the cursor will descend from the outer radius to the inner. 26 | 27 | Possible value range is 0.0001..1, higher values mean more smoothing (slower descent to the inner radius). 28 | 29 | Default value is 0.95 30 | 31 | ## Soft Knee Scale 32 | Soft knee scale determines how soft the transition between smoothing inside and outside the outer radius is. 33 | 34 | Possible value range is 0..100, higher values mean softer transition. 35 | The effect is somewhat logarithmic, i.e. most of the change happens closer to zero. 36 | 37 | Default value is 1.0 38 | 39 | ## Smoothing Leak Coefficient 40 | Smoothing leak coefficient allows for input smooting to continue past outer radius at a reduced rate. 41 | 42 | Possible value range is 0..1, 0 means no smoothing past outer radius, 1 means 100% of the smoothing gets through. 43 | 44 | Default value is 0.0 45 | 46 | -------------------------------------------------------------------------------- /RadialFollow/RadialFollow.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | net6.0 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /RadialFollow/RadialFollowCore.cs: -------------------------------------------------------------------------------- 1 | /* This Source Code Form is subject to the terms of the Mozilla Public 2 | * License, v. 2.0. If a copy of the MPL was not distributed with this 3 | * file, You can obtain one at https://mozilla.org/MPL/2.0/. */ 4 | 5 | using System; 6 | using System.Numerics; 7 | using OpenTabletDriver.Plugin.Timing; 8 | 9 | namespace RadialFollow 10 | { 11 | public class RadialFollowCore 12 | { 13 | 14 | public double OuterRadius 15 | { 16 | get { return rOuter; } 17 | set { rOuter = System.Math.Clamp(value, 0.0f, 1000000.0f); } 18 | } 19 | private double rOuter = 0; 20 | 21 | public double InnerRadius 22 | { 23 | get { return rInner; } 24 | set { rInner = System.Math.Clamp(value, 0.0f, 1000000.0f); } 25 | } 26 | private double rInner = 0; 27 | 28 | public double SmoothingCoefficient 29 | { 30 | get { return smoothCoef; } 31 | set { smoothCoef = System.Math.Clamp(value, 0.0001f, 1.0f); } 32 | } 33 | private double smoothCoef; 34 | 35 | public double SoftKneeScale 36 | { 37 | get { return knScale; } 38 | set { knScale = System.Math.Clamp(value, 0.0f, 100.0f); updateDerivedParams(); } 39 | } 40 | private double knScale; 41 | 42 | public double SmoothingLeakCoefficient 43 | { 44 | get { return leakCoef; } 45 | set { leakCoef = System.Math.Clamp(value, 0.0f, 1.0f); } 46 | } 47 | private double leakCoef; 48 | public float SampleRadialCurve(float dist) => (float)deltaFn(dist, xOffset, scaleComp); 49 | public double ResetMs = 50; 50 | public double GridScale = 1; 51 | 52 | Vector2 cursor; 53 | HPETDeltaStopwatch stopwatch = new HPETDeltaStopwatch(true); 54 | 55 | public Vector2 Filter(Vector2 target) 56 | { 57 | Vector2 direction = target - cursor; 58 | float distToMove = SampleRadialCurve(direction.Length()); 59 | direction = Vector2.Normalize(direction); 60 | cursor = cursor + Vector2.Multiply(direction, distToMove); 61 | 62 | // Catch NaNs and pen redetection 63 | if (!(float.IsFinite(cursor.X) & float.IsFinite(cursor.Y) & stopwatch.Restart().TotalMilliseconds < 50)) 64 | cursor = target; 65 | 66 | return cursor; 67 | } 68 | 69 | double xOffset, scaleComp; 70 | void updateDerivedParams() 71 | { 72 | if (knScale > 0.0001f) 73 | { 74 | xOffset = getXOffest(); 75 | scaleComp = getScaleComp(); 76 | } 77 | else // Calculating them with functions would cause / by 0 78 | { 79 | xOffset = -1; 80 | scaleComp = 1; 81 | } 82 | } 83 | 84 | /// Math functions 85 | 86 | double kneeFunc(double x) => x switch 87 | { 88 | < -3 => x, 89 | < 3 => Math.Log(Math.Tanh(Math.Exp(x)), Math.E), 90 | _ => 0, 91 | }; 92 | 93 | double kneeScaled(double x) => knScale switch 94 | { 95 | > 0.0001f => knScale * kneeFunc(x / knScale) + 1, 96 | _ => x > 0 ? 1 : 1 + x, 97 | }; 98 | 99 | double inverseTanh(double x) => Math.Log((1 + x) / (1 - x), Math.E) / 2; 100 | 101 | double inverseKneeScaled(double x) => knScale * Math.Log(inverseTanh(Math.Exp((x - 1) / knScale)), Math.E); 102 | 103 | double derivKneeScaled(double x) 104 | { 105 | var e = Math.Exp(x / knScale); 106 | var tanh = Math.Tanh(e); 107 | return (e - e * (tanh * tanh)) / tanh; 108 | } 109 | 110 | double getXOffest() => inverseKneeScaled(0); 111 | 112 | double getScaleComp() => derivKneeScaled(getXOffest()); 113 | 114 | double rOuterAdjusted => GridScale * Math.Max(rOuter, rInner + 0.0001f); 115 | double rInnerAdjusted => GridScale * rInner; 116 | 117 | double leakedFn(double x, double offset, double scaleComp) 118 | => kneeScaled(x + offset) * (1 - leakCoef) + x * leakCoef * scaleComp; 119 | 120 | double smoothedFn(double x, double offset, double scaleComp) 121 | => leakedFn(x * smoothCoef / scaleComp, offset, scaleComp); 122 | 123 | double scaleToOuter(double x, double offset, double scaleComp) 124 | => (rOuterAdjusted - rInnerAdjusted) * smoothedFn(x / (rOuterAdjusted - rInnerAdjusted), offset, scaleComp); 125 | 126 | double deltaFn(double x, double offset, double scaleComp) 127 | => x > rInnerAdjusted ? x - scaleToOuter(x - rInnerAdjusted, offset, scaleComp) - rInnerAdjusted : 0; 128 | } 129 | } 130 | -------------------------------------------------------------------------------- /RadialFollow/RadialFollowGraphs.ggb: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AbstractQbit/AbstractOTDPlugins/ba5d418aa1cce3bdc8c8d0b5940baeb7ec835e5c/RadialFollow/RadialFollowGraphs.ggb -------------------------------------------------------------------------------- /RadialFollow/RadialFollowSmoothingScreenSpace.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using OpenTabletDriver.Plugin.Attributes; 3 | using OpenTabletDriver.Plugin.Output; 4 | using OpenTabletDriver.Plugin.Tablet; 5 | 6 | namespace RadialFollow 7 | { 8 | [PluginName("AbstractQbit's Radial Follow Smoothing (Screen coordinates)")] 9 | public class RadialFollowSmoothingScreenSpace : IPositionedPipelineElement 10 | { 11 | public RadialFollowSmoothingScreenSpace() : base() { } 12 | public PipelinePosition Position => PipelinePosition.Pixels; 13 | 14 | [Property("Outer Radius"), DefaultPropertyValue(5.0d), Unit("px"), ToolTip 15 | ( 16 | "Outer radius defines the max distance the cursor can lag behind the actual reading.\n\n" + 17 | "Unit of measurement is pixels.\n" + 18 | "The value should be >= 0 and inner radius.\n" + 19 | "If smoothing leak is used, defines the point at which smoothing will be reduced,\n" + 20 | "instead of hard clamping the max distance between the tablet position and a cursor.\n\n" + 21 | "Default value is 5.0 px" 22 | )] 23 | public double OuterRadius 24 | { 25 | get => radialCore.OuterRadius; 26 | set { radialCore.OuterRadius = value; } 27 | } 28 | 29 | [Property("Inner Radius"), DefaultPropertyValue(0.0d), Unit("px"), ToolTip 30 | ( 31 | "Inner radius defines the max distance the tablet reading can deviate from the cursor without moving it.\n" + 32 | "This effectively creates a deadzone in which no movement is produced.\n\n" + 33 | "Unit of measurement is pixels.\n" + 34 | "The value should be >= 0 and <= outer radius.\n\n" + 35 | "Default value is 0.0 px" 36 | )] 37 | public double InnerRadius 38 | { 39 | get => radialCore.InnerRadius; 40 | set { radialCore.InnerRadius = value; } 41 | } 42 | 43 | [Property("Initial Smoothing Coefficient"), DefaultPropertyValue(0.95d), ToolTip 44 | ( 45 | "Smoothing coefficient determines how fast or slow the cursor will descend from the outer radius to the inner.\n\n" + 46 | "Possible value range is 0.0001..1, higher values mean more smoothing (slower descent to the inner radius).\n\n" + 47 | "Default value is 0.95" 48 | )] 49 | public double SmoothingCoefficient 50 | { 51 | get => radialCore.SmoothingCoefficient; 52 | set { radialCore.SmoothingCoefficient = value; } 53 | } 54 | 55 | [Property("Soft Knee Scale"), DefaultPropertyValue(1.0d), ToolTip 56 | ( 57 | "Soft knee scale determines how soft the transition between smoothing inside and outside the outer radius is.\n\n" + 58 | "Possible value range is 0..100, higher values mean softer transition.\n" + 59 | "The effect is somewhat logarithmic, i.e. most of the change happens closer to zero.\n\n" + 60 | "Default value is 1.0" 61 | )] 62 | public double SoftKneeScale 63 | { 64 | get => radialCore.SoftKneeScale; 65 | set { radialCore.SoftKneeScale = value; } 66 | } 67 | 68 | [Property("Smoothing Leak Coefficient"), DefaultPropertyValue(0.0d), ToolTip 69 | ( 70 | "Smoothing leak coefficient allows for input smooting to continue past outer radius at a reduced rate.\n\n" + 71 | "Possible value range is 0..1, 0 means no smoothing past outer radius, 1 means 100% of the smoothing gets through.\n\n" + 72 | "Default value is 0.0" 73 | )] 74 | public double SmoothingLeakCoefficient 75 | { 76 | get => radialCore.SmoothingLeakCoefficient; 77 | set { radialCore.SmoothingLeakCoefficient = value; } 78 | } 79 | 80 | public event Action Emit; 81 | 82 | public void Consume(IDeviceReport value) 83 | { 84 | if (value is ITabletReport report) 85 | { 86 | report.Position = radialCore.Filter(report.Position); 87 | value = report; 88 | } 89 | Emit?.Invoke(value); 90 | } 91 | 92 | RadialFollowCore radialCore = new RadialFollowCore(); 93 | } 94 | } 95 | -------------------------------------------------------------------------------- /RadialFollow/RadialFollowSmoothingTabletSpace.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Numerics; 3 | using OpenTabletDriver.Plugin.Attributes; 4 | using OpenTabletDriver.Plugin.Output; 5 | using OpenTabletDriver.Plugin.Tablet; 6 | 7 | namespace RadialFollow 8 | { 9 | [PluginName("AbstractQbit's Radial Follow Smoothing (Tablet coordinates)")] 10 | public class RadialFollowSmoothingTabletSpace : IPositionedPipelineElement 11 | { 12 | public RadialFollowSmoothingTabletSpace() : base() { } 13 | public PipelinePosition Position => PipelinePosition.PreTransform; 14 | 15 | [Property("Outer Radius"), DefaultPropertyValue(1.0d), Unit("mm"), ToolTip 16 | ( 17 | "Outer radius defines the max distance the cursor can lag behind the actual reading.\n\n" + 18 | "Unit of measurement is millimetres.\n" + 19 | "The value should be >= 0 and inner radius.\n" + 20 | "If smoothing leak is used, defines the point at which smoothing will be reduced,\n" + 21 | "instead of hard clamping the max distance between the tablet position and a cursor.\n\n" + 22 | "Default value is 1.0 mm" 23 | )] 24 | public double OuterRadius 25 | { 26 | get => radialCore.OuterRadius; 27 | set { radialCore.OuterRadius = value; } 28 | } 29 | 30 | [Property("Inner Radius"), DefaultPropertyValue(0.0d), Unit("mm"), ToolTip 31 | ( 32 | "Inner radius defines the max distance the tablet reading can deviate from the cursor without moving it.\n" + 33 | "This effectively creates a deadzone in which no movement is produced.\n\n" + 34 | "Unit of measurement is millimetres.\n" + 35 | "The value should be >= 0 and <= outer radius.\n\n" + 36 | "Default value is 0.0 mm" 37 | )] 38 | public double InnerRadius 39 | { 40 | get => radialCore.InnerRadius; 41 | set { radialCore.InnerRadius = value; } 42 | } 43 | 44 | [Property("Initial Smoothing Coefficient"), DefaultPropertyValue(0.95d), ToolTip 45 | ( 46 | "Smoothing coefficient determines how fast or slow the cursor will descend from the outer radius to the inner.\n\n" + 47 | "Possible value range is 0.0001..1, higher values mean more smoothing (slower descent to the inner radius).\n\n" + 48 | "Default value is 0.95" 49 | )] 50 | public double SmoothingCoefficient 51 | { 52 | get => radialCore.SmoothingCoefficient; 53 | set { radialCore.SmoothingCoefficient = value; } 54 | } 55 | 56 | [Property("Soft Knee Scale"), DefaultPropertyValue(1.0d), ToolTip 57 | ( 58 | "Soft knee scale determines how soft the transition between smoothing inside and outside the outer radius is.\n\n" + 59 | "Possible value range is 0..100, higher values mean softer transition.\n" + 60 | "The effect is somewhat logarithmic, i.e. most of the change happens closer to zero.\n\n" + 61 | "Default value is 1.0" 62 | )] 63 | public double SoftKneeScale 64 | { 65 | get => radialCore.SoftKneeScale; 66 | set { radialCore.SoftKneeScale = value; } 67 | } 68 | 69 | [Property("Smoothing Leak Coefficient"), DefaultPropertyValue(0.0d), ToolTip 70 | ( 71 | "Smoothing leak coefficient allows for input smooting to continue past outer radius at a reduced rate.\n\n" + 72 | "Possible value range is 0..1, 0 means no smoothing past outer radius, 1 means 100% of the smoothing gets through.\n\n" + 73 | "Default value is 0.0" 74 | )] 75 | public double SmoothingLeakCoefficient 76 | { 77 | get => radialCore.SmoothingLeakCoefficient; 78 | set { radialCore.SmoothingLeakCoefficient = value; } 79 | } 80 | 81 | public event Action Emit; 82 | 83 | public void Consume(IDeviceReport value) 84 | { 85 | if (value is ITabletReport report) 86 | { 87 | report.Position = radialCore.Filter(report.Position * mmScale) / mmScale; 88 | value = report; 89 | } 90 | Emit?.Invoke(value); 91 | } 92 | 93 | RadialFollowCore radialCore = new RadialFollowCore(); 94 | 95 | [TabletReference] 96 | public TabletReference TabletReference 97 | { 98 | set 99 | { 100 | var digitizer = value.Properties.Specifications.Digitizer; 101 | mmScale = new Vector2 102 | { 103 | X = digitizer.Width / digitizer.MaxX, 104 | Y = digitizer.Height / digitizer.MaxY 105 | }; 106 | } 107 | } 108 | private Vector2 mmScale = Vector2.One; 109 | } 110 | } 111 | -------------------------------------------------------------------------------- /SinCursor/SinCursor.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Numerics; 3 | using OpenTabletDriver.Plugin.Attributes; 4 | using OpenTabletDriver.Plugin.Output; 5 | using OpenTabletDriver.Plugin.Tablet; 6 | using OpenTabletDriver.Plugin.Timing; 7 | 8 | namespace SinCursor 9 | { 10 | [PluginName("sin(cursor)")] 11 | public class SinCursor : IPositionedPipelineElement 12 | { 13 | public SinCursor() : base() { } 14 | public PipelinePosition Position => PipelinePosition.PostTransform; 15 | 16 | [Property("Amplitude"), DefaultPropertyValue(10.0f), Unit("px")] 17 | public float Amplitude 18 | { 19 | get { return amp; } 20 | set { amp = Math.Clamp(value, 0.0f, 1000.0f); } 21 | } 22 | private float amp; 23 | 24 | [Property("Elastic amplitude"), DefaultPropertyValue(true)] 25 | public bool ElasticAmp { get; set; } 26 | 27 | 28 | [Property("Frequency"), DefaultPropertyValue(10.0f), Unit("Hz")] 29 | public float Freq 30 | { 31 | get { return freq; } 32 | set { freq = Math.Clamp(value, 0.0f, 1000.0f); } 33 | } 34 | private float freq; 35 | 36 | [Property("Elastic frequency"), DefaultPropertyValue(false)] 37 | public bool ElasticFreq { get; set; } 38 | 39 | 40 | public event Action Emit; 41 | 42 | public void Consume(IDeviceReport value) 43 | { 44 | if (value is ITabletReport report) 45 | { 46 | if (!vec2IsFinite(prevRadial)) prevRadial = report.Position; 47 | if (!vec2IsFinite(prevPos)) prevPos = report.Position; 48 | 49 | var deltaRadial = report.Position - prevRadial; 50 | var delta = report.Position - prevPos; 51 | 52 | phase = (phase + (float)stopwatch.Restart().TotalSeconds * freq * (ElasticFreq ? delta.Length() / amp: 1)) % 1f; 53 | 54 | prevRadial += Vector2.Normalize(deltaRadial) * Math.Max(deltaRadial.Length() - amp, 0); 55 | 56 | deltaRadial = report.Position - prevRadial; 57 | prevPos = report.Position; 58 | 59 | report.Position += MathF.Sin(phase * MathF.PI * 2) 60 | * Vector2.Transform(ElasticAmp ? delta : deltaRadial, Matrix3x2.CreateRotation(MathF.PI / 2)); 61 | value = report; 62 | } 63 | Emit?.Invoke(value); 64 | } 65 | 66 | private Vector2 prevRadial, prevPos; 67 | private float phase = 0; // 0..1 68 | private HPETDeltaStopwatch stopwatch = new HPETDeltaStopwatch(); 69 | private bool vec2IsFinite(Vector2 vec) => float.IsFinite(vec.X) & float.IsFinite(vec.Y); 70 | } 71 | } 72 | -------------------------------------------------------------------------------- /SinCursor/SinCursor.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | net6.0 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /TouchTapping/TouchTapping.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Linq; 3 | using System.Numerics; 4 | using OpenTabletDriver.Plugin; 5 | using OpenTabletDriver.Plugin.Attributes; 6 | using OpenTabletDriver.Plugin.DependencyInjection; 7 | using OpenTabletDriver.Plugin.Output; 8 | using OpenTabletDriver.Plugin.Tablet; 9 | using OpenTabletDriver.Plugin.Tablet.Touch; 10 | using OpenTabletDriver.Plugin.Platform.Keyboard; 11 | 12 | namespace TouchTapping 13 | { 14 | [PluginName("Touch Tapping")] 15 | public class TouchTappingPlugin : IPositionedPipelineElement 16 | { 17 | [Property("Key 1"), DefaultPropertyValue("Z")] 18 | public string K1 { set; get; } 19 | [Property("Key 2"), DefaultPropertyValue("X")] 20 | public string K2 { set; get; } 21 | 22 | [BooleanProperty("Force full alt", "Keys always alternate (still only 2 simultaneous touches are allowed)"), DefaultPropertyValue(false)] 23 | public bool ForceAlternate { set; get; } 24 | 25 | public PipelinePosition Position => PipelinePosition.PreTransform; 26 | 27 | public TouchTappingPlugin() : base() { } 28 | 29 | public event Action Emit; 30 | 31 | bool[] pressed = { false, false }; 32 | public void Consume(IDeviceReport value) 33 | { 34 | if (value is ITouchReport report) 35 | { 36 | foreach (int kn in Enumerable.Range(0, 2)) 37 | { 38 | if (pressed[kn] == false & !(report.Touches[kn] is null)) 39 | { 40 | pressed[kn] = true; 41 | HandlePress(kn, report.Touches[kn].Position); 42 | } 43 | if (pressed[kn] == true & (report.Touches[kn] is null)) 44 | { 45 | pressed[kn] = false; 46 | HandleRelease(kn); 47 | } 48 | } 49 | } 50 | Emit?.Invoke(value); 51 | } 52 | 53 | int fullAltNextBind = 0; 54 | void HandlePress(int kn, Vector2 pos) 55 | { 56 | Keybind bind; 57 | if (ForceAlternate) 58 | { 59 | bind = Binds[fullAltNextBind]; 60 | fullAltNextBind = fullAltNextBind == 0 ? 1 : 0; 61 | } 62 | else 63 | { 64 | bind = Binds.Where(a => !ActiveBinds.Contains(a)) 65 | .MinBy(a => (a.Lastpos - pos).Length()); 66 | } 67 | VirtualKeyboard.Press(bind.Key); 68 | bind.Lastpos = pos; 69 | ActiveBinds[kn] = bind; 70 | } 71 | 72 | void HandleRelease(int kn) 73 | { 74 | VirtualKeyboard.Release(ActiveBinds[kn].Key); 75 | ActiveBinds[kn] = null; 76 | } 77 | 78 | [OnDependencyLoad] 79 | public void SetBinds() 80 | { 81 | if (!VirtualKeyboard.SupportedKeys.Contains(K1)) 82 | { 83 | Log.WriteNotify("Touch Tapping", "K1 is set incorrectly"); 84 | return; 85 | } 86 | if (!VirtualKeyboard.SupportedKeys.Contains(K2)) 87 | { 88 | Log.WriteNotify("Touch Tapping", "K2 is set incorrectly"); 89 | return; 90 | } 91 | Binds = new Keybind[] 92 | { 93 | new Keybind{Key=K1}, 94 | new Keybind{Key=K2}, 95 | }; 96 | } 97 | 98 | Keybind[] Binds = new Keybind[] 99 | { 100 | new Keybind{Key="Z"}, 101 | new Keybind{Key="X"}, 102 | }; 103 | 104 | Keybind[] ActiveBinds = new Keybind[2]; 105 | 106 | [Resolved] 107 | public IVirtualKeyboard VirtualKeyboard; 108 | } 109 | 110 | public class Keybind 111 | { 112 | public string Key; 113 | public Vector2 Lastpos = Vector2.Zero; 114 | } 115 | 116 | } 117 | -------------------------------------------------------------------------------- /TouchTapping/TouchTapping.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | net6.0 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /build.ps1: -------------------------------------------------------------------------------- 1 | Remove-Item -Recurse -Force bld 2 | $options = @('--configuration', 'Release', '-p:DebugType=embedded') 3 | dotnet publish ./BezierInterpolator $options --framework net6.0 -o ./bld 4 | dotnet publish ./RadialFollow $options --framework net6.0 -o ./bld 5 | dotnet publish ./TouchTapping $options --framework net6.0 -o ./bld 6 | dotnet publish ./SinCursor $options --framework net6.0 -o ./bld 7 | 8 | 9 | Write-Host -NoNewLine 'Press any key to continue...'; 10 | $null = $Host.UI.RawUI.ReadKey('NoEcho,IncludeKeyDown'); 11 | --------------------------------------------------------------------------------