4 * Copyright (C) 1997-2011 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 #include "bcdisplayinfo.h"
24 #include "bcsignals.h"
26 #include "condition.h"
30 #include "edlsession.h"
32 #include "filesystem.h"
33 #include "indexable.h"
35 #include "localsession.h"
39 #include "pluginclient.h"
40 #include "pluginserver.h"
41 #include "preferences.h"
43 #include "transportque.inc"
54 PluginClientThread::PluginClientThread(PluginClient *client)
57 this->client = client;
59 init_complete = new Condition(0, "PluginClientThread::init_complete");
62 PluginClientThread::~PluginClientThread()
65 //printf("PluginClientThread::~PluginClientThread %p %d\n", this, __LINE__);
66 delete window; window = 0;
67 //printf("PluginClientThread::~PluginClientThread %p %d\n", this, __LINE__);
71 void PluginClientThread::run()
75 if(client->window_x < 0) client->window_x = info.get_abs_cursor_x();
76 if(client->window_y < 0) client->window_y = info.get_abs_cursor_y();
78 window = (PluginClientWindow*)client->new_window();
81 window->lock_window("PluginClientThread::run");
82 window->create_objects();
83 window->unlock_window();
85 /* Only set it here so tracking doesn't update it until everything is created. */
86 client->thread = this;
87 init_complete->unlock();
89 result = window->run_window();
90 window->lock_window("PluginClientThread::run");
91 //printf("PluginClientThread::run %p %d\n", this, __LINE__);
92 window->hide_window(1);
93 window->unlock_window();
94 window->done_event(result);
95 // Can't save defaults in the destructor because it's not called immediately
97 /* if(client->defaults) */ client->save_defaults_xml();
98 /* This is needed when the GUI is closed from itself */
99 if(result) client->client_side_close();
104 client->thread = this;
105 init_complete->unlock();
109 BC_WindowBase* PluginClientThread::get_window()
114 PluginClient* PluginClientThread::get_client()
124 PluginClientFrame::PluginClientFrame(int data_size,
128 this->data_size = data_size;
130 this->period_n = period_n;
131 this->period_d = period_d;
134 PluginClientFrame::~PluginClientFrame()
143 PluginClientWindow::PluginClientWindow(PluginClient *client,
149 : BC_Window(client->gui_string,
150 client->window_x /* - w / 2 */,
151 client->window_y /* - h / 2 */,
152 w, h, min_w, min_h, allow_resize, 0, 1)
154 this->client = client;
157 PluginClientWindow::PluginClientWindow(const char *title,
158 int x, int y, int w, int h, int min_w, int min_h, int allow_resize)
159 : BC_Window(title, x, y, w, h, min_w, min_h, allow_resize, 0, 1)
164 PluginClientWindow::~PluginClientWindow()
169 int PluginClientWindow::translation_event()
173 client->window_x = get_x();
174 client->window_y = get_y();
180 int PluginClientWindow::close_event()
182 /* Set result to 1 to indicate a client side close */
191 PluginClient::PluginClient(PluginServer *server)
194 this->server = server;
195 smp = server->preferences->project_smp;
197 update_timer = new Timer;
198 // Virtual functions don't work here.
201 PluginClient::~PluginClient()
203 // Delete the GUI thread. The GUI must be hidden with hide_gui first.
206 // Virtual functions don't work here.
207 if(defaults) delete defaults;
208 frame_buffer.remove_all_objects();
212 int PluginClient::reset()
221 realtime_priority = 0;
223 total_in_buffers = 0;
224 total_out_buffers = 0;
228 direction = PLAY_FORWARD;
235 void PluginClient::hide_gui()
237 if(thread && thread->window)
239 //printf("PluginClient::delete_thread %d\n", __LINE__);
240 /* This is needed when the GUI is closed from elsewhere than itself */
241 /* Since we now use autodelete, this is all that has to be done, thread will take care of itself ... */
242 /* Thread join will wait if this was not called from the thread itself or go on if it was */
243 thread->window->lock_window("PluginClient::hide_gui");
244 thread->window->set_done(0);
245 //printf("PluginClient::hide_gui %d thread->window=%p\n", __LINE__, thread->window);
246 thread->window->unlock_window();
247 //printf("PluginClient::delete_thread %d\n", __LINE__);
251 // For realtime plugins initialize buffers
252 int PluginClient::plugin_init_realtime(int realtime_priority,
253 int total_in_buffers,
257 // Get parameters for all
258 master_gui_on = get_gui_status();
262 // get parameters depending on video or audio
263 init_realtime_parameters();
265 this->realtime_priority = realtime_priority;
266 this->total_in_buffers = this->total_out_buffers = total_in_buffers;
267 this->out_buffer_size = this->in_buffer_size = buffer_size;
271 int PluginClient::plugin_start_loop(int64_t start,
276 //printf("PluginClient::plugin_start_loop %d %ld %ld %ld %d\n",
277 // __LINE__, start, end, buffer_size, total_buffers);
278 this->source_start = start;
279 this->total_len = end - start;
282 this->in_buffer_size = this->out_buffer_size = buffer_size;
283 this->total_in_buffers = this->total_out_buffers = total_buffers;
288 int PluginClient::plugin_process_loop()
290 return process_loop();
293 int PluginClient::plugin_stop_loop()
298 MainProgressBar* PluginClient::start_progress(char *string, int64_t length)
300 return server->start_progress(string, length);
304 // Non realtime parameters
305 int PluginClient::plugin_get_parameters()
307 int result = get_parameters();
308 if(defaults) save_defaults();
312 // ========================= main loop
314 int PluginClient::is_multichannel() { return 0; }
315 int PluginClient::is_synthesis() { return 0; }
316 int PluginClient::is_realtime() { return 0; }
317 int PluginClient::is_fileio() { return 0; }
318 int PluginClient::delete_buffer_ptrs() { return 0; }
319 const char* PluginClient::plugin_title() { return _("Untitled"); }
321 Theme* PluginClient::new_theme() { return 0; }
323 int PluginClient::load_configuration()
328 Theme* PluginClient::get_theme()
330 return server->get_theme();
333 int PluginClient::show_gui()
335 load_configuration();
336 thread = new PluginClientThread(this);
338 thread->init_complete->lock("PluginClient::show_gui");
339 // Must wait before sending any hide_gui
340 if( !thread->window ) return 1;
341 thread->window->init_wait();
345 void PluginClient::raise_window()
347 if(thread && thread->window)
349 thread->window->lock_window("PluginClient::raise_window");
350 thread->window->raise_window();
351 thread->window->flush();
352 thread->window->unlock_window();
356 int PluginClient::set_string()
360 thread->window->lock_window("PluginClient::set_string");
361 thread->window->put_title(gui_string);
362 thread->window->unlock_window();
371 void PluginClient::begin_process_buffer()
373 // Delete all unused GUI frames
374 frame_buffer.remove_all_objects();
378 void PluginClient::end_process_buffer()
380 if(frame_buffer.size())
388 void PluginClient::plugin_update_gui()
393 // Delete unused GUI frames
394 while(frame_buffer.size() > MAX_FRAME_BUFFER)
395 frame_buffer.remove_object_number(0);
399 void PluginClient::update_gui()
403 int PluginClient::get_gui_update_frames()
405 if(frame_buffer.size())
407 PluginClientFrame *frame = frame_buffer.get(0);
408 int total_frames = update_timer->get_difference() *
412 if(total_frames) update_timer->subtract(total_frames *
417 // printf("PluginClient::get_gui_update_frames %d %ld %d %d %d\n",
419 // update_timer->get_difference(),
420 // frame->period_n * 1000 / frame->period_d,
422 // frame_buffer.size());
425 for(int i = 0; i < frame_buffer.size(); i++)
426 if(frame_buffer.get(i)->force) total_frames++;
427 total_frames = MIN(frame_buffer.size(), total_frames);
438 PluginClientFrame* PluginClient::get_gui_frame()
440 if(frame_buffer.size())
442 PluginClientFrame *frame = frame_buffer.get(0);
443 frame_buffer.remove_number(0);
452 void PluginClient::add_gui_frame(PluginClientFrame *frame)
454 frame_buffer.append(frame);
457 void PluginClient::send_render_gui()
459 server->send_render_gui(&frame_buffer);
462 void PluginClient::send_render_gui(void *data)
464 server->send_render_gui(data);
467 void PluginClient::send_render_gui(void *data, int size)
469 server->send_render_gui(data, size);
472 void PluginClient::plugin_render_gui(void *data, int size)
474 render_gui(data, size);
478 void PluginClient::plugin_render_gui(void *data)
483 void PluginClient::render_gui(void *data)
487 thread->get_window()->lock_window("PluginClient::render_gui");
489 // Set all previous frames to draw immediately
490 for(int i = 0; i < frame_buffer.size(); i++)
491 frame_buffer.get(i)->force = 1;
493 ArrayList<PluginClientFrame*> *src =
494 (ArrayList<PluginClientFrame*>*)data;
496 // Shift GUI data to GUI client
499 this->frame_buffer.append(src->get(0));
500 src->remove_number(0);
503 // Start the timer for the current buffer
504 update_timer->update();
505 thread->get_window()->unlock_window();
509 void PluginClient::render_gui(void *data, int size)
511 printf("PluginClient::render_gui %d\n", __LINE__);
521 int PluginClient::is_audio() { return 0; }
522 int PluginClient::is_video() { return 0; }
523 int PluginClient::is_theme() { return 0; }
524 int PluginClient::uses_gui() { return 1; }
525 int PluginClient::is_transition() { return 0; }
526 int PluginClient::load_defaults()
528 // printf("PluginClient::load_defaults undefined in %s.\n", plugin_title());
532 int PluginClient::save_defaults()
535 // printf("PluginClient::save_defaults undefined in %s.\n", plugin_title());
539 void PluginClient::load_defaults_xml()
541 char path[BCTEXTLEN];
542 server->get_defaults_path(path);
544 fs.complete_path(path);
546 //printf("PluginClient::load_defaults_xml %d %s\n", __LINE__, path);
548 KeyFrame temp_keyframe;
549 FILE *fd = fopen(path, "r");
552 char *data = temp_keyframe.get_data();
553 int data_size = fread(data, 1, MESSAGESIZE-1, fd);
554 if( data_size < 0 ) data_size = 0;
557 // Get window extents
559 for(int i = 0; i < data_size - 8; i++)
561 if(data[i] == '<') break;
566 window_x = atoi(data + i);
571 window_y = atoi(data + i);
574 while(i < data_size && isdigit(data[i])) i++;
578 read_data(&temp_keyframe);
584 //printf("PluginClient::load_defaults_xml %d %s\n", __LINE__, path);
587 void PluginClient::save_defaults_xml()
589 char path[BCTEXTLEN];
590 server->get_defaults_path(path);
592 fs.complete_path(path);
595 KeyFrame temp_keyframe;
596 save_data(&temp_keyframe);
598 const char *data = temp_keyframe.get_data();
599 int len = strlen(data);
600 FILE *fp = fopen(path, "w");
603 fprintf(fp, "%d\n%d\n", window_x, window_y);
604 if( len > 0 && !fwrite(data, len, 1, fp) ) {
605 fprintf(stderr, "PluginClient::save_defaults_xml %d \"%s\" %d bytes: %s\n",
606 __LINE__, path, len, strerror(errno));
614 int PluginClient::is_defaults()
616 return using_defaults;
619 BC_Hash* PluginClient::get_defaults()
623 PluginClientThread* PluginClient::get_thread()
628 BC_WindowBase* PluginClient::new_window()
630 printf("PluginClient::new_window undefined in %s.\n", plugin_title());
633 int PluginClient::get_parameters() { return 0; }
634 int PluginClient::get_samplerate() { return get_project_samplerate(); }
635 double PluginClient::get_framerate() { return get_project_framerate(); }
636 int PluginClient::init_realtime_parameters() { return 0; }
637 int PluginClient::delete_nonrealtime_parameters() { return 0; }
638 int PluginClient::start_loop() { return 0; };
639 int PluginClient::process_loop() { return 0; };
640 int PluginClient::stop_loop() { return 0; };
642 void PluginClient::set_interactive()
647 int64_t PluginClient::get_in_buffers(int64_t recommended_size)
649 return recommended_size;
652 int64_t PluginClient::get_out_buffers(int64_t recommended_size)
654 return recommended_size;
657 int PluginClient::get_gui_status()
659 return server->get_gui_status();
662 // close event from client side
663 void PluginClient::client_side_close()
665 // Last command executed
666 server->client_side_close();
669 int PluginClient::stop_gui_client()
671 if(!client_gui_on) return 0;
676 int PluginClient::get_project_samplerate()
678 return server->get_project_samplerate();
681 double PluginClient::get_project_framerate()
683 return server->get_project_framerate();
686 const char *PluginClient::get_source_path()
688 int64_t source_position = server->plugin->startproject;
689 Edit *edit = server->plugin->track->edits->editof(source_position,PLAY_FORWARD,0);
690 Indexable *indexable = edit ? edit->get_source() : 0;
691 return indexable ? indexable->path : 0;
695 void PluginClient::update_display_title()
697 server->generate_display_title(gui_string);
701 char* PluginClient::get_gui_string()
707 char* PluginClient::get_path()
712 char* PluginClient::get_plugin_dir()
714 return server->preferences->plugin_dir;
717 int PluginClient::set_string_client(char *string)
719 strcpy(gui_string, string);
725 int PluginClient::get_interpolation_type()
727 return server->get_interpolation_type();
731 float PluginClient::get_red()
733 EDL *edl = server->mwindow ? server->mwindow->edl : server->edl;
734 return !edl ? 0 : edl->local_session->use_max ?
735 edl->local_session->red_max :
736 edl->local_session->red;
739 float PluginClient::get_green()
741 EDL *edl = server->mwindow ? server->mwindow->edl : server->edl;
742 return !edl ? 0 : edl->local_session->use_max ?
743 edl->local_session->green_max :
744 edl->local_session->green;
747 float PluginClient::get_blue()
749 EDL *edl = server->mwindow ? server->mwindow->edl : server->edl;
750 return !edl ? 0 : edl->local_session->use_max ?
751 edl->local_session->blue_max :
752 edl->local_session->blue;
756 int64_t PluginClient::get_source_position()
758 return source_position;
761 int64_t PluginClient::get_source_start()
766 int64_t PluginClient::get_total_len()
771 int PluginClient::get_direction()
777 int64_t PluginClient::local_to_edl(int64_t position)
782 int64_t PluginClient::edl_to_local(int64_t position)
787 int PluginClient::get_use_opengl()
789 return server->get_use_opengl();
792 int PluginClient::get_total_buffers()
794 return total_in_buffers;
797 int PluginClient::get_buffer_size()
799 return in_buffer_size;
802 int PluginClient::get_project_smp()
804 //printf("PluginClient::get_project_smp %d %d\n", __LINE__, smp);
808 const char* PluginClient::get_defaultdir()
810 return File::get_plugin_path();
814 int PluginClient::send_hide_gui()
816 // Stop the GUI server and delete GUI messages
821 int PluginClient::send_configure_change()
824 server->mwindow->undo->update_undo_before(_("tweek"), this);
825 #ifdef USE_KEYFRAME_SPANNING
827 keyframe.copy_from(server->get_keyframe());
828 save_data(&keyframe);
829 server->apply_keyframe(&keyframe);
831 KeyFrame* keyframe = server->get_keyframe();
832 // Call save routine in plugin
836 server->mwindow->undo->update_undo_after(_("tweek"), LOAD_AUTOMATION);
837 server->sync_parameters();
842 KeyFrame* PluginClient::get_prev_keyframe(int64_t position, int is_local)
844 if(is_local) position = local_to_edl(position);
845 return server->get_prev_keyframe(position);
848 KeyFrame* PluginClient::get_next_keyframe(int64_t position, int is_local)
850 if(is_local) position = local_to_edl(position);
851 return server->get_next_keyframe(position);
854 void PluginClient::get_camera(float *x, float *y, float *z, int64_t position)
856 server->get_camera(x, y, z, position, direction);
859 void PluginClient::get_projector(float *x, float *y, float *z, int64_t position)
861 server->get_projector(x, y, z, position, direction);
865 EDLSession* PluginClient::get_edlsession()
868 return server->edl->session;
872 int PluginClient::gui_open()
874 return server->gui_open();