
/*
 * 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 KEYFRAME_H
#define KEYFRAME_H

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

#include "auto.h"
#include "filexml.inc"
#include "keyframes.inc"
#include "messages.inc"

// The default constructor is used for menu effects and pasting effects.

class KeyFrame : public Auto
{
	KeyFrame &operator =(KeyFrame &k) { return k; } //illegal
public:
	KeyFrame();
	KeyFrame(const char *buf, long len);
	KeyFrame(EDL *edl, KeyFrames *autos);
	virtual ~KeyFrame();

	void load(FileXML *file);

// Copy to clipboard
	void copy(int64_t start, int64_t end, FileXML *file, int default_only);
// Copy data + everything else from that to this
	void copy_from(Auto *that);
	void copy_from(KeyFrame *that);
	void copy_from_common(KeyFrame *that);
	int operator==(Auto &that);
	int operator==(KeyFrame &that);
	void copy_data(KeyFrame *src);
	void dump(FILE *fp=stdout);
	int identical(KeyFrame *src);
// Generate pointers to parameters which are different than *src.
// User must free nonzero return arguments.
	void get_diff(KeyFrame *src, BC_Hash **params, char **text, char **extra);

	void set_data(char *data);
	char* get_data(int64_t sz=-1);
// Get parameters in a hash table,
// the anonymous text in a newly allocated string.
// extra text in a newly allocated string
	void get_contents(BC_Hash *ptr, char **text, char **extra);
// Update a single parameter or the anonymous text depending on which argument is nonzero
	void update_parameter(BC_Hash *params, const char *text, const char *extra);
	void span_keyframes(int64_t start, int64_t end);

	XMLBuffer *xbuf;
};

#endif
