Introduction
------------

The goal of the WarpVision project is to create an OS/2 multimedia player
that supports the latest formats, as well as the latest hardware features.


Licensing
---------

See the file COPYING


Status
------

The WarpVision Player is currently undergoing development, but in the interim
you can download the beta versions. All of the work on this project is done in
spare time and is distributed under GNU licencing guidelines.

If you know of some new features that you'd like to see implemented, or even
if you'd just like to do something nice for the authors, you can always make
a financial contribution! To find out how you can help the WarpVision team,
please mail us at wvision@os2.ru.


Installation
------------

Unzip the zip file, and run wvision.exe for help. Configuration file
wvision.cfg should be in the same directry as wvision.exe.


Command-line options
--------------------

Usage: WarpVision [options] movie_file

 Audio options:
  -noaudio - Disable audio
  -44100   - Resample audio 48kHz to 44kHz
  -48000   - Resample any audio samplerate to 48kHz
  -adevNNN - Select audio device NNN (0...)
  -aidNNN  - Select audio channel NNN

 Video options:
  -vrgb     - Output decoded frames in RGB16
  -vbgr     - Output decoded frames in BGR24
  -vyuv     - Output decoded frames in YUV422
  -idx      - Rebuild AVI file index
  -vidNNN   - Select video channel NNN
  -vaspect  - Keep aspect ratio
  -vasp43   - Force aspect ratio to 4:3
  -vasp169  - Force aspect ratio to 16:9
  -fni      - Force non-interleaved avi file format
  -pfb      - Force pts from bps
  -gammaNNN - Set gamma correction to NNN (-127...127)
  -snapNNN  - Select scale factor NNN for image (1...4)
  -autosnap - Automatically select maximal scale factor
  -ppqX     - postprocess quality (0...6)
  -npp ...  - postprocess options (see -npp help for details)

 DVD options:
  -dvdNNN     - Select and play title NNN (1...)
  -chapterNNN - Select chapter NNN (1...)
  -angleNNN   - Select angle NNN (1...)
  -sidNNN     - Select subtitle NNN (0...)

 VCD options:
  -vcdNNN     - Select and play track NNN (1...)

 Player control options:
  -pipeNNN  - Pipe name to use
  -perm     - Don't shutdown when list is empty

  * example: wvision.exe -dvd1 g:
             wvision.exe -dvd1 -sid0 -aid130 f:

             wvision.exe -dvd1 d:\dvd_disk_unencrypted_copy_dir

             wvision.exe -vcd1 h:

  * dvdcss.dll can be found at:
      ftp://ftp.os2.spb.ru/pub/mmedia/contrib/libdvdcss-1.2.6.zip

  * Audio stream can be selected by -aid option

  * postprocess example: wvision.exe -ppq6 -npp de
                         wvision.exe -npp lb -dvd1 h:

 Multifile and wildchar usage:
  wvision.exe x:\path\*.avi or wvision.exe x:\path\*.*


Keyboard control
----------------

Left / Right  - seek backward/forward 15 seconds
                (approximately, to the nearest videoframe)
Up   / Down   - seek backward/forward 1 minute
PgUp / PgDown - seek backward/forward 10 minutes
+    / -      - sync correction
<    / >      - gamma correction / brightness (Warp Overlay!)
k    / l      - contrast correction (Warp Overlay!)
p             - pause movie (press any key)
f             - switch full screen/windowed mode
Esc           - quit program
m             - mute/unmute audio
Ins  / Del    - audio volume correction


Supported formats
-----------------
Files: AVI, MPEG, DAT, VOB, ASF, OGG/OGM Vorbis

Audio: MPEG Layer-1,2,3, AC-3, Uncompressed PCM, Linear PCM,
       Windows Media Audio v1/2, MS ADPCM, RIFF ALAW, RIFF MULAW, Ogg Vorbis

Video: MPEG-1/2, MPEG-4 v1,2,3,4,5 DivX, MJPEG, Windows Media Video 7 (WMV1),
       Sony DV


CVS repository
--------------

The latest Warp Vision source code can be found by anonymous CVS at:

cvs -d:pserver:guest@cvs.netlabs.org:/netlabs.cvs/warpvision login
cvs -d:pserver:guest@cvs.netlabs.org:/netlabs.cvs/warpvision co .

Password: readonly


Player control (named pipe interface)
-------------------------------------

