Credit Andrew - improve in-tree documentation
[goodguy/cinelerra.git] / cinelerra / floatauto.h
1
2 /*
3  * CINELERRA
4  * Copyright (C) 2008 Adam Williams <broadcast at earthling dot net>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  */
21
22 #ifndef FLOATAUTO_H
23 #define FLOATAUTO_H
24
25 // Automation point that takes floating point values
26
27 class FloatAuto;
28
29 #include "auto.h"
30 #include "edl.inc"
31 #include "floatautos.inc"
32
33 class FloatAuto : public Auto
34 {
35         friend class FloatAutos;
36 public:
37         FloatAuto() {};
38         FloatAuto(EDL *edl, FloatAutos *autos);
39         ~FloatAuto();
40
41         bool is_floatauto() { return true; }
42         int operator==(Auto &that);
43         int operator==(FloatAuto &that);
44         int identical(FloatAuto *src);
45         int equals(FloatAuto *src);
46         void copy_from(Auto *that);
47         void copy_from(FloatAuto *that);
48         int interpolate_from(Auto *a1, Auto *a2, int64_t pos, Auto *templ=0); // bezier interpolation
49         void copy(int64_t start, int64_t end, FileXML *file, int default_only);
50         void load(FileXML *xml);
51
52 // "the value" (=payload of this keyframe)
53         float get_value() {return this->value;}
54         void  set_value(float newval);
55
56 // Possible policies to handle the tagents for the
57 // bézier curves connecting adjacent automation points
58         enum t_mode
59         {
60                 SMOOTH,     // curves are coupled in order to yield a smooth curve
61                 LINEAR,     // curves always pointing directly to neighbouring automation points
62                 TFREE,      // curves on both sides coupled but editable by dragging the handles
63                 FREE        // curves on both sides are independent and editable via GUI
64         };
65
66         t_mode curve_mode;
67         void change_curve_mode(t_mode); // recalculates curves as well
68         void toggle_curve_mode();       // cycles through all modes (e.g. by ctrl-click)
69
70 // Control values (y coords of bézier control point), relative to value
71         float get_control_in_value()            {check_pos(); return this->control_in_value;}
72         float get_control_out_value()           {check_pos(); return this->control_out_value;}
73         void set_control_in_value(float newval);
74         void set_control_out_value(float newval);
75
76 // get calculated x-position of control points for drawing,
77 // relative to auto position, in native units of the track.
78         int64_t get_control_in_position()       {check_pos(); return this->control_in_position;}
79         int64_t get_control_out_position()      {check_pos(); return this->control_out_position;}
80
81 // define new position and value, re-adjust ctrl point, notify neighbours
82         void adjust_to_new_coordinates(int64_t position, float value);
83 // text name for curve mode
84         static const char *curve_name(int curve_mode);
85
86 private:
87         void adjust_curves();             // recalc. ctrk in and out points, if automatic curve mode (SMOOTH or LINEAR)
88         void adjust_ctrl_positions(FloatAuto *p=0, FloatAuto *n=0); // recalc. x location of ctrl points, notify neighbours
89         void set_ctrl_positions(FloatAuto*, FloatAuto*);
90         void calculate_slope(FloatAuto* a1, FloatAuto* a2, float& dvdx, float& dx);
91         void check_pos()                    { if(position != pos_valid) adjust_ctrl_positions(); }
92         void curve_dirty()                { pos_valid=-1; }
93         void handle_automatic_curve_after_copy();
94
95 // Control values are relative to value
96         float value, control_in_value, control_out_value;
97 // X control positions relative to value position for drawing.
98 // In native units of the track.
99         int64_t control_in_position, control_out_position;
100
101         int64_t pos_valid;                  // 'dirty flag' to recalculate ctrl point positions on demand
102         int value_to_str(char *string, float value);
103 };
104
105
106
107 #endif