                           K Movie Player test ver.
                          --------------------------
                            
1. Introduce
------------
  
  This program, based on FFplay, is made to play various media files on OS/2 
and eComStation.

2. Development Environment
--------------------------
  
  - OS/2 Warp v4 for Korean with FixPak #15
  
  - GCC v3.3.5 CSD1
  
  - OS/2 ToolKit v4.5
  
  - nasm 0.98.38
  
  - OS2UNIX environment ( GNU Make 3.81r2, cp, rm, ... )
      
3. Requirement
---------------------

  - Audio : DART

  - Video : DIVE or WarpOverlay

4. Test Environment
-------------------

  This program is tested on OS/2 Warp v4 for Korean with FixPak #15 and 
eComStation 1.2MR.

5. Installation
---------------

  Put kmp.exe into any directory.
  
6. Usage and Options
--------------------

6.1 Usage
---------

6.1.1 Usage
--------------
    kmp [options] input_file
  
6.1.2 While playing
-------------------
q                   quit
f, Enter            toggle full screen
p, SPC              toggle pause
m                   toggle audio mute
a                   cycle audio channel
v                   cycle video channel
t                   cycle subtitle channel
w                   show audio waves
left/right          seek backward/forward 10 seconds
ctrl+left/right     seek backward/forward 1 minute
down/up             volume down/up by 1%
ctrl+down/up        volume down/up by 5%
mouse click         seek to position in file corresponding to fraction of width

6.2 Options
------------

6.2.1 Main options
------------------
-h                  show help
-video driver       set video driver (driver=auto/wo/dive)
-x width            force displayed width
-y height           force displayed height
-fs                 force full screen
-vol level          set initial volume level in percentage
-an                 disable audio
-vn                 disable video
-ss pos             seek to a given position in seconds
-bytes              seek by bytes
-nodisp             disable graphical display
-f fmt              force format

6.2.2 Advanced options
----------------------
-stats              show status
-debug              print specific debug info
-bug                workaround bugs
-vismv              visualize motion vectors
-fast               non spec compliant optimizations
-genpts             generate pts
-lowres
-skiploop
-skipframe
-skipidct
-idct algo          set idct algo
-er threshold       set error detection threshold (0-4)
-ec bit_mask        set error concealment options
-rtp_tcp            force RTP/TCP protocol usage
-sync type          set audio-video sync. type (type=audio/video/ext)
-threads count      thread count

6.2.3 KMPOPT Environment Variable
---------------------------------
  You can use 'KMPOPT' env. var. for your favorite options. For examples,
  
      SET KMPOPT=-vol 50
      KMP input_file
   
  This is the same as the following.
     
      KMP -vol 50 input_file
      
7. Limitations/Known bugs
-------------------------

  - KMP doesn't quit even though play back ended. Press 'q' or push close 
    button to quit.

  - Some broken files aren't played up to its play time.    
  
  - On pause, client area isn't updated.
  
  - Don't supports SNAP overlay( I don't have it ).
    
8. TODOs...
-----------

  - Support OSD
  
  - Support text file subtitle
  
  - Support configuration file
  
  - Support SNAP overlay
  
9. History
----------

  - Test vesrion ( 2007/02/02 )
    .Removed dependency on SDL of FFplay, and changed the name to KMP
    .Added volume control feature
    .Added audio mute on/off feature
    .Changed function of some keys
    .Improved 'Pause'( After long pause, sync will be incorrect ).
    
10. Compilation
---------------
  If you prepare all development environment, you should modify some settings.
  First, you should modify the following three variable in 'config.mak'. They 
have to point top level directory of your source tree. The following is mine.

    SRC_PATH="/lang/work/kmp/kmp-test"
    SRC_PATH_BARE=/lang/work/kmp/kmp-test
    BUILD_ROOT="/lang/work/kmp/kmp-test"

  Second, if you want to compile FFplay, you need SDL library. After 
installing this library, modify the following two variables. The following is 
mine( I renamed SDL12.lib to SDL.lib ).

    SDL_LIBS=-L/usr/lib -lSDL     #where SDL.lib is
    SDL_CFLAGS=-I/usr/include/SDL #where SDL header files are
    
  gcc have conflictions with SDL header files. You can be refered to the 
following site to solve them.

    http://www.virtualbox.org/wiki/OS/2%20build%20instructions      

  If you don't want FFplay, you can remove ffplay related stuff of Makefile.
  
  Finally, you should modify C_INCLUDE_PATH, CPLUS_INCLUDE_PATH, LIBRARY_PATH 
for OS/2 ToolKit v4.5.

  Now, run 'make'.

11. Modules
-------------

  kmp.exe : 'K Movie Player' executable file.
  
12. Contacts
------------

  e-mail : komh@chollian.net
  ICQ    : 124861818
  MSN    : komh@chollian.net
  IRC    : lvzuufx, #os2 at HANIRC(irc.hanirc.org)
               
                                                       KO Myung-Hun
               
