libs/appleutility/CoreAudio/PublicUtility/CAMixMap.h

   1 /*
   2      File: CAMixMap.h
   3  Abstract: Part of CoreAudio Utility Classes
   4   Version: 1.1
   5
   6  Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple
   7  Inc. ("Apple") in consideration of your agreement to the following
   8  terms, and your use, installation, modification or redistribution of
   9  this Apple software constitutes acceptance of these terms.  If you do
  10  not agree with these terms, please do not use, install, modify or
  11  redistribute this Apple software.
  12
  13  In consideration of your agreement to abide by the following terms, and
  14  subject to these terms, Apple grants you a personal, non-exclusive
  15  license, under Apple's copyrights in this original Apple software (the
  16  "Apple Software"), to use, reproduce, modify and redistribute the Apple
  17  Software, with or without modifications, in source and/or binary forms;
  18  provided that if you redistribute the Apple Software in its entirety and
  19  without modifications, you must retain this notice and the following
  20  text and disclaimers in all such redistributions of the Apple Software.
  21  Neither the name, trademarks, service marks or logos of Apple Inc. may
  22  be used to endorse or promote products derived from the Apple Software
  23  without specific prior written permission from Apple.  Except as
  24  expressly stated in this notice, no other rights or licenses, express or
  25  implied, are granted by Apple herein, including but not limited to any
  26  patent rights that may be infringed by your derivative works or by other
  27  works in which the Apple Software may be incorporated.
  28
  29  The Apple Software is provided by Apple on an "AS IS" basis.  APPLE
  30  MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
  31  THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
  32  FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
  33  OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
  34
  35  IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
  36  OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  37  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  38  INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
  39  MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
  40  AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
  41  STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
  42  POSSIBILITY OF SUCH DAMAGE.
  43
  44  Copyright (C) 2014 Apple Inc. All Rights Reserved.
  45
  46 */
  47 #ifndef __CAMixMap_h__
  48 #define __CAMixMap_h__
  49
  50         // manages the setting of mix map volumes
  51
  52 class CAMixMap {
  53 public:
  54                                 CAMixMap ()
  55                                         : mIns(0), mOuts (0), mMixMap(NULL)
  56                                         {}
  57
  58                                 CAMixMap (const CAMixMap &mm)
  59                                         : mIns(0), mOuts (0), mMixMap(NULL)
  60                                         { *this = mm; }
  61
  62                                 CAMixMap (UInt32 numIns, UInt32 numOuts)
  63                                         : mIns(numIns), mOuts (numOuts), mMixMap(NULL)
  64                                         {
  65                                                 mMixMap = new Float32[numIns * numOuts];
  66                                                 memset (mMixMap, 0, ByteSize());
  67                                         }
  68
  69                                 ~CAMixMap () { delete [] mMixMap; }
  70
  71         CAMixMap&       operator=(const CAMixMap& mm)
  72                                 {
  73                                         if (mMixMap) { delete [] mMixMap; mMixMap = NULL; }
  74                                         mIns = mm.mIns; mOuts = mm.mOuts;
  75                                         if (NumIns() && NumOuts()) {
  76                                                 mMixMap = new Float32 [ NumIns() * NumOuts() ];
  77                                                 memcpy (mMixMap, mm.mMixMap, ByteSize());
  78                                         }
  79                                         return *this;
  80                                 }
  81
  82         UInt32          NumIns () const { return mIns; }
  83         UInt32          NumOuts () const { return mOuts; }
  84
  85         void            SetCrossPoint (UInt32 inputChan, UInt32 outputChan, Float32 val)
  86                                 {
  87                                         if (inputChan < NumIns() && outputChan < NumOuts())
  88                                                 mMixMap[inputChan * NumOuts() + outputChan] = val;
  89                                 }
  90         Float32         GetCrossPoint (UInt32 inputChan, UInt32 outputChan) const
  91                                 {
  92                                         return (inputChan < NumIns() && outputChan < NumOuts())
  93                                                         ? mMixMap[inputChan * NumOuts() + outputChan]
  94                                                         : 0;
  95                                 }
  96
  97         void            SetDiagonal (Float32 val)
  98                                 {
  99                                         for (UInt32 i = 0; i < NumIns() && i < NumOuts(); ++i) {
 100                                                 mMixMap[i * NumOuts() + i] = val;
 101                                         }
 102                                 }
 103
 104         void            Clear () { memset (mMixMap, 0, ByteSize()); }
 105
 106
 107         Float32*        MM() { return mMixMap; }
 108         const Float32*  MM() const { return mMixMap; }
 109         UInt32          ByteSize () const { return NumIns() * NumOuts() * sizeof(Float32); }
 110
 111         UInt32          CountActiveInputs(UInt32 inOutputChannel)
 112                                 {
 113                                         UInt32 sum = 0;
 114                                         for (UInt32 i = 0, k = inOutputChannel; i < mIns; ++i, k+=mOuts) {
 115                                                 if (mMixMap[k] != 0.f) sum++;
 116                                         }
 117                                         return sum;
 118                                 }
 119
 120         void            Normalize()
 121                                 {
 122                                         // ensure that no output channel will sum over unity.
 123                                         Float32* mixmap = mMixMap;
 124                                         Float32 maxsum = 0.f;
 125                                         for (UInt32 j = 0; j < mOuts; ++j) {
 126                                                 Float32 sum = 0.f;
 127                                                 for (UInt32 i = 0, k = j; i < mIns; ++i, k+=mOuts) {
 128                                                         sum += mixmap[k];
 129                                                 }
 130                                                 if (sum > maxsum) maxsum = sum;
 131                                         }
 132
 133                                         if (maxsum == 0.f) return;
 134                                         Float32 scale = 1.f / maxsum;
 135                                         for (UInt32 i = 0; i < mIns * mOuts; ++i) {
 136                                                 mixmap[i] *= scale;
 137                                         }
 138                                 }
 139
 140         void            Print ()
 141                                 {
 142                                         printf ("Num Ins: %d, Num Outs: %d\n", (int)mIns, (int)mOuts);
 143                                         for (unsigned int ins = 0; ins < mIns; ++ins) {
 144                                                 printf ("\t%d: ", ins);
 145                                                 for (unsigned int outs = 0; outs < mOuts; ++outs)
 146                                                         printf ("(%.3f) ", mMixMap[ins * NumOuts() + outs]);
 147                                                 printf("\n");
 148                                         }
 149                                 }
 150
 151 private:
 152         UInt32  mIns;
 153         UInt32  mOuts;
 154         Float32 *mMixMap;
 155 };
 156
 157 #endif