cinelerra-5.1/cinelerra/pluginserver.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 PLUGINSERVER_H
  23 #define PLUGINSERVER_H
  24
  25 // inherited by plugins
  26
  27
  28 #include <stdio.h>
  29 #include <stdint.h>
  30 #include <string.h>
  31 #include <unistd.h>
  32
  33 #include "arraylist.h"
  34 #include "attachmentpoint.inc"
  35 #include "edl.inc"
  36 #include "floatauto.inc"
  37 #include "floatautos.inc"
  38 #include "garbage.h"
  39 #include "keyframe.inc"
  40 #include "ladspa.h"
  41 #include "mainprogress.inc"
  42 #include "maxbuffers.h"
  43 #include "menueffects.inc"
  44 #include "module.inc"
  45 #include "mwindow.inc"
  46 #include "plugin.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"
  53 #include "theme.inc"
  54 #include "thread.h"
  55 #include "track.inc"
  56 #include "vframe.inc"
  57 #include "videodevice.inc"
  58 #include "virtualnode.inc"
  59
  60 #include <dlfcn.h>
  61
  62 class PluginObj : public Garbage {
  63         void *dlobj;
  64 public:
  65
  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; }
  72
  73         PluginObj() : Garbage("PluginObj:Garbage") { dlobj = 0; }
  74         ~PluginObj() { if( dlobj ) unload(dlobj); }
  75 };
  76
  77 class PluginGUIs : public ArrayList<PluginServer*>
  78 {
  79         MWindow *mwindow;
  80 public:
  81         PluginGUIs(MWindow *mwindow);
  82         ~PluginGUIs();
  83
  84         void append(PluginServer *server);
  85         PluginServer *gui_server(int gui_id);
  86 };
  87
  88 class PluginServer
  89 {
  90         PluginObj *plugin_obj;
  91         int load_obj();
  92         const char *load_error();
  93         void *get_sym(const char *sym);
  94
  95         int reset_parameters();
  96         void init();
  97         int cleanup_plugin();
  98
  99 // Base class created by client
 100         PluginClient *client;
 101 // If no path, this is going to be set to a function which
 102 // instantiates the plugin.
 103         PluginClient* (*new_plugin)(PluginServer*);
 104
 105 // LAD support
 106         int lad_index;
 107         LADSPA_Descriptor_Function lad_descriptor_function;
 108         const LADSPA_Descriptor *lad_descriptor;
 109
 110         int use_opengl;
 111 // FFMPEG support
 112         const char *ff_name;
 113 // Driver for opengl calls.
 114         VideoDevice *vdevice;
 115 public:
 116         PluginServer();
 117         PluginServer(MWindow *mwindow, const char *path, int type);
 118         PluginServer(PluginServer &);
 119         virtual ~PluginServer();
 120
 121         friend class PluginAClientLAD;
 122         friend class PluginAClientConfig;
 123         friend class PluginAClientWindow;
 124
 125         friend class PluginFClient;
 126         friend class PluginFAClient;
 127         friend class PluginFVClient;
 128         friend class PluginFClientConfig;
 129         friend class PluginFClientWindow;
 130
 131 // open a plugin and wait for commands
 132 // Get information for plugindb if master.
 133 #define PLUGINSERVER_IS_LAD 2
 134 #define PLUGINSERVER_NOT_RECOGNIZED 1
 135 #define PLUGINSERVER_OK 0
 136         int open_plugin(int master, Preferences *preferences,
 137                         EDL *edl, Plugin *plugin);
 138 // close the plugin
 139         int close_plugin();
 140         void get_plugin_png_name(char *png_name);
 141         int get_plugin_png_path(char *png_path, const char *plugin_icons);
 142         int get_plugin_png_path(char *png_path);
 143         void dump(FILE *fp=stdout);
 144 // Release any objects which are required after playback stops.
 145         void render_stop();
 146 // Write entry into plugin table
 147         void write_table(FILE *fp, const char *path, int idx, int64_t mtime);
 148         static int scan_table(char *text, int &type, char *path, char *title, int64_t &mtime);
 149         int read_table(char *text);
 150 // queries
 151         void set_title(const char *string);
 152 // Generate title for display
 153         void generate_display_title(char *string);
 154 // Get keyframes for configuration.  Position is always relative to EDL rate.
 155         KeyFrame* get_prev_keyframe(int64_t position);
 156         KeyFrame* get_next_keyframe(int64_t position);
 157 // get camera and projector positions
 158         void get_camera(float *x, float *y, float *z,
 159                         int64_t position, int direction);
 160         void get_projector(float *x, float *y, float *z,
 161                         int64_t position, int direction);
 162 // Get interpolation used by EDL
 163         int get_interpolation_type();
 164 // plugin position or -1 if no plugin
 165         int64_t get_startproject();
 166         int64_t get_endproject();
 167 // Get or create keyframe for writing, depending on whether auto keyframes
 168 // is enabled.  Called by PluginClient::send_configure_change
 169         KeyFrame* get_keyframe();
 170 // Apply new settings from the plugin GUI.  Called by PluginClient::send_configure_change
 171 // Used in keyframe spanning mode.
 172         void apply_keyframe(Plugin *plugin, KeyFrame *src);
 173
 174 // Create new theme object.  Used by theme plugins.
 175         Theme* new_theme();
 176 // Get theme being used by Cinelerra currently.  Used by all plugins.
 177         Theme* get_theme();
 178 // Get picon png vframe image
 179         VFrame *get_picon();
 180         VFrame *get_plugin_images();
 181
 182         int is_unknown();
 183         int is_executable();
 184         int is_builtin();
 185 // ffmpeg
 186         int is_ffmpeg();
 187         PluginClient *new_ffmpeg_plugin();
 188 // ladspa
 189         void set_lad_index(int i);
 190         int get_lad_index();
 191         int is_ladspa();
 192 // lv2
 193         int is_lv2();
 194         PluginClient *new_lv2_plugin();
 195 // =============================== for realtime plugins
 196 // save configuration of plugin
 197         void save_data(KeyFrame *keyframe);
 198 // Update EDL and playback engines to reflect changes
 199         void sync_parameters();
 200 // set for realtime processor usage
 201         int set_realtime_sched();
 202         int get_gui_status();
 203 // Raise the GUI
 204         void raise_window();
 205 // cause the plugin to show the GUI
 206 // Called by MWindow::show_plugin
 207         void show_gui();
 208         void hide_gui();
 209 // Update GUI with keyframe settings
 210         void update_gui();
 211         void update_title();
 212         void client_side_close();
 213 // Set to 1 before every process call if the user supports OpenGL buffers.
 214 // Also provides the driver location.
 215         void set_use_opengl(int value, VideoDevice *vdevice);
 216 // Plugin must call this before performing OpenGL operations.
 217         int get_use_opengl();
 218         int to_ram(VFrame *vframe);
 219
 220 // Called from plugin client
 221 // Returns 1 if a GUI is open so OpenGL routines can determine if
 222 // they can run.
 223         int gui_open();
 224 // Called by plugin client to request synchronous routine.
 225         void run_opengl(PluginClient *plugin_client);
 226
 227 // set the string that appears on the plugin title
 228         int set_string(char *string);
 229 // give the buffers and sizes and prepare processing realtime data
 230         int init_realtime(int realtime_sched,
 231                 int total_in_buffers,
 232                 int buffer_size);
 233 // process the data in the buffers
 234 // input - the current edit's data
 235 // output - the previous edit's data and the destination of the transition output
 236 // current_position - Position from start of the transition and
 237 //     relative to the transition.
 238 // total_len - total len for transition
 239         void process_transition(VFrame *input,
 240                 VFrame *output,
 241                 int64_t current_position,
 242                 int64_t total_len);
 243         void process_transition(Samples *input,
 244                 Samples *output,
 245                 int64_t current_position,
 246                 int64_t fragment_size,
 247                 int64_t total_len);
 248
 249 // Process using pull method.
 250 // current_position - start of region if forward, end of region if reverse
 251 //     relative to requested rate
 252 // fragment_size - amount of data to put in buffer relative to requested rate
 253 // sample_rate - sample rate of requested output
 254 // frame_rate - frame rate of requested output
 255 // total_len - length of plugin in track units relative to the EDL rate
 256 // Units are kept relative to the EDL rate so plugins don't need to convert rates
 257 // to get the keyframes.
 258         void process_buffer(VFrame **frame,
 259                 int64_t current_position,
 260                 double frame_rate,
 261                 int64_t total_len,
 262                 int direction);
 263         void process_buffer(Samples **buffer,
 264                 int64_t current_position,
 265                 int64_t fragment_size,
 266                 int64_t sample_rate,
 267                 int64_t total_len,
 268                 int direction);
 269
 270 // Called by rendering client to cause the GUI to display something with the data.
 271         void send_render_gui(void *data);
 272         void send_render_gui(void *data, int size);
 273
 274 // Called by MWindow to cause GUI to display
 275         void render_gui(void *data);
 276         void render_gui(void *data, int size);
 277 // PluginClientFrames queuing to gui client_frames
 278         void send_reset_gui_frames();
 279         void reset_gui_frames();
 280         void render_gui_frames(PluginClientFrames *frames);
 281         void reset_plugin_gui_frames();
 282         void render_plugin_gui_frames(PluginClientFrames *frames);
 283
 284 // Send the boundary autos of the next fragment
 285         int set_automation(FloatAutos *autos, FloatAuto **start_auto, FloatAuto **end_auto, int reverse);
 286
 287
 288
 289 // set the fragment position of a buffer before rendering
 290         int arm_buffer(int buffer_number,
 291                                 int64_t in_fragment_position,
 292                                 int64_t out_fragment_position,
 293                                 int double_buffer_in,
 294                                 int double_buffer_out);
 295 // Detach all the shared buffers.
 296         int detach_buffers();
 297
 298         int send_buffer_info();
 299
 300
 301 // ============================ for non realtime plugins
 302 // start processing data in plugin
 303         int start_loop(int64_t start, int64_t end, int64_t buffer_size, int total_buffers);
 304 // Do one iteration of a nonrealtime plugin and return if finished
 305         int process_loop(VFrame **buffers, int64_t &write_length);
 306         int process_loop(Samples **buffers, int64_t &write_length);
 307         int stop_loop();
 308
 309
 310 // Called by client to read data in non-realtime effect
 311         int read_frame(VFrame *buffer,
 312                 int channel,
 313                 int64_t start_position);
 314         int read_samples(Samples *buffer,
 315                 int channel,
 316                 int64_t start_position,
 317                 int64_t len);
 318
 319
 320 // Called by client to read data in realtime effect.
 321 // Returns -1 if error or 0 if success.
 322         int read_frame(VFrame *buffer,
 323                 int channel,
 324                 int64_t start_position,
 325                 double frame_rate,
 326 // Set to 1 if the reader can use OpenGL objects.
 327                 int use_opengl = 0);
 328         int read_samples(Samples *buffer,
 329                 int channel,
 330                 int64_t sample_rate,
 331                 int64_t start_position,
 332                 int64_t len);
 333
 334 // For non realtime, prompt user for parameters, waits for plugin to finish and returns a result
 335         int get_parameters(int64_t start, int64_t end, int channels);
 336         int get_samplerate();      // get samplerate produced by plugin
 337         double get_framerate();     // get framerate produced by plugin
 338         int get_project_samplerate();            // get samplerate of project data before processing
 339         double get_project_framerate();         // get framerate of project data before processing
 340         void set_path(const char *path);        // required first
 341         char *get_path();
 342         int get_synthesis();
 343         void get_defaults_path(char *path);
 344         void save_defaults();
 345 // Used by PluginArray and MenuEffects to get user parameters and progress bar.
 346 // Set pointer to mwindow for opening GUI and reconfiguring EDL.
 347         void set_mwindow(MWindow *mwindow);
 348 // Used in VirtualConsole
 349 // Set pointer to AttachmentPoint to render GUI.
 350         void set_attachmentpoint(AttachmentPoint *attachmentpoint);
 351 // Set pointer to a default keyframe when there is no plugin
 352         void set_keyframe(KeyFrame *keyframe);
 353 // Set pointer to menueffect window
 354         void set_prompt(MenuEffectPrompt *prompt);
 355         int set_interactive();             // make this the master plugin for progress bars
 356         int set_error();         // flag to send plugin an error on next request
 357         MainProgressBar* start_progress(char *string, int64_t length);
 358
 359 // add track to the list of affected tracks for a non realtime plugin
 360         void append_module(Module *module);
 361 // add node for realtime plugin
 362         void append_node(VirtualNode *node);
 363 // reset node table after virtual console reconfiguration
 364         void reset_nodes();
 365
 366         int64_t get_written_samples();   // after samples are written, get the number written
 367         int64_t get_written_frames();   // after frames are written, get the number written
 368
 369 // client origin
 370         int plugin_type;
 371         int plugin_id;
 372
 373 // buffers
 374         int64_t out_buffer_size;   // size of a send buffer to the plugin
 375         int64_t in_buffer_size;    // size of a receive buffer from the plugin
 376         int total_in_buffers;
 377         int total_out_buffers;
 378
 379 // number of double buffers for each channel
 380         ArrayList<int> ring_buffers_in;
 381         ArrayList<int> ring_buffers_out;
 382 // Parameters for automation.  Setting autos to 0 disables automation.
 383         FloatAuto **start_auto, **end_auto;
 384         FloatAutos *autos;
 385         int reverse;
 386
 387 // size of each buffer
 388         ArrayList<int64_t> realtime_in_size;
 389         ArrayList<int64_t> realtime_out_size;
 390
 391 // When arming buffers need to know the offsets in all the buffers and which
 392 // double buffers for each channel before rendering.
 393         ArrayList<int64_t> offset_in_render;
 394         ArrayList<int64_t> offset_out_render;
 395         ArrayList<int64_t> double_buffer_in_render;
 396         ArrayList<int64_t> double_buffer_out_render;
 397
 398 // don't delete buffers if they belong to a virtual module
 399         int shared_buffers;
 400 // Send new buffer information for next render
 401         int new_buffers;
 402
 403
 404         int plugin_open;                 // Whether or not the plugin is open.
 405 // Specifies what type of plugin.
 406         int realtime, multichannel, fileio;
 407 // Plugin generates media
 408         int synthesis;
 409 // What data types the plugin can handle.  One of these is set.
 410         int audio, video, theme;
 411 // Can display a GUI
 412         int uses_gui;
 413 // Plugin is a transition
 414         int transition;
 415 // name/tip of plugin
 416         char *title, *tip;
 417         int64_t written_samples, written_frames;
 418         char *path;           // location of plugin on disk
 419         char *data_text;      // pointer to the data that was requested by a save_data command
 420         char *args[4];
 421         int total_args;
 422         int error_flag;       // send plugin an error code on next request
 423         int dir_idx;          // directory id, for icon visibility grouping
 424 // Pointers to tracks affected by this plugin during a non realtime operation.
 425 // Allows read functions to read data.
 426         ArrayList<Module*> *modules;
 427 // Used by realtime read functions to get data.  Corresponds to the buffer table in the
 428 // attachment point.
 429         ArrayList<VirtualNode*> *nodes;
 430         AttachmentPoint *attachmentpoint;
 431         MWindow *mwindow;
 432 // Pointer to keyframe when plugin is not available
 433         KeyFrame *keyframe;
 434         AttachmentPoint *attachment;
 435
 436 // Storage of session parameters
 437         EDL *edl;
 438         Preferences *preferences;
 439         MenuEffectPrompt *prompt;
 440         int gui_on, gui_id;
 441
 442         VFrame *temp_frame;
 443
 444 // Icon for tracking update
 445         VFrame *picon;
 446 };
 447
 448
 449 #endif