+++ /dev/null
-
-/*
- * CINELERRA
- * Copyright (C) 2008 Adam Williams <broadcast at earthling dot net>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- *
- */
-
-#ifndef PLUGINSERVER_H
-#define PLUGINSERVER_H
-
-// inherited by plugins
-
-
-#include <stdio.h>
-#include <stdint.h>
-#include <string.h>
-#include <unistd.h>
-
-#include "arraylist.h"
-#include "attachmentpoint.inc"
-#include "edl.inc"
-#include "floatauto.inc"
-#include "floatautos.inc"
-#include "garbage.h"
-#include "keyframe.inc"
-#include "ladspa.h"
-#include "mainprogress.inc"
-#include "maxbuffers.h"
-#include "menueffects.inc"
-#include "module.inc"
-#include "mwindow.inc"
-#include "plugin.inc"
-#include "pluginaclientlad.inc"
-#include "pluginfclient.inc"
-#include "pluginclient.inc"
-#include "pluginserver.inc"
-#include "preferences.inc"
-#include "samples.inc"
-#include "theme.inc"
-#include "thread.h"
-#include "track.inc"
-#include "vframe.inc"
-#include "videodevice.inc"
-#include "virtualnode.inc"
-
-#include <dlfcn.h>
-
-class PluginObj : public Garbage {
- void *dlobj;
-public:
-
- void *load(const char *dlp) { return dlobj = dlopen(dlp, RTLD_NOW); }
- void *load(const char *plugin_dir, const char *path);
- void unload(void *obj) { dlclose(obj); }
- void *load_sym(const char *sym) { return dlsym(dlobj, sym); }
- const char *load_error() { return dlerror(); }
- void *obj() { return dlobj; }
-
- PluginObj() : Garbage("PluginObj:Garbage") { dlobj = 0; }
- ~PluginObj() { if( dlobj ) unload(dlobj); }
-};
-
-class PluginServer
-{
- PluginObj *plugin_obj;
- int load_obj();
- const char *load_error();
- void *get_sym(const char *sym);
-
- int reset_parameters();
- void init();
- int cleanup_plugin();
-
-// Base class created by client
- PluginClient *client;
-// If no path, this is going to be set to a function which
-// instantiates the plugin.
- PluginClient* (*new_plugin)(PluginServer*);
-
-// LAD support
- int lad_index;
- LADSPA_Descriptor_Function lad_descriptor_function;
- const LADSPA_Descriptor *lad_descriptor;
- int use_opengl;
-// FFMPEG support
- const char *ff_name;
-// Driver for opengl calls.
- VideoDevice *vdevice;
-public:
- PluginServer();
- PluginServer(MWindow *mwindow, char *path, int type);
- PluginServer(PluginServer &);
- virtual ~PluginServer();
-
- friend class PluginAClientLAD;
- friend class PluginAClientConfig;
- friend class PluginAClientWindow;
-
- friend class PluginFClient;
- friend class PluginFAClient;
- friend class PluginFVClient;
- friend class PluginFClientConfig;
- friend class PluginFClientWindow;
-
-// open a plugin and wait for commands
-// Get information for plugindb if master.
-#define PLUGINSERVER_IS_LAD 2
-#define PLUGINSERVER_NOT_RECOGNIZED 1
-#define PLUGINSERVER_OK 0
- int open_plugin(int master, Preferences *preferences,
- EDL *edl, Plugin *plugin);
-// close the plugin
- int close_plugin();
- int get_theme_png_path(char *png_path, const char *theme_dir);
- int get_theme_png_path(char *png_path, Theme *theme);
- int get_plugin_png_path(char *png_path);
- void dump(FILE *fp=stdout);
-// Release any objects which are required after playback stops.
- void render_stop();
-// Write entry into plugin table
- void write_table(FILE *fp, const char *path, int idx, int64_t mtime);
- static int scan_table(char *text, int &type, char *path, char *title, int64_t &mtime);
- int read_table(char *text);
-// queries
- void set_title(const char *string);
-// Generate title for display
- void generate_display_title(char *string);
-// Get keyframes for configuration. Position is always relative to EDL rate.
- KeyFrame* get_prev_keyframe(int64_t position);
- KeyFrame* get_next_keyframe(int64_t position);
-// get camera and projector positions
- void get_camera(float *x, float *y, float *z,
- int64_t position, int direction);
- void get_projector(float *x, float *y, float *z,
- int64_t position, int direction);
-// Get interpolation used by EDL
- int get_interpolation_type();
-// Get or create keyframe for writing, depending on whether auto keyframes
-// is enabled. Called by PluginClient::send_configure_change
- KeyFrame* get_keyframe();
-// Apply new settings from the plugin GUI. Called by PluginClient::send_configure_change
-// Used in keyframe spanning mode.
- void apply_keyframe(KeyFrame *src);
-
-// Create new theme object. Used by theme plugins.
- Theme* new_theme();
-// Get theme being used by Cinelerra currently. Used by all plugins.
- Theme* get_theme();
-// Get picon png vframe image
- VFrame *get_picon();
- VFrame *get_plugin_images();
-
-// ladspa
- void set_lad_index(int i);
- int get_lad_index();
- int is_ladspa();
-// ffmpeg
- int is_ffmpeg();
- PluginClient *new_ffmpeg_plugin();
-// =============================== for realtime plugins
-// save configuration of plugin
- void save_data(KeyFrame *keyframe);
-// Update EDL and playback engines to reflect changes
- void sync_parameters();
-// set for realtime processor usage
- int set_realtime_sched();
- int get_gui_status();
-// Raise the GUI
- void raise_window();
-// cause the plugin to show the GUI
-// Called by MWindow::show_plugin
- void show_gui();
- void hide_gui();
-// Update GUI with keyframe settings
- void update_gui();
- void update_title();
- void client_side_close();
-// Set to 1 before every process call if the user supports OpenGL buffers.
-// Also provides the driver location.
- void set_use_opengl(int value, VideoDevice *vdevice);
-// Plugin must call this before performing OpenGL operations.
- int get_use_opengl();
-
-// Called from plugin client
-// Returns 1 if a GUI is open so OpenGL routines can determine if
-// they can run.
- int gui_open();
-// Called by plugin client to request synchronous routine.
- void run_opengl(PluginClient *plugin_client);
-
-// set the string that appears on the plugin title
- int set_string(char *string);
-// give the buffers and sizes and prepare processing realtime data
- int init_realtime(int realtime_sched,
- int total_in_buffers,
- int buffer_size);
-// process the data in the buffers
-// input - the current edit's data
-// output - the previous edit's data and the destination of the transition output
-// current_position - Position from start of the transition and
-// relative to the transition.
-// total_len - total len for transition
- void process_transition(VFrame *input,
- VFrame *output,
- int64_t current_position,
- int64_t total_len);
- void process_transition(Samples *input,
- Samples *output,
- int64_t current_position,
- int64_t fragment_size,
- int64_t total_len);
-
-// Process using pull method.
-// current_position - start of region if forward, end of region if reverse
-// relative to requested rate
-// fragment_size - amount of data to put in buffer relative to requested rate
-// sample_rate - sample rate of requested output
-// frame_rate - frame rate of requested output
-// total_len - length of plugin in track units relative to the EDL rate
-// Units are kept relative to the EDL rate so plugins don't need to convert rates
-// to get the keyframes.
- void process_buffer(VFrame **frame,
- int64_t current_position,
- double frame_rate,
- int64_t total_len,
- int direction);
- void process_buffer(Samples **buffer,
- int64_t current_position,
- int64_t fragment_size,
- int64_t sample_rate,
- int64_t total_len,
- int direction);
-
-// Called by rendering client to cause the GUI to display something with the data.
- void send_render_gui(void *data);
- void send_render_gui(void *data, int size);
-// Called by MWindow to cause GUI to display
- void render_gui(void *data);
- void render_gui(void *data, int size);
-
-// Send the boundary autos of the next fragment
- int set_automation(FloatAutos *autos, FloatAuto **start_auto, FloatAuto **end_auto, int reverse);
-
-
-
-// set the fragment position of a buffer before rendering
- int arm_buffer(int buffer_number,
- int64_t in_fragment_position,
- int64_t out_fragment_position,
- int double_buffer_in,
- int double_buffer_out);
-// Detach all the shared buffers.
- int detach_buffers();
-
- int send_buffer_info();
-
-
-// ============================ for non realtime plugins
-// start processing data in plugin
- int start_loop(int64_t start, int64_t end, int64_t buffer_size, int total_buffers);
-// Do one iteration of a nonrealtime plugin and return if finished
- int process_loop(VFrame **buffers, int64_t &write_length);
- int process_loop(Samples **buffers, int64_t &write_length);
- int stop_loop();
-
-
-// Called by client to read data in non-realtime effect
- int read_frame(VFrame *buffer,
- int channel,
- int64_t start_position);
- int read_samples(Samples *buffer,
- int channel,
- int64_t start_position,
- int64_t len);
-
-
-// Called by client to read data in realtime effect.
-// Returns -1 if error or 0 if success.
- int read_frame(VFrame *buffer,
- int channel,
- int64_t start_position,
- double frame_rate,
-// Set to 1 if the reader can use OpenGL objects.
- int use_opengl = 0);
- int read_samples(Samples *buffer,
- int channel,
- int64_t sample_rate,
- int64_t start_position,
- int64_t len);
-
-// For non realtime, prompt user for parameters, waits for plugin to finish and returns a result
- int get_parameters(int64_t start, int64_t end, int channels);
- int get_samplerate(); // get samplerate produced by plugin
- double get_framerate(); // get framerate produced by plugin
- int get_project_samplerate(); // get samplerate of project data before processing
- double get_project_framerate(); // get framerate of project data before processing
- void set_path(const char *path); // required first
- char *get_path();
- int get_synthesis();
- void get_defaults_path(char *path);
- void save_defaults();
-// Used by PluginArray and MenuEffects to get user parameters and progress bar.
-// Set pointer to mwindow for opening GUI and reconfiguring EDL.
- void set_mwindow(MWindow *mwindow);
-// Used in VirtualConsole
-// Set pointer to AttachmentPoint to render GUI.
- void set_attachmentpoint(AttachmentPoint *attachmentpoint);
-// Set pointer to a default keyframe when there is no plugin
- void set_keyframe(KeyFrame *keyframe);
-// Set pointer to menueffect window
- void set_prompt(MenuEffectPrompt *prompt);
- int set_interactive(); // make this the master plugin for progress bars
- int set_error(); // flag to send plugin an error on next request
- MainProgressBar* start_progress(char *string, int64_t length);
-
-// add track to the list of affected tracks for a non realtime plugin
- void append_module(Module *module);
-// add node for realtime plugin
- void append_node(VirtualNode *node);
-// reset node table after virtual console reconfiguration
- void reset_nodes();
-
- int64_t get_written_samples(); // after samples are written, get the number written
- int64_t get_written_frames(); // after frames are written, get the number written
-
-// client origin
- int plugin_type;
-
-// buffers
- int64_t out_buffer_size; // size of a send buffer to the plugin
- int64_t in_buffer_size; // size of a recieve buffer from the plugin
- int total_in_buffers;
- int total_out_buffers;
-
-// number of double buffers for each channel
- ArrayList<int> ring_buffers_in;
- ArrayList<int> ring_buffers_out;
-// Parameters for automation. Setting autos to 0 disables automation.
- FloatAuto **start_auto, **end_auto;
- FloatAutos *autos;
- int reverse;
-
-// size of each buffer
- ArrayList<int64_t> realtime_in_size;
- ArrayList<int64_t> realtime_out_size;
-
-// When arming buffers need to know the offsets in all the buffers and which
-// double buffers for each channel before rendering.
- ArrayList<int64_t> offset_in_render;
- ArrayList<int64_t> offset_out_render;
- ArrayList<int64_t> double_buffer_in_render;
- ArrayList<int64_t> double_buffer_out_render;
-
-// don't delete buffers if they belong to a virtual module
- int shared_buffers;
-// Send new buffer information for next render
- int new_buffers;
-
-
- int plugin_open; // Whether or not the plugin is open.
-// Specifies what type of plugin.
- int realtime, multichannel, fileio;
-// Plugin generates media
- int synthesis;
-// What data types the plugin can handle. One of these is set.
- int audio, video, theme;
-// Can display a GUI
- int uses_gui;
-// Plugin is a transition
- int transition;
-// name of plugin in english.
-// Compared against the title value in the plugin for resolving symbols.
- char *title;
- int64_t written_samples, written_frames;
- char *path; // location of plugin on disk
- char *data_text; // pointer to the data that was requested by a save_data command
- char *args[4];
- int total_args;
- int error_flag; // send plugin an error code on next request
- int dir_idx; // directory id, for icon visibility grouping
-// Pointers to tracks affected by this plugin during a non realtime operation.
-// Allows read functions to read data.
- ArrayList<Module*> *modules;
-// Used by realtime read functions to get data. Corresponds to the buffer table in the
-// attachment point.
- ArrayList<VirtualNode*> *nodes;
- AttachmentPoint *attachmentpoint;
- MWindow *mwindow;
-// Pointer to keyframe when plugin is not available
- KeyFrame *keyframe;
- AttachmentPoint *attachment;
-// Storage of keyframes and GUI status
- Plugin *plugin;
-
-// Storage of session parameters
- EDL *edl;
- Preferences *preferences;
- MenuEffectPrompt *prompt;
- int gui_on;
-
- VFrame *temp_frame;
-
-// Icon for tracking update
- VFrame *picon;
-};
-
-
-#endif
projects / goodguy / history.git / blobdiff