Command line video player
Go to file
alex c4560b672e added LCL decoder by Roberto Togni <r_togni@libero.it>, removed my old vd_zlib
git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@7223 b3059339-0415-0410-9bf9-f77b7e298cf2
2002-09-01 15:10:01 +00:00
DOCS cosmetics, 10l at beginning, no real changes 2002-09-01 11:46:38 +00:00
Gui rewrite eq interface and add *.rm to fs 2002-09-01 11:28:18 +00:00
TOOLS some fixes 2002-08-31 14:19:11 +00:00
TVout recursive CC fixed 2001-12-06 22:31:57 +00:00
debian Remove config files on purge. 2002-09-01 09:33:36 +00:00
drivers Fixed some breakages of single-buffer rendering of tdfx 2002-08-29 12:04:21 +00:00
etc recurse make into subdirectories by D Richard Felker III <dalias@aerifal.cx> 2002-08-30 10:57:08 +00:00
input removed old input code 2002-08-28 15:55:58 +00:00
liba52 use dir/libname.a instead of -Ldir -lname 2002-08-29 21:30:57 +00:00
libao2 added needed errno.h 2002-08-30 13:34:08 +00:00
libdha removed -W -Wall -g and other gcc-specific warning/debug options 2002-08-22 23:29:46 +00:00
libmpcodecs added LCL decoder by Roberto Togni <r_togni@libero.it>, removed my old vd_zlib 2002-09-01 15:10:01 +00:00
libmpdemux audio in layer is used only bu tvi_v4l, don't compile for others. 2002-08-31 22:41:29 +00:00
libmpdvdkit2 Bah, if we start spellchecking this, we might as well do it right ;-) 2002-08-17 10:25:18 +00:00
libmpeg2 obsoleted, use vd_libmpeg2.c 2002-04-18 14:45:43 +00:00
libvo Improved MacOS X SDL support, enable SDL main() wrapper for Darwin, remove unused envp. 2002-08-31 15:04:18 +00:00
linux removed -W -Wall -g and other gcc-specific warning/debug options 2002-08-22 23:29:46 +00:00
loader fix some warnings on cygwin, patch by Sylvain Petreolle <spetreolle@yahoo.fr> 2002-08-31 01:44:54 +00:00
mp3lib use dir/libname.a instead of -Ldir -lname 2002-08-29 21:30:57 +00:00
postproc warning fixes by Dominik Mierzejewski <dominik@rangers.eu.org> 2002-09-01 14:30:55 +00:00
vidix mostly compiler warning fixes, some small bugfix 2002-08-28 22:45:48 +00:00
.cvsignore ignore .libdeps 2002-08-30 13:53:32 +00:00
Makefile ability to override MANDIR, BINDIR 2002-09-01 14:40:09 +00:00
README Reorganized the README. More general information up front, more concise 2002-07-26 03:53:27 +00:00
asxparser.c Portability fix with realloc 2002-04-23 20:06:00 +00:00
asxparser.h Implementation of entryref 2002-01-22 22:47:17 +00:00
bswap.h Bswap fixes for 64bit cpus, thx to Falk Hueffner for the hint. 2002-08-05 13:04:54 +00:00
cfg-common.h -afm/-vfm migration from ID (int) to NAME (string) - simplifies code and makes dlopen()'ing possible 2002-08-30 21:44:20 +00:00
cfg-mencoder.h new mencoder option -info, to store copyright, title, encoder version etc in AVI 2002-08-29 20:50:49 +00:00
cfg-mplayer-def.h
cfg-mplayer.h General Timing Formula algorithm from a scratch. 2002-08-22 23:03:51 +00:00
cfgparser.c Improved MacOS X SDL support, enable SDL main() wrapper for Darwin, remove unused envp. 2002-08-31 15:04:18 +00:00
cfgparser.h warning fixes by Dominik Mierzejewski <dominik@rangers.eu.org> 2002-09-01 14:30:55 +00:00
codec-cfg.c make -ac/-vc help look better 2002-08-31 13:22:03 +00:00
codec-cfg.h -afm/-vfm migration from ID (int) to NAME (string) - simplifies code and makes dlopen()'ing possible 2002-08-30 21:44:20 +00:00
configure ability to override MANDIR, BINDIR 2002-09-01 14:40:09 +00:00
cpudetect.c more cpudetect cosmetics 2002-05-20 01:00:51 +00:00
cpudetect.h added cpuStepping to CpuCaps struct (needed win32.c) 2001-12-09 17:03:04 +00:00
cputable.h
darwinfixlib.sh Darwin needs to run ranlib on any static lib before linking, we do this in this script just before the final linking. 2002-05-03 19:23:15 +00:00
divx4_vbr.c we don't need dl nor stat functions - why to include tehir headers... 2002-03-23 19:14:13 +00:00
divx4_vbr.h divx4_vbr -> mplayer integration 2001-11-02 23:58:26 +00:00
dll_init.c mostly compiler warning fixes, some small bugfix 2002-08-28 22:45:48 +00:00
dll_init.h warning & newline fixes by Dominik Mierzejewski <dominik@rangers.eu.org> 2002-06-07 22:43:29 +00:00
fibmap_mplayer.c Return of the 'Old-style-DVD-support', with dynamic loading (using libdl) so 2002-01-04 13:08:14 +00:00
fifo.c Profiling fix by Artur Skawina <skawina@geocities.com> 2001-11-20 00:23:49 +00:00
find_sub.c final (?) libvo2 cleanup patch by Joey Parrish 2002-08-28 16:09:31 +00:00
get_path.c some debugging 2001-12-25 20:41:04 +00:00
help_diff.sh This script has no bash specific stuff, it's all standard bourne shell, so execute with sh. 2002-06-09 14:48:16 +00:00
help_mp-bg.h fix vfm and add afm support 2002-08-31 09:45:59 +00:00
help_mp-cs.h fix vfm and add afm support 2002-08-31 09:45:59 +00:00
help_mp-de.h fix vfm and add afm support 2002-08-31 09:45:59 +00:00
help_mp-dk.h fix vfm and add afm support 2002-08-31 09:45:59 +00:00
help_mp-el.h Translated by: Ioannis Panteleakis <pioann@csd.auth.gr> 2002-06-04 20:09:43 +00:00
help_mp-en.h some cosmetics for gui 2002-08-31 14:28:28 +00:00
help_mp-es.h typo 2002-08-03 21:26:25 +00:00
help_mp-fr.h add VCD support for GUI 2002-06-03 15:06:32 +00:00
help_mp-hu.h fix vfm and add afm support 2002-08-31 09:45:59 +00:00
help_mp-it.h Sync by Michele Balistreri <brain87 at gmx.net> 2002-07-10 03:17:40 +00:00
help_mp-ko.h 100l too 2002-06-03 21:58:53 +00:00
help_mp-nl.h fix vfm and add afm support 2002-08-31 09:45:59 +00:00
help_mp-no.h add VCD support for GUI 2002-06-03 15:06:32 +00:00
help_mp-pl.h fix vfm and add afm support 2002-08-31 09:45:59 +00:00
help_mp-pt_BR.h add VCD support for GUI 2002-06-03 15:06:32 +00:00
help_mp-ro.h added help strings for RoQ and REAL file detection 2002-02-01 05:31:51 +00:00
help_mp-ru.h add VCD support for GUI 2002-06-03 15:06:32 +00:00
help_mp-sk.h add VCD support for GUI 2002-06-03 15:06:32 +00:00
help_mp-uk.h translated by Volodymyr M. Lisivka <lvm@mystery.lviv.net> 2002-06-12 20:18:12 +00:00
help_mp-zh_CN.h fix vfm and add afm support 2002-08-31 09:45:59 +00:00
lirc_mp.c Make old and new lirc support independant from each other 2002-02-23 21:18:40 +00:00
lirc_mp.h
mangle.h Flush from my local tree, probably more future safe mangle decision of OpenBSD, in case they switch over to ELF. 2002-07-28 11:07:30 +00:00
me-opt-reg.c Options registration for mencoder 2002-02-20 17:02:31 +00:00
mencoder.c warning fixes by Dominik Mierzejewski <dominik@rangers.eu.org> 2002-09-01 14:30:55 +00:00
mixer.c add mute support ( step 1 ) and fixed panscan bugs (1000l for me) 2002-06-06 07:13:57 +00:00
mixer.h add mute support ( step 1 ) and fixed panscan bugs (1000l for me) 2002-06-06 07:13:57 +00:00
mmx.h forgot, sorry 2001-10-28 11:47:22 +00:00
mmx_defs.h warning & newline fixes by Dominik Mierzejewski <dominik@rangers.eu.org> 2002-06-07 22:43:29 +00:00
mp-opt-reg.c removed old input code 2002-08-28 15:55:58 +00:00
mp_msg-mencoder.c gui vs. mencoder conflict workaround 2002-05-03 22:05:46 +00:00
mp_msg.c WARNING message gui windows disabled, the only critical warn message (too 2002-08-31 16:20:07 +00:00
mp_msg.h new v4l capture patch by Jindrich Makovicka <makovick@kmlinux.fjfi.cvut.cz>: 2002-08-21 21:31:20 +00:00
mplayer.c 10l - use NULL instead of -1 for init_video's vfm 2002-08-31 18:24:56 +00:00
mplayer.h fix vfm and add afm support 2002-08-31 09:45:59 +00:00
my_profile.c using volatile modifier 2001-11-11 15:20:19 +00:00
my_profile.h warning & newline fixes by Dominik Mierzejewski <dominik@rangers.eu.org> 2002-06-07 22:43:29 +00:00
playtree.c Portability fix with realloc 2002-04-23 20:06:00 +00:00
playtree.h Set the params given to a playlist url to the playlist 2002-03-20 10:27:27 +00:00
playtreeparser.c 10L don't add a base path to the urls 2002-07-07 04:07:57 +00:00
playtreeparser.h Playtree parser switch to a by line mode. 2002-02-21 13:12:53 +00:00
spudec.c Put all spudec_new stuff in a single function, 2002-08-06 13:32:55 +00:00
spudec.h warning fixes by Sylvain Petreolle <spetreolle@yahoo.fr> 2002-08-14 21:28:18 +00:00
sub_cc.c codmetics :) 2002-07-25 16:39:22 +00:00
sub_cc.h codmetics :) 2002-07-25 16:39:22 +00:00
subreader.c FreeBSD iconv change/fix 2002-08-28 23:00:25 +00:00
subreader.h increased SUB_MAX_TEXT by Piotr Krukowiecki <piotr@pingu.ii.uj.edu.pl> 2002-09-01 11:08:28 +00:00
version.sh Fix for darwins date 2002-05-03 19:17:19 +00:00
vobsub.c Use RGB for palette from .IDX file 2002-07-28 16:37:05 +00:00
vobsub.h New function vobsub_get_next_packet for subrip. 2002-07-28 16:28:30 +00:00
xacodec.c final (?) libvo2 cleanup patch by Joey Parrish 2002-08-28 16:09:31 +00:00
xacodec.h Patch by Alan Young <ayoung at teleport.com>: Fix xacodec type mismatch, which 2002-07-10 08:56:06 +00:00

