DAFFDefs.h

Go to the documentation of this file.

/*
 * -------------------------------------------------------------------------------------
 *
 *  OpenDAFF - A free, open source software package for directional audio data
 *  Copyright 2016 Institute of Technical Acoustics, RWTH Aachen University
 *  OpenDAFF is distributed under the Apache License Version 2.0.
 *
 *  ------------------------------------------------------------------------------------
 *
 */

#ifndef IW_DAFF_DEFS
#define IW_DAFF_DEFS

// Import/export directives
#ifdef WIN32
    // Windows DLL
    #ifdef DAFF_DLL
        #ifdef DAFF_DLL_EXPORTS
            #define DAFF_API __declspec(dllexport)
        #else
            #define DAFF_API __declspec(dllimport)
        #endif
    #endif
#endif

// Default directive: None
#ifndef DAFF_API
    #define DAFF_API
#endif

#include <string>
#include <sstream>

// Define necessary typedef from stdint.h for Microsoft compilers before Visual C++ 2010
#if _MSC_VER < 1600

#ifdef WIN32
typedef __int8 int8_t;
typedef __int16 int16_t;
typedef __int32 int32_t;
typedef __int64 int64_t;

typedef unsigned __int8 uint8_t;
typedef unsigned __int16 uint16_t;
typedef unsigned __int32 uint32_t;
typedef unsigned __int64 uint64_t;
#endif

#else

// On GNU-platforms include stdint.h automatically
#include <stdint.h>

#endif // _MSC_VER

// Define NULL if it is not present
#ifndef NULL
#define NULL 0
#endif // NULL


enum DAFF_CONTENT_TYPES
{
    DAFF_IMPULSE_RESPONSE           =0, 
    DAFF_MAGNITUDE_SPECTRUM         =1, 
    DAFF_PHASE_SPECTRUM             =2, 
    DAFF_MAGNITUDE_PHASE_SPECTRUM   =3, 
    DAFF_DFT_SPECTRUM               =4, 
};


enum DAFF_QUANTIZATIONS
{
    DAFF_INT16      =0, 
    DAFF_INT24      =1, 
    DAFF_FLOAT32    =2, 
};


enum DAFF_VIEWS
{
    DAFF_DATA_VIEW      =0, 
    DAFF_OBJECT_VIEW    =1, 
};


enum DAFF_ERROR 
{
    DAFF_NO_ERROR       =0,                 

    DAFF_MODAL_ERROR    = 10001,            
    DAFF_FILE_INVALID,                      
    DAFF_FILE_INVALID_MAIN_PARAMETER,       
    DAFF_FILE_CONTENT_TYPE_UNKOWN,          
    DAFF_FILE_ALPHA_ANGLES_INVALID,         
    DAFF_FILE_BETA_ANGLES_INVALID,          
    DAFF_FILE_QUANTIZATION_UNKOWN,          
    DAFF_FILE_FORMAT_VERSION_UNSUPPORTED,   
    DAFF_FILE_CONTENT_INVALID_PARAMETER,    
    DAFF_FILE_NOT_FOUND,                    
    DAFF_FILE_UNKOWN_METADATA_TYPE,         
    DAFF_FILE_CORRUPTED,                    
    DAFF_INVALID_INDEX,                     
};


struct DAFF_API DAFFVersion
{
    int iVersionMajor;      
    int iVersionMinor;      
    std::string sVersion;   
};


struct DAFF_API DAFFQuad
{
    int iIndex1; 
    int iIndex2; 
    int iIndex3; 
    int iIndex4; 
};



class DAFF_API DAFFOrientationYPR
{
public:
    float fYawAngleDeg;     
    float fPitchAngleDeg;   
    float fRollAngleDeg;    

    inline DAFFOrientationYPR()
        : fYawAngleDeg(0)
        , fPitchAngleDeg(0)
        , fRollAngleDeg(0)
    {};


    inline DAFFOrientationYPR(float fInitYawAngleDeg, float fInitPitchAngleDeg, float fInitRollAngleDeg)
        : fYawAngleDeg(fInitYawAngleDeg)
        , fPitchAngleDeg(fInitPitchAngleDeg)
        , fRollAngleDeg(fInitRollAngleDeg)
    {};


    inline std::string toString() const
    {
        std::stringstream ss;
        // Note: \xF8 => Degree sign
        ss << "( Y" << fYawAngleDeg << "\xF8, P" << fPitchAngleDeg << "\xF8, R" << fRollAngleDeg << "\xF8 )";
        return ss.str();
    };
};

#endif // IW_DAFF_DEFS