Skip to content

Latest commit

 

History

History
104 lines (69 loc) · 10.9 KB

README.md

File metadata and controls

104 lines (69 loc) · 10.9 KB
Raw

\mainpage vvopensource

Introduction

I write software for a living at Vidvox. The more I write, the more I find myself using a couple basic classes, or putting together frameworks so I can re-use code. This project is an ever-growing collection of simple frameworks which I can link against to reuse code I already wrote and make my life easier; hopefully, it makes your life a bit easier too.

All of these frameworks are contained in a single XCode project- as I write more frameworks, I link against code in other frameworks, so collecting everything together in a single project ensures that you can get everything necessary to compile all of these frameworks in one go- there are no external dependencies. All of the code is always being worked on, and you should never assume that anything is "finished"- I would recommend updating the trunk whenever you get a chance. Get in touch with me if you bump into an unfinished method or other oddity/problem- the code posted here is used in any number of other applications, and I'm always willing to fix or work on it.

How to get help

Please open an "issue". If i'm really busy (a frequent occurrence) it may take a while for me to get back to you- sorry in advance! Documentation is generated with 'Doxygen', and can be found here: http://www.vidvox.net/rays_oddsnends/vvopensource_doc/index.html

I'm not a programmer, I just want to download a MIDI/OSC/ISF test application!

Here's the ISF Editor: https://www.vidvox.net/download/ISF_Editor_2.9.7.3.dmg

Here's an OSC test application: https://www.vidvox.net/rays_oddsnends/vvopensource_downloads/OSCTestApp_0.2.7.zip

Here's an application that sends MIDI input on one computer to another computer over the network/internet using OSC: https://www.vidvox.net/rays_oddsnends/vvopensource_downloads/MIDIviaOSC_0.1.5.zip

Here's an extremely crude MIDI test application ("MIDIMonitor" from snoize is much more comprehensive and fully-featured!): https://www.vidvox.net/rays_oddsnends/vvopensource_downloads/MIDITestApp_1.0.6.zip

What does this project include/do/make?

  • Frameworks
    • VVBasics is an Objective-C framework with a number of common classes which I find to be generally useful; other frameworks and applications in this project link against VVBasics.
    • VVOSC is an Objective-C framework for quickly and easily working with OSC data. Capable of doing everything necessary to send and receive OSC data. There are also targets for compiling, assembling, and installing an SDK which allows you to link against and use VVOSC on iPhones.
    • VVMIDI is an Objective-C framework for quickly and easily working with MIDI data.
    • VVUIToolbox is an objective-c framework that I use extensively to ease the process of creating UI items. It contains a number of objects that standardize the act of creating, drawing, and interacting with sprites that work transparently with both NS and GL views.
    • VVBufferPool is an objective-c framework for creating and managing GL-backed resources. This framework is used as the basis for the rendering engines I build for various proejcts, and is focused on the general goal of simplifying the task of "rendering to a texture" in an extensible manner to better work with a variety of APIs and formats.
    • VVISFKit is an objective-c framework that opens and renders ISF files. ISF is a simple/minimal image filter format based on GLSL- more about ISF files can be found here.
    • MultiClassXPC is an objective-c framework that simplifies the process of quickly setting upa number of different classes to work in an XPC service.
  • Potentially useful apps
    • OSCTestApp is a Cocoa application used for testing and debugging OSC Applications (created entirely with VVOSC). Capable of both sending and receiving a number of OSC data types, it also demonstrates the use of bonjour/zero-configuration networking to automatically auto-locate and set up OSC Input Ports for OSC destinations found on the local network. In other words, two copies of OSCTestApp on different machines on the same local network will "see" each other, and automatically do the backend work necessary to send data to one another.
    • MIDITestApp is a Cocoa application (created using VVMIDI) used to demonstrate the sending and receiving of MIDI data.
    • MIDIviaOSC is a Cocoa application (created using VVMIDI and VVOSC) that lets you send MIDI data to another computer on the internet via OSC
    • QCQL and ISFQL are QuickLook plugins that render thumbnails for, respectively, Quartz Composer and ISF content.
    • MTCSender is a simple Cocoa app that sends MTC data to a given MIDI destination on the same machine.
    • ISF Editor is a browser and editor for ISF files- it's packed with enough features that listing them here would be very awkward.
  • Test/example apps- the majority of the apps here are test apps or example apps demonstrating how to use many of the classes and frameworks in this repository. Examples include rendering GL contexts to textures, rendering Quartz Composer and CoreImage content to textures, rendering ISF files as generative sources and fx, working with textures from Syphon, working with QuickTime and the Hap video codec, accelerated GL texture download and upload, etc.
  • External code (stuff other people wrote hosted here to avoid dependency/submodule issues)
    • DDMathParser is the DDMathParser project by Dave DeLong packaged up as a framework. this is an older version of DDMathParser (the last version capable of compiling 32-bit binaries that can run on 10.6). DDMathParser is used by VVISFKit to parse and evaluate mathematical expressions- it's a really great project, you should check it out!
    • Fragaria is a Cocoa-based text view that supports code-completion and customizable syntax highlighting- the compiled framework is included in this repos, the source can be found here. This is used by the ISF editor.
    • Syphon is a widely-supported open source framework that facilitates inter-application sharing of GL textures in realtime. A compiled version of Syphon.framework is included here for a couple test apps and the ISF Editor- source can be found here.

