Fujitsu DTV/STB solution driver (FAPex driver) Documentation [V01L00R00]


fapex/abst_libaudec.h File Reference

abstraction library header file (Audio Decoder driver) More...

Data Structures

struct  FAPEX_AUDEC_OpenParamStrT
 open parameters for the AUDEC driver More...
struct  FAPEX_AUDEC_OutputParamStrT
 output parameters for the AUDEC driver More...
struct  FAPEX_AUDEC_CodecSpecificParamStrT
 codec specific information for the AUDEC driver More...
struct  FAPEX_AUDEC_CapabilitiesParamStrT
 decoder capabilities for the AUDEC driver More...
struct  FAPEX_AUDEC_StatusStrT
 decoder status information for the AUDEC driver More...

Defines

#define FAPEX_AUDEC_ERR_BASE   (FAPEX_AUDEC_MODULE_BASE + FAPEX_RET_ERR_BASE)
#define FAPEX_AUDEC_ERR_BAD_PARAMETER   (FAPEX_AUDEC_ERR_BASE + FAPEX_ERR_BAD_PARAMETER)
#define FAPEX_AUDEC_ERR_OUT_OF_MEMORY   (FAPEX_AUDEC_ERR_BASE + FAPEX_ERR_OUT_OF_MEMORY)
#define FAPEX_AUDEC_ERR_INVALID_STATUS   (FAPEX_AUDEC_ERR_BASE + FAPEX_ERR_INVALID_HANDLE)
#define FAPEX_AUDEC_ERR_SEMAPHORE_CREATE   (FAPEX_AUDEC_ERR_BASE + FAPEX_ERR_SEMAPHORE_CREATE)
#define FAPEX_AUDEC_CODEC_TYPE_UNDEF   (-1)
 Audio decoder undefined.
#define FAPEX_AUDEC_CODEC_TYPE_AC3   (0)
 Dolby Digital 5.1(AC-3) audio decoder.
#define FAPEX_AUDEC_CODEC_TYPE_AC3SPDIF   (1)
 Dolby Digital 5.1(AC-3) to SPDIF copier/synchronizer.
#define FAPEX_AUDEC_CODEC_TYPE_DD   (2)
 Dolby Digital 5.1(AC-3) audio decoder.
#define FAPEX_AUDEC_CODEC_TYPE_DDPDCV   (3)
 Dolby Digital Plus 5.1(E-/AC-3) decoder/converter.
#define FAPEX_AUDEC_CODEC_TYPE_HEAAC   (4)
 HE-AAC 5.1 audio decoder.
#define FAPEX_AUDEC_CODEC_TYPE_MPEG   (5)
 MPEG audio decoder.
#define FAPEX_AUDEC_CODEC_TYPE_PCMOUTPUT   (6)
 PCM/WAV Copier.
#define FAPEX_AUDEC_CODEC_TYPE_WMA   (7)
 WMA audio decoder.
#define FAPEX_AUDEC_FIRM_STATUS_RUNNING   0
 Decoder is normally running.
#define FAPEX_AUDEC_FIRM_STATUS_IDLE   1
 Decoder is waiting for start (after Open or Stop).
#define FAPEX_AUDEC_FIRM_STATUS_WAIT_INPUT   2
 Decoder gets no more input data.
#define FAPEX_AUDEC_FIRM_STATUS_WAIT_OUTPUT   3
 Decoder cannot write to audio output.
#define FAPEX_AUDEC_FIRM_STATUS_ABORT   4
 Decoder aborted due to fatal error.
#define FAPEX_AUDEC_FIRM_STATUS_NOT_RESPOND   5
 Decoder doesn't respond at all (maybe hanging).
#define FAPEX_AUDEC_FIRM_STATUS_RETRY   6
 Decoder is retrying to decode after errors.
#define FAPEX_IOCCOM_AUDEC_OPEN   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_AUDEC + 0, FAPEX_AUDEC_OpenParamStrT)
 ioctl specific command for the AUDEC driver
