Current File : //usr/share/man/man3mlib/mlib_SignalLimit.3mlib

'\" te
.\" Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved 
.TH mlib_SignalLimit 3MLIB "2 Mar 2007" "SunOS 5.11" "mediaLib Library Functions"
.SH NAME
mlib_SignalLimit, mlib_SignalLimit_S16_S16, mlib_SignalLimit_S16S_S16S, mlib_SignalLimit_S16, mlib_SignalLimit_S16S, mlib_SignalLimit_F32_F32, mlib_SignalLimit_F32S_F32S, mlib_SignalLimit_F32, mlib_SignalLimit_F32S \- signal hard limiting
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR... ] \fIfile\fR... \fB-lmlib\fR [ \fIlibrary\fR... ]
#include <mlib.h>

\fBmlib_status\fR \fBmlib_SignalLimit_S16_S16\fR(\fBmlib_s16 *\fR\fIdst\fR,
     \fBconst mlib_s16 *\fR\fIsrc\fR, \fBconst mlib_s16 *\fR\fIlow\fR,
     \fBconst mlib_s16 *\fR\fIhigh\fR, \fBmlib_s32\fR \fIn\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_SignalLimit_S16S_S16S\fR(\fBmlib_s16 *\fR\fIdst\fR,
     \fBconst mlib_s16 *\fR\fIsrc\fR, \fBconst mlib_s16 *\fR\fIlow\fR,
     \fBconst mlib_s16 *\fR\fIhigh\fR, \fBmlib_s32\fR \fIn\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_SignalLimit_S16\fR(\fBmlib_s16 *\fR\fIsrcdst\fR,
     \fBconst mlib_s16 *\fR\fIlow\fR, \fBconst mlib_s16 *\fR\fIhigh\fR, \fBmlib_s32\fR \fIn\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_SignalLimit_S16S\fR(\fBmlib_s16 *\fR\fIsrcdst\fR,
     \fBconst mlib_s16 *\fR\fIlow\fR, \fBconst mlib_s16 *\fR\fIhigh\fR, \fBmlib_s32\fR \fIn\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_SignalLimit_F32_F32\fR(\fBmlib_f32 *\fR\fIdst\fR,
     \fBconst mlib_f32 *\fR\fIsrc\fR, \fBconst mlib_f32 *\fR\fIlow\fR,
     \fBconst mlib_f32 *\fR\fIhigh\fR, \fBmlib_s32\fR \fIn\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_SignalLimit_F32S_F32S\fR(\fBmlib_f32 *\fR\fIdst\fR,
     \fBconst mlib_f32 *\fR\fIsrc\fR, \fBconst mlib_f32 *\fR\fIlow\fR,
     \fBconst mlib_f32 *\fR\fIhigh\fR, \fBmlib_s32\fR \fIn\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_SignalLimit_F32\fR(\fBmlib_f32 *\fR\fIsrcdst\fR,
     \fBconst mlib_f32 *\fR\fIlow\fR, \fBconst mlib_f32 *\fR\fIhigh\fR, \fBmlib_s32\fR \fIn\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_SignalLimit_F32S\fR(\fBmlib_f32 *\fR\fIsrcdst\fR,
     \fBconst mlib_f32 *\fR\fIlow\fR, \fBconst mlib_f32 *\fR\fIhigh\fR, \fBmlib_s32\fR \fIn\fR);
.fi

.SH DESCRIPTION
.sp
.LP
Each of these functions performs hard limiting.
.sp
.LP
For monaural signals, the following equation is used:
.sp
.in +2
.nf
dst[i] = low[0]           if src[i] < low[0]
dst[i] = src[i]           if low[0] \(<= src[i] < high[0]
dst[i] = high[0]          if src[i] \(>= high[0]
.fi
.in -2

.sp
.LP
where \fBi = 0, 1, ..., (n - 1)\fR.
.sp
.LP
For stereo signals, the following equation is used:
.sp
.in +2
.nf
dst[2*i] = low[0]         if src[2*i] < low[0]
dst[2*i] = src[2*i]       if low[0] \(<= src[2*i] < high[0]
dst[2*i] = high[0]        if src[2*i] \(>= high[0]

dst[2*i+1] = low[1]       if src[2*i+1] < low[1]
dst[2*i+1] = src[2*i+1]   if low[1] \(<= src[2*i+1] < high[1]
dst[2*i+1] = high[1]      if src[2*i+1] \(>= high[1]
.fi
.in -2

.sp
.LP
where \fBi = 0, 1, ..., (n - 1)\fR.
.SH PARAMETERS
.sp
.LP
Each of the functions takes some of the following arguments:
.sp
.ne 2
.mk
.na
\fB\fIdst\fR\fR
.ad
.RS 10n
.rt  
Destination signal array.
.RE

.sp
.ne 2
.mk
.na
\fB\fIsrc\fR\fR
.ad
.RS 10n
.rt  
Source signal array.
.RE

.sp
.ne 2
.mk
.na
\fB\fIsrcdst\fR\fR
.ad
.RS 10n
.rt  
Source and destination signal array.
.RE

.sp
.ne 2
.mk
.na
\fB\fIlow\fR\fR
.ad
.RS 10n
.rt  
Lower input limit. In the stereo version, \fBlow[0]\fR contains the lower limit for channel \fB0\fR, and \fBlow[1]\fR contains the lower limit for channel \fB1\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fIhigh\fR\fR
.ad
.RS 10n
.rt  
Upper input limit. In the stereo version. \fBhigh[0]\fR contains the upper limit for channel \fB0\fR, and \fBhigh[1]\fR contains the upper limit for channel \fB1\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fIn\fR\fR
.ad
.RS 10n
.rt  
Number of samples in the source signal array.
.RE

.SH RETURN VALUES
.sp
.LP
Each of the functions returns \fBMLIB_SUCCESS\fR if successful. Otherwise it returns \fBMLIB_FAILURE\fR.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBattributes\fR(5)