
/*
 * CINELERRA
 * Copyright (C) 2008-2013 Adam Williams <broadcast at earthling dot net>
 * Copyright (C) 2003-2016 Cinelerra CV contributors
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#ifndef AUTOMATION_H
#define AUTOMATION_H

#include <stdio.h>
#include <stdint.h>

#include "arraylist.h"
#include "autoconf.inc"
#include "automation.inc"
#include "autos.inc"
#include "edl.inc"
#include "filexml.inc"
#include "maxchannels.h"
#include "module.inc"
#include "track.inc"

// Match the clipping at per cinelerra/virtualanode.C which contains:
//  if(fade_value <= INFINITYGAIN) fade_value = 0;
//  in reality, this should be matched to a user-defined minimum in the preferences
#define AUTOMATIONCLAMPS(value, autogrouptype)				\
	if (autogrouptype == AUTOGROUPTYPE_AUDIO_FADE && value <= INFINITYGAIN) \
		value = INFINITYGAIN;					\
	if (autogrouptype == AUTOGROUPTYPE_VIDEO_FADE)			\
		CLAMP(value, 0, 100);					\
	if (autogrouptype == AUTOGROUPTYPE_ZOOM && value < ZOOM_MIN)	\
		value = ZOOM_MIN;					\
	else if (autogrouptype == AUTOGROUPTYPE_SPEED && value < SPEED_MIN) \
		value = SPEED_MIN;

#define AUTOMATIONVIEWCLAMPS(value, autogrouptype)			\
	if (autogrouptype == AUTOGROUPTYPE_ZOOM && value < 0)		\
		value = 0;						\
	else if (autogrouptype == AUTOGROUPTYPE_SPEED && value < SPEED_MIN)	\
		value = SPEED_MIN;


class Automation
{
public:
	static int autogrouptypes_fixedrange[];
	Automation(EDL *edl, Track *track);
	virtual ~Automation();

	static int autogrouptype(int type, Track *track);
	virtual void create_objects();
	void equivalent_output(Automation *automation, int64_t *result);
	virtual Automation& operator=(Automation& automation);
	virtual void copy_from(Automation *automation);
	int load(FileXML *file);
// For copy automation, copy, and save
	int copy(int64_t start,
		int64_t end,
		FileXML *xml,
		int default_only,
		int active_only);
	virtual void dump(FILE *fp);
	virtual int direct_copy_possible(int64_t start, int direction);
	virtual int direct_copy_possible_derived(int64_t start, int direction) { return 1; };
// For paste automation only
	int paste(int64_t start,
		int64_t length,
		double scale,
		FileXML *file,
		int default_only,
		int active_only,
		AutoConf *autoconf);

// Get projector coordinates if this is video automation
	virtual void get_projector(float *x,
		float *y,
		float *z,
		int64_t position,
		int direction);
// Get camera coordinates if this is video automation
	virtual void get_camera(float *x,
		float *y,
		float *z,
		int64_t position,
		int direction);

// Returns the point to restart background rendering at.
// -1 means nothing changed.
	void clear(int64_t start,
		int64_t end,
		AutoConf *autoconf,
		int shift_autos);
	void set_automation_mode(int64_t start,
		int64_t end,
		int mode,
		AutoConf *autoconf);
	void paste_silence(int64_t start, int64_t end);
	void insert_track(Automation *automation,
		int64_t start_unit,
// Pad keyframes to this length.
		int64_t length_units,
		int replace_default);
	void resample(double old_rate, double new_rate);
	int64_t get_length();
	virtual void get_extents(float *min,
		float *max,
		int *coords_undefined,
		int64_t unit_start,
		int64_t unit_end,
		int autogrouptype);





	Autos *autos[AUTOMATION_TOTAL];


	EDL *edl;
	Track *track;
};

#endif