How to use these frameworks in your Mac application

The general idea is to compile the framework/frameworks you want to use, add them to your XCode project so you may link against them, and then set up a build phase to copy the framework into your application bundle. This is fairly important: most of the time when you link against a framework, the framework is expected to be installed on your OS. VVOSC, VVBasics, and VVMIDI are different: your application will include a compiled copy of the relevant framework(s), so you're guaranteed that the framework won't change outside of your control (which means you won't inherit bugs or have to deal with changed APIs until you're ready to do so). Here's the exact procedure:

  1. In XCode, close the VVOpenSource project (if it is open), and then open your project.
  2. In the Finder, drag "VVOpenSource.xcodeproj" into your project's workspace.
  3. Switch back to XCode, and locate the "Build Phases" section for your project/application's target.
  4. Add a dependency for "vvopensource-Build Mac Frameworks". This will ensure that all the frameworks in the vvopensource project get compiled before your project, so there won't be any missing dependencies.
  5. Add the frameworks you want to use to the "Link Binary with Libraries" section.
  6. Create a new "Copy Files" build phase, set its destination to the "Frameworks" folder, and add the frameworks you linked against in the previous step- the goal is to copy the frameworks you need into the "Frameworks" folder inside your app package. When you click the "+" button to add the frameworks, they will be listed in the "Products" folder in the "vvopensource" project in your workspace.
  7. Switch to the "Build Settings" section of your project's target, locate the "Runpath Search Paths" settings, and add the following paths: "@loader_path/../Frameworks" and "@executable_path/../Frameworks".
  8. That's it- you're done now. You can import/include objects from the framework in your source just as you normally would.

How to use these frameworks in a plugin

If you're writing a plugin, you need to weak-link against these frameworks. If you don't do this and the host app which loads your plugin has a different version of these frameworks installed, you won't know which version of the framework will get used- which usually means a crash and/or generally confusing and buggy behavior. You can prevent this by weak-linking against the frameworks: your plugin will still contain its own copy of the framework, but if the host app has already loaded a different version of the framework that will be used instead.

  1. Follow the steps listed above for using these frameworks in a Mac application- you're going to be embedding a copy of these frameworks in your plugin just as you would for a mac app.
  2. Double-click your plugin/target in the left-hand list of your project window (or select it and get its info). Click on the "Build" tab, locate the "Other Linker Flags" setting, and add the following flags: "-weak_framework VVBasics", "-weak_framework VVOSC", "-weak_framework VVMIDI".

Using VVBasics/VVOSC/etc. in closed-source iOS applications

At some point it was brought to my attention that the LGPL doesn't cover static libraries, so I hereby grant permission to treat the static lib compiled by this project as if it were a dynamic lib with respect to the terms of the LGPL. All the terms and provisions which apply to dynamic libs are conferred to the VVOSC SDK. If you have a question about this, feel free to either email me directly or open an issue in the project for clarification.

Documentation and sample code

Doxygen was used to generate documentation for most things in this project, which can be found here:

[https://www.vidvox.net/rays_oddsnends/vvopensource_doc/index.html]

...if you're reading this on the doc page, start by checking out the "Modules", which breaks down the documentation by framework!

Licensing

This project is made available under the terms of the LGPL: https://www.gnu.org/copyleft/lesser.html. Some classes in this project use code from other open-source projects- all third-party code and licensing information is located in the top-level "external" directory. At present, the third-party code used includes MAZeroingWeakRef from Mike Ash, and DDMathParser from Dave DeLong.