root/trunk/PublicUtility/CAStreamBasicDescription.h

/*      Copyright:      © Copyright 2004 Apple Computer, Inc. All rights reserved.

        Disclaimer:     IMPORTANT:  This Apple software is supplied to you by Apple Computer, Inc.
                        ("Apple") in consideration of your agreement to the following terms, and your
                        use, installation, modification or redistribution of this Apple software
                        constitutes acceptance of these terms.  If you do not agree with these terms,
                        please do not use, install, modify or redistribute this Apple software.

                        In consideration of your agreement to abide by the following terms, and subject
                        to these terms, Apple grants you a personal, non-exclusive license, under AppleÕs
                        copyrights in this original Apple software (the "Apple Software"), to use,
                        reproduce, modify and redistribute the Apple Software, with or without
                        modifications, in source and/or binary forms; provided that if you redistribute
                        the Apple Software in its entirety and without modifications, you must retain
                        this notice and the following text and disclaimers in all such redistributions of
                        the Apple Software.  Neither the name, trademarks, service marks or logos of
                        Apple Computer, Inc. may be used to endorse or promote products derived from the
                        Apple Software without specific prior written permission from Apple.  Except as
                        expressly stated in this notice, no other rights or licenses, express or implied,
                        are granted by Apple herein, including but not limited to any patent rights that
                        may be infringed by your derivative works or by other works in which the Apple
                        Software may be incorporated.

                        The Apple Software is provided by Apple on an "AS IS" basis.  APPLE MAKES NO
                        WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
                        WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
                        PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
                        COMBINATION WITH YOUR PRODUCTS.

                        IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
                        CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
                        GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                        ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION
                        OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT
                        (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN
                        ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/*=============================================================================
        CAStreamBasicDescription.h
        
=============================================================================*/

#ifndef __CAStreamBasicDescription_h__
#define __CAStreamBasicDescription_h__

#if !defined(__COREAUDIO_USE_FLAT_INCLUDES__)
        #include <CoreAudio/CoreAudioTypes.h>
        #include <CoreFoundation/CoreFoundation.h>
#else
        #include "CoreAudioTypes.h"
        #include "CoreFoundation.h"
#endif

#include "CADebugMacros.h"
#include <string.h>     // for memset, memcpy
#include <stdio.h>      // for FILE *

