From ed7c4a7fc411114ddcd484987f7098b57ecb26d6 Mon Sep 17 00:00:00 2001 From: trinitou Date: Sun, 19 Feb 2023 11:22:01 +0100 Subject: [PATCH] consistently use 'XJadeo' instead of 'xjadeo' or 'xJadeo' --- Changelog.md | 14 +++++++------- Readme.md | 10 +++++----- doc/help.md | 14 +++++++------- generate_release.ps1 | 10 +++++----- ...ync.control.js => XJadeo Video Sync.control.js} | 4 ++-- src/{launch xjadeo.bat => launch XJadeo.bat} | 0 6 files changed, 26 insertions(+), 26 deletions(-) rename src/{xJadeo Video Sync.control.js => XJadeo Video Sync.control.js} (95%) rename src/{launch xjadeo.bat => launch XJadeo.bat} (100%) diff --git a/Changelog.md b/Changelog.md index 83dbcea..6a1e2b9 100644 --- a/Changelog.md +++ b/Changelog.md @@ -10,13 +10,13 @@ ## Added ### Initial Bitwig Studio controller script - - vendor: xjadeo - - name: xJadeo Video Sync - - connects to an xjadeo instance opened in OSC remote control mode on port `12345`. + - vendor: XJadeo + - name: XJadeo Video Sync + - connects to an XJadeo instance opened in OSC remote control mode on port `12345`. - Studio I/O panel settings - - An absolute video file path and frame rate can be defined per project which then will be played back by xjadeo. - - 'Flush!' button: (re-)send all settings to an open xjadeo window + - An absolute video file path and frame rate can be defined per project which then will be played back by XJadeo. + - 'Flush!' button: (re-)send all settings to an open XJadeo window - Controller script preferences - '?' button opens the help HTML - - 'Keep on top' checkbox: makes the xjadeo window stay on top of all other windows - - 'Flush!' button: (re-)send all settings to an open xjadeo window + - 'Keep on top' checkbox: makes the XJadeo window stay on top of all other windows + - 'Flush!' button: (re-)send all settings to an open XJadeo window diff --git a/Readme.md b/Readme.md index d124b75..397c04a 100644 --- a/Readme.md +++ b/Readme.md @@ -1,16 +1,16 @@ -# Video playback for Bitwig Studio using xjadeo. +# Video playback for Bitwig Studio using XJadeo. -A lightweight solution for video playback with [Bitwig Studio](https://www.bitwig.com/de/overview/) using [xjadeo](https://xjadeo.sourceforge.net). A video file can be added per Bitwig project which then will be played back in sync with Bitwig's transport. Also the video will be saved and opened together with the project automatically. +A lightweight solution for video playback with [Bitwig Studio](https://www.bitwig.com/de/overview/) using [XJadeo](https://xjadeo.sourceforge.net). A video file can be added per Bitwig project which then will be played back in sync with Bitwig's transport. Also the video will be saved and opened together with the project automatically. -The implementation makes use of xjadeo's OSC remote control capabilities which are documented [here](https://xjadeo.sourceforge.net/osc.html). +The implementation makes use of XJadeo's OSC remote control capabilities which are documented [here](https://xjadeo.sourceforge.net/osc.html). ## Installation 1. Put the .js into the Bitwig controller script folder 2. Add the controller script in Bitwig Studio - via *Dashboard -> 'Settings' -> 'Controllers' -> '+ Add Controller'* - - select hardware vendor: 'xjadeo' - - select product: 'xJadeo Video Sync' + - select hardware vendor: 'XJadeo' + - select product: 'XJadeo Video Sync' - click *'Add'* 3. Click the "?" icon and follow the setup instructions in the help HTML diff --git a/doc/help.md b/doc/help.md index 9ddac58..be21842 100644 --- a/doc/help.md +++ b/doc/help.md @@ -1,25 +1,25 @@ -# xJadeo Video Synchronization +# XJadeo Video Synchronization ## Setup -- **Download and install xjadeo**, e.g. from [here](https://xjadeo.sourceforge.net/download.html) -- **Launch the *'launch xJadeo.bat'* script**. This opens the xjadeo window. +- **Download and install XJadeo**, e.g. from [here](https://xjadeo.sourceforge.net/download.html) +- **Launch the *'launch XJadeo.bat'* script**. This opens the XJadeo window. - In Bitwig Studio, connect the video file for playback like this: - Open a project. - - In the *Studio I/O panel*, unfold the *xJadeo Video Sync* settings. + - In the *Studio I/O panel*, unfold the *XJadeo Video Sync* settings. - Enter the absolute video file path under *Path*. - Enter the original frame rate of the video under 'Frame rate'. ## Features - If you save the project and open it later, the video will be opened again together with the project. -- You can easily switch Bitwig project tabs with different videos and the xJadeo window will be udpated on the fly! +- You can easily switch Bitwig project tabs with different videos and the XJadeo window will be udpated on the fly! - There is a *'Keep on top'* checkbox which will ensure that the video window stays in front of Bitwig Studio. (default: on) -- The *'Flush!'* button in the settings will (re-)send all data to the xJadeo window. This is helpful if xJadeo was opened after Bitwig Studio. +- The *'Flush!'* button in the settings will (re-)send all data to the XJadeo window. This is helpful if XJadeo was opened after Bitwig Studio. ## Tipps & tricks - 'Where to quickly find original video frame?' - - When using the *'launch xJadeo.bat'* script, a console window will open as well. Look into the log text! + - When using the *'launch XJadeo.bat'* script, a console window will open as well. Look into the log text! - How to hear the original sound of the video file in sync with the video? - If Bitwig supports the file format, you can drag it into the project so that. - Place it into the Arranger at position 1.1.1.00 diff --git a/generate_release.ps1 b/generate_release.ps1 index f572b64..8543110 100644 --- a/generate_release.ps1 +++ b/generate_release.ps1 @@ -22,8 +22,8 @@ $rootDir = "." $changelogAsMarkdown = ConvertFrom-Markdown -Path "$rootDir\Changelog.md" if($docAsMarkdown && $changelogAsMarkdown) { # main HTML - $docHtmlHeadSection = GenerateHtmlHeadSection -Title "xjadeo Video Sync" -RelativeCssPath "./doc/help.css" - $docHtmlHeadSection + $docAsMarkdown.Html | Out-File -Encoding utf8 "$targetTempDir\xJadeo Video Sync.html" + $docHtmlHeadSection = GenerateHtmlHeadSection -Title "XJadeo Video Sync" -RelativeCssPath "./doc/help.css" + $docHtmlHeadSection + $docAsMarkdown.Html | Out-File -Encoding utf8 "$targetTempDir\XJadeo Video Sync.html" # HTML resource directory $htmlResourceTargetDir = "$targetTempDir\doc" New-Item -ItemType Directory -Force -Path "$htmlResourceTargetDir" @@ -38,14 +38,14 @@ if($docAsMarkdown && $changelogAsMarkdown) { } $sourceDir = ".\src" -$controlScriptFileName = "xJadeo Video Sync.control.js" +$controlScriptFileName = "XJadeo Video Sync.control.js" Copy-Item -Path "$sourceDir\$controlScriptFileName" -Destination "$targetTempDir\$controlScriptFileName" -$launchScriptFileName = "launch xjadeo.bat" +$launchScriptFileName = "launch XJadeo.bat" Copy-Item -Path "$sourceDir\$launchScriptFileName" -Destination "$targetTempDir\$launchScriptFileName" $controlScriptFileName = "LICENSE" Copy-Item -Path "$rootDir\$controlScriptFileName" -Destination "$targetTempDir\$controlScriptFileName" -$targetZipPath = "$PSScriptRoot\target\xJadeo_Video_Sync_" + ($version -replace '\.', '_') + ".zip" +$targetZipPath = "$PSScriptRoot\target\XJadeo_Video_Sync_" + ($version -replace '\.', '_') + ".zip" $compress = @{ Path = "$targetTempDir\*" CompressionLevel = "Fastest" diff --git a/src/xJadeo Video Sync.control.js b/src/XJadeo Video Sync.control.js similarity index 95% rename from src/xJadeo Video Sync.control.js rename to src/XJadeo Video Sync.control.js index d73b7f4..3a3ee58 100644 --- a/src/xJadeo Video Sync.control.js +++ b/src/XJadeo Video Sync.control.js @@ -2,7 +2,7 @@ loadAPI(17); host.setShouldFailOnDeprecatedUse(true); -host.defineController("xjadeo", "xJadeo Video Sync", "0.1.1", "295c10cb-b8d6-416b-9be5-dc2375936ac0", "Trinitou"); +host.defineController("XJadeo", "XJadeo Video Sync", "0.1.1", "295c10cb-b8d6-416b-9be5-dc2375936ac0", "Trinitou"); var oscConnection; @@ -87,7 +87,7 @@ function init() { invalidateAll(); - println("xJadeo Connect initialized!"); + println("XJadeo Video Sync initialized!"); } function flush() { diff --git a/src/launch xjadeo.bat b/src/launch XJadeo.bat similarity index 100% rename from src/launch xjadeo.bat rename to src/launch XJadeo.bat