README

Welcome to MPlayer, the Unix movie player. MPlayer can play most standard video
formats out of the box and almost all others with the help of external codecs.
MPlayer currently works best from the command line, but visual feedback for
many functions is available from its onscreen status display (OSD), which is
also used for displaying subtitles. A GUI with skin support is in the alpha
development stage, but not completely finished yet.

This document is for getting you started in a few minutes. It cannot answer all
of your questions. If you have problems, please read the documentation in
DOCS/documentation.html, which should help you solve most of your problems.
Also read the man page to learn how to use MPlayer.


Requirements:
- To compile MPlayer with X11 support, you need to have the XFree86 development
  packages installed.
- For the GUI you need the GTK 1.2 development packages.


Before you start...
Unless you know what are you doing, consult DOCS/video.html to see which driver
to use with your video card to get the best quality and performance. Most cards
require special drivers not included with XFree86 to drive their 2-D video
acceleration features like YUV and scaling.

A quick and incomplete list of recommendations:
- ATI cards: Get the GATOS drivers for X11/Xv or use VIDIX.
- Matrox G200/G4x0/G550: Compile and use mga_vid for Linux, on BSD use VIDIX.
- 3dfx Voodoo3/Banshee: Get XFree86 4.2.0+ for Xv or use the tdfxfb driver.
- nVidia cards: Get the X11 driver from www.nvidia.com for Xv support.
- NeoMagic cards: Get an Xv capable driver from our homepage as described in
  DOCS/video.html.

