Part 2: Building the Helix Producer from CVS

Helix Producer Category > Helix Producer SDK > Docs > QuickStart

Part 2: Building the Helix Producer from CVS


Introduction

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

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

If you are having problems building an application with the Helix DNA Producer SDK or running the command line application, see the troubleshooting section of the Helix DNA Producer SDK Project ReadMe for helpful tips.

https://common.helixcommunity.org/files/2004/devdocs/icons/note.gif

Note: It is assumed that you have already installed the sources as described in Part 1: Installing and Running CVS, and are ready to build the Helix DNA Producer. Note that there are other technology-specific build guides, including guides for Helix DNA Server, Helix DNA Client, and Helix Player.

Step-by-Step Instructions

  1. Create a directory C:\src where you will download source code.
  2. Create a build environment batch file as follows:

Open Notepad and type the following text. Save this to C:\src\helx.bat (make sure to choose "All Files" so the .txt file extension is not automatically added). Confirm items in bold below are correct for your system. See above for the SYSTEM_ID for your operating system/compiler.

set BUILD_ROOT=C:\src\ribosome\build
set PYTHON_ROOT=C:\Progra~1\Python
set SYSTEM_ID=win32-i386-vc6
set PATH=%BUILD_ROOT%\bin;%PYTHON_ROOT%;%PATH%
  1. Create a build resource file as follows:

Open Notepad and type the following text. Save this to C:\.buildrc (make sure to choose "All Files" so the .txt file extension is not automatically added). 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

AddMultiCVS("helix",":ext:USERNAME@cvs.helixcommunity.org:/cvsroot")
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, following the instructions in Part 1: Installing and Running CVS
  2. Run the build system build system as follows:
cd c:\src
helix.bat
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: C:\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 C:\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: C:\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 the troubleshooting section of the Helix DNA Producer 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 Vorbis.com 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. The following DLLs are required:

    • ogg.dll, vorbis.dll, vorbisenc.dll

In order for the producer to find these DLLs, they will need to be located the command line application directory or somewhere else in your command path.

  1. Set up the application by finding the file 'producer.zip' 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.zip 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.