frame_definitions.h

/*
 * BSD 3-Clause License
 *
 * Copyright (c) 2019, Analog Devices, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef FRAME_DEFINITIONS_H
#define FRAME_DEFINITIONS_H

#include <iostream>
#include <string>
#include <vector>

namespace aditof {

struct FrameDataDetails {
    std::string type;

    unsigned int width;

    unsigned int height;

    unsigned int subelementSize;

    unsigned int subelementsPerElement;

    unsigned int bytesCount;
};

struct FrameDetails {
    std::string type;

    std::vector<FrameDataDetails> dataDetails;

    std::string cameraMode;

    unsigned int width;

    unsigned int height;

    uint8_t totalCaptures;

    bool passiveIRCaptured;
};

struct Point3I {
    int16_t a; 
    int16_t b; 
    int16_t c; 
};

#pragma pack(push, 1)

struct Metadata {

    uint16_t width;

    uint16_t height;

    uint8_t outputConfiguration;

    uint8_t bitsInDepth;

    uint8_t bitsInAb;

    uint8_t bitsInConfidence;

    uint16_t invalidPhaseValue;

    uint8_t frequencyIndex;

    uint8_t abFrequencyIndex;

    uint32_t frameNumber;

    uint8_t imagerMode;

    uint8_t numberOfPhases;

    uint8_t numberOfFrequencies;

    uint8_t xyzEnabled;

    uint32_t elapsedTimeFractionalValue;

    uint32_t elapsedTimeSecondsValue;

    int32_t sensorTemperature;

    int32_t laserTemperature;
};
#pragma pack(pop)

inline std::ostream &operator<<(std::ostream &o, const struct Metadata &meta) {
    o << "\tWidth: " << meta.width << "\tHeight: " << meta.height
      << "\tOutputConfiguration: "
      << static_cast<unsigned int>(meta.outputConfiguration)
      << "\tBitsInDepth: " << static_cast<unsigned int>(meta.bitsInDepth)
      << "\tBitsInAb: " << static_cast<unsigned int>(meta.bitsInAb)
      << "\tBitsInConfidenc: "
      << static_cast<unsigned int>(meta.bitsInConfidence)
      << "\tInvalidPhaseValue: " << meta.invalidPhaseValue
      << "\tFrequencyIndex: " << static_cast<unsigned int>(meta.frequencyIndex)
      << "\tFrameNumber: " << meta.frameNumber
      << "\tImagerMode: " << static_cast<unsigned int>(meta.imagerMode)
      << "\tNumberOfPhases: " << static_cast<unsigned int>(meta.numberOfPhases)
      << "\tNumberOfFrequencies: "
      << static_cast<unsigned int>(meta.numberOfFrequencies)
      << "\tXYZEnabled: " << static_cast<unsigned int>(meta.xyzEnabled)
      << "\tElapsedTimeFractionalValue: " << meta.elapsedTimeFractionalValue
      << "\tElapsedTimeSecondsValue: " << meta.elapsedTimeSecondsValue
      << "\tSensorTemperature: " << meta.sensorTemperature
      << "\tLaserTemperature: " << meta.laserTemperature << "\n";
    return o;
}

} // namespace aditof

#endif // FRAME_DEFINITIONS_H