Helix Producer for Quick Start Unix & Mac OS X Guide

Helix Producer Category > Helix Producer SDK > UNIX QuickStart

Contents

Helix Producer for Quick Start Unix & Mac OS X Guide


Purpose

The purpose of this document is to give developers instructions for obtaining and building the Helix DNA Producer source code.

Instructions below are for Unix and Max OS X. For the same document with instructions translated to Windows commands, see the Helix DNA Producer Quick Start Windows Guide.

What You Need Before Starting

Make sure you have the following:

  1. One of the following compilers:
    • MSVC 7.0 on Windows NT4, 2000, or XP (SYSETM_ID=win32-i386-vc6)
    • gcc 3.2 on x86 Linux 2.2 (SYSTEM_ID=linux-2.2-libc6-i386)
    • Macintosh OS X with Project Builder 2.1 and gcc 3.1 (SYSTEM_ID=macos-gcc3-pb)
  2. A helixcommunity.org account. For more information, see the Helix Community web site. Note that you must have already agreed to the RPSL or RCSL license.

System Setup

  1. Download cvs for your operating system from http://www.cvshome.org/downloads.html if you don't already have it and save this in your command path (e.g. /usr/local/bin).
  2. Download and install Python from http://www.python.org.
  3. Download zip from Info-ZIP's Zip and save this in your command path (e.g. /usr/local/bin).
  4. Make sure you have an SSH tunnel established with cvs.helixcommunity.org. The exact syntax for setting up such a tunnel varies by SSH client. A common Unix syntax is: ssh -x -2 -L2401:localhost:2401 tunnel@cvs.helixcommunity.org
    If you have never set up an SSH tunnel, there are several pages of instructions available to you for finding and configuring appropriate tunnel software.

Setting up the build system

  1. Create a directory ~/src where you will download source code.
  2. Set the following environment variables:

You will need to configure the items in bold for your system. See above for the SYSTEM_ID for your operating system/compiler. If you are using bash:

export CVSROOT=:pserver:USERNAME@localhost:/cvs
export BUILD_ROOT=~/src/ribosome/build
export PYTHON_ROOT=/usr/local/python
export SYSTEM_ID=win32-i386-vc6
export PATH=$BUILD_ROOT/bin:$PYTHON_ROOT:$PATH

These additional settings must be present on Mac OS X (be sure to include all the quotes around BUILD_SW):
export BUILD_SW='"YourPrimaryHardDrive:Applications:Metrowerks CodeWarrior 8:Metrowerks CodeWarrior:CodeWarrior IDE 4.2.6"'
export BUILD_VOL=YourPrimaryHardDrive
export BUILD_ON_PLATFORM=MacOSX
export TARGET_ARCHITECTURE=mac-carbon
export COMPILER_VERSION=8

If you are using tcsh:

setenv CVSROOT :pserver:USERNAME@localhost:/cvs
setenv BUILD_ROOT ~/src/ribosome/build
setenv PYTHON_ROOT /usr/local/python
setenv SYSTEM_ID win32-i386-vc6
setenv PATH $BUILD_ROOT/bin\:$PYTHON_ROOT\:$PATH

These additional settings must be present on Mac OS X (be sure to include all the quotes around BUILD_SW):
setenv BUILD_SW '"YourPrimaryHardDrive:Applications:Metrowerks CodeWarrior 8:Metrowerks CodeWarrior:CodeWarrior IDE 4.2.6"'
setenv BUILD_VOL YourPrimaryHardDrive
setenv BUILD_ON_PLATFORM MacOSX
setenv TARGET_ARCHITECTURE mac-carbon
setenv COMPILER_VERSION 8
  1. Create a build resource file as follows:

Use a text editor to create ~/.buildrc. Confirm items in bold above are correct for your system. The SetSDKPath line is optional and only required if you want capture support on Windows, DirectShow file reader support, or QuickTime file reader support

AddCVS("helix",":pserver:USERNAME@localhost:/cvs")
AddBIFPath("common","[helix]common/build/BIF")
SetSDKPath("dxsdk", "/path/to/DirectXSDK")
SetSDKPath("qt5sdk_include", "/path/to/QT5 SDK/CIncludes")
SetSDKPath("qt5sdk_lib", "/path/to/QT5 SDK/Libraries")
  1. Check out the build system components.

