Credit Andrew - improve in-tree documentation
[goodguy/cinelerra.git] / cinelerra / amodule.h
1
2 /*
3  * CINELERRA
4  * Copyright (C) 2008-2013 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 AMODULE_H
23 #define AMODULE_H
24
25 class AModuleGUI;
26 class AModuleTitle;
27 class AModulePan;
28 class AModuleFade;
29 class AModuleInv;
30 class AModuleMute;
31 class AModuleReset;
32
33 #include "aedit.inc"
34 #include "amodule.inc"
35 #include "aplugin.inc"
36 #include "asset.inc"
37 #include "datatype.h"
38 #include "edl.inc"
39 #include "file.inc"
40 #include "filexml.inc"
41 #include "floatautos.inc"
42 #include "maxchannels.h"
43 #include "meterhistory.h"
44 #include "module.h"
45 #include "resample.h"
46 #include "samples.inc"
47 #include "sharedlocation.inc"
48 #include "track.inc"
49 #include "units.h"
50
51 class AModuleResample : public Resample
52 {
53 public:
54         AModuleResample(AModule *module);
55         ~AModuleResample();
56
57 // All positions are in source sample rate
58         int read_samples(Samples *buffer, int64_t start, int64_t len);
59
60         AModule *module;
61 // output for nested EDL if resampled
62         Samples *nested_output[MAX_CHANNELS];
63 // number of samples allocated
64         int nested_allocation;
65 };
66
67 class AModule : public Module
68 {
69 public:
70         AModule(RenderEngine *renderengine,
71                 CommonRender *commonrender,
72                 PluginArray *plugin_array,
73         Track *track);
74         virtual ~AModule();
75
76         void create_objects();
77         CICache* get_cache();
78
79         int import_samples(AEdit *playable_edit,
80                 int64_t start_project,
81                 int64_t edit_startproject,
82                 int64_t edit_startsource,
83                 int direction,
84                 int sample_rate,
85                 Samples *buffer,
86                 int64_t fragment_len);
87
88
89         int render(Samples *buffer,
90                 int64_t input_len,
91                 int64_t input_position,
92                 int direction,
93                 int sample_rate,
94                 int use_nudge);
95         int get_buffer_size();
96
97         AttachmentPoint* new_attachment(Plugin *plugin);
98
99
100
101
102 // synchronization with tracks
103         FloatAutos* get_pan_automation(int channel);  // get pan automation
104         FloatAutos* get_fade_automation();       // get the fade automation for this module
105
106         MeterHistory *meter_history;
107
108 // Temporary buffer for rendering transitions
109         Samples *transition_temp;
110 // Temporary buffer for rendering speed curve
111         Samples *speed_temp;
112 // Previous buffers for rendering speed curve
113 #define SPEED_OVERLAP 4
114         double prev_head[SPEED_OVERLAP];
115         double prev_tail[SPEED_OVERLAP];
116
117 // Pointer to an asset for the resampler
118         Asset *asset;
119 // Channel to import from the source
120         int channel;
121 // File being read if source is a file.
122         File *file;
123
124 // Temporary buffer for rendering a nested audio EDL.
125 // Sharing nested output between modules wouldn't work because if the
126 // segment was cut inside input_len, the shared channels would have to
127 // initialize their EDL's at different starting points and botch their
128 // starting states.
129         Samples *nested_output[MAX_CHANNELS];
130 // number of samples allocated
131         int nested_allocation;
132 // resampling for nested output
133         AModuleResample *resample;
134 };
135
136
137 #endif
138