                           K Movie Player v0.4.1
                          -----------------------
                            
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 CSD 3
  
  - OS/2 ToolKit v4.5
  
  - OS2UNIX environment ( GNU Make v3.81r2, cp, rm, ... )

  - lxlite v1.3.3 ( for strip of debugging infos )
  
  - SubVersion v1.4.4( to merge with latest FFMpeg sources )

3. Requirement
---------------------

  - Audio : DART

  - Video : SNAP/WarpOverlay!/DIVE

  - RunTime : kLIBC v0.6.3
  
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. If you want to use SNAP overlay, you need 
snapwrap.dll as well. Put it with kmp.exe or on a directory in LIBPATH.
  
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
+/-                 grow up/down font size
Alt-0/1/2/3         set aspec ratio none/original/force43/force169 respectively
8/9                 brightness down/up by 5 level(only for wo)
i/o                 contrast down/up by 5 level(only for wo)
k/l                 saturation down/up by 5 level(only for wo)
,/.                 hue down/up by 5 level(only for wo)
/                   reset attributes(b/c/s/h) to default value(only for wo)
[/]                 correct subtitle sync -/+ 0.5 seconds

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

6.2.1 Main options
------------------
-h                  show help
-video driver       set video driver (driver=auto/wo/snap/dive)
-x width            force displayed width
-y height           force displayed height
-s size             set frame size (WxH or abbreviation)
-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
-subfont xx.name    set subtitle font name and size (xx=size, name=font name)
-osdfont xx.name    set OSD font name and size (xx=size, name=font name)
-aspect ratio       set aspect ratio (ratio=none, original, force43, force169)
-framedrop          frame drop if necessary
-hidemouse          hide mouse pointer on full screen mode
-brightness level   set brightness level, except dive (level=0..255)
-contrast level     set contrast level, except dive (level=0..255)
-saturation level   set saturation level, except dive (level=0..255)
-hue level          set hue level, except dive (level=0..255)
-res48              resample 48KHz audio to 44.1KHz(experimental)
-subimg             display subtitles/OSD to image
-subcolor f,o,s     set subtitle color in hexa RGB(font, outline, shadow) *
-osdcolor f,o,s     set OSD color in hexa RGB(font, outline, shadow) *

* Default values are f=FFFFFF, o=010101, s=010101. But, in case of 15/16 bits 
  colors mode, o=0F0F0F, s=0F0F0F are recommended.

6.2.2 Advanced options
----------------------
-ast
-vst
-pix_fmt format     set pixel format
-stats              show status
-debug              print specific debug info
-bug                workaround bugs
-vismv              visualize motion vectors
-fast               non spec compliant optimizations
-genpts             generate pts
-drp                let decoder reorder 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
-sync type          set audio-video sync. type (type=audio/video/ext)
-threads count      thread count
-fixt23             workaround diagonal stripes on T23 laptop with S3 Video
-noaudioshare       open audio as exclusive mode

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
-------------------------

  - Some movie files aren't played up to its play time or auto-closed.
  
  - On dive mode, boundary and shadow of subtitle is not displayed well. 
    GpiBitBlt() is missing a needed function. Use -subimg option.
    
  - On dive mode, subtitle/OSD is flickering. Use -subimg option.
  
  - Don't support codepage conversion of subtitle.
  
  - If there is no font with specified name and size, system default font( 
    maybe WarpSans ) is used. But in this case, you cannot adjust font size.

  - On wave mode, OSD flicker.
  
  - On pause, updating of window cause cpu load to high.
  
  - On near the end of movie, sometimes seek fails.
  
  - Non-interleaved AVI file is not supported correctly.
  
8. TODOs...
-----------

  - Support configuration file
  
  - Support sliderbar
      
