ap_temi.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (c) 2020 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright (c) 2020 Ocean Blue Software Ltd
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 *
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 *
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
/* pre-processor mechanism so multiple inclusions don't cause compilation error*/

#ifndef _AP_TEMI_H
#define _AP_TEMI_H

#include "techtype.h"

/*---Constant and macro definitions for public use-----------------------------*/
#define TEMI_FILTER_INVALID       0xffff

/*---Enumerations for public use-----------------------------------------------*/

typedef enum
{
   TEMI_NOTIFICATION_AVAILABLE = 0,
   TEMI_NOTIFICATION_DISAPPEARED,
   TEMI_NOTIFICATION_PAUSED
} E_TEMI_NOTIFICATION_TYPE;

/*---Global type defs for public use-------------------------------------------*/

typedef void (*TEMI_CALLBACK)(U16BIT pfilt_id, E_TEMI_NOTIFICATION_TYPE type);

typedef struct
{
   U64BIT pts;
   U32BIT timescale;
   U64BIT media_timestamp;
} S_TEMI_TIMESTAMP;


/*---Global Function prototypes for public use---------------------------------*/

void TEMI_Initialise(void);

void TEMI_Finalise(void);

U16BIT TEMI_StartMonitoring(U8BIT path, U8BIT component_tag, U8BIT timeline_id, TEMI_CALLBACK cb);

void TEMI_StopMonitoring(U16BIT filt_id);

S_TEMI_TIMESTAMP TEMI_GetCurrentTimestamp(U16BIT filt_id);

#endif /*  _AP_TEMI_H */