Manual Pages for UNIX Operating System command usage for man mlib_SignalLimit_S16_S16

mediaLib Library Functions                mlib_SignalLimit(3MLIB)



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

SYNOPSIS
     cc [ flag... ] file... -lmlib [ library... ]
     #include 

     mlib_status mlib_SignalLimit_S16_S16(mlib_s16 *dst,
          const mlib_s16 *src, const mlib_s16 *low,
          const mlib_s16 *high, mlib_s32 n);


     mlib_status mlib_SignalLimit_S16S_S16S(mlib_s16 *dst,
          const mlib_s16 *src, const mlib_s16 *low,
          const mlib_s16 *high, mlib_s32 n);


     mlib_status mlib_SignalLimit_S16(mlib_s16 *srcdst,
          const mlib_s16 *low, const mlib_s16 *high, mlib_s32 n);


     mlib_status mlib_SignalLimit_S16S(mlib_s16 *srcdst,
          const mlib_s16 *low, const mlib_s16 *high, mlib_s32 n);


     mlib_status mlib_SignalLimit_F32_F32(mlib_f32 *dst,
          const mlib_f32 *src, const mlib_f32 *low,
          const mlib_f32 *high, mlib_s32 n);


     mlib_status mlib_SignalLimit_F32S_F32S(mlib_f32 *dst,
          const mlib_f32 *src, const mlib_f32 *low,
          const mlib_f32 *high, mlib_s32 n);


     mlib_status mlib_SignalLimit_F32(mlib_f32 *srcdst,
          const mlib_f32 *low, const mlib_f32 *high, mlib_s32 n);


     mlib_status mlib_SignalLimit_F32S(mlib_f32 *srcdst,
          const mlib_f32 *low, const mlib_f32 *high, mlib_s32 n);


DESCRIPTION
     Each of these functions performs hard limiting.






SunOS 5.11           Last change: 2 Mar 2007                    1






mediaLib Library Functions                mlib_SignalLimit(3MLIB)



     For monaural signals, the following equation is used:

       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]



     where i = 0, 1, ..., (n - 1).


     For stereo signals, the following equation is used:

       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]



     where i = 0, 1, ..., (n - 1).

PARAMETERS
     Each of the functions takes some of the following arguments:

     dst       Destination signal array.


     src       Source signal array.


     srcdst    Source and destination signal array.


     low       Lower input limit. In the stereo  version,  low[0]
               contains the lower limit for channel 0, and low[1]
               contains the lower limit for channel 1.


     high      Upper input limit. In the stereo version.  high[0]
               contains  the  upper  limit  for  channel  0,  and
               high[1] contains the upper limit for channel 1.


     n         Number of samples in the source signal array.


RETURN VALUES




SunOS 5.11           Last change: 2 Mar 2007                    2






mediaLib Library Functions                mlib_SignalLimit(3MLIB)



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

ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:



     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Interface Stability         | Committed                   |
    |_____________________________|_____________________________|
    | MT-Level                    | MT-Safe                     |
    |_____________________________|_____________________________|


SEE ALSO
     attributes(5)



































SunOS 5.11           Last change: 2 Mar 2007                    3