audiomanagertypes.h

Go to the documentation of this file.

#if !defined(EA_E0F066FD_E6D8_4ca9_84C3_D0C02AF09BF8__INCLUDED_)
#define EA_E0F066FD_E6D8_4ca9_84C3_D0C02AF09BF8__INCLUDED_

#include <stdint.h>
#include <string>
#include <vector>

//for c, we need the static in front of the constants, for c++ the compiler cannot optimize
//so we need the macro here

#if defined __cplusplus
#define A_CONST const
#else
#define A_CONST static const
#endif


namespace am {

typedef uint16_t am_domainID_t;

typedef uint16_t am_crossfaderID_t;

typedef uint16_t am_connectionID_t;

typedef uint16_t am_sourceID_t;

typedef uint16_t am_sinkID_t;

typedef uint16_t am_converterID_t;

typedef uint16_t am_gatewayID_t;

typedef uint16_t am_mainConnectionID_t;

typedef uint16_t am_speed_t;

typedef int16_t am_volume_t;
A_CONST am_volume_t AM_MUTE = -3000;

typedef int16_t am_mainVolume_t;

typedef uint16_t am_sourceClass_t;

typedef uint16_t am_sinkClass_t;

typedef uint16_t am_time_t;

typedef int16_t am_timeSync_t;

typedef uint16_t am_CustomAvailabilityReason_t;
A_CONST am_CustomAvailabilityReason_t AR_UNKNOWN = 0;
A_CONST am_CustomAvailabilityReason_t AR_GENIVI_NEWMEDIA = 1;
A_CONST am_CustomAvailabilityReason_t AR_GENIVI_SAMEMEDIA = 2;
A_CONST am_CustomAvailabilityReason_t AR_GENIVI_NOMEDIA = 3;
A_CONST am_CustomAvailabilityReason_t AR_GENIVI_TEMPERATURE = 4;
A_CONST am_CustomAvailabilityReason_t AR_GENIVI_VOLTAGE = 5;
A_CONST am_CustomAvailabilityReason_t AR_GENIVI_ERRORMEDIA = 6;

typedef uint16_t am_CustomClassProperty_t;
A_CONST am_CustomClassProperty_t CP_UNKNOWN = 0;
A_CONST am_CustomClassProperty_t CP_GENIVI_SOURCE_TYPE = 1;
A_CONST am_CustomClassProperty_t CP_GENIVI_SINK_TYPE = 2;

typedef uint16_t am_CustomConnectionFormat_t;
A_CONST am_CustomConnectionFormat_t CF_UNKNOWN = 0;
A_CONST am_CustomConnectionFormat_t CF_GENIVI_MONO = 1;
A_CONST am_CustomConnectionFormat_t CF_GENIVI_STEREO = 2;
A_CONST am_CustomConnectionFormat_t CF_GENIVI_ANALOG = 3;
A_CONST am_CustomConnectionFormat_t CF_GENIVI_AUTO = 4;

typedef uint16_t am_CustomMainSoundPropertyType_t;
A_CONST am_CustomMainSoundPropertyType_t MSP_UNKNOWN = 0;
A_CONST am_CustomMainSoundPropertyType_t MSP_GENIVI_TREBLE = 1;
A_CONST am_CustomMainSoundPropertyType_t MSP_GENIVI_MID = 2;
A_CONST am_CustomMainSoundPropertyType_t MSP_GENIVI_BASS = 3;

typedef uint16_t am_CustomNotificationType_t;
A_CONST am_CustomNotificationType_t NT_UNKNOWN = 0;

typedef uint16_t am_CustomRampType_t;
A_CONST am_CustomRampType_t RAMP_UNKNOWN = 0;
A_CONST am_CustomRampType_t RAMP_GENIVI_DIRECT = 1;
A_CONST am_CustomRampType_t RAMP_GENIVI_NO_PLOP = 2;
A_CONST am_CustomRampType_t RAMP_GENIVI_EXP_INV = 3;
A_CONST am_CustomRampType_t RAMP_GENIVI_LINEAR = 4;
A_CONST am_CustomRampType_t RAMP_GENIVI_EXP = 5;

typedef uint16_t am_CustomSoundPropertyType_t;
A_CONST am_CustomSoundPropertyType_t SP_UNKNOWN = 0;
A_CONST am_CustomSoundPropertyType_t SP_GENIVI_TREBLE = 1;
A_CONST am_CustomSoundPropertyType_t SP_GENIVI_MID = 2;
A_CONST am_CustomSoundPropertyType_t SP_GENIVI_BASS = 3;

typedef uint16_t am_CustomSystemPropertyType_t;
A_CONST am_CustomSystemPropertyType_t SYP_UNKNOWN = 0;

enum am_HotSink_e
{
    HS_UNKNOWN = 0,
    HS_SINKA = 1,
    HS_SINKB = 2,
    HS_INTERMEDIATE = 3,
    HS_MAX
};

enum am_Availability_e
{
    A_UNKNOWN = 0,
    A_AVAILABLE = 1,
    A_UNAVAILABLE = 2,
    A_MAX
};

enum am_ConnectionState_e
{
    CS_UNKNOWN = 0,
    CS_CONNECTING = 1,
    CS_CONNECTED = 2,
    CS_DISCONNECTING = 3,
    CS_DISCONNECTED = 4,
    CS_SUSPENDED = 5,
    CS_MAX
};

enum am_DomainState_e
{
    DS_UNKNOWN = 0,
    DS_CONTROLLED = 1,
    DS_INDEPENDENT_STARTUP = 2,
    DS_INDEPENDENT_RUNDOWN = 3,
    DS_MAX
};

enum am_EarlyDataType_e
{
    ES_UNKNOWN = 0,
    ED_SOURCE_VOLUME = 1,
    ED_SINK_VOLUME = 2,
    ED_SOURCE_PROPERTY = 3,
    ED_SINK_PROPERTY = 4,
    ED_INTERRUPT_STATE = 5,
    ED_MAX
};

enum am_Error_e
{
    E_OK = 0,
    E_UNKNOWN = 1,
    E_OUT_OF_RANGE = 2,
    E_NOT_USED = 3,
    E_DATABASE_ERROR = 4,
    E_ALREADY_EXISTS = 5,
    E_NO_CHANGE = 6,
    E_NOT_POSSIBLE = 7,
    E_NON_EXISTENT = 8,
    E_ABORTED = 9,
    E_WRONG_FORMAT = 10,
    E_COMMUNICATION = 11,
    E_MAX
};

enum am_MuteState_e
{
    MS_UNKNOWN = 0,
    MS_MUTED = 1,
    MS_UNMUTED = 2,
    MS_MAX
};

enum am_SourceState_e
{
    SS_UNKNNOWN = 0,
    SS_ON = 1,
    SS_OFF = 2,
    SS_PAUSED = 3,
    SS_MAX
};

enum am_Handle_e
{
    H_UNKNOWN = 0,
    H_CONNECT = 1,
    H_DISCONNECT = 2,
    H_SETSOURCESTATE = 3,
    H_SETSINKVOLUME = 4,
    H_SETSOURCEVOLUME = 5,
    H_SETSINKSOUNDPROPERTY = 6,
    H_SETSOURCESOUNDPROPERTY = 7,
    H_SETSINKSOUNDPROPERTIES = 8,
    H_SETSOURCESOUNDPROPERTIES = 9,
    H_CROSSFADE = 10,
    H_SETVOLUMES = 11,
    H_SETSINKNOTIFICATION = 12,
    H_SETSOURCENOTIFICATION = 13,
    H_MAX
};

enum am_InterruptState_e
{
    IS_UNKNOWN = 0,
    IS_OFF = 1,
    IS_INTERRUPTED = 2,
    IS_MAX
};

enum am_VolumeType_e
{
    VT_UNKNOWN = 0,
    VT_SINK = 1,
    VT_SOURCE = 2,
    VT_MAX
};

enum am_NotificationStatus_e
{
    NS_UNKNOWN = 0,
    NS_OFF = 1,
    NS_PERIODIC = 2,
    NS_MINIMUM = 3,
    NS_MAXIMUM = 4,
    NS_CHANGE  = 5,
    NS_MAX
};

struct am_Availability_s
{

public:
    am_Availability_e availability;
    am_CustomAvailabilityReason_t availabilityReason;

};

struct am_ClassProperty_s
{

public:
    am_CustomClassProperty_t classProperty;
    int16_t value;

};

struct am_Crossfader_s
{

public:
    am_crossfaderID_t crossfaderID;
    std::string name;
    am_sinkID_t sinkID_A;
    am_sinkID_t sinkID_B;
    am_sourceID_t sourceID;
    am_HotSink_e hotSink;

};

struct am_Converter_s
{

public:
    am_converterID_t converterID;
    std::string name;
    am_sinkID_t sinkID;
    am_sourceID_t sourceID;
    am_domainID_t domainID;
    std::vector<am_CustomConnectionFormat_t> listSourceFormats;
    std::vector<am_CustomConnectionFormat_t> listSinkFormats;
    std::vector<bool> convertionMatrix;

};

struct am_Gateway_s
{

public:
    am_gatewayID_t gatewayID;
    std::string name;
    am_sinkID_t sinkID;
    am_sourceID_t sourceID;
    am_domainID_t domainSinkID;
    am_domainID_t domainSourceID;
    am_domainID_t controlDomainID;
    std::vector<am_CustomConnectionFormat_t> listSourceFormats;
    std::vector<am_CustomConnectionFormat_t> listSinkFormats;
    std::vector<bool> convertionMatrix;

};

struct am_RoutingElement_s
{

public:
    am_sourceID_t sourceID;
    am_sinkID_t sinkID;
    am_domainID_t domainID;
    am_CustomConnectionFormat_t connectionFormat;

};

struct am_Route_s
{

public:
    am_sourceID_t sourceID;
    am_sinkID_t sinkID;
    std::vector<am_RoutingElement_s> route;

};

struct am_SoundProperty_s
{

public:
    am_CustomSoundPropertyType_t type;
    int16_t value;

};

struct am_SystemProperty_s
{

public:
    am_CustomSystemPropertyType_t type;
    int16_t value;

};

struct am_SinkClass_s
{

public:
    am_sinkClass_t sinkClassID;
    std::string name;
    std::vector<am_ClassProperty_s> listClassProperties;

};

struct am_SourceClass_s
{

public:
    am_sourceClass_t sourceClassID;
    std::string name;
    std::vector<am_ClassProperty_s> listClassProperties;

};

struct am_SourceType_s
{

public:
    am_sourceID_t sourceID;
    std::string name;
    am_Availability_s availability;
    am_sourceClass_t sourceClassID;

};

struct am_SinkType_s
{

public:
    am_sinkID_t sinkID;
    std::string name;
    am_Availability_s availability;
    am_mainVolume_t volume;
    am_MuteState_e muteState;
    am_sinkClass_t sinkClassID;

};

struct am_Handle_s
{

public:
    am_Handle_e handleType:6;
    uint16_t handle:10;
};

struct am_MainSoundProperty_s
{

public:
    am_CustomMainSoundPropertyType_t type;
    int16_t value;

};

struct am_MainConnectionType_s
{

public:
    am_mainConnectionID_t mainConnectionID;
    am_sourceID_t sourceID;
    am_sinkID_t sinkID;
    am_timeSync_t delay;
    am_ConnectionState_e connectionState;

};

struct am_MainConnection_s
{

public:
    am_mainConnectionID_t mainConnectionID;
    am_ConnectionState_e connectionState;
    am_sinkID_t sinkID;
    am_sourceID_t sourceID;
    am_timeSync_t delay;
    std::vector<am_connectionID_t> listConnectionID;

};

struct am_NotificationPayload_s
{

public:
    am_CustomNotificationType_t type;
    int16_t value;

};

struct am_NotificationConfiguration_s
{

public:
    am_CustomNotificationType_t type;
    am_NotificationStatus_e status;
    int16_t parameter;

};

struct am_Sink_s
{

public:
    am_sinkID_t sinkID;
    std::string name;
    am_domainID_t domainID;
    am_sinkClass_t sinkClassID;
    am_volume_t volume;
    bool visible;
    am_Availability_s available;
    am_MuteState_e muteState;
    am_mainVolume_t mainVolume;
    std::vector<am_SoundProperty_s> listSoundProperties;
    std::vector<am_CustomConnectionFormat_t> listConnectionFormats;
    std::vector<am_MainSoundProperty_s> listMainSoundProperties;
    std::vector<am_NotificationConfiguration_s> listMainNotificationConfigurations;
    std::vector<am_NotificationConfiguration_s> listNotificationConfigurations;

};

struct am_Source_s
{

public:
    am_sourceID_t sourceID;
    am_domainID_t domainID;
    std::string name;
    am_sourceClass_t sourceClassID;
    am_SourceState_e sourceState;
    am_volume_t volume;
    bool visible;
    am_Availability_s available;
    am_InterruptState_e interruptState;
    std::vector<am_SoundProperty_s> listSoundProperties;
    std::vector<am_CustomConnectionFormat_t> listConnectionFormats;
    std::vector<am_MainSoundProperty_s> listMainSoundProperties;
    std::vector<am_NotificationConfiguration_s> listMainNotificationConfigurations;
    std::vector<am_NotificationConfiguration_s> listNotificationConfigurations;

};

struct am_Domain_s
{

public:
    am_domainID_t domainID;
    std::string name;
    std::string busname;
    std::string nodename;
    bool early;
    bool complete;
    am_DomainState_e state;

};

struct am_Connection_s
{

public:
    am_connectionID_t connectionID;
    am_sourceID_t sourceID;
    am_sinkID_t sinkID;
    am_timeSync_t delay;
    am_CustomConnectionFormat_t connectionFormat;

};

union am_EarlyData_u
{

public:
    am_volume_t volume;
    am_SoundProperty_s soundProperty;
    am_InterruptState_e interruptState;

};

union am_DataType_u
{

public:
    am_sinkID_t sink;
    am_sourceID_t source;

};

struct am_EarlyData_s
{

public:
    am_EarlyDataType_e type;
    am_DataType_u sinksource;
    am_EarlyData_u data;

};

struct am_Volumes_s
{

public:
    am_VolumeType_e volumeType;
    am_DataType_u volumeID;
    am_volume_t volume;
    am_CustomRampType_t ramp;
    am_time_t time;

};
}
#endif // !defined(EA_E0F066FD_E6D8_4ca9_84C3_D0C02AF09BF8__INCLUDED_)