Open a command prompt and type the following:

cd ~/src
cvs login (enter your helixcommunity.org password)
cvs checkout ribosome

This downloads the build system to ~/src/ribosome. You only need to perform the above steps once. Note that you must have established a SSH tunnel and set your CVSROOT environment setting to complete this step successfully.

  1. Run the build system build system as follows:
cd ~/src
build

You will be prompted with the build system menu as follows. Leave this menu open for the remaining steps.

Build System Menu
-> Current Directory: ~/src
[0] Set BIF branch (helix)
[1] Set Target(s) (splay_mp3)
[2] Set Profile (helix-client-local-net-nodist)
[3] run: build -trelease
[4] Toggle make depend & makefiles (-e -n)
[5] Toggle release (-trelease)
[6] Toggle 'make clean' (-c)
[7] Toggle clobber (Dangerous!) (-C)
[8] Toggle halt-on-error (-p green)
[9] Toggle verbose mode (-v)
[10] Toggle static build (-tnodll)
[11] Checkout Source for Target
[12] Help Page (full help in build/doc/index.html)
[13] Quit

Note: You will no longer need to run cvs login as long as you run cvs from ~/src.

  1. Set your build target by choosing option 1 from the build system menu. You can type the target if you know it or type '?' for a list. For Helix DNA Producer, choose either 'producerapps_installer' for the command line application or 'producersdk_installer' for the compiled SDK only.
    ALERT: Due to a problem with the producerapps_installer target, use producerdna_all instead. Once this issue is resolved, this message will be removed.
  2. Set your build profile by choosing option 2 from the build system menu. You can type the target if you know it or type '?' for a list. For Helix DNA Producer, choose 'helix-producer-all-defines'.

The build system menu should now look like (important lines in bold font):

Build System Menu
-> Current Directory: ~/src
[0] Set BIF branch (helix) [1] Set Target(s) (producerdna_all) [2] Set Profile (helix-producer-all-defines) [3] run: build -trelease
[4] Toggle make depend & makefiles (-e -n)
[5] Toggle release (-trelease)
[6] Toggle 'make clean' (-c)
[7] Toggle clobber (Dangerous!) (-C)
[8] Toggle halt-on-error (-p green)
[9] Toggle verbose mode (-v)
[10] Toggle static build (-tnodll)
[11] Checkout Source for Target
[12] Help Page (full help in build/doc/index.html)
[13] Quit
  1. Build Helix DNA Producer by choosing option 3 from the build system menu. If you just wish to check out code, choose option 11.
  2. If building completes successfully, proceed to step 10 to set up and run the application. If not, see troubleshooting section of the Helix DNA Producer SDK Project ReadMe for helpful tips.

If you agreed to the Helix DNA Binary EULA, you will have all necessary binaries included in your build to capture from audio or video devices, encode to RealMedia files and broadcast to RealMedia servers as well as encode to Ogg Vorbis audio files. If not, you can still perform file to file encoding to Ogg Vorbis audio files as long as you download the necessary DLLs from Xiph.org as described below. Before running a producer encode for the Ogg Vorbis format, you must download and install the Ogg and Vorbis libraries from http://www.xiph.org. You can find compiled copies or source for these DLLs in the Ogg Vorbis SDK at http://www.vorbis.com/download.psp.

    • Linux: ogg.so, vorbis.so, vorbisenc.so
    • Mac OS X:libogg.dylib, libvorbis.dylib, libvorbisenc.dylib

In order for the producer to find these DLLs, they will need to be located in your library path.

  1. Set up the application by finding the file 'producer.tgz' in the 'release' or 'debug' directory and unpack it anywhere on your system.
  2. Run the application by opening a command prompt, change directory to the location where you unpacked producer.tgz and type the following command or type 'producer -m' for detailed help.

producer -i test.wav -o test.ogg -ad v56k

That's it! if you are having problems running the command line application, see troubleshooting section of the Helix DNA Producer SDK Project ReadMe for helpful tips.