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 (int)(w*get_resources()->font_scale+0.5), (int)(h*get_resources()->font_scale+0.5),
153 (int)(min_w*get_resources()->font_scale+0.5), (int)(min_h*get_resources()->font_scale+0.5),
156 this->client = client;
159 PluginClientWindow::PluginClientWindow(const char *title,
160 int x, int y, int w, int h, int min_w, int min_h, int allow_resize)
161 : BC_Window(title, x, y,
162 (int)(w*get_resources()->font_scale+0.5), (int)(h*get_resources()->font_scale+0.5),
163 (int)(min_w*get_resources()->font_scale+0.5), (int)(min_h*get_resources()->font_scale+0.5),
169 PluginClientWindow::~PluginClientWindow()
174 int PluginClientWindow::translation_event()
178 client->window_x = get_x();
179 client->window_y = get_y();
185 int PluginClientWindow::close_event()
187 /* Set result to 1 to indicate a client side close */
196 PluginClient::PluginClient(PluginServer *server)
199 this->server = server;
200 smp = server->preferences->project_smp;
202 update_timer = new Timer;
203 // Virtual functions don't work here.
206 PluginClient::~PluginClient()
208 // Delete the GUI thread. The GUI must be hidden with hide_gui first.
211 // Virtual functions don't work here.
212 if(defaults) delete defaults;
213 frame_buffer.remove_all_objects();
217 int PluginClient::reset()
226 realtime_priority = 0;
228 total_in_buffers = 0;
229 total_out_buffers = 0;
233 direction = PLAY_FORWARD;
240 void PluginClient::hide_gui()
242 if(thread && thread->window)
244 //printf("PluginClient::delete_thread %d\n", __LINE__);
245 /* This is needed when the GUI is closed from elsewhere than itself */
246 /* Since we now use autodelete, this is all that has to be done, thread will take care of itself ... */
247 /* Thread join will wait if this was not called from the thread itself or go on if it was */
248 thread->window->lock_window("PluginClient::hide_gui");
249 thread->window->set_done(0);
250 //printf("PluginClient::hide_gui %d thread->window=%p\n", __LINE__, thread->window);
251 thread->window->unlock_window();
252 //printf("PluginClient::delete_thread %d\n", __LINE__);
256 // For realtime plugins initialize buffers
257 int PluginClient::plugin_init_realtime(int realtime_priority,
258 int total_in_buffers,
262 // Get parameters for all
263 master_gui_on = get_gui_status();
267 // get parameters depending on video or audio
268 init_realtime_parameters();
270 this->realtime_priority = realtime_priority;
271 this->total_in_buffers = this->total_out_buffers = total_in_buffers;
272 this->out_buffer_size = this->in_buffer_size = buffer_size;
276 int PluginClient::plugin_start_loop(int64_t start,
281 //printf("PluginClient::plugin_start_loop %d %ld %ld %ld %d\n",
282 // __LINE__, start, end, buffer_size, total_buffers);
283 this->source_start = start;
284 this->total_len = end - start;
287 this->in_buffer_size = this->out_buffer_size = buffer_size;
288 this->total_in_buffers = this->total_out_buffers = total_buffers;
293 int PluginClient::plugin_process_loop()
295 return process_loop();
298 int PluginClient::plugin_stop_loop()
303 MainProgressBar* PluginClient::start_progress(char *string, int64_t length)
305 return server->start_progress(string, length);
309 // Non realtime parameters
310 int PluginClient::plugin_get_parameters()
312 int result = get_parameters();
313 if(defaults) save_defaults();
317 // ========================= main loop
319 int PluginClient::is_multichannel() { return 0; }
320 int PluginClient::is_synthesis() { return 0; }
321 int PluginClient::is_realtime() { return 0; }
322 int PluginClient::is_fileio() { return 0; }
323 int PluginClient::delete_buffer_ptrs() { return 0; }
324 const char* PluginClient::plugin_title() { return _("Untitled"); }
326 Theme* PluginClient::new_theme() { return 0; }
328 int PluginClient::load_configuration()
333 Theme* PluginClient::get_theme()
335 return server->get_theme();
338 int PluginClient::show_gui()
340 load_configuration();
341 thread = new PluginClientThread(this);
343 thread->init_complete->lock("PluginClient::show_gui");
344 // Must wait before sending any hide_gui
345 if( !thread->window ) return 1;
346 thread->window->init_wait();
350 void PluginClient::raise_window()
352 if(thread && thread->window)
354 thread->window->lock_window("PluginClient::raise_window");
355 thread->window->raise_window();
356 thread->window->flush();
357 thread->window->unlock_window();
361 int PluginClient::set_string()
365 thread->window->lock_window("PluginClient::set_string");
366 thread->window->put_title(gui_string);
367 thread->window->unlock_window();
376 void PluginClient::begin_process_buffer()
378 // Delete all unused GUI frames
379 frame_buffer.remove_all_objects();
383 void PluginClient::end_process_buffer()
385 if(frame_buffer.size())
393 void PluginClient::plugin_update_gui()
398 // Delete unused GUI frames
399 while(frame_buffer.size() > MAX_FRAME_BUFFER)
400 frame_buffer.remove_object_number(0);
404 void PluginClient::update_gui()
408 int PluginClient::get_gui_update_frames()
410 if(frame_buffer.size())
412 PluginClientFrame *frame = frame_buffer.get(0);
413 int total_frames = update_timer->get_difference() *
417 if(total_frames) update_timer->subtract(total_frames *
422 // printf("PluginClient::get_gui_update_frames %d %ld %d %d %d\n",
424 // update_timer->get_difference(),
425 // frame->period_n * 1000 / frame->period_d,
427 // frame_buffer.size());
430 for(int i = 0; i < frame_buffer.size(); i++)
431 if(frame_buffer.get(i)->force) total_frames++;
432 total_frames = MIN(frame_buffer.size(), total_frames);
443 PluginClientFrame* PluginClient::get_gui_frame()
445 if(frame_buffer.size())
447 PluginClientFrame *frame = frame_buffer.get(0);
448 frame_buffer.remove_number(0);
457 void PluginClient::add_gui_frame(PluginClientFrame *frame)
459 frame_buffer.append(frame);
462 void PluginClient::send_render_gui()
464 server->send_render_gui(&frame_buffer);
467 void PluginClient::send_render_gui(void *data)
469 server->send_render_gui(data);
472 void PluginClient::send_render_gui(void *data, int size)
474 server->send_render_gui(data, size);
477 void PluginClient::plugin_render_gui(void *data, int size)
479 render_gui(data, size);
483 void PluginClient::plugin_render_gui(void *data)
488 void PluginClient::render_gui(void *data)
492 thread->get_window()->lock_window("PluginClient::render_gui");
494 // Set all previous frames to draw immediately
495 for(int i = 0; i < frame_buffer.size(); i++)
496 frame_buffer.get(i)->force = 1;
498 ArrayList<PluginClientFrame*> *src =
499 (ArrayList<PluginClientFrame*>*)data;
501 // Shift GUI data to GUI client
504 this->frame_buffer.append(src->get(0));
505 src->remove_number(0);
508 // Start the timer for the current buffer
509 update_timer->update();
510 thread->get_window()->unlock_window();
514 void PluginClient::render_gui(void *data, int size)
516 printf("PluginClient::render_gui %d\n", __LINE__);
526 int PluginClient::is_audio() { return 0; }
527 int PluginClient::is_video() { return 0; }
528 int PluginClient::is_theme() { return 0; }
529 int PluginClient::uses_gui() { return 1; }
530 int PluginClient::is_transition() { return 0; }
531 int PluginClient::load_defaults()
533 // printf("PluginClient::load_defaults undefined in %s.\n", plugin_title());
537 int PluginClient::save_defaults()
540 // printf("PluginClient::save_defaults undefined in %s.\n", plugin_title());
544 void PluginClient::load_defaults_xml()
546 char path[BCTEXTLEN];
547 server->get_defaults_path(path);
549 fs.complete_path(path);
551 //printf("PluginClient::load_defaults_xml %d %s\n", __LINE__, path);
553 KeyFrame temp_keyframe;
554 FILE *fd = fopen(path, "r");
557 char *data = temp_keyframe.get_data();
558 int data_size = fread(data, 1, MESSAGESIZE-1, fd);
559 if( data_size < 0 ) data_size = 0;
562 // Get window extents
564 for(int i = 0; i < data_size - 8; i++)
566 if(data[i] == '<') break;
571 window_x = atoi(data + i);
576 window_y = atoi(data + i);
579 while(i < data_size && isdigit(data[i])) i++;
583 read_data(&temp_keyframe);
589 //printf("PluginClient::load_defaults_xml %d %s\n", __LINE__, path);
592 void PluginClient::save_defaults_xml()
594 char path[BCTEXTLEN];
595 server->get_defaults_path(path);
597 fs.complete_path(path);
600 KeyFrame temp_keyframe;
601 save_data(&temp_keyframe);
603 const char *data = temp_keyframe.get_data();
604 int len = strlen(data);
605 FILE *fp = fopen(path, "w");
608 fprintf(fp, "%d\n%d\n", window_x, window_y);
609 if( len > 0 && !fwrite(data, len, 1, fp) ) {
610 fprintf(stderr, "PluginClient::save_defaults_xml %d \"%s\" %d bytes: %s\n",
611 __LINE__, path, len, strerror(errno));
619 int PluginClient::is_defaults()
621 return using_defaults;
624 BC_Hash* PluginClient::get_defaults()
628 PluginClientThread* PluginClient::get_thread()
633 BC_WindowBase* PluginClient::new_window()
635 printf("PluginClient::new_window undefined in %s.\n", plugin_title());
638 int PluginClient::get_parameters() { return 0; }
639 int PluginClient::get_samplerate() { return get_project_samplerate(); }
640 double PluginClient::get_framerate() { return get_project_framerate(); }
641 int PluginClient::init_realtime_parameters() { return 0; }
642 int PluginClient::delete_nonrealtime_parameters() { return 0; }
643 int PluginClient::start_loop() { return 0; };
644 int PluginClient::process_loop() { return 0; };
645 int PluginClient::stop_loop() { return 0; };
647 void PluginClient::set_interactive()
652 int64_t PluginClient::get_in_buffers(int64_t recommended_size)
654 return recommended_size;
657 int64_t PluginClient::get_out_buffers(int64_t recommended_size)
659 return recommended_size;
662 int PluginClient::get_gui_status()
664 return server->get_gui_status();
667 // close event from client side
668 void PluginClient::client_side_close()
670 // Last command executed
671 server->client_side_close();
674 int PluginClient::stop_gui_client()
676 if(!client_gui_on) return 0;
681 int PluginClient::get_project_samplerate()
683 return server->get_project_samplerate();
686 double PluginClient::get_project_framerate()
688 return server->get_project_framerate();
691 const char *PluginClient::get_source_path()
693 int64_t source_position = server->plugin->startproject;
694 Edit *edit = server->plugin->track->edits->editof(source_position,PLAY_FORWARD,0);
695 Indexable *indexable = edit ? edit->get_source() : 0;
696 return indexable ? indexable->path : 0;
700 void PluginClient::update_display_title()
702 server->generate_display_title(gui_string);
706 char* PluginClient::get_gui_string()
712 char* PluginClient::get_path()
717 char* PluginClient::get_plugin_dir()
719 return server->preferences->plugin_dir;
722 int PluginClient::set_string_client(char *string)
724 strcpy(gui_string, string);
730 int PluginClient::get_interpolation_type()
732 return server->get_interpolation_type();
736 float PluginClient::get_red()
738 EDL *edl = server->mwindow ? server->mwindow->edl : server->edl;
739 return !edl ? 0 : edl->local_session->use_max ?
740 edl->local_session->red_max :
741 edl->local_session->red;
744 float PluginClient::get_green()
746 EDL *edl = server->mwindow ? server->mwindow->edl : server->edl;
747 return !edl ? 0 : edl->local_session->use_max ?
748 edl->local_session->green_max :
749 edl->local_session->green;
752 float PluginClient::get_blue()
754 EDL *edl = server->mwindow ? server->mwindow->edl : server->edl;
755 return !edl ? 0 : edl->local_session->use_max ?
756 edl->local_session->blue_max :
757 edl->local_session->blue;
761 int64_t PluginClient::get_source_position()
763 return source_position;
766 int64_t PluginClient::get_source_start()
771 int64_t PluginClient::get_total_len()
776 int PluginClient::get_direction()
782 int64_t PluginClient::local_to_edl(int64_t position)
787 int64_t PluginClient::edl_to_local(int64_t position)
792 int PluginClient::get_use_opengl()
794 return server->get_use_opengl();
797 int PluginClient::get_total_buffers()
799 return total_in_buffers;
802 int PluginClient::get_buffer_size()
804 return in_buffer_size;
807 int PluginClient::get_project_smp()
809 //printf("PluginClient::get_project_smp %d %d\n", __LINE__, smp);
813 const char* PluginClient::get_defaultdir()
815 return File::get_plugin_path();
819 int PluginClient::send_hide_gui()
821 // Stop the GUI server and delete GUI messages
826 int PluginClient::send_configure_change()
829 server->mwindow->undo->update_undo_before(_("tweek"), this);
830 #ifdef USE_KEYFRAME_SPANNING
832 keyframe.copy_from(server->get_keyframe());
833 save_data(&keyframe);
834 server->apply_keyframe(&keyframe);
836 KeyFrame* keyframe = server->get_keyframe();
837 // Call save routine in plugin
841 server->mwindow->undo->update_undo_after(_("tweek"), LOAD_AUTOMATION);
842 server->sync_parameters();
847 KeyFrame* PluginClient::get_prev_keyframe(int64_t position, int is_local)
849 if(is_local) position = local_to_edl(position);
850 return server->get_prev_keyframe(position);
853 KeyFrame* PluginClient::get_next_keyframe(int64_t position, int is_local)
855 if(is_local) position = local_to_edl(position);
856 return server->get_next_keyframe(position);
859 void PluginClient::get_camera(float *x, float *y, float *z, int64_t position)
861 server->get_camera(x, y, z, position, direction);
864 void PluginClient::get_projector(float *x, float *y, float *z, int64_t position)
866 server->get_projector(x, y, z, position, direction);
870 EDLSession* PluginClient::get_edlsession()
873 return server->edl->session;
877 int PluginClient::gui_open()
879 return server->gui_open();