4 * Copyright (C) 2008 Adam Williams <broadcast at earthling dot net>
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.
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.
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
22 #ifndef PLUGINSERVER_H
23 #define PLUGINSERVER_H
25 // inherited by plugins
33 #include "arraylist.h"
34 #include "attachmentpoint.inc"
36 #include "floatauto.inc"
37 #include "floatautos.inc"
39 #include "keyframe.inc"
41 #include "mainprogress.inc"
42 #include "maxbuffers.h"
43 #include "menueffects.inc"
45 #include "mwindow.inc"
47 #include "pluginaclientlad.inc"
48 #include "pluginfclient.inc"
49 #include "pluginclient.inc"
50 #include "pluginserver.inc"
51 #include "preferences.inc"
52 #include "samples.inc"
57 #include "videodevice.inc"
58 #include "virtualnode.inc"
62 class PluginObj : public Garbage {
66 void *load(const char *dlp) { return dlobj = dlopen(dlp, RTLD_NOW); }
67 void *load(const char *plugin_dir, const char *path);
68 void unload(void *obj) { dlclose(obj); }
69 void *load_sym(const char *sym) { return dlsym(dlobj, sym); }
70 const char *load_error() { return dlerror(); }
71 void *obj() { return dlobj; }
73 PluginObj() : Garbage("PluginObj:Garbage") { dlobj = 0; }
74 ~PluginObj() { if( dlobj ) unload(dlobj); }
79 PluginObj *plugin_obj;
81 const char *load_error();
82 void *get_sym(const char *sym);
84 int reset_parameters();
88 // Base class created by client
90 // If no path, this is going to be set to a function which
91 // instantiates the plugin.
92 PluginClient* (*new_plugin)(PluginServer*);
96 LADSPA_Descriptor_Function lad_descriptor_function;
97 const LADSPA_Descriptor *lad_descriptor;
101 // Driver for opengl calls.
102 VideoDevice *vdevice;
105 PluginServer(MWindow *mwindow, char *path, int type);
106 PluginServer(PluginServer &);
107 virtual ~PluginServer();
109 friend class PluginAClientLAD;
110 friend class PluginAClientConfig;
111 friend class PluginAClientWindow;
113 friend class PluginFClient;
114 friend class PluginFAClient;
115 friend class PluginFVClient;
116 friend class PluginFClientConfig;
117 friend class PluginFClientWindow;
119 // open a plugin and wait for commands
120 // Get information for plugindb if master.
121 #define PLUGINSERVER_IS_LAD 2
122 #define PLUGINSERVER_NOT_RECOGNIZED 1
123 #define PLUGINSERVER_OK 0
124 int open_plugin(int master, Preferences *preferences,
125 EDL *edl, Plugin *plugin);
128 void get_plugin_png_name(char *png_name);
129 int get_plugin_png_path(char *png_path, const char *plugin_icons);
130 int get_plugin_png_path(char *png_path);
131 void dump(FILE *fp=stdout);
132 // Release any objects which are required after playback stops.
134 // Write entry into plugin table
135 void write_table(FILE *fp, const char *path, int idx, int64_t mtime);
136 static int scan_table(char *text, int &type, char *path, char *title, int64_t &mtime);
137 int read_table(char *text);
139 void set_title(const char *string);
140 // Generate title for display
141 void generate_display_title(char *string);
142 // Get keyframes for configuration. Position is always relative to EDL rate.
143 KeyFrame* get_prev_keyframe(int64_t position);
144 KeyFrame* get_next_keyframe(int64_t position);
145 // get camera and projector positions
146 void get_camera(float *x, float *y, float *z,
147 int64_t position, int direction);
148 void get_projector(float *x, float *y, float *z,
149 int64_t position, int direction);
150 // Get interpolation used by EDL
151 int get_interpolation_type();
152 // Get or create keyframe for writing, depending on whether auto keyframes
153 // is enabled. Called by PluginClient::send_configure_change
154 KeyFrame* get_keyframe();
155 // Apply new settings from the plugin GUI. Called by PluginClient::send_configure_change
156 // Used in keyframe spanning mode.
157 void apply_keyframe(KeyFrame *src);
159 // Create new theme object. Used by theme plugins.
161 // Get theme being used by Cinelerra currently. Used by all plugins.
163 // Get picon png vframe image
165 VFrame *get_plugin_images();
168 void set_lad_index(int i);
173 PluginClient *new_ffmpeg_plugin();
174 // =============================== for realtime plugins
175 // save configuration of plugin
176 void save_data(KeyFrame *keyframe);
177 // Update EDL and playback engines to reflect changes
178 void sync_parameters();
179 // set for realtime processor usage
180 int set_realtime_sched();
181 int get_gui_status();
184 // cause the plugin to show the GUI
185 // Called by MWindow::show_plugin
188 // Update GUI with keyframe settings
191 void client_side_close();
192 // Set to 1 before every process call if the user supports OpenGL buffers.
193 // Also provides the driver location.
194 void set_use_opengl(int value, VideoDevice *vdevice);
195 // Plugin must call this before performing OpenGL operations.
196 int get_use_opengl();
198 // Called from plugin client
199 // Returns 1 if a GUI is open so OpenGL routines can determine if
202 // Called by plugin client to request synchronous routine.
203 void run_opengl(PluginClient *plugin_client);
205 // set the string that appears on the plugin title
206 int set_string(char *string);
207 // give the buffers and sizes and prepare processing realtime data
208 int init_realtime(int realtime_sched,
209 int total_in_buffers,
211 // process the data in the buffers
212 // input - the current edit's data
213 // output - the previous edit's data and the destination of the transition output
214 // current_position - Position from start of the transition and
215 // relative to the transition.
216 // total_len - total len for transition
217 void process_transition(VFrame *input,
219 int64_t current_position,
221 void process_transition(Samples *input,
223 int64_t current_position,
224 int64_t fragment_size,
227 // Process using pull method.
228 // current_position - start of region if forward, end of region if reverse
229 // relative to requested rate
230 // fragment_size - amount of data to put in buffer relative to requested rate
231 // sample_rate - sample rate of requested output
232 // frame_rate - frame rate of requested output
233 // total_len - length of plugin in track units relative to the EDL rate
234 // Units are kept relative to the EDL rate so plugins don't need to convert rates
235 // to get the keyframes.
236 void process_buffer(VFrame **frame,
237 int64_t current_position,
241 void process_buffer(Samples **buffer,
242 int64_t current_position,
243 int64_t fragment_size,
248 // Called by rendering client to cause the GUI to display something with the data.
249 void send_render_gui(void *data);
250 void send_render_gui(void *data, int size);
251 // Called by MWindow to cause GUI to display
252 void render_gui(void *data);
253 void render_gui(void *data, int size);
255 // Send the boundary autos of the next fragment
256 int set_automation(FloatAutos *autos, FloatAuto **start_auto, FloatAuto **end_auto, int reverse);
260 // set the fragment position of a buffer before rendering
261 int arm_buffer(int buffer_number,
262 int64_t in_fragment_position,
263 int64_t out_fragment_position,
264 int double_buffer_in,
265 int double_buffer_out);
266 // Detach all the shared buffers.
267 int detach_buffers();
269 int send_buffer_info();
272 // ============================ for non realtime plugins
273 // start processing data in plugin
274 int start_loop(int64_t start, int64_t end, int64_t buffer_size, int total_buffers);
275 // Do one iteration of a nonrealtime plugin and return if finished
276 int process_loop(VFrame **buffers, int64_t &write_length);
277 int process_loop(Samples **buffers, int64_t &write_length);
281 // Called by client to read data in non-realtime effect
282 int read_frame(VFrame *buffer,
284 int64_t start_position);
285 int read_samples(Samples *buffer,
287 int64_t start_position,
291 // Called by client to read data in realtime effect.
292 // Returns -1 if error or 0 if success.
293 int read_frame(VFrame *buffer,
295 int64_t start_position,
297 // Set to 1 if the reader can use OpenGL objects.
299 int read_samples(Samples *buffer,
302 int64_t start_position,
305 // For non realtime, prompt user for parameters, waits for plugin to finish and returns a result
306 int get_parameters(int64_t start, int64_t end, int channels);
307 int get_samplerate(); // get samplerate produced by plugin
308 double get_framerate(); // get framerate produced by plugin
309 int get_project_samplerate(); // get samplerate of project data before processing
310 double get_project_framerate(); // get framerate of project data before processing
311 void set_path(const char *path); // required first
314 void get_defaults_path(char *path);
315 void save_defaults();
316 // Used by PluginArray and MenuEffects to get user parameters and progress bar.
317 // Set pointer to mwindow for opening GUI and reconfiguring EDL.
318 void set_mwindow(MWindow *mwindow);
319 // Used in VirtualConsole
320 // Set pointer to AttachmentPoint to render GUI.
321 void set_attachmentpoint(AttachmentPoint *attachmentpoint);
322 // Set pointer to a default keyframe when there is no plugin
323 void set_keyframe(KeyFrame *keyframe);
324 // Set pointer to menueffect window
325 void set_prompt(MenuEffectPrompt *prompt);
326 int set_interactive(); // make this the master plugin for progress bars
327 int set_error(); // flag to send plugin an error on next request
328 MainProgressBar* start_progress(char *string, int64_t length);
330 // add track to the list of affected tracks for a non realtime plugin
331 void append_module(Module *module);
332 // add node for realtime plugin
333 void append_node(VirtualNode *node);
334 // reset node table after virtual console reconfiguration
337 int64_t get_written_samples(); // after samples are written, get the number written
338 int64_t get_written_frames(); // after frames are written, get the number written
344 int64_t out_buffer_size; // size of a send buffer to the plugin
345 int64_t in_buffer_size; // size of a recieve buffer from the plugin
346 int total_in_buffers;
347 int total_out_buffers;
349 // number of double buffers for each channel
350 ArrayList<int> ring_buffers_in;
351 ArrayList<int> ring_buffers_out;
352 // Parameters for automation. Setting autos to 0 disables automation.
353 FloatAuto **start_auto, **end_auto;
357 // size of each buffer
358 ArrayList<int64_t> realtime_in_size;
359 ArrayList<int64_t> realtime_out_size;
361 // When arming buffers need to know the offsets in all the buffers and which
362 // double buffers for each channel before rendering.
363 ArrayList<int64_t> offset_in_render;
364 ArrayList<int64_t> offset_out_render;
365 ArrayList<int64_t> double_buffer_in_render;
366 ArrayList<int64_t> double_buffer_out_render;
368 // don't delete buffers if they belong to a virtual module
370 // Send new buffer information for next render
374 int plugin_open; // Whether or not the plugin is open.
375 // Specifies what type of plugin.
376 int realtime, multichannel, fileio;
377 // Plugin generates media
379 // What data types the plugin can handle. One of these is set.
380 int audio, video, theme;
383 // Plugin is a transition
385 // name/tip of plugin
387 int64_t written_samples, written_frames;
388 char *path; // location of plugin on disk
389 char *data_text; // pointer to the data that was requested by a save_data command
392 int error_flag; // send plugin an error code on next request
393 int dir_idx; // directory id, for icon visibility grouping
394 // Pointers to tracks affected by this plugin during a non realtime operation.
395 // Allows read functions to read data.
396 ArrayList<Module*> *modules;
397 // Used by realtime read functions to get data. Corresponds to the buffer table in the
399 ArrayList<VirtualNode*> *nodes;
400 AttachmentPoint *attachmentpoint;
402 // Pointer to keyframe when plugin is not available
404 AttachmentPoint *attachment;
405 // Storage of keyframes and GUI status
408 // Storage of session parameters
410 Preferences *preferences;
411 MenuEffectPrompt *prompt;
416 // Icon for tracking update