1 /*
2      File: CAStreamRangedDescription.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(__CAStreamRangedDescription_h__)
48 #define __CAStreamRangedDescription_h__
49 
50 //==================================================================================================
51 //	Includes
52 //==================================================================================================
53 
54 //  Super Class Includes
55 #include <CoreAudio/AudioHardware.h>
56 
57 //  PublicUtility Includes
58 #include "CAAudioValueRange.h"
59 #include "CAStreamBasicDescription.h"
60 
61 //==================================================================================================
62 //	CAStreamRangedDescription
63 //==================================================================================================
64 
65 class CAStreamRangedDescription
66 :
67 	public AudioStreamRangedDescription
68 {
69 
70 //	Constants
71 public:
72 	static const AudioStreamRangedDescription	sEmpty;
73 
74 //	Construction/Destruction
75 public:
CAStreamRangedDescription()76 								CAStreamRangedDescription()																							{ memset(this, 0, sizeof(AudioStreamRangedDescription)); }
CAStreamRangedDescription(const CAStreamRangedDescription & inFormat)77 								CAStreamRangedDescription(const CAStreamRangedDescription& inFormat)												{ mFormat = inFormat.mFormat; mSampleRateRange = inFormat.mSampleRateRange; }
CAStreamRangedDescription(const AudioStreamRangedDescription & inFormat)78 								CAStreamRangedDescription(const AudioStreamRangedDescription& inFormat)												{ mFormat = inFormat.mFormat; mSampleRateRange = inFormat.mSampleRateRange; }
CAStreamRangedDescription(const AudioStreamBasicDescription & inFormat)79 								CAStreamRangedDescription(const AudioStreamBasicDescription& inFormat)												{ mFormat = inFormat; mSampleRateRange.mMinimum = inFormat.mSampleRate; mSampleRateRange.mMaximum = inFormat.mSampleRate; }
CAStreamRangedDescription(const AudioStreamBasicDescription & inFormat,const AudioValueRange & inSampleRateRange)80 								CAStreamRangedDescription(const AudioStreamBasicDescription& inFormat, const AudioValueRange& inSampleRateRange)	{ mFormat = inFormat; mSampleRateRange = inSampleRateRange; }
81 	CAStreamRangedDescription&  operator=(const CAStreamRangedDescription& inFormat)																{ mFormat = inFormat.mFormat; mSampleRateRange = inFormat.mSampleRateRange; return *this; }
82 	CAStreamRangedDescription&  operator=(const AudioStreamRangedDescription& inFormat)																{ mFormat = inFormat.mFormat; mSampleRateRange = inFormat.mSampleRateRange; return *this; }
83 
IsMixable(const AudioStreamRangedDescription & inDescription)84 	static bool					IsMixable(const AudioStreamRangedDescription& inDescription) { return (inDescription.mFormat.mFormatID == kAudioFormatLinearPCM) && ((inDescription.mFormat.mFormatFlags & kIsNonMixableFlag) == 0); }
85 #if CoreAudio_Debug
86 	static void					PrintToLog(const AudioStreamRangedDescription& inDesc);
87 #endif
88 	static bool					Sorter(const AudioStreamRangedDescription& x, const AudioStreamRangedDescription& y);
89 
90 };
91 
92 inline bool operator<(const AudioStreamRangedDescription& x, const AudioStreamRangedDescription& y)													{	return	(x.mFormat.mFormatID == y.mFormat.mFormatID) ?
93 																																								(x.mFormat < y.mFormat) && (x.mSampleRateRange < y.mSampleRateRange) :
94 																																								(x.mFormat.mFormatID == kAudioFormatLinearPCM) ? false : (x.mFormat.mFormatID < y.mFormat.mFormatID); }
95 inline bool operator==(const AudioStreamRangedDescription& x, const AudioStreamRangedDescription& y)												{ return (x.mFormat == y.mFormat) && (x.mSampleRateRange == y.mSampleRateRange); }
96 #if TARGET_OS_MAC || (TARGET_OS_WIN32 && (_MSC_VER > 600))
97 inline bool	operator!=(const AudioStreamRangedDescription& x, const AudioStreamRangedDescription& y)												{ return !(x == y); }
98 inline bool	operator<=(const AudioStreamRangedDescription& x, const AudioStreamRangedDescription& y)												{ return (x < y) || (x == y); }
99 inline bool	operator>=(const AudioStreamRangedDescription& x, const AudioStreamRangedDescription& y)												{ return !(x < y); }
100 inline bool	operator>(const AudioStreamRangedDescription& x, const AudioStreamRangedDescription& y)													{ return !((x < y) || (x == y)); }
101 #endif
102 
103 inline bool operator<(const AudioStreamBasicDescription& x, const AudioStreamRangedDescription& y)													{	return	(x.mFormatID == y.mFormat.mFormatID) ?
104 																																								(x < y.mFormat) && (x.mSampleRate < y.mSampleRateRange.mMinimum) :
105 																																								(x.mFormatID == kAudioFormatLinearPCM) ? false : (x.mFormatID < y.mFormat.mFormatID); }
106 inline bool operator<(const AudioStreamRangedDescription& x, const AudioStreamBasicDescription& y)													{	return	(x.mFormat.mFormatID == y.mFormatID) ?
107 																																								(x.mFormat < y) && (x.mSampleRateRange.mMinimum < y.mSampleRate) :
108 																																								(x.mFormat.mFormatID == kAudioFormatLinearPCM) ? false : (x.mFormat.mFormatID < y.mFormatID); }
109 inline bool operator==(const AudioStreamBasicDescription& x, const AudioStreamRangedDescription& y)													{ return (x == y.mFormat) && CAAudioValueRange::ContainsValue(y.mSampleRateRange, x.mSampleRate); }
110 inline bool operator==(const AudioStreamRangedDescription& x, const AudioStreamBasicDescription& y)													{ return (x.mFormat == y) && CAAudioValueRange::ContainsValue(x.mSampleRateRange, y.mSampleRate); }
111 #if TARGET_OS_MAC || (TARGET_OS_WIN32 && (_MSC_VER > 600))
112 inline bool	operator!=(const AudioStreamBasicDescription& x, const AudioStreamRangedDescription& y)													{ return !(x == y); }
113 inline bool	operator!=(const AudioStreamRangedDescription& x, const AudioStreamBasicDescription& y)													{ return !(x == y); }
114 inline bool	operator<=(const AudioStreamBasicDescription& x, const AudioStreamRangedDescription& y)													{ return (x < y) || (x == y); }
115 inline bool	operator<=(const AudioStreamRangedDescription& x, const AudioStreamBasicDescription& y)													{ return (x < y) || (x == y); }
116 inline bool	operator>=(const AudioStreamBasicDescription& x, const AudioStreamRangedDescription& y)													{ return !(x < y); }
117 inline bool	operator>=(const AudioStreamRangedDescription& x, const AudioStreamBasicDescription& y)													{ return !(x < y); }
118 inline bool	operator>(const AudioStreamBasicDescription& x, const AudioStreamRangedDescription& y)													{ return !((x < y) || (x == y)); }
119 inline bool	operator>(const AudioStreamRangedDescription& x, const AudioStreamBasicDescription& y)													{ return !((x < y) || (x == y)); }
120 #endif
121 
122 //	STL Functors
123 struct	CAStreamRangedDescription_EqualToASBD
124 :
125 	public std::unary_function<AudioStreamRangedDescription, bool>
126 {
CAStreamRangedDescription_EqualToASBDCAStreamRangedDescription_EqualToASBD127 			CAStreamRangedDescription_EqualToASBD(const AudioStreamBasicDescription& inFormat)	: mFormat(inFormat) {}
operatorCAStreamRangedDescription_EqualToASBD128 	bool	operator()(const AudioStreamRangedDescription& x) const								{ return mFormat == x; }
129 
130 	AudioStreamBasicDescription	mFormat;
131 };
132 
133 struct	CAStreamRangedDescription_ReverseSort
134 :
135 	public std::binary_function<AudioStreamRangedDescription, AudioStreamRangedDescription, bool>
136 {
operatorCAStreamRangedDescription_ReverseSort137 	bool	operator()(const AudioStreamRangedDescription& x, const AudioStreamRangedDescription& y) const	{ return CAStreamRangedDescription::Sorter(x, y); }
138 };
139 
140 #endif
141