Mercurial > mplayer.hg
annotate DOCS/tech/binary-packaging.txt @ 28913:0168df7e4dde
Give table headings more meaningful names.
author | diego |
---|---|
date | Sat, 14 Mar 2009 16:58:22 +0000 |
parents | b748e4e64b50 |
children | 65c1c0903740 |
rev | line source |
---|---|
14267 | 1 ________________________________________________ |
2 How to make good binary package(s) of MPlayer? | |
3 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
4 by Dominik 'Rathann' Mierzejewski | |
5 | |
6 About this document | |
7 ~~~~~~~~~~~~~~~~~~~ | |
8 | |
9 With the release of MPlayer 0.90pre9, all licensing issues have been | |
10 eliminated and all code is licensed under the GPL, which allows | |
11 independent packagers to create and distribute binary packages. At first, | |
12 this was discouraged by some of the developers, but the users' demand for | |
13 ready-to-use binary packages convinced some people to create them. | |
14 Unfortunately, many currently available packages are crippled, include | |
15 their own obsolete config files or are mispackaged in some other way. This | |
16 document aims to establish a common set of packaging guidelines so that | |
17 proper official binary packages for various Linux distributions and other | |
18 operating systems can be maintained. | |
19 | |
20 | |
21 Conventions | |
22 ~~~~~~~~~~~ | |
23 Whenever you see "MUST", it means that following the mentioned guideline | |
24 is required. Whenever you see "SHOULD", it means that following the | |
25 guideline is highly recommended, but not required. | |
26 | |
27 | |
28 Minimum feature set | |
29 ~~~~~~~~~~~~~~~~~~~ | |
30 Due to MPlayer design, it is impossible to simply include all possible | |
31 features and enable or disable them at runtime. That is why packagers | |
32 SHOULD avoid "dependency hell" by retaining a reasonable, limited default | |
33 feature set. After some discussion with other developers, we agreed that | |
34 the following features MUST be included in any official binary package: | |
35 | |
36 * audio/video output | |
37 - fbdev | |
38 - JPEG/PNG/TGA | |
39 - (X)MGA | |
16950 | 40 - OSS |
14267 | 41 - tdfxfb |
42 - (c/x)vidix | |
43 - X11/Xvideo | |
44 | |
45 * codecs | |
19783 | 46 - FAAD(internal) |
14267 | 47 - libavcodec(internal) |
48 - native codecs (libmpeg2/liba52/mp3lib) | |
16949 | 49 - Vorbis Tremor codec(internal) |
19898
d77040154bad
Add (if applicable) footnote to binary codecs in the feature list.
rathann
parents:
19790
diff
changeset
|
50 - RealPlayer codecs support (*) |
d77040154bad
Add (if applicable) footnote to binary codecs in the feature list.
rathann
parents:
19790
diff
changeset
|
51 - Win32/VfW/DShow/QT codecs support (*) |
d77040154bad
Add (if applicable) footnote to binary codecs in the feature list.
rathann
parents:
19790
diff
changeset
|
52 - XAnim codecs support (*) |
14267 | 53 |
54 * general: | |
55 - default font | |
56 - FreeType fonts support | |
57 - HTML documentation | |
58 - large file support | |
59 - man page(s) | |
60 | |
61 * input/demuxers: | |
62 - DVD(mpdvdkit2) | |
63 - streaming | |
64 - Matroska(internal) | |
65 - (S)VCD | |
66 - tv(v4l/v4l2) | |
67 | |
19898
d77040154bad
Add (if applicable) footnote to binary codecs in the feature list.
rathann
parents:
19790
diff
changeset
|
68 (*) if available for your OS/hardware |
d77040154bad
Add (if applicable) footnote to binary codecs in the feature list.
rathann
parents:
19790
diff
changeset
|
69 |
14267 | 70 There is great demand for the GUI, so it SHOULD be included, but it MUST |
71 come as a separate package (see Tips and Tricks for details). | |
72 | |
73 Including other features, like LIVE.COM streaming or JACK support, is | |
74 acceptable. They SHOULD, however, be build-time configurable, with the | |
75 default build configuration containing the above set. | |
76 | |
77 It seems there are some packages in the wild which lack included docs. | |
78 This is VERY BAD, as it forces users to look for outside support when most | |
79 of the common problems are easy to solve and are already described in the | |
80 docs, thus increasing the number of repeated posts in MPlayer mailing | |
81 lists. Binary packages MUST include both the man page and HTML | |
82 documentation. Translated versions SHOULD be included, even if your | |
83 package management system does not provide specific support for | |
84 internationalization. | |
85 | |
19899
b748e4e64b50
Allow shared libavcodec, but explain the implications.
rathann
parents:
19898
diff
changeset
|
86 Libavcodec MUST always be in the latest development version and it SHOULD |
14268 | 87 be linked statically into the mplayer binary, because MPlayer requires a |
19899
b748e4e64b50
Allow shared libavcodec, but explain the implications.
rathann
parents:
19898
diff
changeset
|
88 recent libavcodec snapshot. It is acceptable to use a shared (again, recent) |
b748e4e64b50
Allow shared libavcodec, but explain the implications.
rathann
parents:
19898
diff
changeset
|
89 version of libavcodec, but you must be aware that this disables some of |
b748e4e64b50
Allow shared libavcodec, but explain the implications.
rathann
parents:
19898
diff
changeset
|
90 MPlayer's functions (for example, some postprocessing filters) and sacrifices |
b748e4e64b50
Allow shared libavcodec, but explain the implications.
rathann
parents:
19898
diff
changeset
|
91 speed. |
14267 | 92 |
19790 | 93 Support for binary codecs SHOULD be present to the extent that the combination |
94 of operating system and CPU architecture permits, but it MUST NOT result in a | |
95 hard dependency on a binary codecs package. MPlayer is fully functional without | |
19783 | 96 external binary codecs. If you package binary codecs yourself, package the |
97 essential codecs package, not the all codecs package. | |
98 | |
19898
d77040154bad
Add (if applicable) footnote to binary codecs in the feature list.
rathann
parents:
19790
diff
changeset
|
99 Bitmap fonts are deprecated, don't package them. Use scalable (Type1/TrueType) |
d77040154bad
Add (if applicable) footnote to binary codecs in the feature list.
rathann
parents:
19790
diff
changeset
|
100 fonts instead. |
19783 | 101 |
14267 | 102 |
103 File locations | |
104 ~~~~~~~~~~~~~~ | |
105 In general, you SHOULD follow your distribution guidelines. For example, | |
14268 | 106 for Red Hat and Fedora RPMs I am using FHS-compliant paths: |
14267 | 107 |
108 /etc/mplayer/ system-wide configs | |
109 /usr/bin/ binaries | |
110 /usr/lib/codecs/ binary codecs | |
111 /usr/share/doc/mplayer-version/ docs | |
112 /usr/share/man/man1/ man page | |
113 /usr/share/man/XX/man1/ translated man page | |
114 /usr/share/mplayer/font/ fonts | |
17974
9a5a62f480e6
Rename the default GUI skins directory from 'Skin' to 'skins', keeping
diego
parents:
16950
diff
changeset
|
115 /usr/share/mplayer/skins/ GUI skins |
14267 | 116 |
19783 | 117 You MUST NOT include the codecs.conf file in your package. It is useful |
14267 | 118 only for development purposes and often causes obscure problems for users. |
119 | |
19673
e7cd9c08d1d9
Remind packagers not to use deprecated codecs and skins paths.
diego
parents:
17974
diff
changeset
|
120 Please avoid using the deprecated paths for binary codecs (/usr/lib/win32/) |
e7cd9c08d1d9
Remind packagers not to use deprecated codecs and skins paths.
diego
parents:
17974
diff
changeset
|
121 and skins (/usr/share/mplayer/Skin/). |
e7cd9c08d1d9
Remind packagers not to use deprecated codecs and skins paths.
diego
parents:
17974
diff
changeset
|
122 |
14267 | 123 |
124 One package or many packages? | |
125 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
126 Although it is tempting to simply provide a single all-in-one package, | |
127 I think it is best to split MPlayer into several packages. It may be | |
128 a little more troublesome for less clueful users, but it allows you to | |
14268 | 129 install only what you need. This is the layout I am using for Red Hat and |
14267 | 130 Fedora RPMs: |
131 | |
132 mencoder contains MEncoder binary (mencoder) | |
133 mplayer contains MPlayer binary without GUI (mplayer), | |
134 config files, man pages and documentation; | |
135 required by mplayer-gui | |
136 mplayer-codecs-* contain binary codecs available from MPlayer's site | |
137 mplayer-font-* contain various bitmap fonts for OSD (obsolete) | |
138 mplayer-gui contains MPlayer binary with GUI (gmplayer); | |
16950 | 139 contains default skin (Blue) |
14267 | 140 mplayer-skin-* contain various MPlayer GUI skins |
14268 | 141 mplayer-vidix contains VIDIX support library for MPlayer |
142 mplayer-vidix-* contain VIDIX drivers for specific cards, one per package | |
14267 | 143 |
144 There is no strict policy for now, just use your common sense. | |
145 | |
146 | |
147 Compilation | |
148 ~~~~~~~~~~~ | |
149 While it is acceptable to provide packages optimized for specific CPUs, | |
150 you MUST provide at least one "lowest common denominator" package set | |
14268 | 151 that will work on all CPUs. This means it MUST be configured with the |
14267 | 152 --enable-runtime-cpudetection option. Building for specific CPUs requires |
153 disabling this option, but try to make sure that users cannot accidentally | |
154 install a package not suitable for their CPU. With RPMs, for example, this | |
14268 | 155 is handled automatically, when building with the "--target arch" rpm option. |
14267 | 156 |
157 Compiler flags MUST be set to either configure-generated CFLAGS or something | |
158 as close to them as possible. | |
159 | |
160 Users MUST be able to rebuild your source package without hand-editing on | |
161 any system with the same distribution installed. Remember to disable | |
162 (--disable-xxx) any optional features, because MPlayer's configure script | |
163 autodetects most of them. This ensures that binary package builds are | |
164 deterministic -- that is, provided they have at least the required | |
165 development packages installed, two different people using the same | |
166 distribution will get binaries with the same dependencies. | |
167 | |
168 You SHOULD provide an option to rebuild the package with full debug | |
169 information enabled (by passing --enable-debug=3 to ./configure and | |
170 disabling any stripping of binaries and libs during the build process). | |
14268 | 171 For example my source RPM can be rebuilt with a "--with debug" option, which |
14267 | 172 does just that, making it easier to supply gdb information along with any |
173 bug reports, while retaining all benefits of using binary packages. | |
174 | |
175 | |
176 Modifications | |
177 ~~~~~~~~~~~~~ | |
178 | |
179 You MUST modify `mplayer -v` output so that it is clear that a user is | |
180 using your binary package, by patching version.h and modifying the version | |
181 string inside. Suggested convention is to include distribution name and, | |
182 possibly, the signature of the packager or the repository. For example: | |
183 | |
184 original: | |
185 MPlayer 1.0pre5-3.3.2 (C) 2000-2004 MPlayer Team | |
186 modified: | |
187 MPlayer 1.0pre5-Fedora-GS-3.3.2 (C) 2000-2004 MPlayer Team | |
188 MPlayer 1.0pre5-Mandrake-PLF-3.2.3 (C) 2000-2004 MPlayer Team | |
189 MPlayer 1.0pre5-Solaris-3.4.0 (C) 2000-2004 MPlayer Team | |
190 | |
19783 | 191 If you patch MPlayer, send your patches to us! We will try to integrate them. |
192 Furthermore, we're often able to come up with a cleaner or more general | |
193 solution to your problem. | |
194 | |
19784 | 195 If you have modified configuration files or similar, please patch the official |
196 one instead of copying it into your package. This way you will automatically | |
197 pick up changes we make to it. | |
19783 | 198 |
19898
d77040154bad
Add (if applicable) footnote to binary codecs in the feature list.
rathann
parents:
19790
diff
changeset
|
199 Do not override video and audio output selection in the system-wide config |
d77040154bad
Add (if applicable) footnote to binary codecs in the feature list.
rathann
parents:
19790
diff
changeset
|
200 file. MPlayer will try to pick the best VO and AO itself and fall back |
d77040154bad
Add (if applicable) footnote to binary codecs in the feature list.
rathann
parents:
19790
diff
changeset
|
201 gracefully. If you want to give priority to some AO, add a comma at the end |
d77040154bad
Add (if applicable) footnote to binary codecs in the feature list.
rathann
parents:
19790
diff
changeset
|
202 of the line so that MPlayer can still fall back on others, for example: |
d77040154bad
Add (if applicable) footnote to binary codecs in the feature list.
rathann
parents:
19790
diff
changeset
|
203 ao=alsa, |
14267 | 204 |
205 Tips and tricks | |
206 ~~~~~~~~~~~~~~~ | |
207 In my package layout, mplayer and mplayer-gui can be installed at the same | |
208 time, because they contain differently named binaries and there is no | |
209 conflict. The trick is to build MPlayer once with --enable-gui, rename the | |
210 resulting binary to "gmplayer" and then build it again, without GUI, but | |
211 keeping the rest of ./configure options the same. | |
212 | |
213 To provide man pages for all MPlayer suite binaries (mplayer, gmplayer, | |
214 mencoder), you can use man-links instead of regular symbolic links. | |
215 Creating a mencoder man page linked to mplayer is as simple as: | |
216 | |
217 echo ".so mplayer.1" >> mencoder.1 | |
218 | |
14268 | 219 A similar trick can be used for "man gmplayer". This avoids problems with |
14267 | 220 gzipped man pages and symbolic links. |
221 | |
14268 | 222 Newer Red Hat and Fedora distributions keep localized man pages encoded in |
14267 | 223 UTF-8. If your distribution does the same, make sure you convert MPlayer's |
224 translated man pages to UTF-8 so that man mplayer works for locales other | |
225 than English. |