aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbuddy.liong2014-03-20 15:33:55 -0500
committerPradeep Venkatasubbarao2014-03-25 23:10:00 -0500
commite3cdd16151a180079775acb16c649b6570284076 (patch)
tree873c5524d170e064d9a7f0c16b5787c9cde44667
parent52068e53c7eee945b060496aa308bd0f3e9e0524 (diff)
downloadrepo-libdce-e3cdd16151a180079775acb16c649b6570284076.tar.gz
repo-libdce-e3cdd16151a180079775acb16c649b6570284076.tar.xz
repo-libdce-e3cdd16151a180079775acb16c649b6570284076.zip
Updating README3.00.04.01
The command to build libdce on QNX requires additional information. Instead of "make clean" and "make install", due to the renaming of Makefile to Makefile.qnx, the command becomes "make -f Makefile.qnx clean" and "make -f Makefile.qnx install". Updates the "Supported API Information" to point to the header files instead of listed it again here. Change-Id: Ied47d812eb8b0a6c9a9bb0cace3f6241f91d7325 Signed-off-by: buddy.liong <buddy.budiono@ti.com>
-rw-r--r--README94
1 files changed, 6 insertions, 88 deletions
diff --git a/README b/README
index 515606f..84c2882 100644
--- a/README
+++ b/README
@@ -1,13 +1,13 @@
1****************************** LIBDCE README ****************************** 1****************************** LIBDCE README ******************************
2 2
3The libDCE component provides an interface for applications running on the 3The LIBDCE component provides an interface for applications running on the
4MPU (HLOS) to invoke the Codec Engine APIs on the remote core (IPU). It 4MPU (HLOS) to invoke the Codec Engine APIs on the remote core (IPU). It
5enables the Video Encode/Decode Usecases. Apart from the exposed CE APIs, 5enables the Video Encode/Decode Usecases. Apart from the exposed CE APIs,
6it provides a memplugin utility to allocate memory that can be read/written 6it provides a memplugin utility to allocate memory that can be read/written
7from the remote IPU core. 7from the remote IPU core.
8 8
9This ReadMe file comprises: 9This ReadMe file comprises:
101. LibDCE Build Information 101. LIBDCE Build Information
11 a. For QNX 11 a. For QNX
12 b. For Linux 12 b. For Linux
13 c. For Android 13 c. For Android
@@ -62,10 +62,10 @@ $(IPCHEADERS)/usr/include/ti/shmemallocator
62$(IPCHEADERS)/usr/include/ 62$(IPCHEADERS)/usr/include/
63 63
64Building: 64Building:
65make install 65make -f Makefile.qnx install
66 66
67Clean: 67Clean:
68make clean 68make -f Makefile.qnx clean
69 69
70Location of Binaries: 70Location of Binaries:
71INSTALL_ROOT/armle-v7/usr/lib/libdce.so 71INSTALL_ROOT/armle-v7/usr/lib/libdce.so
@@ -319,94 +319,12 @@ Void Engine_close(Engine_Handle engine)
319 319
320############################ libDCE APIs ############################ 320############################ libDCE APIs ############################
321 321
322/*==================================================================*/ 322See libdce.h
323/** dce_alloc : Allocate the Data structures passed to
324 * codec-engine APIs except Input/Output buffers.
325 * @ param sz [in] : Size of memory to be allocated.
326 * @ return : Pointer to allocated memory.
327 */
328void *dce_alloc(int sz)
329
330
331/*==================================================================*/
332/** dce_free : Free the Data structures passed to codec-engine APIs
333 * allocated through the dce_alloc() API.
334 * @ param ptr [in] : Pointer to allocated memory.
335 */
336void dce_free(void *ptr)
337
338
339/*================ The below APIs are LINUX specifc ================*/
340/*==================================================================*/
341/** dce_init : Initialize DCE. Only Linux applications
342 * should call this API.
343 * @ return : Pointer to omap_device structure.
344 */
345void *dce_init(void)
346
347
348/*===============================================================*/
349/** dce_deinit : Deinitialize DCE. Only Linux applications
350 * should call this API.
351 * @ param dev [in] : Pointer to omap_device structure.
352 */
353void dce_deinit(void *dev)
354
355
356/*===============================================================*/
357/** dce_buf_lock : Pin or lock Tiler Buffers which would be
358 * used by the codec as reference buffers.
359 * Only Linux applications should call this API.
360 * @ param num [in] : Number of buffers to be locked.
361 * @ param handle [in] : Pointer to array of DMA Buf FDs of the
362 * buffers to be locked.
363 * @ return : DCE error status is returned.
364 * #DCE_EOK [0] : Success.
365 * #DCE_EOUT_OF_MEMORY [-2] : Out of Shared/Tiler Memory.
366 * #DCE_EIPC_CALL_FAIL [-5] : MmRpc Call failed.
367 * #DCE_EINVALID_INPUT [-6] : Invalid Inputs.
368 */
369int dce_buf_lock(int num, size_t *handle)
370
371
372/*===============================================================*/
373/** dce_buf_unlock : Unpin or unlock Tiler Buffers which were
374 * locked to be used by the codec as
375 * reference buffers. Only Linux
376 * applications should call this API.
377 * @ param num [in] : Number of buffers to be unlocked.
378 * @ param handle [in] : Pointer to array of DMA Buf FDs of
379 * the buffers to be unlocked.
380 * @ return : DCE error status is returned.
381 * #DCE_EOK [0] : Success.
382 * #DCE_EXDM_FAIL [-1] : XDM Failure.
383 * #DCE_EOUT_OF_MEMORY [-2] : Out of Shared/Tiler Memory.
384 * #DCE_EXDM_UNSUPPORTED [-3] : Unsupported XDM request.
385 * #DCE_EIPC_CALL_FAIL [-5] : MmRpc Call failed.
386 * #DCE_EINVALID_INPUT [-6] : Invalid Inputs.
387 */
388int dce_buf_unlock(int num, size_t *handle)
389
390
391/*===============================================================*/
392/** dce_get_fd : Get OMAP DRM File Descriptor. Only Linux
393 * applications should call this API.
394 * @ return : OMAP DRM File Descriptor.
395 */
396int dce_get_fd()
397
398
399/*===============================================================*/
400/** dce_set_fd : Set OMAP DRM File Descriptor. Only Linux
401 * applications should call this API.
402 * @ param fd [in] : OMAP DRM File Descriptor.
403 */
404void dce_set_fd(int fd)
405 323
406 324
407******************************* API call flow ****************************** 325******************************* API call flow ******************************
408 326
409// For a Decoder Application 327// For example of a Decoder Application - using CE video3 interfaces to IPU (IVA-HD)
410If (BUILDOS_LINUX) { 328If (BUILDOS_LINUX) {
411 dev = dce_init() 329 dev = dce_init()
412} 330}