devmansworld / ofxofelia

ofelia/ofxOfelia: Pd external library written with openFrameworks for creating cross-platform multimedia applications.

ofelia

Description

ofelia is a Pure Data external library written with openFrameworks for creating cross-platform multimedia applications.
ofelia allows one to use various features of openFrameworks core in a real-time graphical programming environment, Pure Data.

The external library is currently available to be used under macOS, Linux(64bit) and Windows.

Installation

• Make sure you have Pd-0.48-1 installed on your desktop. (Earlier versions of Pd may not work)
• Start Pd and go to Help -> Find externals, then search for ofelia
• Select the proper version of ofelia for your system to download and install.
• Go to Pd -> Preferences -> Startup, click New and add ofelia
• Restart Pd.
• (Linux only) Open the Terminal and run the following command to install dependencies.

  cd ofelia/scripts/distro_name
  sudo ./install_dependencies.sh

Explore

• Try the example patches inside ofelia/examples directory.
• Open ofelia/help-intro.pd to see the list of built-in objects in ofelia.
• Open the help files to learn more about each object.
• Create something cool and share it with other people.

ofxOfelia

Description

ofxOfelia is ofelia packaged as an openFrameworks addon which enables you to build the external yourself or create a standalone application for macOS, Linux(64bit), Windows(32bit), iOS and Android that can run Pd patches made with ofelia.

Build Requirements

In order to use ofxOfelia, you first need to download and install openFrameworks 0.9.8 which is the most recent stable release. ofxOfelia is currently not compatible with openFrameworks 0.10.x and it will be updated after the next stable release of openFrameworks. Please follow the setup guides to download and install openFrameworks 0.9.8. The following tools are used to build ofxOfelia project.

• macOS / iOS : Xcode
• Linux : Makefile.
• Windows : Visual Studio Community 2015.
• Android : Android Studio.

Setup guide

• Make sure you have openFrameworks setup on your desktop.
• Download ofxOfelia, ofxPd, ofxMidi and rename the extracted folders to ofxOfelia, ofxPd and ofxMidi.
  Place them within the directory OF/addons. ("OF" indicates the base directory of openFrameworks)
• Download pd-0.48-1 source archive and find src folder inside the extracted directory and copy it into OF/addons/ofxOfelia/libs/pd.
• (macOS / Linux / iOS / Android) Open the Terminal and run the following to update openFrameworks.

  cd OF/addons/ofxOfelia/scripts/(targetOS)
  sudo ./updateOF.sh

• (Windows) Execute the following batch file to update openFrameworks.

  OF/addons/ofxOfelia/scripts/Win/updateOF.bat

Building the external

macOS

• Open OF/addons/ofxOfelia/macOSExternal/ofelia.xcodeproj with Xcode and build the project.
• Copy the binaries from OF/addons/ofxOfelia/macOSExternal/bin into the externals directory.

Linux

• Open the Terminal and run the following command to build the project.

  cd OF/addons/ofxOfelia/Linux64External
  make

• Copy the binaries from OF/addons/ofxOfelia/Linux64External/bin into the externals directory.

Windows

• Open OF/addons/ofxOfelia/Win32External/ofelia.vcxproj with Visual Studio and build the solution.
• Copy the binaries from OF/addons/ofxOfelia/Win32External/bin into the externals directory.

Running the standalone example

macOS

• Open OF/addons/ofxOfelia/macOSExample/macOSExample.xcodeproj with Xcode and run the project.

Linux

• Open the Terminal and run the following command to run the project.

  cd OF/addons/ofxOfelia/Linux64Example
  make && make RunRelease

Windows

• Open OF/addons/ofxOfelia/Win32Example/Win32Example.vcxproj with Visual Studio and run the project.

iOS

• Open OF/addons/ofxOfelia/iOSExample/iOSExample.xcodeproj with Xcode.
• Connect your iOS device and run the project.

Android

• Open Android Studio, select Open an existing Android Studio project and open OF/addons/ofxOfelia/AndroidExample.
• Connect your Android device and run the project.

Creating your own standalone project

macOS

• Copy the folder OF/addons/ofxOfelia/macOSExample and paste it into OF/apps/myApps.
• Rename the project in Xcode and rename the project folder to your liking.
• Replace Pd patch and resources in yourProject/bin/data/pd with your files.
• Build the project in Xcode. you will find a .app file in yourProject/bin directory.

Linux

• Copy the folder OF/addons/ofxOfelia/Linux64Example and paste it into OF/apps/myApps.
• Rename the project folder to your liking.
• Replace Pd patch and resources in yourProject/bin/data/pd with your files.
• Build the project with make. you will find a Unix executable file in yourProject/bin directory.

Windows

• Copy the folder OF/addons/ofxOfelia/Win32Example and paste it into OF/apps/myApps.
• Rename the project in Visual Studio and rename the project folder to your liking.
• Replace Pd patch and resources in yourProject/bin/data/pd with your files.
• Build the project in Visual Studio. you will find a .exe file in yourProject/bin directory.

iOS

• Copy the folder OF/addons/ofxOfelia/iOSExample (or iOSABExample if you want your app to support Audiobus) and paste it into OF/apps/myApps.
• Rename the project in Xcode and rename the project folder to your liking.
• Replace Pd patch and resources in yourProject/bin/data/pd with your files.
• Connect your iOS device and run the project in Xcode.

Android

• Copy the folder OF/addons/ofxOfelia/AndroidExample and paste it into OF/apps/myApps.
• Rename the project in Android Studio. (please read Creating new projects section from this link)
• Replace Pd patch and resources in yourProject/bin/data/pd with your files.
• If your app uses portrait orientation as default, then change android:screenOrientation="reverseLandscape" to android:screenOrientation="portrait" in AndroidManifest.xml file.
• Connect your Android device and run the project in Android Studio.

Developing ofxOfelia

You can help developing ofxOfelia on GitHub: https://github.com/cuinjune/ofxOfelia
Create an account, clone or fork the repo, then request a push/merge.
If you find any bugs or suggestions please log them to GitHub as well.

Author

Copyright (c) 2018 Zack Lee: [email protected]
GNU General Public License v3.0
For information on usage and redistribution, and for a DISCLAIMER OF ALL WARRANTIES, see the file, "LICENSE.txt," in this distribution.