man pages section 3: Multimedia Library Functions

Exit Print View

Updated: July 2014
 
 

mlib_SignalConvertShift_S32_F32_Sat(3MLIB)

Name

mlib_SignalConvertShift_U8_S8_Sat, mlib_SignalConvertShift_U8_S16_Sat, mlib_SignalConvertShift_U8_S32_Sat, mlib_SignalConvertShift_U8_F32_Sat, mlib_SignalConvertShift_U8S_S8S_Sat, mlib_SignalConvertShift_U8S_S16S_Sat , mlib_SignalConvertShift_U8S_S32S_Sat, mlib_SignalConvertShift_U8S_F32S_Sat, mlib_SignalConvertShift_S8_U8_Sat, mlib_SignalConvertShift_S8_S16_Sat, mlib_SignalConvertShift_S8_S32_Sat, mlib_SignalConvertShift_S8_F32_Sat , mlib_SignalConvertShift_S8S_U8S_Sat, mlib_SignalConvertShift_S8S_S16S_Sat, mlib_SignalConvertShift_S8S_S32S_Sat, mlib_SignalConvertShift_S8S_F32S_Sat, mlib_SignalConvertShift_S16_U8_Sat, mlib_SignalConvertShift_S16_S8_Sat , mlib_SignalConvertShift_S16_S32_Sat, mlib_SignalConvertShift_S16_F32_Sat, mlib_SignalConvertShift_S16S_U8S_Sat, mlib_SignalConvertShift_S16S_S8S_Sat, mlib_SignalConvertShift_S16S_S32S_Sat, mlib_SignalConvertShift_S16S_F32S_Sat , mlib_SignalConvertShift_S32_U8_Sat, mlib_SignalConvertShift_S32_S8_Sat, mlib_SignalConvertShift_S32_S16_Sat, mlib_SignalConvertShift_S32_F32_Sat, mlib_SignalConvertShift_S32S_U8S_Sat, mlib_SignalConvertShift_S32S_S8S_Sat , mlib_SignalConvertShift_S32S_S16S_Sat, mlib_SignalConvertShift_S32S_F32S_Sat - data type convert with shifting

Synopsis

cc [ flag... ] file... –lmlib [ library... ]
#include <mlib.h>

mlib_status mlib_SignalConvertShift_U8_S8_Sat(mlib_u8 *dst, 
     const mlib_s8 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_U8_S16_Sat(mlib_u8 *dst, 
     const mlib_s16 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_U8_S32_Sat(mlib_u8 *dst, 
     const mlib_s32 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_U8_F32_Sat(mlib_u8 *dst, 
     const mlib_f32 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_U8S_S8S_Sat(mlib_u8 *dst, 
     const mlib_s8 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_U8S_S16S_Sat(mlib_u8 *dst, 
     const mlib_s16 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_U8S_S32S_Sat(mlib_u8 *dst, 
     const mlib_s32 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_U8S_F32S_Sat(mlib_u8 *dst, 
     const mlib_f32 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S8_U8_Sat(mlib_s8 *dst, 
     const mlib_u8 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S8_S16_Sat(mlib_s8 *dst, 
     const mlib_s16 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S8_S32_Sat(mlib_s8 *dst, 
     const mlib_s32 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S8_F32_Sat(mlib_s8 *dst, 
     const mlib_f32 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S8S_U8S_Sat(mlib_s8 *dst, 
     const mlib_u8 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S8S_S16S_Sat(mlib_s8 *dst, 
     const mlib_s16 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S8S_S32S_Sat(mlib_s8 *dst, 
     const mlib_s32 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S8S_F32S_Sat(mlib_s8 *dst, 
     const mlib_f32 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S16_U8_Sat(mlib_s16 *dst, 
     const mlib_u8 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S16_S8_Sat(mlib_s16 *dst, 
     const mlib_s8 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S16_S32_Sat(mlib_s16 *dst, 
     const mlib_s32 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S16_F32_Sat(mlib_s16 *dst, 
     const mlib_f32 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S16S_U8S_Sat(mlib_s16 *dst,
     const mlib_u8 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S16S_S8S_Sat(mlib_s16 *dst,
     const mlib_s8 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S16S_S32S_Sat(mlib_s16 *dst,
     const mlib_s32 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S16S_F32S_Sat(mlib_s16 *dst,
     const mlib_f32 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S32_U8_Sat(mlib_s32 *dst, 
     const mlib_u8 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S32_S8_Sat(mlib_s32 *dst, 
    const mlib_s8 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S32_S16_Sat(mlib_s32 *dst, 
    const mlib_s16 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S32_F32_Sat(mlib_s32 *dst, 
    const mlib_f32 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S32S_U8S_Sat(mlib_s32 *dst,
     const mlib_u8 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S32S_S8S_Sat(mlib_s32 *dst,
     const mlib_s8 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S32S_S16S_Sat(mlib_s32 *dst,
     const mlib_s16 *src, mlib_s32 shift, mlib_s32 n);
mlib_status mlib_SignalConvertShift_S32S_F32S_Sat(mlib_s32 *dst,
     const mlib_f32 *src, mlib_s32 shift, mlib_s32 n);

Description

Each of these functions performs data type convert with shifting.

The following equation is used:

dst[i] = saturate(src[i] * 2**shift)

See the following tables for available variations of this group of data type convert functions.

Type [*]
U8
S8
S16
S32
U8
Y
Y
Y
S8
Y
Y
Y
S16
Y
Y
Y
S32
Y
Y
Y
F32
Y
Y
Y
Y
Type [*]
U8S
S8S
S16S
S32S
U8S
Y
Y
Y
S8S
Y
Y
Y
S16S
Y
Y
Y
S32S
Y
Y
Y
F32S
Y
Y
Y
Y

[*] Each row represents a source data type. Each column represents a destination data type.

Parameters

Each of the functions takes the following arguments:

dst

Destination signal array.

src

Source signal array.

shift

Left shifting factor.

n

Number of samples in the source signal arrays.

Return Values

Each of the functions returns MLIB_SUCCESS if successful. Otherwise it returns MLIB_FAILURE.

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
MT-Safe

See also

mlib_SignalConvertShift_F32_U8(3MLIB), attributes( 5)