Audio_Structures.h

Go to the documentation of this file.

#ifndef AUDIO_STRUCTURES_H_
#define AUDIO_STRUCTURES_H_

#include <stdint.h>

#pragma                         pack(push,1)

/**
 * \author fsimeone
 */

struct DAQ_Common_Header
{
        uint32_t                Frame_Length;                                           //The length of the complete frame in bytes (including the header). This field is created in the DataQueue.
        uint32_t                Data_Type;
        uint32_t                Detector_Identifier;
        uint32_t                Run_Number;                                                     //Number of the run. Inherited from CLB Common Header.
        uint32_t                Sequence_Number;                                        //Sequence number of the frame in the current run.
        uint32_t                Time_Stamp_seconds;                                     //UTC timestamp of Frame start, seconds counted since 1.1.1970 00:00:00.
        uint32_t                Time_Stamp_ticks;                                       //UTC timestamp of Frame start, 16 nanosecond-ticks.
        uint32_t                DOM_Identifier;                                         //Identifier of the DOM at the DataQueue level - inherited from CLB Common Header - and detector subset at the DataFilter/DataWriter level.
        uint32_t                DQ_Status;
        uint32_t                DOM_Status1;
        uint32_t                DOM_Status2;
        uint32_t                DOM_Status3;
        uint32_t                DOM_Status4;
        uint32_t                Number_of_Items;                                        //number of hits (optical) or audio words/time of arrival data (acoustical)
};

struct Info_Word
{
        union Info_Word_Bitfield
        {
                struct
                {
                        unsigned                Reserved                                :3;
                        unsigned                Amplitude_Resolution    :2; //Amplitude Resolution (0 = 12 bit; 1 = 16 bit; 2 = 24 bit)
                        unsigned                ChannelsSent                    :2; //Channels sent (0 = both; 1 = ch1; 2 = ch2)
                        unsigned                Fixed                                   :1;     //“1”: mark the info word
                }                                       Bits;
                uint8_t                         Valore;
        }                               Info;
        uint8_t                 Samplig_Rate;                                           //Sampling rate: main clock in MHz; the sampling frequency is SR / 128 (25 MHz / 128 = 195.3 kHz, for example)
        uint32_t                Time_Info;                                                      //Time between Frame start and the time of the acquisition of the first audio data of the current Frame.(16 ns ticks)
};

struct Audio_Header
{
        DAQ_Common_Header       Common_Header;
        Info_Word                       Info;
};

union Audio_Word_Info
{
        struct
        {
                unsigned                Reserved                                :2;
                unsigned                Start_Frame                             :1;     //Indicates the first AES3 frame of a AES3 block
                unsigned                Locked                                  :1;     //Indicates that the AES3 decoding module on the CLB is properly locked with the incoming stream
                unsigned                Parity_Error                    :1;     //Parity error of the decoded AES3 frame
                unsigned                Validity_Channel_2              :1;     //Valid bit of channel 0 incoming from the acoustic device (0 = ok)
                unsigned                Validity_Channel_1              :1;             //Valid bit of channel 1 incoming from the acoustic device (0 = ok)
                unsigned                Fixed                                   :1;     //“0”: mark the data word
        }                                       Bits;
        uint8_t                         Valore;
};

struct Audio_Time
{
        uint32_t                Time_Stamp_seconds;                                     //UTC timestamp of Frame start, seconds counted since 1.1.1970 00:00:00.
        uint32_t                Time_Stamp_ticks;                                       //UTC timestamp of Frame start, 16 nanosecond-ticks plus Time between Frame start and the time of the acquisition of the first audio data of the current Frame.(16 ns ticks)
};

struct Acoustic_Time_of_Arrival
{
        uint8_t                 Channel;
        uint8_t                 Resolution;
        uint8_t                 Sampling_Rate;
        uint8_t                 Reserved;
        uint32_t                Emitter_ID;
        uint32_t                ToA;                                                            //Time of arrival of the signal emitted by the emitter in microseconds
        uint32_t                Quality_Factor;
};

struct ToA_Packet
{
        DAQ_Common_Header                       Header;
        Acoustic_Time_of_Arrival        Time;
};

#pragma                         pack(pop)

#define AUDIO_PACKET_FIXED_SIZE sizeof(DAQ_Common_Header)+sizeof(Info_Word)

#endif /* AUDIO_STRUCTURES_H_ */