Code Monkey home page Code Monkey logo

opaz-plugdk's Introduction

Build Status

WHAT'S THERE ?

Opaz-PlugDK makes it easier/faster to create portable (Mac OS X, Windows, Linux) VST 2 plugins.

You can mix and match JRuby, Duby and Java to implement the plugins.

QUICK COURSE

AVAILABLE EXAMPLES

The examples are under the plugins folder:

  • DubyGain, DubyFilta and DubyFreeComp are reflecting our current work trend, ie: mix JRuby (for declarative stuff) and Duby (for computation)
  • HybridGain, HybridFilta and HybridSynth mix JRuby (for declarative stuff) and Java (for computation)
  • RubyDelay, RubyFreeComp and RubyGain are pure JRuby version

DEPENDENCIES

Required:

  • Java JDK (tested with version 1.6+) - the JRE is not sufficient
  • JRuby (tested with version 1.6.7)

Optional:

  • Mirah: jgem install mirah (or on Windows: jruby -S gem install mirah)
  • JavaFX: install the JavaFX SDK 1.2.3

HOW TO BUILD A PLUGIN

See under plugins/ then use the available rake tasks to package one of them:

rake -f build.rakefile package plugin=DubyFreeComp

The package system will create ready-to-use VST for Windows, Mac OS X and Linux under the build subfolder of the plugin.

BUILD ORDER

Things are currently compiled in this order:

  • src/* (Opaz stuff)
  • your_plugin/*.duby
  • your_plugin/*.java
  • your_plugin/*.fx

PLUGINS STATUS

All the plugins compile and are able to be loaded in Ableton Live, except the Ruby based ones (temporary issue).

GUI SUPPORT

Basic GUI support is included. Example:

class MyEditor
	def initialize(frame)
		frame.setTitle("Hello from DefaultEditor!")
		frame.setSize(400, 300)
	end
end

class MyPlugin < OpazPlug
	plugin "MyPlugin", "Opaz", "LoGeek"
	# ...
	
	editor MyEditor
end

You'll be passed the main container frame so that you can add stuff in it.

LIVE DEBUGGING

Thanks to Daniel309, it's possible to enable live plugin patching through an IRB session.

Tweak tasks/tools.rb around line 90 to enable the IRB debugging editor:

PluginUIClass=IRBPluginGUI

LOGGING

It's often useful to log some informations while creating plugins. You can achieve this by calling "log" from the plugin:

class MyPlugin < OpazPlug
	def some_stuff
		log("message!")
	end
end

The logs end up inside some txt file in the plugin folder.

NOTES

The libs and templates folders are generated using rake prepare:templates and rake prepare:libs. Have a look at the rake file to see more about available tasks (compile, package, deploy).

AUTHORS AND CONTRIBUTORS

  • Thibaut Barrère and Daniel309 (author of jVSTwRapper) for the whole thing
  • Robert Pitts for his test clean-up patch
  • Big thanks to Charles Oliver Nutter for his help on JRuby/Duby!
  • Thanks as well to JFXtras for their implementation of SceneToJComponent.

opaz-plugdk's People

Contributors

dfl avatar makevoid avatar rbxbx avatar thbar avatar weirdpercent avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

opaz-plugdk's Issues

IRB window doesn't close on plugin removal

via Martin:

i have built the examples and have a minor problem in that the irb window
will not close, even if I delete the plugin from my host. it only goes once
the host (energyxt) itself is closed. is this a bug or intended behaviour?

Start on First Thread issue

Hi,
I'm using OSX 10.8.2, Ableton Live 8.2.6, JDK 1.6.0_37, jruby 1.6.8.

I was getting the following error:

** org.jruby.exceptions.RaiseException: (LoadError) load error: SimplePlugin -- java.lang.InternalError: Can't start the AWT because Java was started on the first thread. Make sure StartOnFirstThread is not specified in your application's Info.plist or on the command line

I'm absolutely not a Java expert, but googling around I solved it specifying:
JVMOption2=-Djava.awt.headless=true
in Plugin.jnilib.ini

Maybe it can be useful!

RubyDelay

Hi thbar,

RubyDelay is a bit buggy and needs the following changes:

-Line 214 should be: @echoLFODiff = @echoLFODiffMax * (1.0 + Math.sin(@echoLFOPos))

-Line 192 should be: if (echoRead >= @echoSize-1)

-Line 62 should be: @echo = Array.new(@echoSize){|i| 0.0} unless @echo.size == @echoSize

I think it should work okay then..

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.