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,
144 int w, int h, int min_w, int min_h, int allow_resize)
145 : BC_Window(client->gui_string,
146 client->window_x /* - w / 2 */,
147 client->window_y /* - h / 2 */,
148 (int)(w*get_resources()->font_scale+0.5), (int)(h*get_resources()->font_scale+0.5),
149 (int)(min_w*get_resources()->font_scale+0.5), (int)(min_h*get_resources()->font_scale+0.5),
152 this->client = client;
155 PluginClientWindow::PluginClientWindow(const char *title,
156 int x, int y, int w, int h, int min_w, int min_h, int allow_resize)
157 : BC_Window(title, x, y,
158 (int)(w*get_resources()->font_scale+0.5), (int)(h*get_resources()->font_scale+0.5),
159 (int)(min_w*get_resources()->font_scale+0.5), (int)(min_h*get_resources()->font_scale+0.5),
165 PluginClientWindow::~PluginClientWindow()
170 int PluginClientWindow::translation_event()
174 client->window_x = get_x();
175 client->window_y = get_y();
181 int PluginClientWindow::close_event()
183 /* Set result to 1 to indicate a client side close */
192 PluginClient::PluginClient(PluginServer *server)
195 this->server = server;
196 smp = server->preferences->project_smp;
198 update_timer = new Timer;
199 // Virtual functions don't work here.
202 PluginClient::~PluginClient()
204 // Delete the GUI thread. The GUI must be hidden with hide_gui first.
207 // Virtual functions don't work here.
208 if(defaults) delete defaults;
209 frame_buffer.remove_all_objects();
213 int PluginClient::reset()
222 realtime_priority = 0;
224 total_in_buffers = 0;
225 total_out_buffers = 0;
229 direction = PLAY_FORWARD;
236 void PluginClient::hide_gui()
238 if(thread && thread->window)
240 //printf("PluginClient::delete_thread %d\n", __LINE__);
241 /* This is needed when the GUI is closed from elsewhere than itself */
242 /* Since we now use autodelete, this is all that has to be done, thread will take care of itself ... */
243 /* Thread join will wait if this was not called from the thread itself or go on if it was */
244 thread->window->lock_window("PluginClient::hide_gui");
245 thread->window->set_done(0);
246 //printf("PluginClient::hide_gui %d thread->window=%p\n", __LINE__, thread->window);
247 thread->window->unlock_window();
248 //printf("PluginClient::delete_thread %d\n", __LINE__);
253 // For realtime plugins initialize buffers
254 int PluginClient::plugin_init_realtime(int realtime_priority,
255 int total_in_buffers,
259 // Get parameters for all
260 master_gui_on = get_gui_status();
264 // get parameters depending on video or audio
265 init_realtime_parameters();
267 this->realtime_priority = realtime_priority;
268 this->total_in_buffers = this->total_out_buffers = total_in_buffers;
269 this->out_buffer_size = this->in_buffer_size = buffer_size;
273 int PluginClient::plugin_start_loop(int64_t start,
278 //printf("PluginClient::plugin_start_loop %d %ld %ld %ld %d\n",
279 // __LINE__, start, end, buffer_size, total_buffers);
280 this->source_start = start;
281 this->total_len = end - start;
284 this->in_buffer_size = this->out_buffer_size = buffer_size;
285 this->total_in_buffers = this->total_out_buffers = total_buffers;
290 int PluginClient::plugin_process_loop()
292 return process_loop();
295 int PluginClient::plugin_stop_loop()
300 MainProgressBar* PluginClient::start_progress(char *string, int64_t length)
302 return server->start_progress(string, length);
306 // Non realtime parameters
307 int PluginClient::plugin_get_parameters()
309 int result = get_parameters();
310 if(defaults) save_defaults();
314 // ========================= main loop
316 int PluginClient::is_multichannel() { return 0; }
317 int PluginClient::is_synthesis() { return 0; }
318 int PluginClient::is_realtime() { return 0; }
319 int PluginClient::is_fileio() { return 0; }
320 int PluginClient::delete_buffer_ptrs() { return 0; }
321 const char* PluginClient::plugin_title() { return _("Untitled"); }
323 Theme* PluginClient::new_theme() { return 0; }
325 int PluginClient::load_configuration()
330 Theme* PluginClient::get_theme()
332 return server->get_theme();
335 int PluginClient::show_gui()
337 load_configuration();
338 thread = new PluginClientThread(this);
340 thread->init_complete->lock("PluginClient::show_gui");
341 // Must wait before sending any hide_gui
342 if( !thread->window ) return 1;
343 thread->window->init_wait();
347 void PluginClient::raise_window()
349 if(thread && thread->window)
351 thread->window->lock_window("PluginClient::raise_window");
352 thread->window->raise_window();
353 thread->window->flush();
354 thread->window->unlock_window();
358 int PluginClient::set_string()
362 thread->window->lock_window("PluginClient::set_string");
363 thread->window->put_title(gui_string);
364 thread->window->unlock_window();
373 void PluginClient::begin_process_buffer()
375 // Delete all unused GUI frames
376 frame_buffer.remove_all_objects();
380 void PluginClient::end_process_buffer()
382 if(frame_buffer.size())
390 void PluginClient::plugin_update_gui()
395 // Delete unused GUI frames
396 while(frame_buffer.size() > MAX_FRAME_BUFFER)
397 frame_buffer.remove_object_number(0);
401 void PluginClient::update_gui()
405 int PluginClient::get_gui_update_frames()
407 if(frame_buffer.size())
409 PluginClientFrame *frame = frame_buffer.get(0);
410 int total_frames = update_timer->get_difference() *
414 if(total_frames) update_timer->subtract(total_frames *
419 // printf("PluginClient::get_gui_update_frames %d %ld %d %d %d\n",
421 // update_timer->get_difference(),
422 // frame->period_n * 1000 / frame->period_d,
424 // frame_buffer.size());
427 for(int i = 0; i < frame_buffer.size(); i++)
428 if(frame_buffer.get(i)->force) total_frames++;
429 total_frames = MIN(frame_buffer.size(), total_frames);
440 PluginClientFrame* PluginClient::get_gui_frame()
442 if(frame_buffer.size())
444 PluginClientFrame *frame = frame_buffer.get(0);
445 frame_buffer.remove_number(0);
454 void PluginClient::add_gui_frame(PluginClientFrame *frame)
456 frame_buffer.append(frame);
459 void PluginClient::send_render_gui()
461 server->send_render_gui(&frame_buffer);
464 void PluginClient::send_render_gui(void *data)
466 server->send_render_gui(data);
469 void PluginClient::send_render_gui(void *data, int size)
471 server->send_render_gui(data, size);
474 void PluginClient::plugin_render_gui(void *data, int size)
476 render_gui(data, size);
480 void PluginClient::plugin_render_gui(void *data)
485 void PluginClient::render_gui(void *data)
489 thread->get_window()->lock_window("PluginClient::render_gui");
491 // Set all previous frames to draw immediately
492 for(int i = 0; i < frame_buffer.size(); i++)
493 frame_buffer.get(i)->force = 1;
495 ArrayList<PluginClientFrame*> *src =
496 (ArrayList<PluginClientFrame*>*)data;
498 // Shift GUI data to GUI client
501 this->frame_buffer.append(src->get(0));
502 src->remove_number(0);
505 // Start the timer for the current buffer
506 update_timer->update();
507 thread->get_window()->unlock_window();
511 void PluginClient::render_gui(void *data, int size)
513 printf("PluginClient::render_gui %d\n", __LINE__);
523 int PluginClient::is_audio() { return 0; }
524 int PluginClient::is_video() { return 0; }
525 int PluginClient::is_theme() { return 0; }
526 int PluginClient::uses_gui() { return 1; }
527 int PluginClient::is_transition() { return 0; }
528 int PluginClient::load_defaults()
530 // printf("PluginClient::load_defaults undefined in %s.\n", plugin_title());
534 int PluginClient::save_defaults()
537 // printf("PluginClient::save_defaults undefined in %s.\n", plugin_title());
541 void PluginClient::load_defaults_xml()
543 char path[BCTEXTLEN];
544 server->get_defaults_path(path);
546 fs.complete_path(path);
548 //printf("PluginClient::load_defaults_xml %d %s\n", __LINE__, path);
550 KeyFrame temp_keyframe;
551 FILE *fp = fopen(path, "r");
553 struct stat st; int fd = fileno(fp);
554 int64_t sz = !fstat(fd, &st) ? st.st_size : BCTEXTLEN;
555 char *data = temp_keyframe.get_data(sz+1);
556 int data_size = fread(data, 1, sz, fp);
557 if( data_size < 0 ) data_size = 0;
558 if( data_size > 0 ) {
559 // Get window extents
561 for( int i=0; i<(data_size-8) && data[i]!='<'; ++i ) {
562 if( !isdigit(data[i]) ) continue;
564 window_x = atoi(data + i);
568 window_y = atoi(data + i);
571 while( i<data_size && isdigit(data[i]) ) ++i;
574 read_data(&temp_keyframe);
580 //printf("PluginClient::load_defaults_xml %d %s\n", __LINE__, path);
583 void PluginClient::save_defaults_xml()
585 char path[BCTEXTLEN];
586 server->get_defaults_path(path);
588 fs.complete_path(path);
591 KeyFrame temp_keyframe;
592 save_data(&temp_keyframe);
594 const char *data = temp_keyframe.get_data();
595 int len = strlen(data);
596 FILE *fp = fopen(path, "w");
599 fprintf(fp, "%d\n%d\n", window_x, window_y);
600 if( len > 0 && !fwrite(data, len, 1, fp) ) {
601 fprintf(stderr, "PluginClient::save_defaults_xml %d \"%s\" %d bytes: %s\n",
602 __LINE__, path, len, strerror(errno));
610 int PluginClient::is_defaults()
612 return using_defaults;
615 BC_Hash* PluginClient::get_defaults()
619 PluginClientThread* PluginClient::get_thread()
624 BC_WindowBase* PluginClient::new_window()
626 printf("PluginClient::new_window undefined in %s.\n", plugin_title());
629 int PluginClient::get_parameters() { return 0; }
630 int PluginClient::get_samplerate() { return get_project_samplerate(); }
631 double PluginClient::get_framerate() { return get_project_framerate(); }
632 int PluginClient::init_realtime_parameters() { return 0; }
633 int PluginClient::delete_nonrealtime_parameters() { return 0; }
634 int PluginClient::start_loop() { return 0; };
635 int PluginClient::process_loop() { return 0; };
636 int PluginClient::stop_loop() { return 0; };
638 void PluginClient::set_interactive()
643 int64_t PluginClient::get_in_buffers(int64_t recommended_size)
645 return recommended_size;
648 int64_t PluginClient::get_out_buffers(int64_t recommended_size)
650 return recommended_size;
653 int PluginClient::get_gui_status()
655 return server->get_gui_status();
658 // close event from client side
659 void PluginClient::client_side_close()
661 // Last command executed
662 server->client_side_close();
665 int PluginClient::stop_gui_client()
667 if(!client_gui_on) return 0;
672 int PluginClient::get_project_samplerate()
674 return server->get_project_samplerate();
677 double PluginClient::get_project_framerate()
679 return server->get_project_framerate();
682 const char *PluginClient::get_source_path()
684 int64_t source_position = server->plugin->startproject;
685 Edit *edit = server->plugin->track->edits->editof(source_position,PLAY_FORWARD,0);
686 Indexable *indexable = edit ? edit->get_source() : 0;
687 return indexable ? indexable->path : 0;
691 void PluginClient::update_display_title()
693 server->generate_display_title(gui_string);
697 char* PluginClient::get_gui_string()
703 char* PluginClient::get_path()
708 char* PluginClient::get_plugin_dir()
710 return server->preferences->plugin_dir;
713 int PluginClient::set_string_client(char *string)
715 strcpy(gui_string, string);
721 int PluginClient::get_interpolation_type()
723 return server->get_interpolation_type();
727 float PluginClient::get_red()
729 EDL *edl = server->mwindow ? server->mwindow->edl : server->edl;
730 return !edl ? 0 : edl->local_session->use_max ?
731 edl->local_session->red_max :
732 edl->local_session->red;
735 float PluginClient::get_green()
737 EDL *edl = server->mwindow ? server->mwindow->edl : server->edl;
738 return !edl ? 0 : edl->local_session->use_max ?
739 edl->local_session->green_max :
740 edl->local_session->green;
743 float PluginClient::get_blue()
745 EDL *edl = server->mwindow ? server->mwindow->edl : server->edl;
746 return !edl ? 0 : edl->local_session->use_max ?
747 edl->local_session->blue_max :
748 edl->local_session->blue;
752 int64_t PluginClient::get_source_position()
754 return source_position;
757 int64_t PluginClient::get_source_start()
762 int64_t PluginClient::get_total_len()
767 int PluginClient::get_direction()
773 int64_t PluginClient::local_to_edl(int64_t position)
778 int64_t PluginClient::edl_to_local(int64_t position)
783 int PluginClient::get_use_opengl()
785 return server->get_use_opengl();
788 int PluginClient::get_total_buffers()
790 return total_in_buffers;
793 int PluginClient::get_buffer_size()
795 return in_buffer_size;
798 int PluginClient::get_project_smp()
800 //printf("PluginClient::get_project_smp %d %d\n", __LINE__, smp);
804 const char* PluginClient::get_defaultdir()
806 return File::get_plugin_path();
810 int PluginClient::send_hide_gui()
812 // Stop the GUI server and delete GUI messages
817 int PluginClient::send_configure_change()
820 server->mwindow->undo->update_undo_before(_("tweek"), this);
821 #ifdef USE_KEYFRAME_SPANNING
823 save_data(&keyframe);
824 server->apply_keyframe(&keyframe);
826 KeyFrame* keyframe = server->get_keyframe();
827 // Call save routine in plugin
831 server->mwindow->undo->update_undo_after(_("tweek"), LOAD_AUTOMATION);
832 server->sync_parameters();
837 KeyFrame* PluginClient::get_prev_keyframe(int64_t position, int is_local)
839 if(is_local) position = local_to_edl(position);
840 return server->get_prev_keyframe(position);
843 KeyFrame* PluginClient::get_next_keyframe(int64_t position, int is_local)
845 if(is_local) position = local_to_edl(position);
846 return server->get_next_keyframe(position);
849 void PluginClient::get_camera(float *x, float *y, float *z, int64_t position)
851 server->get_camera(x, y, z, position, direction);
854 void PluginClient::get_projector(float *x, float *y, float *z, int64_t position)
856 server->get_projector(x, y, z, position, direction);
860 EDLSession* PluginClient::get_edlsession()
863 return server->edl->session;
867 int PluginClient::gui_open()
869 return server->gui_open();