Without accelerated video even an 800MHz P3 may be too slow to play DVDs.


______________________
STEP0: Getting MPlayer
~~~~~~~~~~~~~~~~~~~~~~

Official releases, prereleases and CVS snapshots, as well as fonts for the
OSD, Win32 codecs and a number of different skins for the GUI are available
from the download section of our homepage at

  http://www.mplayerhq.hu/homepage/dload.html

A set of fonts is necessary for the OSD and subtitles, the GUI needs at least
one skin and Win32 codecs add support for some more video and audio formats.
MPlayer does not come with any of these by default, you have to download and
install them separately.

MPlayer is also available via anonymous CVS. Issue the following commands to
get the latest sources:

  cvs -d:pserver:anonymous@mplayerhq.hu:/cvsroot/mplayer login
  cvs -z3 -d:pserver:anonymous@mplayerhq.hu:/cvsroot/mplayer co main

When asked for a password, just hit enter. A directory named 'main' will be
created. You can later update your sources by saying

  cvs -z3 update -dPA

from within that directory.


___________________________________
STEP1: Installing FFmpeg libavcodec
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you are using an official (pre)release, skip this step, since official
releases include libavcodec. CVS sources and CVS snapshots do not include
libavcodec. To verify if you do have libavcodec or not, check if the libavcodec
subdirectory in the MPlayer source tree is empty or not.

The FFmpeg project provides libavcodec, a very portable codec collection (among
the supported formats is MPEG4/DivX) with excellent quality and speed, that is
the preferred MPEG4/DivX codec of MPlayer. You have to get libavcodec directly
from the FFmpeg CVS server.

