cinelerra-5.1/cinelerra/pluginclient.h

   1
   2 /*
   3  * CINELERRA
   4  * Copyright (C) 1997-2011 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 PLUGINCLIENT_H
  23 #define PLUGINCLIENT_H
  24
  25 // Base class inherited by all the different types of plugins.
  26
  27 #define MAX_FRAME_BUFFER 1024
  28
  29 class PluginClient;
  30
  31
  32 #include "arraylist.h"
  33 #include "bchash.inc"
  34 #include "condition.h"
  35 #include "edlsession.inc"
  36 #include "keyframe.h"
  37 #include "mainprogress.inc"
  38 #include "maxbuffers.h"
  39 #include "pluginclient.inc"
  40 #include "plugincommands.h"
  41 #include "pluginserver.inc"
  42 #include "samples.inc"
  43 #include "theme.inc"
  44 #include "vframe.h"
  45
  46
  47 extern "C"
  48 {
  49 extern PluginClient* new_plugin(PluginServer *server);
  50 }
  51
  52 class PluginClientAuto
  53 {
  54 public:
  55         float position;
  56         float intercept;
  57         float slope;
  58 };
  59
  60
  61
  62
  63 // Convenience functions
  64
  65 #define REGISTER_PLUGIN(class_title) \
  66 PluginClient* new_plugin(PluginServer *server) \
  67 { \
  68         return new class_title(server); \
  69 }
  70
  71
  72
  73
  74
  75
  76
  77
  78 // Prototypes for user to put in class header
  79 #define PLUGIN_CLASS_MEMBERS(config_name) \
  80         int load_configuration(); \
  81         const char* plugin_title(); \
  82         PluginClientWindow* new_window(); \
  83         config_name config;
  84
  85
  86
  87 // Prototypes for user to put in class header
  88 #define PLUGIN_CLASS_MEMBERS2(config_name) \
  89         int load_configuration(); \
  90         const char* plugin_title(); \
  91         PluginClientWindow* new_window(); \
  92         config_name config;
  93
  94
  95
  96
  97
  98 #define NEW_WINDOW_MACRO(plugin_class, window_class) \
  99 PluginClientWindow* plugin_class::new_window() \
 100 { \
 101         return new window_class(this); \
 102 }
 103
 104 // Not all plugins load configuration the same way.  Use this to define
 105 // the normal way.
 106 #define LOAD_CONFIGURATION_MACRO(plugin_class, config_class) \
 107 int plugin_class::load_configuration() \
 108 { \
 109         KeyFrame *prev_keyframe, *next_keyframe; \
 110         prev_keyframe = get_prev_keyframe(get_source_position()); \
 111         next_keyframe = get_next_keyframe(get_source_position()); \
 112  \
 113         int64_t next_position = edl_to_local(next_keyframe->position); \
 114         int64_t prev_position = edl_to_local(prev_keyframe->position); \
 115  \
 116         config_class old_config, prev_config, next_config; \
 117         old_config.copy_from(config); \
 118         read_data(prev_keyframe); \
 119         prev_config.copy_from(config); \
 120         read_data(next_keyframe); \
 121         next_config.copy_from(config); \
 122  \
 123         config.interpolate(prev_config,  \
 124                 next_config,  \
 125                 (next_position == prev_position) ? \
 126                         get_source_position() : \
 127                         prev_position, \
 128                 (next_position == prev_position) ? \
 129                         get_source_position() + 1 : \
 130                         next_position, \
 131                 get_source_position()); \
 132  \
 133         if(!config.equivalent(old_config)) \
 134                 return 1; \
 135         else \
 136                 return 0; \
 137 }
 138
 139
 140
 141
 142 class PluginClientWindow : public BC_Window
 143 {
 144 public:
 145         PluginClientWindow(PluginClient *client,
 146                 int w,
 147                 int h,
 148                 int min_w,
 149                 int min_h,
 150                 int allow_resize);
 151         PluginClientWindow(const char *title,
 152                 int x,
 153                 int y,
 154                 int w,
 155                 int h,
 156                 int min_w,
 157                 int min_h,
 158                 int allow_resize);
 159         virtual ~PluginClientWindow();
 160
 161         virtual int translation_event();
 162         virtual int close_event();
 163         virtual void done_event(int result) {}
 164
 165         PluginClient *client;
 166 };
 167
 168
 169
 170
 171 class PluginClientThread : public Thread
 172 {
 173 public:
 174         PluginClientThread(PluginClient *client);
 175         ~PluginClientThread();
 176         void run();
 177
 178         friend class PluginClient;
 179
 180         BC_WindowBase* get_window();
 181         PluginClient* get_client();
 182         PluginClientWindow *window;
 183         PluginClient *client;
 184
 185 private:
 186         Condition *init_complete;
 187 };
 188
 189
 190
 191 // Client overrides for GUI update data
 192 class PluginClientFrame
 193 {
 194 public:
 195 // Period_d is 1 second
 196         PluginClientFrame(int data_size, int period_n, int period_d);
 197         virtual ~PluginClientFrame();
 198         int data_size;
 199         int period_n;
 200         int period_d;
 201 // Draw immediately
 202         int force;
 203 };
 204
 205
 206
 207 class PluginClient
 208 {
 209 public:
 210         PluginClient(PluginServer *server);
 211         virtual ~PluginClient();
 212
 213         friend class PluginClientThread;
 214         friend class PluginClientWindow;
 215
 216 // Queries for the plugin server.
 217         virtual int is_realtime();
 218         virtual int is_audio();
 219         virtual int is_video();
 220         virtual int is_fileio();
 221         virtual int is_theme();
 222         virtual int uses_gui();
 223         virtual int is_multichannel();
 224         virtual int is_synthesis();
 225         virtual int is_transition();
 226         virtual const char* plugin_title();   // return the title of the plugin
 227         virtual Theme* new_theme();
 228 // Get theme being used by Cinelerra currently.  Used by all plugins.
 229         Theme* get_theme();
 230
 231
 232
 233
 234
 235
 236 // Non realtime signal processors define these.
 237 // Give the samplerate of the output for a non realtime plugin.
 238 // For realtime plugins give the requested samplerate.
 239         virtual int get_samplerate();
 240 // Give the framerate of the output for a non realtime plugin.
 241 // For realtime plugins give the requested framerate.
 242         virtual double get_framerate();
 243         virtual int delete_nonrealtime_parameters();
 244         virtual int get_parameters();     // get information from user before non realtime processing
 245         virtual int64_t get_in_buffers(int64_t recommended_size);  // return desired size for input buffers
 246         virtual int64_t get_out_buffers(int64_t recommended_size);     // return desired size for output buffers
 247         virtual int start_loop();
 248         virtual int process_loop();
 249         virtual int stop_loop();
 250 // Hash files are the defaults for rendered plugins
 251         virtual int load_defaults();       // load default settings for the plugin
 252         virtual int save_defaults();      // save the current settings as defaults
 253         BC_Hash* get_defaults();
 254
 255
 256
 257
 258 // Realtime commands for signal processors.
 259 // These must be defined by the plugin itself.
 260 // Set the GUI title identifying the plugin to modules and patches.
 261         int set_string();
 262 // cause the plugin to create a new GUI class
 263         virtual BC_WindowBase* new_window();
 264 // Load the current keyframe.  Return 1 if it changed.
 265         virtual int load_configuration();
 266 // cause the plugin to hide the gui
 267         void client_side_close();
 268         void update_display_title();
 269 // Raise the GUI
 270         void raise_window();
 271 // Create GUI
 272         int show_gui();
 273 // XML keyframes are the defaults for realtime plugins
 274         void load_defaults_xml();
 275         void save_defaults_xml();
 276 // Tell the client if the load is the defaults
 277         int is_defaults();
 278
 279         virtual void update_gui();
 280         virtual void save_data(KeyFrame *keyframe) {};    // write the plugin settings to text in text format
 281         virtual void read_data(KeyFrame *keyframe) {};    // read the plugin settings from the text
 282         int send_hide_gui();                                    // should be sent when the GUI receives a close event from the user
 283 // Destroys the window but not the thread pointer.
 284         void hide_gui();
 285
 286         int get_configure_change();                             // get propogated configuration change from a send_configure_change
 287
 288 // Called by plugin server to update GUI with rendered data.
 289         void plugin_render_gui(void *data);
 290         void plugin_render_gui(void *data, int size);
 291
 292         void begin_process_buffer();
 293         void end_process_buffer();
 294
 295         void plugin_update_gui();
 296         virtual int plugin_process_loop(VFrame **buffers, int64_t &write_length) { return 1; };
 297         virtual int plugin_process_loop(Samples **buffers, int64_t &write_length) { return 1; };
 298 // get parameters depending on video or audio
 299         virtual int init_realtime_parameters();
 300 // release objects which are required after playback stops
 301         virtual void render_stop() {};
 302         int get_gui_status();
 303         char* get_gui_string();
 304
 305 // Used by themes
 306 // Used by plugins which need to know where they are.
 307         char* get_path();
 308 // Get the directory for plugins
 309         char* get_plugin_dir();
 310
 311 // Return keyframe objects.  The position in the resulting object
 312 // is relative to the EDL rate.  This is the only way to avoid copying the
 313 // data for every frame.
 314 // If the result is the default keyframe, the keyframe's position is 0.
 315 // position - relative to EDL rate or local rate to allow simple
 316 //     passing of get_source_position.
 317 //     If -1 the tracking position in the edl is used.
 318 // is_local - if 1, the position is converted to the EDL rate.
 319         KeyFrame* get_prev_keyframe(int64_t position, int is_local = 1);
 320         KeyFrame* get_next_keyframe(int64_t position, int is_local = 1);
 321 // get current camera and projector position
 322         void get_camera(float *x, float *y, float *z, int64_t position);
 323         void get_projector(float *x, float *y, float *z, int64_t position);
 324
 325         void output_to_track(float ox, float oy, float &tx, float &ty);
 326         void track_to_output(float tx, float ty, float &ox, float &oy);
 327 // When this plugin is adjusted, propogate parameters back to EDL and virtual
 328 // console.  This gets a keyframe from the EDL, with the position set to the
 329 // EDL tracking position.
 330         int send_configure_change();
 331
 332
 333 // Called from process_buffer
 334 // Returns 1 if a GUI is open so OpenGL routines can determine if
 335 // they can run.
 336         int gui_open();
 337
 338
 339 // Length of source.  For effects it's the plugin length.  For transitions
 340 // it's the transition length.  Relative to the requested rate.
 341 // The only way to get smooth interpolation is to make all position queries
 342 // relative to the requested rate.
 343         int64_t get_total_len();
 344
 345 // For realtime plugins gets the lowest sample of the plugin in the requested
 346 // rate.  For others it's the start of the EDL selection in the EDL rate.
 347         int64_t get_source_start();
 348
 349 // Convert the position relative to the requested rate to the position
 350 // relative to the EDL rate.  If the argument is < 0, it is not changed.
 351 // Used for interpreting keyframes.
 352         virtual int64_t local_to_edl(int64_t position);
 353
 354 // Convert the EDL position to the local position.
 355         virtual int64_t edl_to_local(int64_t position);
 356
 357 // For transitions the source_position is the playback position relative
 358 // to the start of the transition.
 359 // For realtime effects, the start of the most recent process_buffer in forward
 360 // and the end of the range to process in reverse.  Relative to start of EDL in
 361 // the requested rate.
 362         int64_t get_source_position();
 363
 364 // Get server edl
 365         EDL *get_edl();
 366 // Get the direction of the most recent process_buffer
 367         int get_direction();
 368
 369 // Plugin must call this before performing OpenGL operations.
 370 // Returns 1 if the user supports opengl buffers.
 371         int get_use_opengl();
 372
 373 // Get total tracks to process
 374         int get_total_buffers();
 375
 376 // Get size of buffer to fill in non-realtime plugin
 377         int get_buffer_size();
 378
 379 // Get interpolation used by EDL from overlayframe.inc
 380         int get_interpolation_type();
 381
 382 // Get the values from the color picker
 383         float get_red();
 384         float get_green();
 385         float get_blue();
 386
 387
 388
 389 // Operations for file handlers
 390         virtual int open_file() { return 0; };
 391         virtual int get_audio_parameters() { return 0; };
 392         virtual int get_video_parameters() { return 0; };
 393         virtual int check_header(char *path) { return 0; };
 394         virtual int open_file(char *path, int wr, int rd) { return 1; };
 395         virtual int close_file() { return 0; };
 396
 397
 398
 399
 400
 401 // All plugins define these.
 402         PluginClientThread* get_thread();
 403
 404
 405
 406 // Non realtime operations for signal processors.
 407         virtual int plugin_start_loop(int64_t start,
 408                 int64_t end,
 409                 int64_t buffer_size,
 410                 int total_buffers);
 411         int plugin_stop_loop();
 412         int plugin_process_loop();
 413         MainProgressBar* start_progress(char *string, int64_t length);
 414 // get samplerate of EDL
 415         int get_project_samplerate();
 416 // get framerate of EDL
 417         double get_project_framerate();
 418 // get asset path
 419         const char *get_source_path();
 420 // Total number of processors - 1
 421         int get_project_smp();
 422         int get_aspect_ratio(float &aspect_w, float &aspect_h);
 423
 424
 425         int write_frames(int64_t total_frames);  // returns 1 for failure / tells the server that all output channel buffers are ready to go
 426         int write_samples(int64_t total_samples);  // returns 1 for failure / tells the server that all output channel buffers are ready to go
 427         virtual int plugin_get_parameters();
 428         const char* get_defaultdir();     // Directory defaults should be stored in
 429         void set_interactive();
 430
 431 // Realtime operations.
 432         int reset();
 433 // Extension of plugin_run for derived plugins
 434         virtual int plugin_command_derived(int plugin_command) { return 0; };
 435         int plugin_get_range();
 436         int plugin_init_realtime(int realtime_priority,
 437                 int total_in_buffers,
 438                 int buffer_size);
 439
 440
 441 // GUI updating wrappers for realtime plugins
 442 // Append frame to queue for next send_frame_buffer
 443         void add_gui_frame(PluginClientFrame *frame);
 444
 445
 446
 447         virtual void render_gui(void *data);
 448         virtual void render_gui(void *data, int size);
 449
 450 // Called by client to get the total number of frames to draw in update_gui
 451         int get_gui_update_frames();
 452 // Get GUI frame from frame_buffer.  Client must delete it.
 453         PluginClientFrame* get_gui_frame();
 454
 455 // Called by client to cause GUI to be rendered with data.
 456         void send_render_gui();
 457         void send_render_gui(void *data);
 458         void send_render_gui(void *data, int size);
 459
 460
 461
 462
 463
 464
 465
 466
 467 // create pointers to buffers of the plugin's type before realtime rendering
 468         virtual int delete_buffer_ptrs();
 469
 470
 471
 472
 473 // communication convenience routines for the base class
 474         int stop_gui_client();
 475         int save_data_client();
 476         int load_data_client();
 477         int set_string_client(char *string);                // set the string identifying the plugin
 478         int send_cancelled();        // non realtime plugin sends when cancelled
 479
 480 // ================================= Buffers ===============================
 481
 482 // number of double buffers for each channel
 483         ArrayList<int> double_buffers_in;
 484         ArrayList<int> double_buffers_out;
 485 // When arming buffers need to know the offsets in all the buffers and which
 486 // double buffers for each channel before rendering.
 487         ArrayList<int64_t> offset_in_render;
 488         ArrayList<int64_t> offset_out_render;
 489         ArrayList<int64_t> double_buffer_in_render;
 490         ArrayList<int64_t> double_buffer_out_render;
 491 // total size of each buffer depends on if it's a master or node
 492         ArrayList<int64_t> realtime_in_size;
 493         ArrayList<int64_t> realtime_out_size;
 494
 495 // ================================= Automation ===========================
 496
 497         ArrayList<PluginClientAuto> automation;
 498
 499 // ================================== Messages ===========================
 500         char gui_string[BCTEXTLEN];          // string identifying module and plugin
 501         int master_gui_on;              // Status of the master gui plugin
 502         int client_gui_on;              // Status of this client's gui
 503
 504         int show_initially;             // set to show a realtime plugin initially
 505 // range in project for processing
 506         int64_t start, end;
 507         int interactive;                // for the progress bar plugin
 508         int success;
 509         int total_out_buffers;          // total send buffers allocated by the server
 510         int total_in_buffers;           // total receive buffers allocated by the server
 511         int wr, rd;                     // File permissions for fileio plugins.
 512
 513 // These give the largest fragment the plugin is expected to handle.
 514 // size of a send buffer to the server
 515         int64_t out_buffer_size;
 516 // size of a receive buffer from the server
 517         int64_t in_buffer_size;
 518
 519
 520
 521
 522 // Direction of most recent process_buffer
 523         int direction;
 524
 525 // Operating system scheduling
 526         int realtime_priority;
 527
 528 // Position relative to start of EDL in requested rate.  Calculated for every process
 529 // command.  Used for keyframes.
 530         int64_t source_position;
 531 // For realtime plugins gets the lowest sample of the plugin in the requested
 532 // rate.  For others it's always 0.
 533         int64_t source_start;
 534 // Length of source.  For effects it's the plugin length.  For transitions
 535 // it's the transition length.  Relative to the requested rate.
 536         int64_t total_len;
 537 // Total number of processors available - 1
 538         int smp;
 539         PluginServer *server;
 540         BC_Hash *defaults;
 541         PluginClientThread *thread;
 542
 543 // Frames for updating GUI
 544         ArrayList<PluginClientFrame*> frame_buffer;
 545 // Time of last GUI update
 546         Timer *update_timer;
 547
 548
 549 private:
 550         int using_defaults;
 551 // Temporaries set in new_window
 552         int window_x, window_y;
 553 // File handlers:
 554 //      Asset *asset;     // Point to asset structure in shared memory
 555 };
 556
 557
 558 #endif