vitasdk
Documentation of the vitasdk

Exports for User. More...

Data Structures

struct  SceAudioencInitStreamParam
 Initialization structure to provide to SceAudioencInitParam. More...
 
struct  SceAudioencInfoCelp
 Information structure for CELP. More...
 
struct  SceAudioencOptInfoCelp
 Optional information structure for CELP. More...
 
union  SceAudioencInitParam
 Initialization structure to pass as argument to sceAudioencInitLibrary. More...
 
union  SceAudioencInfo
 Audio encoder info. More...
 
union  SceAudioencOptInfo
 Audio encoder optional info. More...
 
struct  SceAudioencCtrl
 

Macros

#define SCE_AUDIOENC_WORD_LENGTH_16BITS   16
 Definition of wordlength.
 
#define SCE_AUDIOENC_TYPE_CELP   0x2006U
 Audio encoder type.
 
#define SCE_AUDIOENC_CELP_MAX_STREAMS   1
 Max number of streams.
 
#define SCE_AUDIOENC_CELP_MAX_SAMPLES   320
 Max number of samples.
 
#define SCE_AUDIOENC_CELP_MAX_ES_SIZE   24
 Max elementary stream size.
 
#define SCE_AUDIOENC_CELP_MPE   (0)
 CELP encoder default excitation mode.
 
#define SCE_AUDIOENC_CELP_SAMPLING_RATE_8KHZ   (8000)
 CELP encoder default sampling rate.
 

Enumerations

enum  SceAudioencErrorCode {
  SCE_AUDIOENC_ERROR_API_FAIL = 0x80860000 , SCE_AUDIOENC_ERROR_INVALID_TYPE = 0x80860001 , SCE_AUDIOENC_ERROR_INVALID_INIT_PARAM = 0x80860002 , SCE_AUDIOENC_ERROR_ALREADY_INITIALIZED = 0x80860003 ,
  SCE_AUDIOENC_ERROR_OUT_OF_MEMORY = 0x80860004 , SCE_AUDIOENC_ERROR_NOT_INITIALIZED = 0x80860005 , SCE_AUDIOENC_ERROR_A_HANDLE_IN_USE = 0x80860006 , SCE_AUDIOENC_ERROR_ALL_HANDLES_IN_USE = 0x80860007 ,
  SCE_AUDIOENC_ERROR_INVALID_PTR = 0x80860008 , SCE_AUDIOENC_ERROR_INVALID_HANDLE = 0x80860009 , SCE_AUDIOENC_ERROR_NOT_HANDLE_IN_USE = 0x8086000A , SCE_AUDIOENC_ERROR_CH_SHORTAGE = 0x8086000B ,
  SCE_AUDIOENC_ERROR_INVALID_WORD_LENGTH = 0x8086000C , SCE_AUDIOENC_ERROR_INVALID_SIZE = 0x8086000D , SCE_AUDIOENC_ERROR_INVALID_ALIGNMENT = 0x8086000E , SCE_AUDIOENC_ERROR_UNSUPPORTED = 0x8086000F
}
 
enum  SceAudioencCelpErrorCode { SCE_AUDIOENC_CELP_ERROR_INVALID_CONFIG = 0x80861001 }
 
enum  SceAudioencCelpBitrate {
  SCE_AUDIOENC_CELP_BIT_RATE_3850BPS = 3850 , SCE_AUDIOENC_CELP_BIT_RATE_4650BPS = 4650 , SCE_AUDIOENC_CELP_BIT_RATE_5700BPS = 5700 , SCE_AUDIOENC_CELP_BIT_RATE_6600BPS = 6600 ,
  SCE_AUDIOENC_CELP_BIT_RATE_7300BPS = 7300 , SCE_AUDIOENC_CELP_BIT_RATE_8700BPS = 8700 , SCE_AUDIOENC_CELP_BIT_RATE_9900BPS = 9900 , SCE_AUDIOENC_CELP_BIT_RATE_10700BPS = 10700 ,
  SCE_AUDIOENC_CELP_BIT_RATE_11800BPS = 11800 , SCE_AUDIOENC_CELP_BIT_RATE_12200BPS = 12200
}
 