The named pipe interface provides simple way to control running copy
of WarpVision CLI. After start wvision.exe prepares server-side
named pipe \PIPE\WV (default name, can be changed using -pipe
command line switch or configuration file) and waits for command.
Command can be send using either programmatically, using DosWrite() API
(or appropriate equivalent in used programming language) or from
command line using "echo" command. For example:

    [Z:\]echo open u:\kolob2.avi >\pipe\wv

    [Z:\]echo set seek 10>\pipe\wv

Additional -perm command line switch tells WarpVision to not shutdown
when play list is empty and wait for command.

Following commands are recognised:

    open NNN         - Add file NNN to play list
    flip pause       - Flip play/stop
    flip fs          - Flip FS/window
    flip mute        - Mute on/off
    set seek NNN     - Seek for NNN seconds (*)
    set gamma NNN    - Set gamma correction to NNN (**)
    set contrast NNN - Set contrast to NNN (**)
    set sync NNN     - Correct synchronization for NNN (***)
    set volume NNN   - Set volume to NNN
    fs               - Switch to FS mode
    window           - Switch to windowed mode
    pause            - Pause playback
    play             - Play media
    mute             - Mute audio output
    unmute           - Enable audio output
    exit             - End playing media (****)
    shutdown         - Shutdown WarpVision

*    Positive value seeks forward, negative - backward.
     Actual seek is performed to the nearest sync frame.
**   Value must be in range from -127 to 127 (inclusively)
***  Value specified in tenth of second
**** Next media is started if available. If not, then player
     exist unless -perm command line switch or appropriate
     configuration file option is specified


Authors
-------

Alex Strelnikov (lelik@os2.ru) Author of the WarpVision "kernel" / CLI,
providing us with the porting and adaptation of audio & video CODECs,
sync, resampling and more.

Vlad Stelmahovsky (vladest@os2.kiev.ua) - WarpVision GUI author,
providing skin support, the player's PM interface and the WVGUI builds.

Sergey Yevtushenko (es@os2.kiev.ua) - WarpVision CLI PM code and more.

Alex Samorukov (samm@os2.kiev.ua) - Provider of silly advice, skins,
Web support and organization of the project

Konstantin Okounkov (ok@os2.ru)- Provider of project management,
Web support and documentation

Yvon Letourneau (yvon.letourneau@cogeco.ca) - Provider of English proofreading
for Kiev Elephant, and chocolate milk management
(managing to drink it all by himself!)

Eirik Overby (ltning@anduin.net) - Comrade the representative of project
in the western Europe

Used software
-------------

Warp Vision uses software from the following free software projects:

liba52 (http://liba52.sf.net/) by Aaron Holtzman and Michel Lespinasse
Free library for decoding ATSC A/52 streams. It is also known as AC-3.

libmpdemux, mp3lib (http://www.MPlayerHQ.hu/homepage/) by Arpad Gereoffy (A'rpi/ESP-team)
Parts of MPlayer project. Stream demultiplexing and mp3 audio decoding.

libmpeg2 (http://libmpeg2.sf.net/) by Aaron Holtzman and Michel Lespinasse
Free MPEG-2 video stream decoder.

ffmpeg (http://ffmpeg.sf.net/) by Fabrice Bellard
Fastest encoder/decoders various audio/video formats.

libDART, libDIVE by Andrew Zabolotny (zap@cobra.ru)
OS/2 audio/video libraries

libdvdread (http://www.dtek.chalmers.se/groups/dvd/index.shtml)
Author: The Ogle Group

The Ogg Vorbis CODEC project (http://www.xiph.org/ogg/vorbis)

Project Odin (http://odin.netlabs.org/)

Gamma correction ideas borrowed from xine project (http://xine.sf.net/)

YUV/RGB transforms based on parts of libmpeg2 & MPlayer


Thanks to
---------

all of #os2russian & #netlabs channels

...

(not completed yet!)


Donation
--------

The WarpVision project is donation-based. It means that you can support authors
by donating some money for them. Your support will allow project to live and
grow. Feel free to donate us via BMT Micro at:

https://secure.bmtmicro.com/ECommerce-OffSite/11980000.html

or directly, by contacting via email

Special info for german users

Es ist auch mglich per berweisung zu spenden

Deutsche Bank Frankfurt Branch
Empfnger Thomas Bradford
Kontonummer 0860221
Bankleitzahl 50070010

Als Verwendungszweck bitte "WarpVision Donation" angeben.


Sponsors & donators
-------------------

"OS/2 User Association Switzerland" DVD sponsoring

Eirik Overby
Jan-Erik Larka
Daniel Rudolph


Contacts, support
-----------------

Warp Vision Web: http://www.os2.kiev.ua/
