Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wang-bin committed May 28, 2013
1 parent 1edc646 commit 2599aa1
Showing 1 changed file with 16 additions and 15 deletions.
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 1,7 @@
# [QtAV](https://sourceforge.net/projects/qtav)

QtAV is a media playing library based on Qt and FFmpeg. It can help you to write a player
with less effort than ever before. Currently only a simple player is supplied. I will write a
stylish one based on QtAV in the feature.
with less effort than ever before.

QtAV has been added to FFmpeg projects page [http://ffmpeg.org/projects.html](http://ffmpeg.org/projects.html)

Expand All @@ -26,11 25,12 @@ QtAV can meet your most demands
- Playing music (not perfect)
- Volume control
- Fullscreen, stay on top
- Compatible: QtAV can be built with both Qt4 and Qt5. QtAV will support
both FFmpeg and [Libav](http://libav.org).
- Compatiblity: QtAV can be built with both Qt4 and Qt5. QtAV supports
both FFmpeg(>=0.9) and [Libav](http://libav.org).
- Multiple render engine support. Currently supports QPainter, GDI , Direct2D, XV and OpenGL.
- Dynamically change render engine when playing.

### Extensible Framework (not finished)
### Extensible Framework (work in progress)

QtAV currently uses FFmpeg to decode video, convert image and audio data, and uses PortAudio to play
sound. Every part in QtAV is designed to be extensible. For example, you can write your audio output
Expand All @@ -42,7 42,7 @@ QtAV can meet your most demands

#### Requirements

1. [FFmpeg](http://ffmpeg.org) Latest version is recommanded.
1. [FFmpeg](http://ffmpeg.org) (>=0.9)Latest version is recommanded.
[![FFmpeg](http://ffmpeg.org/ffmpeg-logo.png)](http://ffmpeg.org)
2. [Qt 4 or 5](http://qt-project.org/downloads)
[![Qt](http://blog.qt.digia.com/wp-content/themes/qt_blog/images/Qt_master_logo_CMYK_noback.gif)](http://qt-project.org)
Expand All @@ -62,11 62,11 @@ Here is a brief guide:
It's recommend not to build in source dir.

cd your_build_dir
qmake QtAV_source_dir/QtAV.pro
qmake QtAV_project_dir/QtAV.pro
make

qmake will run check the required libraries at the first time, so you must make sure those libraries can be found by compiler.
Then qmake will create a cache file _.qmake.cache_ in your build dir. Cache file stores the check results, for example, whether portaudio is available. If you want to recheck, delete _**.qmake.cache**_ and run qmake again
Then qmake will create a cache file _.qmake.cache_ in your build dir. Cache file stores the check results, for example, whether portaudio is available. If you want to recheck, run `qmake QtAV_project_dir/QtAV.pro -config recheck`

_WARNING_: If you are in windows mingw with sh.exe environment, you may need run qmake twice.

Expand All @@ -82,7 82,7 @@ Wrtie a media player using QtAV is quite easy.
player.setRenderer(&renderer);
player.play("test.avi");

For more detail to using QtAV, see the wiki [Use QtAV In Your Project](https://github.com/wang-bin/QtAV/wiki/Use-QtAV-In-Your-Project)
For more detail to using QtAV, see the wiki [Use QtAV In Your Project](https://github.com/wang-bin/QtAV/wiki/Use-QtAV-In-Your-Project) or examples.


For End Users
Expand All @@ -92,7 92,7 @@ For End Users

An simple player can be found in examples. The command line options is

player [-vo qt|gl|d2d|gdi|xv] [url/path]filename
player [-vo qt|gl|d2d|gdi|xv] [url/path]

You can choose a paint engine with _-vo_ option. For example, in windows that support Direct2D, you can run

Expand All @@ -102,6 102,7 @@ The default is Qt's paint engine.

#### Default Shortcuts

- Double click: fullscreen switch
- Ctrl O: open a file
- Space: pause/continue
- F: fullscreen on/off
Expand Down Expand Up @@ -129,20 130,20 @@ The default behavior can be replaced by subclassing QObject and call `void AVPla
3. Hardware acceleration using DirectX, NVIDIA Cuda, ATI UVD, Intel IPP, OpenCL and OpenGL:
* decoding: DXVA, XvBA, cuvid
* image, audio and filters
* rendering: DirectX, XV, OpenGL
* rendering: DirectX, OpenGL ES
4. Stylish GUI based on Qt Graphics View Framework
5. Document and SDK
6. Other: play speed, better sync method and seeking, tests, playing statistics, etc.
7. Region of interest support.
8. More platform support. Maemo, Android, iOS, BB10 etc. Depends on Qt and FFmpeg for those platforms.
9. Try to write decoders myself.
8. More platform support. Maemo, Android, iOS, BB10 etc. Depends on Qt and FFmpeg for those platforms.
9. ppa, debian package etc.

Screenshots
----------

QtAV on Win8

![Alt text](https://github.com/downloads/wang-bin/QtAV/screenshot.png "simple player")
![Alt text](https://sourceforge.net/p/qtav/screenshot/win8.png "simple player")

QtAV on Mac OS X

Expand All @@ -165,4 166,4 @@ Video Wall
> Shanghai University, Shanghai, China
> 2013-01-21
> 2013-01-21

0 comments on commit 2599aa1

Please sign in to comment.