add mask selection btns
[goodguy/cinelerra.git] / cinelerra-5.1 / cinelerra / autos.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 AUTOS_H
23 #define AUTOS_H
24
25 #include <stdio.h>
26 #include <stdint.h>
27
28 // Base class for automation lists.
29 // Units are the native units for the track data type.
30
31 #include "auto.h"
32 #include "edl.inc"
33 #include "guicast.h"
34 #include "filexml.inc"
35 #include "track.inc"
36
37 #define AUTOS_VIRTUAL_HEIGHT 160
38
39 class Autos : public List<Auto>
40 {
41 public:
42         Autos(EDL *edl, Track *track);
43
44         virtual ~Autos();
45
46         void resample(double old_rate, double new_rate);
47
48         virtual void create_objects();
49         void equivalent_output(Autos *autos, int64_t startproject, int64_t *result);
50         void copy_from(Autos *autos);
51         virtual Auto* new_auto();
52 // Get existing auto on or before position.
53 // If use_default is true, return default_auto if none exists
54 // on or before position.
55 // Return 0 if none exists and use_default is false.
56 // If &current is nonzero it is used as a starting point for searching.
57         Auto* get_prev_auto(int64_t position, int direction, Auto* &current, int use_default = 1);
58         Auto* get_prev_auto(int direction, Auto* &current);
59         Auto* get_next_auto(int64_t position, int direction, Auto* &current, int use_default = 1);
60 // Determine if a keyframe exists before creating it.
61         int auto_exists_for_editing(double position);
62 // Returns auto at exact position, null if non-existent. ignores autokeyframming and align on frames
63         Auto* get_auto_at_position(double position = -1);
64
65 // Get keyframe for editing with creation
66 // create: <0: always new keyframe, =0: no new keyframe, >0: auto keyframe
67         Auto* get_auto_for_editing(double position=-1, int create=1);
68
69 // Insert keyframe at the point if it doesn't exist
70 // Interpolate its value if possible
71         Auto* insert_auto(int64_t position, Auto *templ=0);
72         void insert_track(Autos *automation,
73                 int64_t start_unit,
74                 int64_t length_units,
75                 int replace_default);
76         virtual int load(FileXML *xml);
77         void remove_nonsequential(Auto *keyframe);
78         void optimize();
79
80 // Returns a type enumeration
81         int get_type();
82         int64_t get_length();
83         virtual void get_extents(float *min,
84                 float *max,
85                 int *coords_undefined,
86                 int64_t unit_start,
87                 int64_t unit_end);
88
89         EDL *edl;
90         Track *track;
91 // Default settings if no autos.
92 // Having a persistent keyframe created problems when files were loaded and
93 // we wanted to keep only 1 auto.
94 // Default auto has position 0 except in effects, where multiple default autos
95 // exist.
96         Auto *default_auto;
97
98         int autoidx;
99         int autogrouptype;
100         int type;
101         enum
102         {
103                 AUTOMATION_TYPE_FLOAT,
104                 AUTOMATION_TYPE_MASK,
105                 AUTOMATION_TYPE_INT,
106                 AUTOMATION_TYPE_PAN,
107                 AUTOMATION_TYPE_PLUGIN
108         };
109
110
111
112         virtual void dump(FILE *fp);
113
114
115
116
117
118
119         int clear_all();
120         int insert(int64_t start, int64_t end);
121         int paste_silence(int64_t start, int64_t end);
122 // Copy for keyframe clipboard & drag & drop
123 // default_only - only copy the default keyframe
124         int copy(int64_t start,
125                 int64_t end,
126                 FileXML *xml,
127                 int default_only,
128                 int active_only);
129 // Paste for keyframe clipboard & drag & drop
130 // default_only - only paste the default keyframe
131         void paste(int64_t start,
132                 int64_t length,
133                 double scale,
134                 FileXML *file,
135                 int default_only,
136                 int active_only);
137 // Stores the background rendering position in result
138         void clear(int64_t start,
139                 int64_t end,
140                 int shift_autos);
141         virtual void set_automation_mode(int64_t start, int64_t end, int mode);
142         int clear_auto(int64_t position);
143         int save(FileXML *xml);
144         virtual int slope_adjustment(int64_t ax, double slope);
145         int release_auto();
146         virtual int release_auto_derived() { return 0; }
147         Auto* append_auto();
148         int scale_time(float rate_scale, int scale_edits, int scale_autos, int64_t start, int64_t end);
149
150 // rendering utilities
151         int get_neighbors(int64_t start, int64_t end, Auto **before, Auto **after);
152 // 1 if automation doesn't change
153         virtual int automation_is_constant(int64_t start, int64_t end);
154         virtual double get_automation_constant(int64_t start, int64_t end);
155         int init_automation(int64_t &buffer_position,
156                                 int64_t &input_start,
157                                 int64_t &input_end,
158                                 int &automate,
159                                 double &constant,
160                                 int64_t input_position,
161                                 int64_t buffer_len,
162                                 Auto **before,
163                                 Auto **after,
164                                 int reverse);
165
166         int init_slope(Auto **current_auto,
167                                 double &slope_start,
168                                 double &slope_value,
169                                 double &slope_position,
170                                 int64_t &input_start,
171                                 int64_t &input_end,
172                                 Auto **before,
173                                 Auto **after,
174                                 int reverse);
175
176         int get_slope(Auto **current_auto,
177                                 double &slope_start,
178                                 double &slope_end,
179                                 double &slope_value,
180                                 double &slope,
181                                 int64_t buffer_len,
182                                 int64_t buffer_position,
183                                 int reverse);
184
185         int advance_slope(Auto **current_auto,
186                                 double &slope_start,
187                                 double &slope_value,
188                                 double &slope_position,
189                                 int reverse);
190
191         Auto* autoof(int64_t position);   // return nearest auto equal to or after position
192                                                                                                   // 0 if after all autos
193         Auto* nearest_before(int64_t position);    // return nearest auto before or 0
194         Auto* nearest_after(int64_t position);     // return nearest auto after or 0
195 };
196
197 #endif