#define FAPEX_IOCCOM_AUDEC_GET_STATUS   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_AUDEC + 1, FAPEX_AUDEC_StatusStrT)
#define FAPEX_IOCCOM_AUDEC_SET_OUTPUT   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_AUDEC + 2, FAPEX_AUDEC_OutputParamStrT)
#define FAPEX_IOCCOM_AUDEC_SET_CODEC_PARAMS   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_AUDEC + 3, FAPEX_AUDEC_CodecSpecificParamStrT)
#define FAPEX_IOCCOM_AUDEC_GET_CAPABILITIES   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_AUDEC + 4, FAPEX_AUDEC_CapabilitiesParamStrT)
#define FAPEX_IOCCOM_AUDEC_SET_OUTPUT_DELAY   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_AUDEC + 5, uint32_t)

Functions

FAPEXOPENRET_T FAPEX_AUDEC_Open (FAPEXOPENARG1_T id, FAPEXOPENARG2_T flags, FAPEXOPENARG3_T argptr)
 open method. This function is called with the systemcall "open".
FAPEXRELRET_T FAPEX_AUDEC_Close (FAPEXRELARG1_T id)
 release method. This function is called with the systemcall "close".
FAPEXIOCRET_T FAPEX_AUDEC_Ioctl (FAPEXIOCARG1_T id, FAPEXIOCARG2_T cmd, FAPEXIOCARG3_T pArg)
 ioctl method. This function is called with the systemcall "ioctl".

Detailed Description

abstraction library header file (Audio Decoder driver)

Attention:
This program is provided as is. You can redistribute it and/or modify it. Fujitsu Semiconductor Limited accepts no responsibility or liability for any errors or omissions.

Copyright (C) 2008-2010 Fujitsu Semiconductor Limited, All Rights Reserved.


Define Documentation

#define FAPEX_AUDEC_ERR_BASE   (FAPEX_AUDEC_MODULE_BASE + FAPEX_RET_ERR_BASE)

FAPex AUDEC error code base value

#define FAPEX_AUDEC_ERR_BAD_PARAMETER   (FAPEX_AUDEC_ERR_BASE + FAPEX_ERR_BAD_PARAMETER)

Bad parameter passed.

#define FAPEX_AUDEC_ERR_OUT_OF_MEMORY   (FAPEX_AUDEC_ERR_BASE + FAPEX_ERR_OUT_OF_MEMORY)

Memory allocation failed.

#define FAPEX_AUDEC_ERR_INVALID_STATUS   (FAPEX_AUDEC_ERR_BASE + FAPEX_ERR_INVALID_HANDLE)

Invalid status.

#define FAPEX_AUDEC_ERR_SEMAPHORE_CREATE   (FAPEX_AUDEC_ERR_BASE + FAPEX_ERR_SEMAPHORE_CREATE)

Semaphore could not be created.

#define FAPEX_AUDEC_CODEC_TYPE_UNDEF   (-1)

Audio decoder undefined.

#define FAPEX_AUDEC_CODEC_TYPE_AC3   (0)

Dolby Digital 5.1(AC-3) audio decoder.

#define FAPEX_AUDEC_CODEC_TYPE_AC3SPDIF   (1)

Dolby Digital 5.1(AC-3) to SPDIF copier/synchronizer.

#define FAPEX_AUDEC_CODEC_TYPE_DD   (2)

Dolby Digital 5.1(AC-3) audio decoder.

#define FAPEX_AUDEC_CODEC_TYPE_DDPDCV   (3)

Dolby Digital Plus 5.1(E-/AC-3) decoder/converter.

#define FAPEX_AUDEC_CODEC_TYPE_HEAAC   (4)

HE-AAC 5.1 audio decoder.

#define FAPEX_AUDEC_CODEC_TYPE_MPEG   (5)

MPEG audio decoder.

#define FAPEX_AUDEC_CODEC_TYPE_PCMOUTPUT   (6)

PCM/WAV Copier.

#define FAPEX_AUDEC_CODEC_TYPE_WMA   (7)

