README
1-------------------------------------------------------------------------------
2Aften: A/52 audio encoder
3
4A simple AC3-compatible audio encoder based on FFmpeg.
5
6-------------------------------------------------------------------------------
7Aften, Copyright (c) 2006-2007 Justin Ruggles <justin.ruggles@gmail.com>
8 2006-2007 Prakash Punnoor <prakash@punnoor.de>
9http://aften.sourceforge.net/
10-------------------------------------------------------------------------------
11FFmpeg, Copyright (c) 2000-2007 Fabrice Bellard, et al.
12http://ffmpeg.mplayerhq.hu/
13-------------------------------------------------------------------------------
14
15Trademark notice: The authors make no claims that this software or any
16content created with this software is Dolby(R) Digital compliant. As such,
17any content which is created with this software should not be labeled as
18containing Dolby(R) Digital technology, nor should it bear any registered
19trademarks of Dolby Laboratories or any other trademark holder unless
20otherwise authorized.
21
22
23Building Aften with CMake
24==========================
25
26The aim of using CMake is making portable development easier, as CMake
27contains generators for various build systems. On e.g. *nix Makefiles
28will be built, and on Windows MS VC++ project files, if you wish. You
29can get CMake at http://cmake.org/.
30
31This document explains briefly how to build with CMake on Linux via an
32out-of-tree build:
33
34 - Change to the toplevel directory containing the Aften sources.
35 - Create a directory, e.g. "default", and change into it.
36 - Now run something like:
37
38 cmake .. -DCMAKE_INSTALL_PREFIX:STRING="/usr"
39 make
40 make install
41
42 If you exported your CFLAGS, there is no need to specify them
43 explicitly, as CMake will pick them up.
44
45 - Aften should get installed as you got used to it.
46
47I really would like to get CMake building Aften on every supported
48platform. So please contact me if it doesn't build on yours. I'll try to
49fix this with your help.
50
51Following Options might be of interest for you:
52
53SHARED: Builds aften as a shared lib, as well. The API hasn't been set
54 in stone, so you have been warned. ;-)
55DOUBLE: Builds aften using double precision. Beware that you won't get
56 SIMD code, as the SSE code hasn't been ported to SSE2, yet.
57BINDINGS_CXX: Builds C++ bindings for aften. Include aftenxx.h in your
58 C++ project and link to aftenxx.
59
60Some tips:
61
62 - You can use a console GUI named ccmake for configuring cmake. This
63 also comes in handy, to find out about available options. You can
64 also set options via command-line:
65
66 ccmake .. -DCMAKE_INSTALL_PREFIX:STRING="/usr"
67
68 sets the two variables defined on command line and then starts the
69 GUI. Press 'c' the first time and every time you want to commit
70 changes in the config. Finally press 'g' to run the generator. Btw,
71 to set boolean vars from the command line, use -DVAR:BOOL=X, where
72 X is eg. ON or OFF.
73
74 - If you want more output at compile time, use
75
76 make VERBOSE=1
77
78 - If you want to install to a different directory (using same
79 prefix), use
80
81 make install DESTDIR=/foo/bar
82
83 - CMake doesn't have a distclean target by default, so you better
84 really do an out-of-tree build, then you can simply delete its
85 content when you want a distclean... Furthermore it is easier to
86 have different builds using different parameters via out-of-tree
87 builds.
88
89 - If you are interested in variables to set, take a look into
90 CMakeCache.txt after having run the configuring stage.
91
92 - If you update your source tree via svn and want to rebuild an
93 previously built lib without cleaning, you better at least clear
94 the CMake cache (remove CMakeCache.txt) otherwise a modified CMake
95 project file could result in unwanted behaviour.
96