//=============================================================================
//      CAStreamBasicDescription
//
//      This is a wrapper class for the AudioStreamBasicDescription struct.
//      It adds a number of convenience routines, but otherwise adds nothing
//      to the footprint of the original struct.
//=============================================================================
class CAStreamBasicDescription : 
        public AudioStreamBasicDescription
{

//      Constants
public:
        static const AudioStreamBasicDescription        sEmpty;

//      Construction/Destruction
public:
        CAStreamBasicDescription() { memset (this, 0, sizeof(AudioStreamBasicDescription)); }
        
        CAStreamBasicDescription(const AudioStreamBasicDescription &desc)
        {
                SetFrom(desc);
        }
        
        CAStreamBasicDescription(               double inSampleRate,            UInt32 inFormatID,
                                                                        UInt32 inBytesPerPacket,        UInt32 inFramesPerPacket,
                                                                        UInt32 inBytesPerFrame,         UInt32 inChannelsPerFrame,
                                                                        UInt32 inBitsPerChannel,        UInt32 inFormatFlags);

//      Assignment
        CAStreamBasicDescription&       operator=(const AudioStreamBasicDescription& v) { SetFrom(v); return *this; }

        void    SetFrom(const AudioStreamBasicDescription &desc)
        {
                memcpy(this, &desc, sizeof(AudioStreamBasicDescription));
        }
        
        // _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
        //
        // interrogation
        
        bool    IsPCM() const { return mFormatID == kAudioFormatLinearPCM; }
        
        bool    PackednessIsSignificant() const
        {
                Assert(IsPCM(), "PackednessIsSignificant only applies for PCM");
                return (SampleWordSize() << 3) != mBitsPerChannel;
        }
        
        bool    AlignmentIsSignificant() const
        {
                return PackednessIsSignificant() || (mBitsPerChannel & 7) != 0;
        }
        
        bool    IsInterleaved() const
        {
                return !IsPCM() || !(mFormatFlags & kAudioFormatFlagIsNonInterleaved);
        }
        
        // for sanity with interleaved/deinterleaved possibilities, never access mChannelsPerFrame, use these:
        UInt32  NumberInterleavedChannels() const       { return IsInterleaved() ? mChannelsPerFrame : 1; }     
        UInt32  NumberChannelStreams() const            { return IsInterleaved() ? 1 : mChannelsPerFrame; }
        UInt32  NumberChannels() const                          { return mChannelsPerFrame; }
        UInt32  SampleWordSize() const                          { return (mBytesPerFrame > 0) ? mBytesPerFrame / NumberInterleavedChannels() :  0;}

        UInt32  FramesToBytes(UInt32 nframes) const     { return nframes * mBytesPerFrame; }
        UInt32  BytesToFrames(UInt32 nbytes) const      {
                Assert(mBytesPerFrame > 0, "bytesPerFrame must be > 0 in BytesToFrames");
                return nbytes / mBytesPerFrame;
        }
        
        bool    SameChannelsAndInterleaving(const CAStreamBasicDescription &a) const
        {
                return this->NumberChannels() == a.NumberChannels() && this->IsInterleaved() == a.IsInterleaved();
        }
        
        // _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
        //
        //      manipulation
        
        void    SetCanonical(UInt32 nChannels, bool interleaved)
                                // note: leaves sample rate untouched
        {
                mFormatID = kAudioFormatLinearPCM;
                mFormatFlags = kAudioFormatFlagsNativeFloatPacked;
                mBitsPerChannel = 32;
                mChannelsPerFrame = nChannels;
                mFramesPerPacket = 1;
                if (interleaved)
                        mBytesPerPacket = mBytesPerFrame = nChannels * sizeof(Float32);
                else {
                        mBytesPerPacket = mBytesPerFrame = sizeof(Float32);
                        mFormatFlags |= kAudioFormatFlagIsNonInterleaved;
                }
        }
        
        void    ChangeNumberChannels(UInt32 nChannels, bool interleaved)
                                // alter an existing format
        {
                Assert(IsPCM(), "ChangeNumberChannels only works for PCM formats");
                UInt32 wordSize = SampleWordSize();     // get this before changing ANYTHING
                mChannelsPerFrame = nChannels;
                mFramesPerPacket = 1;
                if (interleaved) {
                        mBytesPerPacket = mBytesPerFrame = nChannels * wordSize;
                        mFormatFlags &= ~kAudioFormatFlagIsNonInterleaved;
                } else {
                        mBytesPerPacket = mBytesPerFrame = wordSize;
                        mFormatFlags |= kAudioFormatFlagIsNonInterleaved;
                }
        }
        
        // _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
        //
        //      other
        
        void    Print() const
        {
                Print (stdout);
        }

        void    Print(FILE* file) const
        {
                PrintFormat (file, "", "AudioStreamBasicDescription:"); 
        }

        void PrintFormat(FILE *f, const char *indent, const char *name) const;

        OSStatus                        Save(CFPropertyListRef *outData) const;
                
        OSStatus                        Restore(CFPropertyListRef &inData);

//      Operations
        static void                     NormalizeLinearPCMFormat(AudioStreamBasicDescription& ioDescription);
        static void                     ResetFormat(AudioStreamBasicDescription& ioDescription);
        static void                     FillOutFormat(AudioStreamBasicDescription& ioDescription, const AudioStreamBasicDescription& inTemplateDescription);
        static void                     GetSimpleName(const AudioStreamBasicDescription& inDescription, char* outName, bool inAbbreviate);
#if CoreAudio_Debug
        static void                     PrintToLog(const AudioStreamBasicDescription& inDesc);
#endif
};

bool            operator<(const AudioStreamBasicDescription& x, const AudioStreamBasicDescription& y);
bool            operator==(const AudioStreamBasicDescription& x, const AudioStreamBasicDescription& y);
#if TARGET_OS_MAC || (TARGET_OS_WIN32 && (_MSC_VER > 600))
inline bool     operator!=(const AudioStreamBasicDescription& x, const AudioStreamBasicDescription& y) { return !(x == y); }
inline bool     operator<=(const AudioStreamBasicDescription& x, const AudioStreamBasicDescription& y) { return (x < y) || (x == y); }
inline bool     operator>=(const AudioStreamBasicDescription& x, const AudioStreamBasicDescription& y) { return !(x < y); }
inline bool     operator>(const AudioStreamBasicDescription& x, const AudioStreamBasicDescription& y) { return !((x < y) || (x == y)); }
#endif

bool SanityCheck(const AudioStreamBasicDescription& x);


#endif // __CAStreamBasicDescription_h__