WMA audio decoder.

#define FAPEX_AUDEC_FIRM_STATUS_RUNNING   0

Decoder is normally running.

#define FAPEX_AUDEC_FIRM_STATUS_IDLE   1

Decoder is waiting for start (after Open or Stop).

#define FAPEX_AUDEC_FIRM_STATUS_WAIT_INPUT   2

Decoder gets no more input data.

#define FAPEX_AUDEC_FIRM_STATUS_WAIT_OUTPUT   3

Decoder cannot write to audio output.

#define FAPEX_AUDEC_FIRM_STATUS_ABORT   4

Decoder aborted due to fatal error.

#define FAPEX_AUDEC_FIRM_STATUS_NOT_RESPOND   5

Decoder doesn't respond at all (maybe hanging).

#define FAPEX_AUDEC_FIRM_STATUS_RETRY   6

Decoder is retrying to decode after errors.

#define FAPEX_IOCCOM_AUDEC_OPEN   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_AUDEC + 0, FAPEX_AUDEC_OpenParamStrT)

ioctl specific command for the AUDEC driver

#define FAPEX_IOCCOM_AUDEC_GET_STATUS   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_AUDEC + 1, FAPEX_AUDEC_StatusStrT)
#define FAPEX_IOCCOM_AUDEC_SET_OUTPUT   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_AUDEC + 2, FAPEX_AUDEC_OutputParamStrT)
#define FAPEX_IOCCOM_AUDEC_SET_CODEC_PARAMS   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_AUDEC + 3, FAPEX_AUDEC_CodecSpecificParamStrT)
#define FAPEX_IOCCOM_AUDEC_GET_CAPABILITIES   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_AUDEC + 4, FAPEX_AUDEC_CapabilitiesParamStrT)
#define FAPEX_IOCCOM_AUDEC_SET_OUTPUT_DELAY   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_AUDEC + 5, uint32_t)

Function Documentation

FAPEXOPENRET_T FAPEX_AUDEC_Open ( FAPEXOPENARG1_T  id,
FAPEXOPENARG2_T  flags,
FAPEXOPENARG3_T  argptr 
)

open method. This function is called with the systemcall "open".

Parameters:
idThe device identifier.
flagsThis parameter indicate a open mode (read only/write only/read-write).
This implementation supports only read-write mode.
argptrargument pointer (FAPEX_AUDEC_OpenParamStrT)
If descriptor for this 'id' has already been opened, this 'argptr' will be invalid.
Return values:
>=0process OK, new file descriptor is returned.
<0process fails, its value is set to errno.
FAPEXRELRET_T FAPEX_AUDEC_Close ( FAPEXRELARG1_T  id )

release method. This function is called with the systemcall "close".

Parameters:
idThe identifier for this descriptor.
Return values:
0process OK
<0process fails, its value is set to errno.
FAPEXIOCRET_T FAPEX_AUDEC_Ioctl ( FAPEXIOCARG1_T  id,
FAPEXIOCARG2_T  cmd,
FAPEXIOCARG3_T  pArg 
)

ioctl method. This function is called with the systemcall "ioctl".

Parameters:
idThe identifier for this descriptor.
cmdThe ioctl command.
pArgThe pointer to the argument of the ioctl command.
Return values:
0process OK
<0process fails, its value is set to errno.

ioctl command(cmd) type:

  • FAPEX_IOCCOM_AUDEC_SET_OUTPUT_DELAY
    set the delay for audio presentation.
    Set value of delay in milliseconds to pArg.


Copyright © 2006-2010 by Fujitsu Semiconductor Europe GmbH
Copyright © 2008-2010 by Fujitsu Semiconductor Limited

Disclaimer:
Please note that the use of this has been based on the terms and conditions of "DK Consent Letter (For Linux)" agreement between you and Fujitsu Semiconductor Limited.
The contents of this document may be revised without prior notice. Contact our sales department for confirmation. The information in this document are presented as is, no license is granted by implication or otherwise.
More...

FUJITSU sales representatives