Functions

 VITASDK_BUILD_ASSERT_EQ (8, SceAudioencInitStreamParam)
 
 VITASDK_BUILD_ASSERT_EQ (0x10, SceAudioencInfoCelp)
 
 VITASDK_BUILD_ASSERT_EQ (0x2C, SceAudioencOptInfoCelp)
 
 VITASDK_BUILD_ASSERT_EQ (8, SceAudioencInitParam)
 
 VITASDK_BUILD_ASSERT_EQ (0x10, SceAudioencInfo)
 
 VITASDK_BUILD_ASSERT_EQ (0x2C, SceAudioencOptInfo)
 
 VITASDK_BUILD_ASSERT_EQ (0x2C, SceAudioencCtrl)
 
int sceAudioencInitLibrary (int codecType, SceAudioencInitParam *pInitParam)
 
int sceAudioencTermLibrary (unsigned int codecType)
 
int sceAudioencCreateEncoder (SceAudioencCtrl *pCtrl, int codecType)
 
int sceAudioencDeleteEncoder (SceAudioencCtrl *pCtrl)
 
int sceAudioencEncode (SceAudioencCtrl *pCtrl)
 
int sceAudioencClearContext (SceAudioencCtrl *pCtrl)
 
int sceAudioencGetOptInfo (SceAudioencCtrl *pCtrl)
 
int sceAudioencGetInternalError (SceAudioencCtrl *pCtrl, int *pInternalError)
 

Variables

SceSize SceAudioencInitStreamParam::size
 sizeof(SceAudioencInitStreamParam)
 
unsigned int SceAudioencInitStreamParam::totalStreams
 Total number of audio streams.
 
SceSize SceAudioencInfoCelp::size
 sizeof(SceAudioencInfoCelp)
 
unsigned int SceAudioencInfoCelp::excitationMode
 Excitation mode.
 
unsigned int SceAudioencInfoCelp::samplingRate
 Sampling rate.
 
unsigned int SceAudioencInfoCelp::bitRate
 Bit rate (one of SceAudioencCelpBitrate)
 
SceSize SceAudioencOptInfoCelp::size
 sizeof(SceAudioencOptInfoCelp)
 
uint8_t SceAudioencOptInfoCelp::header [32]
 Header buffer.
 
SceSize SceAudioencOptInfoCelp::headerSize
 Header size.
 
unsigned int SceAudioencOptInfoCelp::encoderVersion
 Encoder version.
 
SceSize SceAudioencInitParam::size
 sizeof(SceAudioencInitParam)
 
SceAudioencInitStreamParam SceAudioencInitParam::celp
 See SceAudioencInitStreamParam.
 
SceSize SceAudioencInfo::size
 sizeof(SceAudioencInfo)
 
SceAudioencInfoCelp SceAudioencInfo::celp
 Information structure for CELP.
 
SceSize SceAudioencOptInfo::size
 sizeof(SceAudioencOptInfo)
 
SceAudioencOptInfoCelp SceAudioencOptInfo::celp
 Optional information structure for CELP.
 
SceSize SceAudioencCtrl::size
 sizeof(SceAudioencCtrl)
 
int SceAudioencCtrl::handle
 Encoder handle.
 
void * SceAudioencCtrl::pInputPcm
 Pointer to elementary stream.
 
SceSize SceAudioencCtrl::inputPcmSize
 Size of elementary stream used actually (in byte)
 
SceSize SceAudioencCtrl::maxPcmSize
 Max size of elementary stream used (in byte)
 
void * SceAudioencCtrl::pOutputEs
 Pointer to PCM.
 
SceSize SceAudioencCtrl::outputEsSize
 Size of PCM output actually (in byte)
 
SceSize SceAudioencCtrl::maxEsSize
 Max size of PCM output (in byte)
 
