Veejay HOWTO Compile
Niels Elburg ( nwelburg AT g mail dot com )
v1.0, 1 Jan 2009
This document describes how to compile veejay, a visual
‘music’ instrument for Linux/GNU
- 1.Introduction
- 1.1 Disclaimer
- 1.2 Acknowledgements
- 1.3 Audience and Intent
- 1.4 Revision History
- 1.5 New versions of this document
- 1.6 Feedback
- 1.7 Distribution Policy
- 2. About veejay
- 2.1 Features
- 2.2Hardware configuration
- 3. Installation
- 3.1 Dependencies
- 3.2 Installing veejay-server
- 3.3 Installing veejay-client
- 3.4 Installing veejay-utils
- 3.5 First startup
- 4.1Veejay Discussion
- 4.2Veejay Developer Lounge
- 5.Credits
- 6.6.GNU Free Documentation License
1. Introduction
1.1 Disclaimer
No liability for the contents of this documents can be accepted. Use the concepts, examples and other content at your own risk. As this is a new edition of this document, there may be errors and inaccuracies, that may of course be damaging to your system. Proceed with caution, and although this is highly unlikely, the authors do not take any responsibility for that.
All copyrights are held by their respective owners, unless specifically noted otherwise. Use of
a term in this document should not be regarded as affecting the validity of any trademark or service mark.
Naming of particular products or brands should not be seen as endorsements.
You are strongly recommended to take a backup of your system before major installation and backups at regular intervals.
1.2 Acknowledgements
1.3 Audience and Intent
This document is targeted at the Linux user interested in compiling veejay from source.
1.4 Revision History
Version 1.0
- Compile veejay 1.4.5
1.5 New versions of this document
You will find the most recent version of this document at veejay-HOWTO-Compile.html.
If you make a translation of this document into another langauge, let us know and we’ll include a reference to it here.
1.6 Feedback
We rely on you, the reader, to make this HOWTO usefull. If you have any suggestions, corrections , or comments , please send them to us ( http://groups.google.com/group/veejay-discussion/post?hl=en ), and we will try to incorporate them in the next revision. Please add ‘HOWTO veejay’ to the Subject-line of the mail.
Before sending bug reports or questions, please read all of the information in this HOWTO, and send detailed information about the problem.
If you publish this document on a CD-ROM or in hardcopy form, a
complimentary copy would be appreciated. Mail us for our postal address. Also consider making a donation to the Veejay Project to help support free video editing software in the future.
1.7 Distribution Policy
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software
Foundation; with no Invariant Sections, with no Front-Cover Texts , and with no Back-Cover Texts. A copy of this license is included in the section entitled "GNU Free Documentation License".
2. About Veejay
Veejay is a visual instrument and realtime video sampler. It allows you to ‘play’ the video like you would play a PianoWhile playing, you can record the resulting video directly to disk (video sampling).
Veejay is being developed in the hope it will be usefull for VJ’s, media artists and other interested users that want to use Free Software for their performances and/or video installations.
Veejay comes with a graphical user interface Reloaded. You can use Reloaded to connect (and switch) to any veejay on the network
2.1 Features
2.2 System configuration
Veejay requires at least a linux kernel 2.4.x, 2.6.x or later and a fast machine.
Use of a preemptive kernel is recommended. You can tweak/thin your system to allocate
as many resources as possible for use with Veejay. For installations or performances, we prefer a lightweight window manager like BlackBox or Window Maker.
3. Installation
Verify that the PKG_CONFIG_PATH variable is set to the directory containing your *.pc files to include them in the build process.
$ echo $PKG_CONFIG_PATH
If nothing is set, do something like
$ export PKG_CONFIG_PATH=/usr/lib/pkgconfig:/usr/local/lib/pkgconfig
3.1 Dependencies
Before you install Veejay, you must have the following software packages.
Required:
- libSDL http://www.libsdl.org/download-1.2.php
- The XML C library 2 for gnome >=2.5.4 http://xmlsoft.org/
- Ffmpeg http://www.ffmpeg.org/download.html
- FreeType >= 2.1.9
- GTK >= 2.6.0
- Kernel headers for Video4Linux
Optional:
- JACK low latency audio server >= 0.98.1
- libunicap http://www.unicap-imaging.org/
- libdv http://libdv.sourceforge.net/
- libquicktime http://libquicktime.sourceforge.net/
For Ubuntu/Debian based systems, you can install the missing software with:
$ apt-get install build-essential autogen autotools-dev autoconf automake1.8 libtool libsdl1.2-dev \ libjack0.100.0-dev libquicktime-dev libxml2-dev libglade2-dev libgtk2.0-dev libmjpegtools-dev \ libavcodec-dev libjpeg62-dev libavformat-dev libswscale-dev libdv-dev xorg-dev libasound-dev \ libsamplerate-dev
3.1.1 Compiling dependencies from source
Most likely, you will need to build ffmpeg from source for use with veejay. A few distributions already include libavcodec , libswscale, libavutil and libavformat. If this is not the case, you can either install a third party ffmpeg binary or build it yourself.
Getting ffmpeg:
svn checkout svn://svn.ffmpeg.org/ffmpeg/trunk ffmpeg
Configuring ffmpeg
cd ffmpeg
./configure --enable-gpl --enable-shared --enable-swscale
Building the sources
make
Installing FFmpeg
(sudo) make install
Other source packages:
./configure && make && make install
3.2 Installing veejay-server
Decompress and untar the file by typing:
$ tar -jxvf veejay-1.4.5.tar.bz2
Change to the directory containing veejay’s source’s:
$ cd veejay-1.4.5 $ cd veejay-server $ ./configure
On completion it will summarize the results of the ./configure
script, which could look like this:
configure: configure: Veejay 1.4.5 build configuration : configure: configure: Compiler flags: -march=nocona -mtune=nocona -msse -m configure: -fif-conversion configure: -O3 configure: configure: Architecture: i686 configure: configure: x86 configure: MMX enabled : yes configure: MMX2 enabled : yes configure: SSE enabled : yes configure: SSE2 enabled : yes configure: 3DNOW enabled : no configure: CMOV enabled : yes configure: configure: Platform: Linux configure: configure: Required dependencies: configure: - POSIX Threads (pthread) : true configure: - FFmpeg AVFormat : true configure: - FFmpeg AVCodec : true configure: - FFmpeg Swscaler : true configure: - SDL support : true configure: - Freetype support : true configure: - XML c library for Gnome : true configure: - JPEG support : true configure: - GDK Pixbuf support : true configure: Optional dependencies configure: - DirectFB support : false configure: - libDV (digital video) support : false configure: - QuickTime support : false configure: - Jack Audio Connection Kit : false configure: - Unicap Imaging : false
Now, you can start building veejay
$ make
Followed by
# make install $ sudo make install
3.3 Installing veejay-client
Now, you can start building Reloaded
$ cd .. $ cd veejay-client $ ./configure
On completion it will summarize the results of the ./configure
script, which could look like this:
configure: configure: GVeejayReloaded 1.4.7 build configuration : configure: configure: Compiler flags: -march=nocona -mtune=nocona -msse -mfpmath=sse -Wall -Wunused configure: -fif-conversion configure: -O3 configure: configure: Architecture: i686 configure: configure: x86 configure: MMX enabled : yes configure: MMX2 enabled : yes configure: SSE enabled : yes configure: SSE2 enabled : yes configure: 3DNOW enabled : no configure: CMOV enabled : yes configure: configure: Platform: Linux configure: configure: Required dependencies: configure: - Veejay 1.4 : true configure: - POSIX Threads (pthread) : true configure: - FFmpeg AVCodec : true configure: - FFmpeg Swscaler : true configure: - GDK Pixbuf support : true configure: - Alsa support (midi sequencer) : true
Now, you can start building Reloaded
$ make
Followed by
# make install $ sudo make install
3.4 Installing veejay-utils
=
Now, you can start building sayVIMS
$ cd .. $ cd veejay-utils $ ./configure
On completion it will summarize the results of the ./configure
script, which could look like this:
configure: configure: Veejay-Utilities 1.4 build configuration : configure: configure: Compiler flags: -march=pentium3 -mtune=pentium3 -msse -mfpmath=sse -Wall -Wunused configure: -fif-conversion configure: -O3 configure: configure: Architecture: i686 configure: configure: x86 configure: MMX enabled : yes configure: MMX2 enabled : yes configure: SSE enabled : yes configure: SSE2 enabled : yes configure: 3DNOW enabled : no configure: CMOV enabled : yes configure: configure: Platform: Linux configure: configure: Required dependencies: configure: - Veejay
Now you can continue with
$ make # make install $ sudo make install
3.5 First startup
=
Before launching veejay, you will need to put a TrueType font in $HOME/.veejay/fonts
You can find the location of your TTF folder by typing:
$ find /usr -name truetype $ find /usr -iname "*.ttf"
Copy a TrueType font to $HOME/.veejay/fonts
cp Verdana.ttf ~/.veejay/fonts
If you run in TwinView or One Bigdesktop mode and would like to use one of your screens for video,
you can set these environment variables:
VEEJAY_SCREEN_GEOMETRY=x + x VEEJAY_SCREEN_SIZE= x
Example
reloaded &
veejay -v -d
reloaded &
veejay -v -w1024 -h768 mjpeg-video-*.avi
veejay -u
man veejay
4.1 Veejay Discussion
You can join the Veejay Discussion Group
to discuss veejay, post questions and get general support.
4.2 Veejay developer’s lounge
Also, the developer lounge hosts a subversion code repository
where you can find the ‘on the bleeding edge’ sourcecode of
veejay.
Many thanks to jaromil (author of FreeJ/Muse) and the Dyne
Foundation for providing these tools.
svn co svn://dyne.org/veejay/trunk/veejay-current
cd veejay-current
sh autogen.sh
5. Credits
End of the Veejay HOWTO Compile. (You can stop reading here.)
6. GNU Free Documentation License
GNU Free Documentation License
Version 1.1, March 2000
Copyright (C) 2000 Free Software Foundation, Inc. 59 Temple Place,
Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies of
this license document, but changing it is not allowed.
0. PREAMBLE
The purpose of this License is to make a manual, textbook, or
other written document "free" in the sense of freedom: to
assure everyone the effective freedom to copy and redistribute it,
with or without modifying it, either commercially or noncommercially.
Secondarily, this License preserves for the author and publisher a
way to get credit for their work, while not being considered
responsible for modifications made by others.
This License is a kind of "copyleft", which means that
derivative works of the document must themselves be free in the same
sense. It complements the GNU General Public License, which is a
copyleft license designed for free software.
We have designed this License in order to use it for manuals for
free software, because free software needs free documentation: a free
program should come with manuals providing the same freedoms that the
software does. But this License is not limited to software manuals;
it can be used for any textual work, regardless of subject matter or
whether it is published as a printed book. We recommend this License
principally for works whose purpose is instruction or reference.
1. APPLICABILITY AND DEFINITIONS
This License applies to any manual or other work that contains a
notice placed by the copyright holder saying it can be distributed
under the terms of this License. The "Document", below,
refers to any such manual or work. Any member of the public is a
licensee, and is addressed as "you".
A "Modified Version" of the Document means any work
containing the Document or a portion of it, either copied verbatim,
or with modifications and/or translated into another language.
A "Secondary Section" is a named appendix or a
front-matter section of the Document that deals exclusively with the
relationship of the publishers or authors of the Document to the
Document’s overall subject (or to related matters) and contains
nothing that could fall directly within that overall subject. (For
example, if the Document is in part a textbook of mathematics, a
Secondary Section may not explain any mathematics.) The relationship
could be a matter of historical connection with the subject or with
related matters, or of legal, commercial, philosophical, ethical or
political position regarding them.
The "Invariant Sections" are certain Secondary Sections
whose titles are designated, as being those of Invariant Sections, in
the notice that says that the Document is released under this
License.
The "Cover Texts" are certain short passages of text
that are listed, as Front-Cover Texts or Back-Cover Texts, in the
notice that says that the Document is released under this License.
A "Transparent" copy of the Document means a
machine-readable copy, represented in a format whose specification is
available to the general public, whose contents can be viewed and
edited directly and straightforwardly with generic text editors or
(for images composed of pixels) generic paint programs or (for
drawings) some widely available drawing editor, and that is suitable
for input to text formatters or for automatic translation to a
variety of formats suitable for input to text formatters. A copy made
in an otherwise Transparent file format whose markup has been
designed to thwart or discourage subsequent modification by readers
is not Transparent. A copy that is not "Transparent" is
called "Opaque".
Examples of suitable formats for Transparent copies include plain
ASCII without markup, Texinfo input format, LaTeX input format, SGML
or XML using a publicly available DTD, and standard-conforming simple
HTML designed for human modification. Opaque formats include
PostScript, PDF, proprietary formats that can be read and edited only
by proprietary word processors, SGML or XML for which the DTD and/or
processing tools are not generally available, and the
machine-generated HTML produced by some word processors for output
purposes only.
The "Title Page" means, for a printed book, the title
page itself, plus such following pages as are needed to hold,
legibly, the material this License requires to appear in the title
page. For works in formats which do not have any title page as such,
"Title Page" means the text near the most prominent
appearance of the work’s title, preceding the beginning of the body
of the text.
2. VERBATIM COPYING
You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies
to the Document are reproduced in all copies, and that you add no
other conditions whatsoever to those of this License. You may not use
technical measures to obstruct or control the reading or further
copying of the copies you make or distribute. However, you may accept
compensation in exchange for copies. If you distribute a large enough
number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above,
and you may publicly display copies.
3. COPYING IN QUANTITY
If you publish printed copies of the Document numbering more than
100, and the Document’s license notice requires Cover Texts, you must
enclose the copies in covers that carry, clearly and legibly, all
these Cover Texts: Front-Cover Texts on the front cover, and
Back-Cover Texts on the back cover. Both covers must also clearly and
legibly identify you as the publisher of these copies. The front
cover must present the full title with all words of the title equally
prominent and visible. You may add other material on the covers in
addition. Copying with changes limited to the covers, as long as they
preserve the title of the Document and satisfy these conditions, can
be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto adjacent
pages.
If you publish or distribute Opaque copies of the Document
numbering more than 100, you must either include a machine-readable
Transparent copy along with each Opaque copy, or state in or with
each Opaque copy a publicly-accessible computer-network location
containing a complete Transparent copy of the Document, free of added
material, which the general network-using public has access to
download anonymously at no charge using public-standard network
protocols. If you use the latter option, you must take reasonably
prudent steps, when you begin distribution of Opaque copies in
quantity, to ensure that this Transparent copy will remain thus
accessible at the stated location until at least one year after the
last time you distribute an Opaque copy (directly or through your
agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of
the Document well before redistributing any large number of copies,
to give them a chance to provide you with an updated version of the
Document.
4. MODIFICATIONS
You may copy and distribute a Modified Version of the Document
under the conditions of sections 2 and 3 above, provided that you
release the Modified Version under precisely this License, with the
Modified Version filling the role of the Document, thus licensing
distribution and modification of the Modified Version to whoever
possesses a copy of it. In addition, you must do these things in the
Modified Version:
A. Use in the Title Page (and on the covers, if any) a title
distinct from that of the Document, and from those of previous
versions (which should, if there were any, be listed in the History
section of the Document). You may use the same title as a previous
version if the original publisher of that version gives permission.
B. List on the Title Page, as authors, one or more persons or
entities responsible for authorship of the modifications in the
Modified Version, together with at least five of the principal
authors of the Document (all of its principal authors, if it has less
than five). C. State on the Title page the name of the publisher of
the Modified Version, as the publisher. D. Preserve all the copyright
notices of the Document. E. Add an appropriate copyright notice for
your modifications adjacent to the other copyright notices. F.
Include, immediately after the copyright notices, a license notice
giving the public permission to use the Modified Version under the
terms of this License, in the form shown in the Addendum below. G.
Preserve in that license notice the full lists of Invariant Sections
and required Cover Texts given in the Document’s license notice. H.
Include an unaltered copy of this License. I. Preserve the section
entitled "History", and its title, and add to it an item
stating at least the title, year, new authors, and publisher of the
Modified Version as given on the Title Page. If there is no section
entitled "History" in the Document, create one stating the
title, year, authors, and publisher of the Document as given on its
Title Page, then add an item describing the Modified Version as
stated in the previous sentence. J. Preserve the network location, if
any, given in the Document for public access to a Transparent copy of
the Document, and likewise the network locations given in the
Document for previous versions it was based on. These may be placed
in the "History" section. You may omit a network location
for a work that was published at least four years before the Document
itself, or if the original publisher of the version it refers to
gives permission. K. In any section entitled "Acknowledgements"
or "Dedications", preserve the section’s title, and
preserve in the section all the substance and tone of each of the
contributor acknowledgements and/or dedications given therein. L.
Preserve all the Invariant Sections of the Document, unaltered in
their text and in their titles. Section numbers or the equivalent are
not considered part of the section titles. M. Delete any section
entitled "Endorsements". Such a section may not be included
in the Modified Version. N. Do not retitle any existing section as
"Endorsements" or to conflict in title with any Invariant
Section.
If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no material
copied from the Document, you may at your option designate some or
all of these sections as invariant. To do this, add their titles to
the list of Invariant Sections in the Modified Version’s license
notice. These titles must be distinct from any other section titles.
You may add a section entitled "Endorsements", provided
it contains nothing but endorsements of your Modified Version by
various parties-for example, statements of peer review or that the
text has been approved by an organization as the authoritative
definition of a standard.
You may add a passage of up to five words as a Front-Cover Text,
and a passage of up to 25 words as a Back-Cover Text, to the end of
the list of Cover Texts in the Modified Version. Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or
through arrangements made by) any one entity. If the Document already
includes a cover text for the same cover, previously added by you or
by arrangement made by the same entity you are acting on behalf of,
you may not add another; but you may replace the old one, on explicit
permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this
License give permission to use their names for publicity for or to
assert or imply endorsement of any Modified Version.
5. COMBINING DOCUMENTS
You may combine the Document with other documents released under
this License, under the terms defined in section 4 above for modified
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and
list them all as Invariant Sections of your combined work in its
license notice.
The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single
copy. If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by
adding at the end of it, in parentheses, the name of the original
author or publisher of that section if known, or else a unique
number. Make the same adjustment to the section titles in the list of
Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections entitled
"History" in the various original documents, forming one
section entitled "History"; likewise combine any sections
entitled "Acknowledgements", and any sections entitled
"Dedications". You must delete all sections entitled
"Endorsements."
6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other
documents released under this License, and replace the individual
copies of this License in the various documents with a single copy
that is included in the collection, provided that you follow the
rules of this License for verbatim copying of each of the documents
in all other respects.
You may extract a single document from such a collection, and
distribute it individually under this License, provided you insert a
copy of this License into the extracted document, and follow this
License in all other respects regarding verbatim copying of that
document.
7. AGGREGATION WITH INDEPENDENT WORKS
A compilation of the Document or its derivatives with other
separate and independent documents or works, in or on a volume of a
storage or distribution medium, does not as a whole count as a
Modified Version of the Document, provided no compilation copyright
is claimed for the compilation. Such a compilation is called an
"aggregate", and this License does not apply to the other
self-contained works thus compiled with the Document, on account of
their being thus compiled, if they are not themselves derivative
works of the Document.
If the Cover Text requirement of section 3 is applicable to these
copies of the Document, then if the Document is less than one quarter
of the entire aggregate, the Document’s Cover Texts may be placed on
covers that surround only the Document within the aggregate.
Otherwise they must appear on covers around the whole aggregate.
8. TRANSLATION
Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4.
Replacing Invariant Sections with translations requires special
permission from their copyright holders, but you may include
translations of some or all Invariant Sections in addition to the
original versions of these Invariant Sections. You may include a
translation of this License provided that you also include the
original English version of this License. In case of a disagreement
between the translation and the original English version of this
License, the original English version will prevail.
9. TERMINATION
You may not copy, modify, sublicense, or distribute the Document
except as expressly provided for under this License. Any other
attempt to copy, modify, sublicense or distribute the Document is
void, and will automatically terminate your rights under this
License. However, parties who have received copies, or rights, from
you under this License will not have their licenses terminated so
long as such parties remain in full compliance.
10. FUTURE REVISIONS OF THIS LICENSE
The Free Software Foundation may publish new, revised versions of
the GNU Free Documentation License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns. See
http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version
number. If the Document specifies that a particular numbered version
of this License "or any later version" applies to it, you
have the option of following the terms and conditions either of that
specified version or of any later version that has been published
(not as a draft) by the Free Software Foundation. If the Document
does not specify a version number of this License, you may choose any
version ever published (not as a draft) by the Free Software
Foundation.
ADDENDUM: How to use this License for your documents
To use this License in a document you have written, include a copy
of the License in the document and put the following copyright and
license notices just after the title page:
Copyright (c) YEAR YOUR NAME.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1
or any later version published by the Free Software Foundation;
with the Invariant Sections being LIST THEIR TITLES, with the
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
A copy of the license is included in the section entitled "GNU
Free Documentation License".
If you have no Invariant Sections, write "with no Invariant
Sections" instead of saying which ones are invariant. If you
have no Front-Cover Texts, write "no Front-Cover Texts"
instead of "Front-Cover Texts being LIST"; likewise for
Back-Cover Texts.
If your document contains nontrivial
examples of program code, we recommend releasing these examples in
parallel under your choice of free software license, such as the GNU
General Public License, to permit their use in free software.