pipewire/spa/include/spa/node/command.h

/* Simple Plugin API
 * Copyright (C) 2016 Wim Taymans <wim.taymans@gmail.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef __SPA_COMMAND_NODE_H__
#define __SPA_COMMAND_NODE_H__

#ifdef __cplusplus
extern "C" {
#endif

#include <spa/support/type-map.h>
#include <spa/pod/command.h>

#define SPA_TYPE_COMMAND__Node			SPA_TYPE_COMMAND_BASE "Node"
#define SPA_TYPE_COMMAND_NODE_BASE		SPA_TYPE_COMMAND__Node ":"

#define SPA_TYPE_COMMAND_NODE__Pause		SPA_TYPE_COMMAND_NODE_BASE "Pause"
#define SPA_TYPE_COMMAND_NODE__Start		SPA_TYPE_COMMAND_NODE_BASE "Start"
#define SPA_TYPE_COMMAND_NODE__Flush		SPA_TYPE_COMMAND_NODE_BASE "Flush"
#define SPA_TYPE_COMMAND_NODE__Drain		SPA_TYPE_COMMAND_NODE_BASE "Drain"
#define SPA_TYPE_COMMAND_NODE__Marker		SPA_TYPE_COMMAND_NODE_BASE "Marker"
#define SPA_TYPE_COMMAND_NODE__ClockUpdate	SPA_TYPE_COMMAND_NODE_BASE "ClockUpdate"

struct spa_type_command_node {
	uint32_t Pause;
	uint32_t Start;
	uint32_t Flush;
	uint32_t Drain;
	uint32_t Marker;
	uint32_t ClockUpdate;
};

static inline void
spa_type_command_node_map(struct spa_type_map *map, struct spa_type_command_node *type)
{
	if (type->Pause == 0) {
		type->Pause = spa_type_map_get_id(map, SPA_TYPE_COMMAND_NODE__Pause);
		type->Start = spa_type_map_get_id(map, SPA_TYPE_COMMAND_NODE__Start);
		type->Flush = spa_type_map_get_id(map, SPA_TYPE_COMMAND_NODE__Flush);
		type->Drain = spa_type_map_get_id(map, SPA_TYPE_COMMAND_NODE__Drain);
		type->Marker = spa_type_map_get_id(map, SPA_TYPE_COMMAND_NODE__Marker);
		type->ClockUpdate = spa_type_map_get_id(map, SPA_TYPE_COMMAND_NODE__ClockUpdate);
	}
}

/**
 * spa_command_node_clock_update:
 * @change_mask: marks which fields are updated
 * @rate: the number of  @ticks per second
 * @ticks: the new ticks, when @change_mask = 1<<0
 * @monotonic_time: the new monotonic time in nanoseconds associated with
 *                  @ticks, when @change_mask = 1<<0
 * @offset: the difference between the time when this update was generated
 *          and @monotonic_time in nanoseconds
 * @scale: update to the speed stored as Q16.16, @change_mask = 1<<1
 * @state: the new clock state, when @change_mask = 1<<2
 */
struct spa_command_node_clock_update_body {
	struct spa_pod_object_body body;
#define SPA_COMMAND_NODE_CLOCK_UPDATE_TIME	(1 << 0)
#define SPA_COMMAND_NODE_CLOCK_UPDATE_SCALE	(1 << 1)
#define SPA_COMMAND_NODE_CLOCK_UPDATE_STATE	(1 << 2)
#define SPA_COMMAND_NODE_CLOCK_UPDATE_LATENCY	(1 << 3)
	struct spa_pod_int change_mask		SPA_ALIGNED(8);
	struct spa_pod_int rate			SPA_ALIGNED(8);
	struct spa_pod_long ticks		SPA_ALIGNED(8);
	struct spa_pod_long monotonic_time	SPA_ALIGNED(8);
	struct spa_pod_long offset		SPA_ALIGNED(8);
	struct spa_pod_int scale		SPA_ALIGNED(8);
	struct spa_pod_int state		SPA_ALIGNED(8);
#define SPA_COMMAND_NODE_CLOCK_UPDATE_FLAG_LIVE	(1 << 0)
	struct spa_pod_int flags		SPA_ALIGNED(8);
	struct spa_pod_long latency		SPA_ALIGNED(8);
};

struct spa_command_node_clock_update {
	struct spa_pod pod;
	struct spa_command_node_clock_update_body body;
};

#define SPA_COMMAND_NODE_CLOCK_UPDATE_INIT(type,change_mask,rate,ticks,monotonic_time,offset,scale,state,flags,latency)  \
	SPA_COMMAND_INIT_COMPLEX(struct spa_command_node_clock_update,			\
			sizeof(struct spa_command_node_clock_update_body), type,	\
			SPA_POD_INT_INIT(change_mask),					\
			SPA_POD_INT_INIT(rate),						\
			SPA_POD_LONG_INIT(ticks),					\
			SPA_POD_LONG_INIT(monotonic_time),				\
			SPA_POD_LONG_INIT(offset),					\
			SPA_POD_INT_INIT(scale),					\
			SPA_POD_INT_INIT(state),					\
			SPA_POD_INT_INIT(flags),					\
			SPA_POD_LONG_INIT(latency))

#ifdef __cplusplus
}  /* extern "C" */
#endif

#endif /* _SPA_COMMAND_NODE_H__ */