/*

    File: CASonogramViewSharedData.h

Abstract: n/a

 Version: 1.0.1

Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple

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 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.

Copyright (C) 2012 Apple Inc. All Rights Reserved.

*/

#ifndef __CASonogramViewSharedData_h__

#define __CASonogramViewSharedData_h__

#if !defined(__COREAUDIO_USE_FLAT_INCLUDES__)

    #include <CoreAudio/CoreAudioTypes.h>

#else

    #include <CoreAudioTypes.h>

#endif

#define kMaxNumAnalysisFrames   512

#define kMaxNumBins             512

#define kMaxSonogramLatency     512

typedef SInt64 SampleTime;

#pragma mark ___CASonogramView DataStructs

/*!

    @struct         SonogramOverview

    @abstract       A structure to hold a buffer of spectrum data for drawing.

    @field          mChannel

                        Which channel you want to draw.

    @field          mFetchStamp

                        The time last fetched.

    @field          mOverview

                       The data.

    @field          mNumBins

                        The number of bins.

    @field          mNumSlices

                        The number of slices.

    @field          mMaxAmp

                        The maximum amp.

    @field          mMinAmp

                        The minimum amp.                        

*/

struct SonogramOverview

{

    UInt32          mChannel;       // the view writes  

    UInt32          mNumSlices;     // the view writes

    AudioTimeStamp  mFetchStamp;    // the view writes

    UInt32          mNumBins;       // the au writes

    Float32         mMaxAmp;        // the au writes

    Float32         mMinAmp;        // the au writes

    Float32         mOverview[1];   // the au writes  

};

typedef struct SonogramOverview  SonogramOverview;

#endif