openavb_avtp_time_pub.h

Go to the documentation of this file.

/*************************************************************************************************************
Copyright (c) 2012-2015, Symphony Teleca Corporation, a Harman International Industries, Incorporated company
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.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS LISTED "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 OWNER OR CONTRIBUTORS LISTED 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.
 
Attributions: The inih library portion of the source code is licensed from 
Brush Technology and Ben Hoyt - Copyright (c) 2009, Brush Technology and Copyright (c) 2009, Ben Hoyt. 
Complete license and copyright information can be found at 
https://github.com/benhoyt/inih/commit/74d2ca064fb293bc60a77b0bd068075b293cf175.
*************************************************************************************************************/

/*
* HEADER SUMMARY : AVTP Time public interface
*/

#ifndef OPENAVB_AVTP_TIME_PUB_H
#define OPENAVB_AVTP_TIME_PUB_H 1

#include "openavb_platform_pub.h"
#include "openavb_types_pub.h"

typedef struct timespec timespec_t;

typedef struct {
    U64 timeNsec;

    U64 maxLatencyNsec;

    bool bTimestampValid;

    bool bTimestampUncertain;
} avtp_time_t;


avtp_time_t * openavbAvtpTimeCreate(U32 maxLatencyUsec);

void openavbAvtpTimeDelete(avtp_time_t *pAvtpTime);

void openavbAvtpTimeSetToWallTime(avtp_time_t *pAvtpTime);

void openavbAvtpTimeSetToSystemTime(avtp_time_t *pAvtpTime);

void openavbAvtpTimeSetToTimestamp(avtp_time_t *pAvtpTime, U32 timestamp);

void openavbAvtpTimeSetToTimespec(avtp_time_t *pAvtpTime, timespec_t* timestamp);

void openavbAvtpTimePushMCR(avtp_time_t *pAvtpTime, U32 timestamp);

void openavbAvtpTimeSetTimestampValid(avtp_time_t *pAvtpTime, bool validFlag);

void openavbAvtpTimeSetTimestampUncertain(avtp_time_t *pAvtpTime, bool uncertainFlag);

void openavbAvtpTimeAddUSec(avtp_time_t *pAvtpTime, long uSec);

void openavbAvtpTimeAddNSec(avtp_time_t *pAvtpTime, long nSec);

void openavbAvtpTimeSubUSec(avtp_time_t *pAvtpTime, long uSec);

void openavbAvtpTimeSubNSec(avtp_time_t *pAvtpTime, long nSec);

U32 openavbAvtpTimeGetAvtpTimestamp(avtp_time_t *pAvtpTime);

U64 openavbAvtpTimeGetAvtpTimeNS(avtp_time_t *pAvtpTime);

bool openavbAvtpTimeTimestampIsValid(avtp_time_t *pAvtpTime);

bool openavbAvtpTimeTimestampIsUncertain(avtp_time_t *pAvtpTime);

bool openavbAvtpTimeIsPast(avtp_time_t *pAvtpTime);

bool openavbAvtpTimeIsPastTime(avtp_time_t *pAvtpTime, U64 nSecTime);

bool openavbAvtpTimeUsecTill(avtp_time_t *pAvtpTime, U32 *pUsecTill);

S32 openavbAvtpTimeUsecDelta(avtp_time_t *pAvtpTime);

#endif  // OPENAVB_AVTP_TIME_PUB_H