SceSize SceAudioencCtrl::wordLength
 PCM bit depth.
 
SceAudioencInfoSceAudioencCtrl::pInfo
 Pointer to SceAudioencInfo.
 
SceAudioencOptInfoSceAudioencCtrl::pOptInfo
 Pointer to SceAudioencOptInfo.
 

Detailed Description

Exports for User.


Using this library in your project

Include the header file in your project:


Link the library to the executable:

SceAudioenc_stub




Data Structure Documentation

◆ SceAudioencInitStreamParam

struct SceAudioencInitStreamParam

Initialization structure to provide to SceAudioencInitParam.

Data Fields
SceSize size sizeof(SceAudioencInitStreamParam)
unsigned int totalStreams Total number of audio streams.

◆ SceAudioencInfoCelp

struct SceAudioencInfoCelp

Information structure for CELP.

Data Fields
SceSize size sizeof(SceAudioencInfoCelp)
unsigned int excitationMode Excitation mode.
unsigned int samplingRate Sampling rate.
unsigned int bitRate Bit rate (one of SceAudioencCelpBitrate)

◆ SceAudioencOptInfoCelp

struct SceAudioencOptInfoCelp

Optional information structure for CELP.

Data Fields
SceSize size sizeof(SceAudioencOptInfoCelp)
uint8_t header[32] Header buffer.
SceSize headerSize Header size.
unsigned int encoderVersion Encoder version.

◆ SceAudioencInitParam

union SceAudioencInitParam

Initialization structure to pass as argument to sceAudioencInitLibrary.

Data Fields
SceSize size sizeof(SceAudioencInitParam)
SceAudioencInitStreamParam celp See SceAudioencInitStreamParam.

◆ SceAudioencInfo

union SceAudioencInfo

Audio encoder info.

Data Fields
SceSize size sizeof(SceAudioencInfo)
SceAudioencInfoCelp celp Information structure for CELP.

◆ SceAudioencOptInfo

union SceAudioencOptInfo

Audio encoder optional info.

Data Fields
SceSize size sizeof(SceAudioencOptInfo)
SceAudioencOptInfoCelp celp Optional information structure for CELP.

◆ SceAudioencCtrl

struct SceAudioencCtrl
Data Fields
SceSize size sizeof(SceAudioencCtrl)
int handle Encoder handle.
void * pInputPcm Pointer to elementary stream.
SceSize inputPcmSize Size of elementary stream used actually (in byte)
SceSize maxPcmSize Max size of elementary stream used (in byte)
void * pOutputEs Pointer to PCM.
SceSize outputEsSize Size of PCM output actually (in byte)
SceSize maxEsSize Max size of PCM output (in byte)
SceSize wordLength PCM bit depth.
SceAudioencInfo * pInfo Pointer to SceAudioencInfo.
SceAudioencOptInfo * pOptInfo Pointer to SceAudioencOptInfo.

Macro Definition Documentation

◆ SCE_AUDIOENC_WORD_LENGTH_16BITS

#define SCE_AUDIOENC_WORD_LENGTH_16BITS   16

Definition of wordlength.

◆ SCE_AUDIOENC_TYPE_CELP

#define SCE_AUDIOENC_TYPE_CELP   0x2006U

Audio encoder type.

◆ SCE_AUDIOENC_CELP_MAX_STREAMS

#define SCE_AUDIOENC_CELP_MAX_STREAMS   1

Max number of streams.

◆ SCE_AUDIOENC_CELP_MAX_SAMPLES

#define SCE_AUDIOENC_CELP_MAX_SAMPLES   320

Max number of samples.

◆ SCE_AUDIOENC_CELP_MAX_ES_SIZE

#define SCE_AUDIOENC_CELP_MAX_ES_SIZE   24

Max elementary stream size.

◆ SCE_AUDIOENC_CELP_MPE

#define SCE_AUDIOENC_CELP_MPE   (0)

CELP encoder default excitation mode.

