libs/appleutility/CoreAudio/PublicUtility/CAAudioValueRange.h

   1 /*
   2      File: CAAudioValueRange.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 #if !defined(__CAAudioValueRange_h__)
  48 #define __CAAudioValueRange_h__
  49
  50 //=============================================================================
  51 //      Includes
  52 //=============================================================================
  53
  54 //      System Includes
  55 #if !defined(__COREAUDIO_USE_FLAT_INCLUDES__)
  56         #include <CoreAudio/CoreAudioTypes.h>
  57 #else
  58         #include <CoreAudioTypes.h>
  59 #endif
  60 //      Standard Library Includes
  61 #include <functional>
  62 #include <vector>
  63
  64 //=============================================================================
  65 //      CAAudioValueRange
  66 //=============================================================================
  67
  68 struct CAAudioValueRange
  69 :
  70         public AudioValueRange
  71 {
  72
  73 //      Construction/Destruction
  74 public:
  75                                                 CAAudioValueRange()                                                                                                                             { mMinimum = 0.0; mMaximum = 0.0; }
  76                                                 CAAudioValueRange(const AudioValueRange& v)                                                                             { mMinimum = v.mMinimum; mMaximum = v.mMaximum; }
  77                                                 CAAudioValueRange(Float64 inMinimum, Float64 inMaximum)                                                 { mMinimum = inMinimum; mMaximum = inMaximum; }
  78
  79 //      Assignment
  80 public:
  81         CAAudioValueRange&      operator=(const AudioValueRange& v)                                                                                             { mMinimum = v.mMinimum; mMaximum = v.mMaximum; return *this; }
  82
  83 //  Operations
  84 public:
  85         static bool                     ContainsValue(const AudioValueRange& inRange, Float64 inValue)                                  { return (inValue >= inRange.mMinimum) && (inValue <= inRange.mMaximum); }
  86         static Float64          BoundValue(const AudioValueRange& inRange, Float64 inValue);
  87         static Float64          PickCommonSampleRate(const AudioValueRange& inRange);
  88         static bool                     IsStrictlyLessThan(const AudioValueRange& x, const AudioValueRange& y)                  { return x.mMaximum < y.mMinimum; }
  89         static bool                     IsStrictlyGreaterThan(const AudioValueRange& x, const AudioValueRange& y)               { return x.mMinimum > y.mMaximum; }
  90         static bool                     IsStrictlyContainedBy(const AudioValueRange& x, const AudioValueRange& y)               { return (x.mMinimum >= y.mMinimum) && (x.mMaximum <= y.mMaximum); }
  91         static bool                     OverlapsLow(const AudioValueRange& x, const AudioValueRange& y)                                 { return (x.mMinimum < y.mMinimum) && (x.mMaximum >= y.mMinimum) && (x.mMaximum <= y.mMaximum); }
  92         static bool                     OverlapsHigh(const AudioValueRange& x, const AudioValueRange& y)                                { return (x.mMinimum >= y.mMinimum) && (x.mMinimum <= y.mMaximum) && (x.mMaximum > y.mMaximum); }
  93         static bool                     Intersection(const AudioValueRange& x, const AudioValueRange& y, AudioValueRange& outRange);
  94         static bool                     Union(const AudioValueRange& x, const AudioValueRange& y, AudioValueRange& outRange);
  95
  96 //      STL Helpers
  97 public:
  98         struct  LessThan
  99         :
 100                 public std::binary_function<AudioValueRange, AudioValueRange, bool>
 101         {
 102                 bool    operator()(const AudioValueRange& x, const AudioValueRange& y) const
 103                 {
 104                         return x.mMinimum < y.mMinimum;
 105                 }
 106         };
 107
 108 };
 109
 110 inline bool     operator<(const AudioValueRange& x, const AudioValueRange& y)                                                           { return x.mMinimum < y.mMinimum; }
 111 inline bool     operator==(const AudioValueRange& x, const AudioValueRange& y)                                                          { return (x.mMinimum == y.mMinimum) && (x.mMaximum == y.mMaximum); }
 112 inline bool     operator!=(const AudioValueRange& x, const AudioValueRange& y)                                                          { return !(x == y); }
 113 inline bool     operator<=(const AudioValueRange& x, const AudioValueRange& y)                                                          { return (x < y) || (x == y); }
 114 inline bool     operator>=(const AudioValueRange& x, const AudioValueRange& y)                                                          { return !(x < y); }
 115 inline bool     operator>(const AudioValueRange& x, const AudioValueRange& y)                                                           { return !((x < y) || (x == y)); }
 116
 117 typedef std::vector<CAAudioValueRange>  CAAudioValueRangeList;
 118 void    CAAudioValueRange_ComputeUnion(const AudioValueRange& inRange, const CAAudioValueRangeList& inRangeList, CAAudioValueRangeList& outUnion);
 119 void    CAAudioValueRange_ComputeIntersection(UInt32 inNumberRangeList1Items, AudioValueRange inRangeList1[], const CAAudioValueRangeList& inRangeList2, CAAudioValueRangeList& outIntersections);
 120
 121 #endif