change from OMX.ffmpeg.vheuristic.decoder to OMX.ffmpeg.vtrial.decoder and

[android-x86/external-stagefright-plugins.git] / README

diff --git a/README b/README
index 14631b3..1523c5c 100644 (file)
--- a/README
+++ b/README
@@ -5,15 +5,11 @@ Stagefright Plugins for Android
 1. Enhance the Android multimedia framework providing additional Plugins for
    user interaction
 2. FFmpeg provides demuxers and av codecs;
-3. SDL provides basic library: thread, mutex, and timer, but all of sdl should 
-   be removed;
-4. NamExtractor is a extractor plugin, it would be loaded by Stagefright when 
-   Stagefright started.
-5. NamExtractor will load FFmpegExtractor, MplayerExtractor and VLCExtractor.
-   but only FFmpegExtractor is implemented now.
-6. FFmpegExtractor is the reference to "ffmpeg/ffplay" to achieve. 
-7. libstagefright_soft_ffmpegvdec plugin is video decoder
-8. libstagefright_soft_ffmpegadec plugin is audio decoder[TODO]
+3. NamExtractor is a extractor plugin, it would be loaded by Stagefright when 
+   Stagefright started. NamExtractor will load FFmpegExtractor.FFmpegExtractor
+   is the reference to "ffmpeg/ffplay" to achieve. 
+4. libstagefright_soft_ffmpegvdec plugin is video decoder
+5. libstagefright_soft_ffmpegadec plugin is audio decoder
 
 ================================================================================
 Why is named nam[NamExtractor]?
@@ -32,14 +28,12 @@ Requirements
 CyanogenMod 9.x (Ice Cream Sandwich)
 http://wiki.cyanogenmod.com/wiki/Galaxy_Nexus_(GSM):_Compile_CyanogenMod_(Linux)
 
-FFMPEG-0.11.1
-git://android.git.linaro.org/platform/external/ffmpeg.git
-
-SDL-1.3.0
-git@github.com:omxcodec/android_external_sdl.git
+FFMPEG-1.0 release
+http://ffmpeg.org
+ref: git://android.git.linaro.org/platform/external/ffmpeg.git
 
 ================================================================================
- How to build
+How to build
 ================================================================================
 
 1. Get the Source
@@ -52,9 +46,7 @@ git@github.com:omxcodec/android_external_sdl.git
    stagefright-plugins:
        git clone git@github.com:omxcodec/stagefright-plugins.git stagefright-plugins
    ffmpeg:
-       git clone git@github.com:omxcodec/android_external_ffmpeg.git ffmpeg -b linaro-0.11.1
-   sdl:
-       git clone git@github.com:omxcodec/android_external_sdl.git sdl
+       git clone git@github.com:omxcodec/android_external_ffmpeg.git ffmpeg -b omxcodec-1.0
 
    in your "android/external" folder, run:
    cp stagefright-plugins/repo/local_manifest.xml ../.repo
@@ -75,14 +67,11 @@ git@github.com:omxcodec/android_external_sdl.git
            endif
 
    ffmpeg:
-   cd android/external/ffmpeg
-   mm ffmpeg  // NOT "mm", plz FIXME!
-
-   cd android/external/sdl
-   mm
+       cd android/external/ffmpeg
+       mm ffmpeg  // NOT "mm", plz FIXME!
 
-   cd android/external/stagefright-plugins
-   mm
+       cd android/external/stagefright-plugins
+       mm
 
 3. Install
    adb root
@@ -106,19 +95,54 @@ git@github.com:omxcodec/android_external_sdl.git
        cd android/external/stagefright-plugins/tools folder, run:
        adb root
        ./install // install my scripts
-       adb root && adb shell set-vdec-sw1 // let omxcode choose software decoder
+       adb root && adb shell set-vdec-sw1 // let omxcodec choose software decoder
        adb shell am start -a android.intent.action.VIEW -d file:///mnt/sdcard/Movies/apple-ipad-this_good-us-20120307_848x480.mov -t video/*
        adb shell am start -a android.intent.action.VIEW -d file:///mnt/sdcard/Movies/apple-ipad-feature-us-20120307_848x480.mp4 -t video/*
 
    run it and enjoy!
 
 ================================================================================
- Known issues
+Features
+================================================================================
+Input formats:
+    MP4 / MOV / 3GP
+    TS / PS
+    AVI
+    ASF / WMV / WMA
+    Matroska (MKV)
+    Real(RM,RMVB)
+    WAV
+    FLV(H.264+AAC)
+
+Video formats:
+    MPEG-1/2
+    MPEG-4
+    H.263
+    H.264 / MPEG-4 AVC
+    WMV 1/2
+    WMV 3 / WMV-9 / VC-1
+    Real Video
+
+Audio formats:
+    MPEG Layer 1/2
+    MP3 - MPEG Layer 3
+    AAC - MPEG-4 part3
+    AC3 - A/52 (Dolby Digital)
+    WMA 1/2
+    WMA 3
+    Real Audio
+    AMR (3GPP)
+    APE
+    DTS
+    FLAC
+    
 ================================================================================
-1. audio codec to be integrated
-2. some media file do not have h263 extradata(FFmpegExtractor)
-3. some .mov movies do not av resync when seeking
+Known issues
+================================================================================
+1. some .mov movies do not av resync when seeking
+2. some video stream ended while seeking
+3. more video and audio codecs codec to be integrated
+4. more formats to be integrated
 
 If you need help with the library, or just want to discuss nam related issues, 
 you can contact me: Michael Chen (omxcodec@gmail.com)
-