◆ SCE_AUDIOENC_CELP_SAMPLING_RATE_8KHZ

#define SCE_AUDIOENC_CELP_SAMPLING_RATE_8KHZ   (8000)

CELP encoder default sampling rate.

Enumeration Type Documentation

◆ SceAudioencErrorCode

Enumerator
SCE_AUDIOENC_ERROR_API_FAIL 
SCE_AUDIOENC_ERROR_INVALID_TYPE 
SCE_AUDIOENC_ERROR_INVALID_INIT_PARAM 
SCE_AUDIOENC_ERROR_ALREADY_INITIALIZED 
SCE_AUDIOENC_ERROR_OUT_OF_MEMORY 
SCE_AUDIOENC_ERROR_NOT_INITIALIZED 
SCE_AUDIOENC_ERROR_A_HANDLE_IN_USE 
SCE_AUDIOENC_ERROR_ALL_HANDLES_IN_USE 
SCE_AUDIOENC_ERROR_INVALID_PTR 
SCE_AUDIOENC_ERROR_INVALID_HANDLE 
SCE_AUDIOENC_ERROR_NOT_HANDLE_IN_USE 
SCE_AUDIOENC_ERROR_CH_SHORTAGE 
SCE_AUDIOENC_ERROR_INVALID_WORD_LENGTH 
SCE_AUDIOENC_ERROR_INVALID_SIZE 
SCE_AUDIOENC_ERROR_INVALID_ALIGNMENT 
SCE_AUDIOENC_ERROR_UNSUPPORTED 

◆ SceAudioencCelpErrorCode

Enumerator
SCE_AUDIOENC_CELP_ERROR_INVALID_CONFIG 

◆ SceAudioencCelpBitrate

Enumerator
SCE_AUDIOENC_CELP_BIT_RATE_3850BPS 
SCE_AUDIOENC_CELP_BIT_RATE_4650BPS 
SCE_AUDIOENC_CELP_BIT_RATE_5700BPS 
SCE_AUDIOENC_CELP_BIT_RATE_6600BPS 
SCE_AUDIOENC_CELP_BIT_RATE_7300BPS 
SCE_AUDIOENC_CELP_BIT_RATE_8700BPS 
SCE_AUDIOENC_CELP_BIT_RATE_9900BPS 
SCE_AUDIOENC_CELP_BIT_RATE_10700BPS 
SCE_AUDIOENC_CELP_BIT_RATE_11800BPS 
SCE_AUDIOENC_CELP_BIT_RATE_12200BPS 

Function Documentation

◆ VITASDK_BUILD_ASSERT_EQ() [1/7]

VITASDK_BUILD_ASSERT_EQ ( ,
SceAudioencInitStreamParam   
)

◆ VITASDK_BUILD_ASSERT_EQ() [2/7]

VITASDK_BUILD_ASSERT_EQ ( 0x10  ,
SceAudioencInfoCelp   
)

◆ VITASDK_BUILD_ASSERT_EQ() [3/7]

VITASDK_BUILD_ASSERT_EQ ( 0x2C  ,
SceAudioencOptInfoCelp   
)

◆ VITASDK_BUILD_ASSERT_EQ() [4/7]

VITASDK_BUILD_ASSERT_EQ ( ,
SceAudioencInitParam   
)

◆ VITASDK_BUILD_ASSERT_EQ() [5/7]

VITASDK_BUILD_ASSERT_EQ ( 0x10  ,
SceAudioencInfo   
)

◆ VITASDK_BUILD_ASSERT_EQ() [6/7]

VITASDK_BUILD_ASSERT_EQ ( 0x2C  ,
SceAudioencOptInfo   
)

◆ VITASDK_BUILD_ASSERT_EQ() [7/7]

VITASDK_BUILD_ASSERT_EQ ( 0x2C  ,
SceAudioencCtrl   
)

◆ sceAudioencInitLibrary()

int sceAudioencInitLibrary ( int  codecType,
SceAudioencInitParam pInitParam 
)

