libs/appleutility/CoreAudio/PublicUtility/CAComponent.h

   1 /*
   2      File: CAComponent.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 __CAComponent_h__
  48 #define __CAComponent_h__
  49
  50 #if !defined(__COREAUDIO_USE_FLAT_INCLUDES__)
  51 #else
  52         #include <ConditionalMacros.h>
  53 #endif
  54
  55 #include "CAComponentDescription.h"
  56
  57 class CAComponent
  58 {
  59 public:
  60         CAComponent ()
  61                 : mComp (0), mDesc(), mManuName(0), mAUName(0), mCompName(0) {}
  62
  63                 // if next is specifed that is used to find the next component after that one
  64         CAComponent (const AudioComponentDescription& inDesc, CAComponent* next = 0);
  65
  66         CAComponent (const CAComponent& y)
  67                 : mComp (0), mDesc(), mManuName(0), mAUName(0), mCompName(0) { *this = y; }
  68
  69         CAComponent (const AudioComponent& comp);
  70
  71         CAComponent (const AudioComponentInstance& compInst);
  72
  73         CAComponent (OSType inType, OSType inSubtype = 0, OSType inManu = 0);
  74
  75         ~CAComponent ();
  76
  77         CAComponent&    operator= (const CAComponent& y);
  78
  79                 // returns true if this object references a valid component
  80         bool                    IsValid () const { return Comp() != 0; }
  81
  82         bool                    HasAUStrings() const {  SetCompNames (); return mManuName != 0; }
  83
  84                 // CFStringRef should be retained by caller if needed beyond lifetime of this object
  85
  86                 // Can return NULL if component doesn't follow AU naming conventions
  87         CFStringRef             GetAUManu () const { SetCompNames (); return mManuName; }
  88         CFStringRef             GetAUName () const { SetCompNames (); return mAUName ? mAUName : mCompName; }
  89
  90                 // Return value of NULL indicates a problem getting that information from the component
  91         CFStringRef             GetCompName () const { SetCompNames(); return mCompName; }
  92
  93         const CAComponentDescription&   Desc () const { return mDesc; }
  94
  95         OSStatus                Open (AudioComponentInstance& outInst) const
  96         {
  97                 return AudioComponentInstanceNew (Comp(), &outInst);
  98         }
  99
 100         OSStatus                        GetVersion (UInt32 &outVersion) const;
 101
 102         const AudioComponent&           Comp() const { return mComp; }
 103
 104         void                            Print(FILE* file = stdout) const;
 105
 106         OSStatus                        Save (CFPropertyListRef *outData) const;
 107
 108         OSStatus                        Restore (CFPropertyListRef &inData);
 109
 110 private:
 111         AudioComponent mComp;
 112         CAComponentDescription mDesc;
 113
 114         CFStringRef mManuName, mAUName, mCompName;
 115
 116         void    SetCompNames () const;
 117         void    SetCompInfo () const;
 118         void    Clear ();
 119 };
 120
 121 #endif