Merge pull request #117 from StartAutomating/obs-powershell-updates

obs-powershell 0.1.8

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [StartAutomating, nyanhp, I-Am-Jakoby]

.github/workflows/build-obs-powershell.yml

@@ -572,6 +572,9 @@ jobs:
     steps: 
       - name: Check out repository
         uses: actions/checkout@v2
+      - name: GitLogger
+        uses: GitLogging/GitLoggerAction@main
+        id: GitLogger
       - name: Use PSSVG Action
         uses: StartAutomating/PSSVG@main
         id: PSSVG

CHANGELOG.md

@@ -1,3 +1,39 @@
+## obs-powershell 0.1.8:
+
+* Added Sponsorship, Please support obs-powershell (#78)
+* Added OBS-PowerShell Effects (#109)
+  * Effect Commands
+    * Get-OBSEffect
+    * Import-OBSEffect
+    * Start-OBSEffect
+    * Stop-OBSEffect
+    * Remove-OBSEffect
+  * ColorLoop (#113)
+  * FadeIn (#112)
+  * FadeOut (#114) (thanks @I-Am-Jakoby !)  
+* Adding Commands for Filtering  
+  * Set/Add-OBSGainFilter (#94) 
+  * Set/Add-OBSColorFilter (#92)
+  * Set/Add-OBSScrollFilter (#93)
+  * Set/Add-OBSSharpnessFilter (#95)
+  * Set/Add-OBSRenderDelayFilter (#96)
+  * Set/Add-OBSEqualizerFilter (#97)
+* New Easy Sources
+  * Set/Add-OBSAudioOutputSource (#110)
+  * Set/Add-OBSWindowSource (#104)
+  * Set/Add-OBSVLCSource (#102)
+* Scene Items Can Now Do A Lot More
+  * Animate allows for multiple steps and is more careful (#75 and #73)
+  * Move, Scale, Rotate are written using animate (#80, #81, #89)
+* Extending Inputs (#99)
+* Autogenerating help for extended types, thanks to a new version of [HelpOut](https://github.com/StartAutomating/HelpOut)
+* Improving Performance and Stability of Send/Receive/Watch-OBS (#77, #90, #86, #106, #107)
+
+
+* Also, new logo (#76)
+
+---
+
 ## obs-powershell 0.1.7:
 
 * New Commands:

Commands/Effects/Get-OBSEffect.ps1

@@ -0,0 +1,46 @@
+function Get-OBSEffect
+{
+    <#
+    .SYNOPSIS
+        Gets OBS Effects
+    .DESCRIPTION
+        Gets effects currently loaded into OBS-PowerShell.
+
+        An effect can be thought of as a name with a series of messages to OBS.
+
+        Those messages can be defined in a .json file or a script, in any module that tags OBS.
+
+        They can also be defined in a function or script named like:
+        
+        * `*.OBS.FX.*`
+        * `*.OBS.Effect.*`
+        * `*.OBS.Effects.*`
+        
+    .LINK
+        Import-OBSEffect
+    .LINK
+        Remove-OBSEffect
+    #>
+    param(
+    # The name of the effect.
+    [Parameter(ValueFromPipelineByPropertyName)]
+    [Alias('EffectName')]
+    [string]
+    $Name
+    )
+
+    begin {
+        if (-not $script:OBSFX) {
+            $script:OBSFX = [Ordered]@{} 
+        }
+    }
+
+    process {
+
+        if (-not $Name) {
+            $script:OBSFX.Values
+        } elseif ($script:OBSFX[$name]) {
+            $script:OBSFX[$name]
+        }
+    }
+}

Commands/Effects/Import-OBSEffect.ps.ps1

@@ -0,0 +1,139 @@
+function Import-OBSEffect
+{
+    <#
+    .SYNOPSIS
+        Imports Effects
+    .DESCRIPTION
+        Imports obs-powershell effects        
+    .EXAMPLE
+        Import-OBSEffect -Path (Get-Module obs-powershell)
+    .LINK
+        Get-OBSEffect
+    #>
+    param(
+    # The source location of the effect.
+    # This can be a string, file, directory, command, or module.
+    [vfp(vbn,Mandatory)]
+    [Alias(        
+        'FromPath',
+        'FromModule',
+        'FromScript',
+        'FromFunction',
+        'FullName',
+        'Path',
+        'Source'
+    )]    
+    [ValidateTypes(TypeName={
+        [string],
+        [IO.FileInfo],
+        [IO.DirectoryInfo]
+        [Management.Automation.CommandInfo]
+        [Management.Automation.PSModuleInfo]
+    })]
+    $From
+    )
+
+    begin {        
+        if (-not $script:OBSFX) {
+            $script:OBSFX = [Ordered]@{}
+        }
+
+        $newEffects = @()
+        $obsEffectsPattern = [Regex]::new('
+        (?>
+            ^OBS.(?>fx|effects?)\p{P}
+            |
+            [\p{P}-[-]]OBS\.(?>fx|effects?)$
+            |
+            \p{P}OBS.(?>fx|effects?)\.(?>ps1|json)$
+        )
+        ','IgnoreCase,IgnorePatternWhitespace')
+    }
+
+    process {
+        # Since -From can be many things, but a metric has to be a command,
+        # the purpose of this function is to essentially resolve many things to a command, 
+        # and then cache that command.
+
+        # If -From was a string
+        if ($From -is [string]) {
+            # It could be a module, so check those first.            
+            :ResolveFromString do {
+                foreach ($loadedModule in @(Get-Module)) {
+                    # If we find the module, don't try to resolve -From as a path
+                    break ResolveFromString
+                        if ($loadedModule.Name -eq $from) {
+                             # (just set -From again and let the function continue)
+                            $from = $fromModule = $loadedModule
+                        }
+                }
+                # If we think from was a path
+                $resolvedPath = $ExecutionContext.SessionState.Path.GetResolvedPSPathFromPSPath($from)
+                # attempt to resolve it
+                if ($resolvedPath) {
+                    $from = Get-Item -LiteralPath $resolvedPath
+                }
+            } while ($false)
+        }
+
+        # If -From is a module
+        if ($from -is [Management.Automation.PSModuleInfo]) {
+            # recursively call ourselves with all matching commands
+            @($from.ExportedCommands.Values) -match $obsEffectsPattern |
+                Import-OBSEffect
+            # then, make -From a directory
+            if ($from.Path) {
+                $from = Get-Item ($from.Path | Split-Path) -ErrorAction SilentlyContinue
+            }
+        }
+
+        # If -From is a directory
+        if ($from -is [IO.DirectoryInfo]) {
+            $FromDirectory = $from
+            # recursively call ourselves with all matching scripts
+            Get-ChildItem -LiteralPath $from.FullName -Recurse -File | 
+                Where-Object Name -match '\.obs\.(?>fx|effects?).(?>ps1|json)$' |
+                Import-OBSEffect
+            return
+        }
+
+        # If -From is a file
+        if ($from -is [IO.FileInfo]) {
+            # and it matches the naming convention
+            return if $from.Name -notmatch '\.obs\.(?>fx|effects?).(?>ps1|json)$'
+            # make -From a command.
+            $from = $ExecutionContext.SessionState.InvokeCommand.GetCommand($from.FullName, 'ExternalScript,Application')
+        }
+
+        # If -From is a command
+        if ($from -is [Management.Automation.CommandInfo]) {
+            # decorate the command
+            if ($from.pstypenames -notcontains 'OBS.PowerShell.Effect') {
+                $from.pstypenames.insert(0,'OBS.PowerShell.Effect')                
+            }
+
+            if ($from -is [Management.Automation.ApplicationInfo]) {
+                $effectName = $from.Name -replace '\.obs\.(?>fx|effects?).(?>ps1|json)$'
+                $newEffect  = [PSCustomObject][Ordered]@{
+                    PSTypeName = 'OBS.PowerShell.Effect'
+                    Messages   = Get-Content -Raw -Path $From.Source | ConvertFrom-Json
+                    EffectName = $effectName
+                    TypeName   = $TypeName
+                }
+                $script:OBSFX[$effectName] = $newEffect
+                $newEffects += $newEffect
+                $newEffect
+            } else {
+                if ($from.pstypenames -notcontains 'OBS.PowerShell.Effect.Command') {
+                    $from.pstypenames.insert(0,'OBS.PowerShell.Effect.Command')                
+                }
+                # and add it to our list of new metrics
+                $newEffects+= $from
+                $script:OBSFX[$from.EffectName] = $from
+                $from
+            }                    
+        }                
+    }
+
+
+}