◆ sceAudioencTermLibrary()

int sceAudioencTermLibrary ( unsigned int  codecType)

◆ sceAudioencCreateEncoder()

int sceAudioencCreateEncoder ( SceAudioencCtrl pCtrl,
int  codecType 
)

◆ sceAudioencDeleteEncoder()

int sceAudioencDeleteEncoder ( SceAudioencCtrl pCtrl)

◆ sceAudioencEncode()

int sceAudioencEncode ( SceAudioencCtrl pCtrl)

◆ sceAudioencClearContext()

int sceAudioencClearContext ( SceAudioencCtrl pCtrl)

◆ sceAudioencGetOptInfo()

int sceAudioencGetOptInfo ( SceAudioencCtrl pCtrl)

◆ sceAudioencGetInternalError()

int sceAudioencGetInternalError ( SceAudioencCtrl pCtrl,
int *  pInternalError 
)

Variable Documentation

◆ size [1/7]

SceSize SceAudioencInitStreamParam::size

sizeof(SceAudioencInitStreamParam)

◆ totalStreams

unsigned int SceAudioencInitStreamParam::totalStreams

Total number of audio streams.

◆ size [2/7]

SceSize SceAudioencInfoCelp::size

sizeof(SceAudioencInfoCelp)

◆ excitationMode

unsigned int SceAudioencInfoCelp::excitationMode

Excitation mode.

◆ samplingRate

unsigned int SceAudioencInfoCelp::samplingRate

Sampling rate.

◆ bitRate

unsigned int SceAudioencInfoCelp::bitRate

Bit rate (one of SceAudioencCelpBitrate)

◆ size [3/7]

SceSize SceAudioencOptInfoCelp::size

sizeof(SceAudioencOptInfoCelp)

◆ header

uint8_t SceAudioencOptInfoCelp::header[32]

Header buffer.

◆ headerSize

SceSize SceAudioencOptInfoCelp::headerSize

Header size.

◆ encoderVersion

unsigned int SceAudioencOptInfoCelp::encoderVersion

Encoder version.

◆ size [4/7]

SceSize SceAudioencInitParam::size

sizeof(SceAudioencInitParam)

◆ celp [1/3]

SceAudioencInitStreamParam SceAudioencInitParam::celp

◆ size [5/7]

SceSize SceAudioencInfo::size

sizeof(SceAudioencInfo)

◆ celp [2/3]

SceAudioencInfoCelp SceAudioencInfo::celp

Information structure for CELP.

◆ size [6/7]

SceSize SceAudioencOptInfo::size

sizeof(SceAudioencOptInfo)

◆ celp [3/3]

SceAudioencOptInfoCelp SceAudioencOptInfo::celp

Optional information structure for CELP.

◆ size [7/7]

SceSize SceAudioencCtrl::size

sizeof(SceAudioencCtrl)

◆ handle

int SceAudioencCtrl::handle

Encoder handle.

◆ pInputPcm

void* SceAudioencCtrl::pInputPcm

Pointer to elementary stream.

◆ inputPcmSize

SceSize SceAudioencCtrl::inputPcmSize

Size of elementary stream used actually (in byte)

◆ maxPcmSize

SceSize SceAudioencCtrl::maxPcmSize

Max size of elementary stream used (in byte)

◆ pOutputEs

void* SceAudioencCtrl::pOutputEs

Pointer to PCM.

◆ outputEsSize

SceSize SceAudioencCtrl::outputEsSize

Size of PCM output actually (in byte)

◆ maxEsSize

SceSize SceAudioencCtrl::maxEsSize

Max size of PCM output (in byte)

◆ wordLength

SceSize SceAudioencCtrl::wordLength

PCM bit depth.

◆ pInfo

SceAudioencInfo* SceAudioencCtrl::pInfo

Pointer to SceAudioencInfo.

◆ pOptInfo

SceAudioencOptInfo* SceAudioencCtrl::pOptInfo

Pointer to SceAudioencOptInfo.