mmal_clock.h

Go to the documentation of this file.

/*
Copyright (c) 2012, Broadcom Europe Ltd
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * 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.
    * 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 MMAL_CLOCK_H
#define MMAL_CLOCK_H

#include "interface/vcos/vcos.h"
#include "mmal_types.h"
#include "mmal_common.h"

#define MMAL_CLOCK_EVENT_MAGIC               MMAL_FOURCC('C','K','L','M')

#define MMAL_CLOCK_EVENT_REFERENCE           MMAL_FOURCC('C','R','E','F')

#define MMAL_CLOCK_EVENT_ACTIVE              MMAL_FOURCC('C','A','C','T')

#define MMAL_CLOCK_EVENT_SCALE               MMAL_FOURCC('C','S','C','A')

#define MMAL_CLOCK_EVENT_TIME                MMAL_FOURCC('C','T','I','M')

#define MMAL_CLOCK_EVENT_UPDATE_THRESHOLD    MMAL_FOURCC('C','U','T','H')

#define MMAL_CLOCK_EVENT_DISCONT_THRESHOLD   MMAL_FOURCC('C','D','T','H')

#define MMAL_CLOCK_EVENT_REQUEST_THRESHOLD   MMAL_FOURCC('C','R','T','H')

#define MMAL_CLOCK_EVENT_INPUT_BUFFER_INFO   MMAL_FOURCC('C','I','B','I')
#define MMAL_CLOCK_EVENT_OUTPUT_BUFFER_INFO  MMAL_FOURCC('C','O','B','I')

#define MMAL_CLOCK_EVENT_LATENCY             MMAL_FOURCC('C','L','A','T')

#define MMAL_CLOCK_EVENT_INVALID   0


typedef struct MMAL_CLOCK_UPDATE_THRESHOLD_T
{
   int64_t threshold_lower;

   int64_t threshold_upper;
} MMAL_CLOCK_UPDATE_THRESHOLD_T;

typedef struct MMAL_CLOCK_DISCONT_THRESHOLD_T
{
   int64_t threshold;

   int64_t duration;
} MMAL_CLOCK_DISCONT_THRESHOLD_T;

typedef struct MMAL_CLOCK_REQUEST_THRESHOLD_T
{
   int64_t threshold;

   MMAL_BOOL_T threshold_enable;
} MMAL_CLOCK_REQUEST_THRESHOLD_T;

typedef struct MMAL_CLOCK_BUFFER_INFO_T
{
   int64_t time_stamp;
   uint32_t arrival_time;
} MMAL_CLOCK_BUFFER_INFO_T;

typedef struct MMAL_CLOCK_LATENCY_T
{
   int64_t target;            
   int64_t attack_period;     
   int64_t attack_rate;       
} MMAL_CLOCK_LATENCY_T;

typedef struct MMAL_CLOCK_EVENT_T
{
   uint32_t id;

   uint32_t magic;

   struct MMAL_BUFFER_HEADER_T *buffer;

   uint32_t padding0;

   union
   {
      MMAL_BOOL_T enable;

      MMAL_RATIONAL_T scale;

      int64_t media_time;

      MMAL_CLOCK_UPDATE_THRESHOLD_T update_threshold;

      MMAL_CLOCK_DISCONT_THRESHOLD_T discont_threshold;

      MMAL_CLOCK_REQUEST_THRESHOLD_T request_threshold;

      MMAL_CLOCK_BUFFER_INFO_T buffer;

      MMAL_CLOCK_LATENCY_T latency;
   } data;

   uint64_t padding1;
} MMAL_CLOCK_EVENT_T;

/* Make sure MMAL_CLOCK_EVENT_T will preserve 64-bit alignment */
vcos_static_assert(!(sizeof(MMAL_CLOCK_EVENT_T) & 0x7));

#define MMAL_CLOCK_EVENT_INIT(id) { id, MMAL_CLOCK_EVENT_MAGIC, NULL, 0, {0}, 0 }

#endif /* MMAL_CLOCK_H */