Fix the clean script (again)
[mplayer/kovensky.git] / build / README
blobe2c6a08b1304288b7fb9a674ac38d31ca2820a5c
1 This repository contains scripts to help build MPlayer together with
2 some dependencies that many platforms will not have a new enough
3 version of.
5 If you have a multicore machine read about FFmpeg-mt below.
9 Initializing the repo
11 First you need to download the actual sources, using either:
13 ./init
15 ./init --shallow
17 The latter form creates only partial git repositories which do not
18 have full history data. This reduces the amount of data you need to
19 download but reduces the development-related functionality of the
20 repositories. If you only want to simply build MPlayer it should
21 usually be enough.
25 Building
27 You can build MPlayer with just 'make'. There is no separate
28 configure step because the MPlayer configure depends on included
29 library sources being configured _and_ built first. If you want to
30 give configuration options see the section below.
34 Enabling FFmpeg-mt
36 FFmpeg-mt is version of FFmpeg with improved threading support, useful
37 for things like high-bitrate H264. It allows significantly faster
38 decoding on multicore machines but is sometimes less stable (it's
39 quite usable in most cases though). You can enable compilation with
40 FFmpeg-mt decoders using "./enable-mt" and disable it with
41 "./disable-mt". To actually use the threading support in your
42 mt-enabled MPlayer you need to it a "-lavdopts threads=N" option,
43 where N is the number of threads you want to use (a value equal to
44 your number of cores is normally good). So if you have a quadcore
45 machine you can do for example:
46 ./enable-mt
47 ./init --shallow
48 make -j 6
49 mplayer/mplayer -lavdopts threads=4 some_high_bitrate_h264_stuff.mkv
50 (or alternatively install first instead of running mplayer from the
51 build location on the last line)
55 Giving configure options to MPlayer and FFmpeg
57 You can specify extra options that will be passed to MPlayer's
58 configure script by placing them in a file called "mplayer_options" in
59 this directory. There's a corresponding file called "ffmpeg_options"
60 for FFmpeg. Options in file "common_options" will be passed to both
61 MPlayer and FFmpeg; this mainly makes sense for generic options like
62 "-cc=gcc-4.4'. Place each option on its own line without any quoting.
66 Helper scripts included in this repo:
68 ./init
69 Prepare the repository by downloading actual sources. You need to run
70 this at least once before you can build anything. With the --shallow
71 argument creates shallow git repositories that require less bandwidth
72 to download.
74 ./update
75 Download the latest version of the sources.
77 ./clean
78 Remove all generated or extra files from build directories and
79 restore them to their original state. Running this between builds is
80 probably a good idea.
82 ./enable-mt
83 ./disable-mt
84 Enabled or disable building with FFmpeg-mt support. Can be run before
85 first ./init or later to switch support on and off. The file
86 'ffmpeg-mt-enabled' is created or deleted to indicate whether -mt
87 support is currently active. Note that if you build MPlayer and then
88 switch -mt support on or off, a rebuild is likely to fail unless you
89 remember to run ./clean before the new build.