/*  Copyright © 2007 Apple Inc. All Rights Reserved.

    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.

*/

#if !defined(__ARStereoPanControl_h__)

#define __ARStereoPanControl_h__

//==================================================================================================

//  Includes

//==================================================================================================

//  System Includes

#include <IOKit/audio/IOAudioControl.h>

//==================================================================================================

//  ARStereoPanControl

//==================================================================================================

class ARStereoPanControl

:

    public IOAudioControl

{

//  Constants

public:

    enum

    {

        kIOAudioControlTypeStereoPan    = 'span',

        kIOAudioControlSubTypeStereoPan = 'span'

    };

    #define kIOAudioStereoPanControlFullLeftValueKey    "IOAudioStereoPanControlFullLeftValue"

    #define kIOAudioStereoPanControlCenterValueKey      "IOAudioStereoPanControlCenterValue"

    #define kIOAudioStereoPanControlFullRightValueKey   "IOAudioStereoPanControlFullRightValue"

    #define kIOAudioStereoPanControlLeftChannelKey      "IOAudioStereoPanControlLeftChannel"

    #define kIOAudioStereoPanControlRightChannelKey     "IOAudioStereoPanControlRightChannel"

//  Construction/Destruction

    OSDeclareDefaultStructors(ARStereoPanControl)

public:

    virtual bool                init(SInt32 inCurrentValue, SInt32 inFullLeftValue, SInt32 inCenterValue, SInt32 inFullRightValue, UInt32 inLeftChannelNumber, UInt32 inRightChannelNumber, UInt32 inChannelID, const char* inChannelName = NULL, UInt32 inControlID = 0, UInt32 inSubType = 0, UInt32 inUsage = 0, OSDictionary* inProperties = NULL);

    virtual void                free();

    static ARStereoPanControl*  create(SInt32 inCurrentValue, SInt32 inFullLeftValue, SInt32 inCenterValue, SInt32 inFullRightValue, UInt32 inLeftChannelNumber, UInt32 inRightChannelNumber, UInt32 inChannelID, const char* inChannelName = NULL, UInt32 inControlID = 0, UInt32 inSubType = 0, UInt32 inUsage = 0);

//  Attributes

public:

    virtual SInt32              getFullLeftValue();

    virtual void                setFullLeftValue(SInt32 inFullLeftValue);

    virtual SInt32              getCenterValue();

    virtual void                setCenterValue(SInt32 inCenterValue);

    virtual SInt32              getFullRightValue();

    virtual void                setFullRightValue(SInt32 inFullRightValue);

    virtual UInt32              getLeftChannelNumber();

    virtual void                setLeftChannelNumber(UInt32 inLeftChannelNumber);

    virtual UInt32              getRightChannelNumber();

    virtual void                setRightChannelNumber(UInt32 inRightChannelNumber);

//  Operations

public:

    virtual IOReturn            validateValue(OSObject* inNewValue);

//  Implementation

private:

    SInt32                      mFullLeftValue;

    SInt32                      mCenterValue;

    SInt32                      mFullRightValue;

    UInt32                      mLeftChannelNumber;

    UInt32                      mRightChannelNumber;

};

#endif