To get the FFmpeg sources, use the following commands in a suitable directory
outside the MPlayer source directory:

cvs -d:pserver:anonymous@cvs.ffmpeg.sourceforge.net:/cvsroot/ffmpeg login
cvs -z3 -d:pserver:anonymous@cvs.ffmpeg.sourceforge.net:/cvsroot/ffmpeg co ffmpeg/libavcodec

When asked for a password, you can just hit enter.

Now, replace the empty libavcodec directory in the MPlayer source tree with the
FFmpeg libavcodec source by removing the libavcodec subdirectory in the MPlayer
source tree and then copying (symbolic linking does not suffice) the freshly
downloaded FFmpeg libavcodec directory back into the MPlayer source tree.


______________________________
STEP2: Installing Win32 Codecs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

MPlayer and libavcodec have builtin support for the most common audio and video
formats, but some others are playable only with the Win32 DLLs or the XAnim
binary plugins. Examples include WMV video, DivX with WMA audio (not normal
DivX files) and Indeo. This step is not mandatory, but recommended for getting
MPlayer to play more different file types. Note that Win32 codecs only work on
Intel compatible PCs.

Unpack the codecs archive and put the contents in a directory where MPlayer
will find them. The default directory is /usr/lib/win32/ but you can change
that to something else by using the '--with-win32libdir=DIR' option when you
run './configure'.


__________________________
STEP3: Configuring MPlayer
~~~~~~~~~~~~~~~~~~~~~~~~~~

MPlayer has a lot of options that get selected in this phase. Run

  ./configure

to configure MPlayer with the default options. The codecs you installed above
should be autodetected. GUI support has to be enabled separately, run

  ./configure --enable-gui

if you want to use the GUI.

If something does not work as expected, try

  ./configure --help

to see the available options and select what you need.

The configure script prints a summary of enabled and disabled options. If you
have something installed that configure fails to detect, check the file
configure.log for errors and reasons for the failure. Repeat this step until
you are satisfied with the enabled feature set.


________________________
STEP4: Compiling MPlayer
~~~~~~~~~~~~~~~~~~~~~~~~

Now you can start the compilation by typing

  make

You can install MPlayer with

  make install

provided that you have write permission in the installation directory.

If all went well, you can run MPlayer by typing 'mplayer'. A help screen with a
summary of the most common options and keyboard shortcuts should be displayed.

If you get 'unable to load shared library' or similar errors, run
'ldd ./mplayer' to check which libraries fail and go back to STEP 3 to fix it.
Sometimes running 'ldconfig' is enough to fix the problem.

NOTE: If you run Debian you can configure, compile and build a proper Debian
.deb package with only one command:

  fakeroot debian/rules binary


____________________________________________
STEP5: Installing the onscreen display fonts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Unpack the archive and choose one of the available font sizes. Then copy the
font files of the corresponding size into /usr/local/share/mplayer/font/ or
~/.mplayer/font/ (or whatever you set with './configure --datadir=DIR').


____________________________
STEP6: Installing a GUI skin
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Unpack the archive and put the contents in /usr/local/share/mplayer/Skin/ or
~/.mplayer/Skin/. MPlayer will use the skin in the default/ subdirectory of
/usr/local/share/mplayer/Skin/ or ~/.mplayer/Skin/ unless told otherwise via
the '-skin' switch. You should therefore rename your skin subdirectory or make
a suitable symbolic link.


__________________
STEP7: Let's play!
~~~~~~~~~~~~~~~~~~

That's it for the moment. To start playing movies, open a command line and try

  mplayer <moviefile>

or for the GUI

  mplayer -gui <moviefile>
  gmplayer <moviefile>

gmplayer is a symbolic link to mplayer created by 'make install'.
Without <moviefile>, MPlayer will come up and you will be able to use the GUI
filepicker.

To play a VCD track or a DVD title, try:

  mplayer -vcd 2 -cdrom-device /dev/hdc
  mplayer -dvd 1 -alang en -slang hu -dvd-device /dev/hdd

See 'mplayer -help' and 'man mplayer' for further options.

'mplayer -vo help' will show you the available video output drivers. Experiment
with the '-vo' switch to see which one gives you the best performance.
If you get jerky playback or no sound, experiment with the '-ao' switch (see
'-ao help') to choose between different audio drivers. Note that jerky playback
is caused by buggy audio drivers or a slow processor and video card. With a
good audio and video driver combination, one can play DVDs and 720x576 DivX
files smoothly on a Celeron 366. Slower systems may need the '-framedrop'
option.

Questions you may have are probably answered in the rest of the documentation.
The places to start reading are the man page, DOCS/documentation.html and
DOCS/faq.html.