/*
 * CINELERRA
 * Copyright (C) 2008 Adam Williams <broadcast at earthling dot net>
 *
 * 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 AUTOS_H
#define AUTOS_H

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

// Base class for automation lists.
// Units are the native units for the track data type.

#include "auto.h"
#include "edl.inc"
#include "guicast.h"
#include "filexml.inc"
#include "track.inc"

#define AUTOS_VIRTUAL_HEIGHT 160

class Autos : public List<Auto>
{
public:
	Autos(EDL *edl, Track *track);

	virtual ~Autos();

	void resample(double old_rate, double new_rate);

	virtual void create_objects();
	void equivalent_output(Autos *autos, int64_t startproject, int64_t *result);
	void copy_from(Autos *autos);
	virtual Auto* new_auto();
// Get existing auto on or before position.
// If use_default is true, return default_auto if none exists
// on or before position.
// Return 0 if none exists and use_default is false.
// If &current is nonzero it is used as a starting point for searching.
	Auto* get_prev_auto(int64_t position, int direction, Auto* &current, int use_default = 1);
	Auto* get_prev_auto(int direction, Auto* &current);
	Auto* get_next_auto(int64_t position, int direction, Auto* &current, int use_default = 1);
// Determine if a keyframe exists before creating it.
	int auto_exists_for_editing(double position);
// Returns auto at exact position, null if non-existent. ignores autokeyframming and align on frames
	Auto* get_auto_at_position(double position = -1);

// Get keyframe for editing with automatic creation if enabled
	Auto* get_auto_for_editing(double position = -1);

// Insert keyframe at the point if it doesn't exist
// Interpolate its value if possible
	Auto* insert_auto(int64_t position, Auto *templ=0);
	void insert_track(Autos *automation,
		int64_t start_unit,
		int64_t length_units,
		int replace_default);
	virtual int load(FileXML *xml);
	void remove_nonsequential(Auto *keyframe);
	void optimize();

// Returns a type enumeration
	int get_type();
	int64_t get_length();
	virtual void get_extents(float *min,
		float *max,
		int *coords_undefined,
		int64_t unit_start,
		int64_t unit_end);

	EDL *edl;
	Track *track;
// Default settings if no autos.
// Having a persistent keyframe created problems when files were loaded and
// we wanted to keep only 1 auto.
// Default auto has position 0 except in effects, where multiple default autos
// exist.
	Auto *default_auto;

	int autoidx;
	int autogrouptype;
	int type;
	enum
	{
		AUTOMATION_TYPE_FLOAT,
		AUTOMATION_TYPE_MASK,
		AUTOMATION_TYPE_INT,
		AUTOMATION_TYPE_PAN,
		AUTOMATION_TYPE_PLUGIN
	};



	virtual void dump(FILE *fp);






	int clear_all();
	int insert(int64_t start, int64_t end);
	int paste_silence(int64_t start, int64_t end);
// Copy for keyframe clipboard & drag & drop
// default_only - only copy the default keyframe
	int copy(int64_t start,
		int64_t end,
		FileXML *xml,
		int default_only,
		int active_only);
// Paste for keyframe clipboard & drag & drop
// default_only - only paste the default keyframe
	void paste(int64_t start,
		int64_t length,
		double scale,
		FileXML *file,
		int default_only,
		int active_only);
// Stores the background rendering position in result
	void clear(int64_t start,
		int64_t end,
		int shift_autos);
	virtual void set_automation_mode(int64_t start, int64_t end, int mode);
	int clear_auto(int64_t position);
	int save(FileXML *xml);
	virtual int slope_adjustment(int64_t ax, double slope);
	int release_auto();
	virtual int release_auto_derived() { return 0; }
	Auto* append_auto();
	int scale_time(float rate_scale, int scale_edits, int scale_autos, int64_t start, int64_t end);

// rendering utilities
	int get_neighbors(int64_t start, int64_t end, Auto **before, Auto **after);
// 1 if automation doesn't change
	virtual int automation_is_constant(int64_t start, int64_t end);
	virtual double get_automation_constant(int64_t start, int64_t end);
	int init_automation(int64_t &buffer_position,
				int64_t &input_start,
				int64_t &input_end,
				int &automate,
				double &constant,
				int64_t input_position,
				int64_t buffer_len,
				Auto **before,
				Auto **after,
				int reverse);

	int init_slope(Auto **current_auto,
				double &slope_start,
				double &slope_value,
				double &slope_position,
				int64_t &input_start,
				int64_t &input_end,
				Auto **before,
				Auto **after,
				int reverse);

	int get_slope(Auto **current_auto,
				double &slope_start,
				double &slope_end,
				double &slope_value,
				double &slope,
				int64_t buffer_len,
				int64_t buffer_position,
				int reverse);

	int advance_slope(Auto **current_auto,
				double &slope_start,
				double &slope_value,
				double &slope_position,
				int reverse);

	Auto* autoof(int64_t position);   // return nearest auto equal to or after position
										                  // 0 if after all autos
	Auto* nearest_before(int64_t position);    // return nearest auto before or 0
	Auto* nearest_after(int64_t position);     // return nearest auto after or 0
};

#endif