9. History
----------

  - v0.4.1 ( 2007/01/24 )
    .Synchronized with FFMpeg SVN-r11604 source
    .Use thread feature
    .Support '-osdfont' option
    .Support optimized IMDCT transformation for AC3 audio
    .Print CPU type and SwScaler flag
    .Improved performance of playing YV12 movie on snap mode.
    .Changed the order of video driver auto-selection from wo > snap > dive to 
     snap > wo > dive.
    .On snap mode, attribute options do not work. Fixed.
    .On snap mode, Once restore window after minimize it, all attributes are 
     reset. Fixed.
    .On snap mode, video is not displayed other modes than 16M colors one. 
     Fixed.
    .If movie image format is not YUV420P, SwScaler print messages 
     continuously. Fixed.
    .SSE is not detected. Fixed.
    .Window is not cleared when video cannot be played. Fixed.

  - v0.4.0 ( 2007/12/29 )
    .Synchronized with FFMpeg SVN-r11313 source
    .Support SNAP overlay ( snapwrap.dll is needed, Thanks to Mike Forester )
    
  - v0.3.1 ( 2007/06/24 )
    .Switch to wave mode if no video stream
    .Support to open audio as exclusive mode
    .Support to set colors of subtitle and OSD
    .Crashed if no video stream. Fixed( Thanks to Franz Bakan for his 
     reporting )
    .On WO mode, if video card cannot downscale, image displayed incorrectly. 
     Fixed( Thanks to Franz Bakan for his reporting and testing )
    .When playing audio files, window is updated periodically even if pause 
     mode. Fixed.     
    .-fs option does not work. Fixed.
    .Crahsed when height of window is 0. Fixed.
    .On DIVE mode, colors of image are displayed incorrectly on 15/16 bits 
     colors mode. Fixed.
    .On 15/16 bits colors mode, font is not displayed clearly when using 
     -subimg. Fixed
    .On 15/16 bits colors mode, outline is not displayed. use -subcolor and 
     -osdcolor. For examples, -subcolor ,0F0F0F,0F0F0F -osdcolor ,0F0F0F,0F0F0F
    .SIGSEGV occur in osdInvalidate(). Fixed.
    .SIGSEGV occur in tbDelete(). Fixed.
    .Sometimes window size is set to 640x480 regardless of movie size. Fixed.
  
  - v0.3.0 ( 2007/05/27 )
    .Synchronized with FFmpeg 2007/05/24 sources
    .Support to display subtitle/OSD directly to image ( useful for DIVE )
    .Support AAC audio format
    .Support to resample 48KHz audio to 44.1KHz (experimental )
    .Use libswcale instead of libyuv
    .Use fastmemcpy()
    .Right side of bitmap of subtitle/OSD is truncated. Fixed.
    .When seeking, subtitle is not disappeared. Fixed.
    
  - v0.2.2 ( 2007/03/14 )
    .Sometimes floating-point arithmetic fails. Fixed.
    .When '/' is pressed, an OSD is not displayed. Fixed.
    .Changed check method for auto-close
    
  - v0.2.1 ( 2007/03/04 )
    .Improved performance when image format of codec was YUV420P
    .On puase, window is not updated. Fixed.
    .On wave mode, OSD is not displayed. Fixed.
    .On wo mode, when visible region of window is changed, flickering occur.
     Fixed.
    .Missed the contribution of Dmitry Froloff to '-hidemouse' option in 
     v0.2.0. Fixed.
    
  - v0.2.0 ( 2007/02/26 )
    .Display information using OSD instaed of TitleBar
    .Support framedrop feature
    .Support to hide mouse pointer when full-screen mode ( by Dmitry Froloff )
    .Support to control Brightness/Contrast/Saturation/Hue( only for wo )
    .Support to adjust sync of text file subtitle
    .When WarpCenter is running, even though changing to full-screen mode, 
     WarpCetner still appear. Fixed. ( by Dmitry Froloff )
    .Bitmap(Raster) font cannot be selected. Fixed.
    
  - v0.1.0 ( 2007/02/12 )
    .Auto close when finishing play back
    .Support text file subtitle( tested only on SAMI file )
    .Support to change font size on play back
    .Support to change aspect ratio on play back
    .Display information related to play back on title bar
    .Improved seek function
    .Modulized sources
    
  - 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
---------------

  First of all, you should decompress source archive to any directoy you want, 
and modify C_INCLUDE_PATH, CPLUS_INCLUDE_PATH, LIBRARY_PATH for OS/2 ToolKit 
v4.5.

  Now, run 'configure.cmd'.
  
  Then, run 'make' as the following.
  
      make SHELL=/bin/sh

  To update sources, do the following
  
      svn update
      
11. Modules
-----------

  kmp.exe      : 'K Movie Player' executable file.
  snapwrap.dll : Wrapper file to use SNAP overlay.

12. Credits
-----------

  FFplay     : Base player
  WarpVision : libdart, libsub
  MPlayer    : liba52, libfaad, libvo

13. Special Thanks To ...
-------------------------

  Dave Yeo : Contribute OS/2 patches to FFMpeg

14. Tips
--------

  KMP use morphing method to use both command and PM window. So when using 
file association, command window is always opened. To avoid this problem, you 
can do the following.

  First of all, you need MARKEXE.EXE of ToolKit 4.5. If you have it, do the 
following.

    copy kmp.exe kmppm.exe
    markexe windowapi kmppm.exe

  Or, you can use 'emxbind.exe' instead of 'markexe.exe' as the following.
  
    emxbind -e -p kmppm.exe
        
Now, you can use kmppm.exe for file association, and command window is not 
opened any more. Of course, you cannot see any infos and helps. Use this only 
for file association. ^^


15. Contacts
------------

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