OpenDAFF C++ API  v1.7
Directional Audio File Format
Classes | Macros | Enumerations
DAFFDefs.h File Reference
#include <string>
#include <sstream>

Go to the source code of this file.

Classes

struct  DAFFVersion
 Pure data class that covers version information. More...
 
struct  DAFFQuad
 Pure data class that describes the points of a quad by their indices and coordinates. More...
 
class  DAFFOrientationYPR
 Data class for orientations in yaw-pitch-roll (YPR) angles (right-handed OpenGL coordinate system) More...
 

Macros

#define DAFF_API
 
#define NULL   0
 

Enumerations

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
}
 Content types. More...
 
enum  DAFF_QUANTIZATIONS { DAFF_INT16 =0, DAFF_INT24 =1, DAFF_FLOAT32 =2 }
 Quantization modes. More...
 
enum  DAFF_VIEWS { DAFF_DATA_VIEW =0, DAFF_OBJECT_VIEW =1 }
 Views on the data (special spherical coordinate system) More...
 
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
}
 Errorcodes. More...
 

Macro Definition Documentation

#define DAFF_API

Definition at line 29 of file DAFFDefs.h.

#define NULL   0

Definition at line 59 of file DAFFDefs.h.

Enumeration Type Documentation

Content types.

Enumerator
DAFF_IMPULSE_RESPONSE 

Impulse response (IR) in the time-domain.

DAFF_MAGNITUDE_SPECTRUM 

Magnitude spectrum defined at discrete frequencies.

DAFF_PHASE_SPECTRUM 

Phase spectrum defined at discrete frequencies.

DAFF_MAGNITUDE_PHASE_SPECTRUM 

Magnitude-phase spectrum defined at discrete frequencies.

DAFF_DFT_SPECTRUM 

Discrete Fourier spectrum in the frequency-domain.

Definition at line 64 of file DAFFDefs.h.

enum DAFF_ERROR

Errorcodes.

Enumerator
DAFF_NO_ERROR 

No error = 0.

DAFF_MODAL_ERROR 

Modal error (e.g. close a file that is not opened)

DAFF_FILE_INVALID 

Invalid DAFF file, i.e. wrong signature.

DAFF_FILE_INVALID_MAIN_PARAMETER 

File has invalid main header parameter (num channels, etc)

DAFF_FILE_CONTENT_TYPE_UNKOWN 

File has unkown content type (IR, MS, DFT, etc)

DAFF_FILE_ALPHA_ANGLES_INVALID 

Invalid alpha angles or range problem.

DAFF_FILE_BETA_ANGLES_INVALID 

Invalid beta angles or range problem.

DAFF_FILE_QUANTIZATION_UNKOWN 

Data uses unrecognized or wrong quantization.

DAFF_FILE_FORMAT_VERSION_UNSUPPORTED 

File format version is not supported by this library version.

DAFF_FILE_CONTENT_INVALID_PARAMETER 

Content parameter invalid (sampling rate, num supporting frequencies, etc)

DAFF_FILE_NOT_FOUND 

File not found.

DAFF_FILE_UNKOWN_METADATA_TYPE 

Given metadata type is unknown, use bool, int, double, string.

DAFF_FILE_CORRUPTED 

Data reading error of an otherwise valid DAFF file.

DAFF_INVALID_INDEX 

Invalid index (e.g. record index)

Definition at line 92 of file DAFFDefs.h.

Quantization modes.

Enumerator
DAFF_INT16 

16-Bit signed integer

DAFF_INT24 

24-Bit signed integer

DAFF_FLOAT32 

32-Bit floating point

Definition at line 75 of file DAFFDefs.h.

enum DAFF_VIEWS

Views on the data (special spherical coordinate system)

Enumerator
DAFF_DATA_VIEW 

Data-related view referring to data spherical coordinates (DSC)

DAFF_OBJECT_VIEW 

Object-related view referring to object spherical coordinates (OSC)

Definition at line 84 of file DAFFDefs.h.

OpenDAFF is a project from the Institute of Technical Acoustics, RWTH Aachen University, Germany.