diff options
author | Chuanbo Weng <chuanbo.weng@intel.com> | 2015-02-02 14:47:31 +0800 |
---|---|---|
committer | Zhigang Gong <zhigang.gong@intel.com> | 2015-02-06 14:17:41 +0800 |
commit | 0d2b10c40766d5a7638c6311f904aec0d60869ad (patch) | |
tree | d598b2b77e783507d844b949bdda727007d70b93 /docs | |
parent | 85cc6e5c50873722e29b2df2682795afba7b7ca4 (diff) | |
download | beignet-0d2b10c40766d5a7638c6311f904aec0d60869ad.tar.gz |
Add document to describe the detials of libva buffer sharing.
This document includes the steps of using libva buffer sharing and
the way to build and run corresponding example.
Signed-off-by: Chuanbo Weng <chuanbo.weng@intel.com>
Reviewed-by: "Guo, Yejun" <yejun.guo@intel.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Beignet.mdwn | 1 | ||||
-rw-r--r-- | docs/howto/libva-buffer-sharing-howto.mdwn | 67 |
2 files changed, 68 insertions, 0 deletions
diff --git a/docs/Beignet.mdwn b/docs/Beignet.mdwn index 8132c36f..fccbac0a 100644 --- a/docs/Beignet.mdwn +++ b/docs/Beignet.mdwn @@ -239,6 +239,7 @@ Documents for OpenCL application developers - [[Cross compile|Beignet/howto/cross-compiler-howto]] - [[Work with old system without c++11|Beignet/howto/oldgcc-howto]] - [[Kernel Optimization Guide|Beignet/optimization-guide]] +- [[Libva Buffer Sharing|Beignet/howto/libva-buffer-sharing-howto]] The wiki URL is as below: [http://www.freedesktop.org/wiki/Software/Beignet/](http://www.freedesktop.org/wiki/Software/Beignet/) diff --git a/docs/howto/libva-buffer-sharing-howto.mdwn b/docs/howto/libva-buffer-sharing-howto.mdwn new file mode 100644 index 00000000..fe64d73a --- /dev/null +++ b/docs/howto/libva-buffer-sharing-howto.mdwn @@ -0,0 +1,67 @@ +Libva Buffer Sharing HowTo +========================== + +Beignet has extensions (clCreateBufferFromLibvaIntel/clCreateImageFromLibvaIntel) +to share gpu buffer object with libva. So users can utilize OpenCL to do processing +on VASurface or VABuffer without buffer copy. + +Prerequisite +------------ + +Libva api version >= 0.36.0. Please check your libva api version by command +`pkg-config --modversion libva`. + +Steps +----- + +In order to use the extension clCreateBufferFromLibvaIntel/clCreateImageFromLibvaIntel +in your program, please follow the steps as below (We have added an example of using +clCreateImageFromLibvaIntel, please read next section for details): + +- Get the address of this extension by the function: + clGetExtensionFunctionAddress("clCreateBufferFromLibvaIntel") + or clGetExtensionFunctionAddress("clCreateImageFromLibvaIntel") + +- Invoke vaAcquireBufferHandle to get VASurface/VABuffer's handle, which you want + to do processing by OpenCL. + +- Use clCreateBufferFromLibvaIntel/clCreateImageFromLibvaIntel to create corresponding + cl memory object from VASurface/VABuffer's handle. If you create a normal VASurface, + you should use clCreateImageFromLibvaIntel to create a cl image object from VASurface, + because VASurface is a tiling gpu buffer object. The only case you should use + clCreateBufferFromLibvaIntel to create a cl buffer object from VASurface is that: The + VASurface is created from an external untiling gpu buffer object. And You should use + clCreateBufferFromLibvaIntel to create a cl buffer object from VABuffer. + +- Use OpenCL to do post-processing. + +- Release this cl buffer object by clReleaseMemObject. + +- Unlock this VABuffer by vaReleaseBufferHandle. + +Sample code +----------- + +We have developed an example of using clCreateImageFromLibvaIntel in examples/libva_buffer_sharing +directory. This example read a source nv12 file to a VASurface, and create a target VASurface. +Then create corresponding cl image objects from them. After using ocl to do a mirror effect +post-processing on this source surface, target VASurface is shown on screen by default. + +- Add option -DBUILD_EXAMPLES=ON to enable building examples when running cmake, such as: + `> mkdir build` + `> cd build` + `> cmake -DBUILD_EXAMPLES=ON ../` + +- Build source code: + `> make` + +- Run: + `> cd examples` + `> . ../utests/setenv.sh` + `> ./example-libva_buffer_sharing` + +In addition, you can choose to save the result as a nv12 file. You can use gst-launch-1.0 to see +the result. Just install gstreamer1.0-plugins-base, gstreamer1.0-plugins-bad and +gstreamer1.0-x by apt on Ubuntu. Then running the following command: + `> gst-launch-1.0 filesrc location=file_name ! videoparse format=nv12 width=xxx height=xxx \ + ! imagefreeze ! videoconvert ! video/x-raw, format=BGRx ! ximagesink` |