mp4chaps Lua script: don't clutter global environment
[ardour.git] / gtk2_ardour / video_timeline.cc
index bb7fc16723128a21b9576c395bb518a7f7d242f1..83d85f84fc1974d96aa6689039defe824e828d91 100644 (file)
 #include "ardour/tempo.h"
 
 #include "pbd/file_utils.h"
-#include "pbd/convert.h"
+#include "pbd/types_convert.h"
 #include "ardour/session_directory.h"
 
 #include "ardour_ui.h"
+#include "ardour_http.h"
 #include "public_editor.h"
 #include "gui_thread.h"
-#include "utils.h"
-#include "canvas_impl.h"
-#include "simpleline.h"
 #include "utils_videotl.h"
 #include "rgb_macros.h"
 #include "video_timeline.h"
+#include "video_tool_paths.h"
 
 #include <gtkmm2ext/utils.h>
 #include <pthread.h>
 #include <curl/curl.h>
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace ARDOUR;
@@ -47,9 +46,9 @@ using namespace PBD;
 using namespace Timecode;
 using namespace VideoUtils;
 
-VideoTimeLine::VideoTimeLine (PublicEditor *ed, ArdourCanvas::Group *vbg, int initial_height)
+VideoTimeLine::VideoTimeLine (PublicEditor *ed, ArdourCanvas::Container *vbg, int initial_height)
        : editor (ed)
-               , videotl_bar_group(vbg)
+               , videotl_group(vbg)
                , bar_height(initial_height)
 {
        video_start_offset = 0L;
@@ -60,8 +59,6 @@ VideoTimeLine::VideoTimeLine (PublicEditor *ed, ArdourCanvas::Group *vbg, int in
        video_offset_lock = false;
        video_aspect_ratio = 4.0/3.0;
        Config->ParameterChanged.connect (*this, invalidator (*this), ui_bind (&VideoTimeLine::parameter_changed, this, _1), gui_context());
-       video_server_url = video_get_server_url(Config);
-       server_docroot   = video_get_docroot(Config);
        video_filename = "";
        local_file = true;
        video_file_fps = 25.0;
@@ -69,6 +66,9 @@ VideoTimeLine::VideoTimeLine (PublicEditor *ed, ArdourCanvas::Group *vbg, int in
        vmonitor=0;
        reopen_vmonitor=false;
        find_xjadeo();
+       find_harvid();
+       video_server_url = video_get_server_url(Config);
+       server_docroot   = video_get_docroot(Config);
 
        VtlUpdate.connect (*this, invalidator (*this), boost::bind (&PublicEditor::queue_visual_videotimeline_update, editor), gui_context());
        GuiUpdate.connect (*this, invalidator (*this), boost::bind (&VideoTimeLine::gui_update, this, _1), gui_context());
@@ -87,11 +87,9 @@ VideoTimeLine::save_session ()
                return;
        }
 
-       LocaleGuard lg (X_("POSIX"));
-
        XMLNode* node = new XMLNode(X_("Videomonitor"));
        if (!node) return;
-       node->add_property (X_("active"), (vmonitor && vmonitor->is_started())?"yes":"no");
+       node->set_property (X_("active"), (vmonitor && vmonitor->is_started()));
        _session->add_extra_xml (*node);
 
        if (vmonitor) {
@@ -104,11 +102,11 @@ VideoTimeLine::save_session ()
        /* VTL settings */
        node = _session->extra_xml (X_("Videotimeline"));
        if (!node) return;
-       node->add_property (X_("id"), id().to_s());
-       node->add_property (X_("Height"), editor->get_videotl_bar_height());
-       node->add_property (X_("VideoOffsetLock"), video_offset_lock?X_("1"):X_("0"));
-       node->add_property (X_("VideoOffset"), video_offset);
-       node->add_property (X_("AutoFPS"), auto_set_session_fps?X_("1"):X_("0"));
+       node->set_property (X_("id"), id());
+       node->set_property (X_("Height"), editor->get_videotl_bar_height());
+       node->set_property (X_("VideoOffsetLock"), video_offset_lock);
+       node->set_property (X_("VideoOffset"), video_offset);
+       node->set_property (X_("AutoFPS"), auto_set_session_fps);
 }
 
 /* close and save settings */
@@ -144,8 +142,7 @@ VideoTimeLine::set_session (ARDOUR::Session *s)
        SessionHandlePtr::set_session (s);
        if (!_session) { return ; }
 
-       _session->SaveSession.connect_same_thread (sessionsave, boost::bind (&VideoTimeLine::save_session, this));
-       LocaleGuard lg (X_("POSIX"));
+       _session->SessionSaveUnderway.connect_same_thread (sessionsave, boost::bind (&VideoTimeLine::save_session, this));
 
        XMLNode* node = _session->extra_xml (X_("Videotimeline"));
 
@@ -157,39 +154,33 @@ VideoTimeLine::set_session (ARDOUR::Session *s)
 
        set_id(*node);
 
-       const XMLProperty* proph = node->property (X_("Height"));
-       if (proph) {
-               editor->set_video_timeline_height(atoi(proph->value()));
+       int height;
+       if (node->get_property (X_("Height"), height)) {
+               editor->set_video_timeline_height(height);
        }
 #if 0 /* TODO THINK: set FPS first time only ?! */
-       const XMLProperty* propasfps = node->property (X_("AutoFPS"));
+       XMLProperty const * propasfps = node->property (X_("AutoFPS"));
        if (propasfps) {
                auto_set_session_fps = atoi(propasfps->value())?true:false;
        }
 #endif
 
-       const XMLProperty* propoffset = node->property (X_("VideoOffset"));
-       if (propoffset) {
-               video_offset = atoll(propoffset->value());
+       if (node->get_property (X_("VideoOffset"), video_offset)) {
                video_offset_p = video_offset;
        }
 
-       const XMLProperty* proplock = node->property (X_("VideoOffsetLock"));
-       if (proplock) {
-               video_offset_lock = atoi(proplock->value())?true:false;
-       }
+       node->get_property (X_("VideoOffsetLock"), video_offset_lock);
+       node->get_property (X_("LocalFile"), local_file);
 
-       const XMLProperty* localfile = node->property (X_("LocalFile"));
-       if (localfile) {
-               local_file = atoi(localfile->value())?true:false;
+       std::string filename;
+       if (node->get_property (X_("Filename"), filename)) {
+               video_file_info (filename, local_file);
        }
 
-       const XMLProperty* propf = node->property (X_("Filename"));
-       video_file_info(propf->value(), local_file);
-
        if ((node = _session->extra_xml (X_("Videomonitor")))) {
-               const XMLProperty* prop = node->property (X_("active"));
-               if (prop && prop->value() == "yes" && found_xjadeo() && !video_filename.empty() && local_file) {
+               bool active;
+               if (node->get_property (X_("active"), active) && active && found_xjadeo () &&
+                   !video_filename.empty () && local_file) {
                        open_video_monitor();
                }
        }
@@ -226,11 +217,7 @@ VideoTimeLine::save_undo ()
 int
 VideoTimeLine::set_state (const XMLNode& node, int /*version*/)
 {
-       LocaleGuard lg (X_("POSIX"));
-       const XMLProperty* propoffset = node.property (X_("VideoOffset"));
-       if (propoffset) {
-               video_offset = atoll(propoffset->value());
-       }
+       node.get_property (X_("VideoOffset"), video_offset);
        ARDOUR_UI::instance()->flush_videotimeline_cache(true);
        return 0;
 }
@@ -239,8 +226,7 @@ XMLNode&
 VideoTimeLine::get_state ()
 {
        XMLNode* node = new XMLNode (X_("Videotimeline"));
-       LocaleGuard lg (X_("POSIX"));
-       node->add_property (X_("VideoOffset"), video_offset_p);
+       node->set_property (X_("VideoOffset"), video_offset_p);
        return *node;
 }
 
@@ -271,7 +257,7 @@ float
 VideoTimeLine::get_apv()
 {
        // XXX: dup code - TODO use this fn in update_video_timeline()
-       float apv = -1; /* audio frames per video frame; */
+       float apv = -1; /* audio samples per video frame; */
        if (!_session) return apv;
 
        if (_session->config.get_use_video_file_fps()) {
@@ -304,8 +290,8 @@ VideoTimeLine::update_video_timeline()
                if (_session->timecode_frames_per_second() == 0 ) return;
        }
 
-       double frames_per_unit = editor->unit_to_frame(1.0);
-       framepos_t leftmost_frame =  editor->leftmost_position();
+       const double samples_per_pixel = editor->get_current_zoom();
+       const framepos_t leftmost_sample =  editor->leftmost_sample();
 
        /* Outline:
         * 1) calculate how many frames there should be in current zoom (plus 1 page on each side)
@@ -317,12 +303,12 @@ VideoTimeLine::update_video_timeline()
 
        /* video-file and session properties */
        double display_vframe_width; /* unit: pixels ; width of one thumbnail in the timeline */
-       float apv; /* audio frames per video frame; */
+       float apv; /* audio samples per video frame; */
        framepos_t leftmost_video_frame; /* unit: video-frame number ; temporary var -> vtl_start */
 
        /* variables needed to render videotimeline -- what needs to computed first */
-       framepos_t vtl_start; /* unit: audio-frames ; first displayed video-frame */
-       framepos_t vtl_dist;  /* unit: audio-frames ; distance between displayed video-frames */
+       framepos_t vtl_start; /* unit: audio-samples ; first displayed video-frame */
+       framepos_t vtl_dist;  /* unit: audio-samples ; distance between displayed video-frames */
        unsigned int visible_video_frames; /* number of frames that fit on current canvas */
 
        if (_session->config.get_videotimeline_pullup()) {
@@ -338,36 +324,40 @@ VideoTimeLine::update_video_timeline()
 
        display_vframe_width = bar_height * video_aspect_ratio;
 
-       if (apv > frames_per_unit * display_vframe_width) {
+       if (apv > samples_per_pixel * display_vframe_width) {
                /* high-zoom: need space between successive video-frames */
                vtl_dist = rint(apv);
        } else {
                /* continous timeline: skip video-frames */
-               vtl_dist = ceil(display_vframe_width * frames_per_unit / apv) * apv;
+               vtl_dist = ceil(display_vframe_width * samples_per_pixel / apv) * apv;
        }
 
        assert (vtl_dist > 0);
        assert (apv > 0);
 
-       leftmost_video_frame = floor (floor((leftmost_frame - video_start_offset - video_offset ) / vtl_dist) * vtl_dist / apv);
+       leftmost_video_frame = floor (floor((long double)(leftmost_sample - video_start_offset - video_offset ) / vtl_dist) * vtl_dist / apv);
 
        vtl_start = rint (video_offset + video_start_offset + leftmost_video_frame * apv);
-       visible_video_frames = 2 + ceil(editor->current_page_frames() / vtl_dist); /* +2 left+right partial frames */
+       visible_video_frames = 2 + ceil((double)editor->current_page_samples() / vtl_dist); /* +2 left+right partial frames */
 
        /* expand timeline (cache next/prev page images) */
        vtl_start -= visible_video_frames * vtl_dist;
        visible_video_frames *=3;
 
-       if (vtl_start < video_offset ) {
-               visible_video_frames += ceil(vtl_start/vtl_dist);
+       /* don't request frames that are too far to the right */
+       if (vtl_start < video_offset) {
+               visible_video_frames = std::max((double)0.0, (double)visible_video_frames + ceil((double)(vtl_start - video_offset)/vtl_dist));
                vtl_start = video_offset;
        }
 
-       /* apply video-file constraints */
+       /* apply video-file constraints
+        * (first frame in video is at video_start_offset) */
        if (vtl_start > video_start_offset + video_duration + video_offset ) {
                visible_video_frames = 0;
        }
-       /* TODO optimize: compute rather than iterate */
+       /* trim end.
+        * end = position on timeline (video-offset)  minus  video-file's first frame position
+        * TODO optimize: compute rather than iterate */
        while (visible_video_frames > 0 && vtl_start + (visible_video_frames-1) * vtl_dist >= video_start_offset + video_duration + video_offset) {
                --visible_video_frames;
        }
@@ -379,7 +369,7 @@ VideoTimeLine::update_video_timeline()
 
        while (video_frames.size() < visible_video_frames) {
                VideoImageFrame *frame;
-               frame = new VideoImageFrame(*editor, *videotl_bar_group, display_vframe_width, bar_height, video_server_url, translated_filename());
+               frame = new VideoImageFrame(*editor, *videotl_group, display_vframe_width, bar_height, video_server_url, translated_filename());
                frame->ImgChanged.connect (*this, invalidator (*this), boost::bind (&PublicEditor::queue_visual_videotimeline_update, editor), gui_context());
                video_frames.push_back(frame);
        }
@@ -412,7 +402,7 @@ VideoTimeLine::update_video_timeline()
                }
                VideoImageFrame * frame = get_video_frame(vframeno, cut, rightend);
                if (frame) {
-                 frame->set_position(vfpos-leftmost_frame);
+                 frame->set_position(vfpos);
                        outdated_video_frames.remove(frame);
                } else {
                        remaining.push_back(vfcount);
@@ -422,7 +412,7 @@ VideoTimeLine::update_video_timeline()
        for (VideoFrames::iterator i = outdated_video_frames.begin(); i != outdated_video_frames.end(); ++i ) {
                VideoImageFrame *frame = (*i);
                if (remaining.empty()) {
-                 frame->set_position(-2 * vtl_dist); /* move off screen */
+                 frame->set_position(-2 * vtl_dist + leftmost_sample); /* move off screen */
                } else {
                        int vfcount=remaining.front();
                        remaining.pop_front();
@@ -433,7 +423,7 @@ VideoTimeLine::update_video_timeline()
                                rightend = display_vframe_width * (video_start_offset + video_duration + video_offset - vfpos) / vtl_dist;
                                //printf("lf(n): %lu\n", vframeno); // XXX
                        }
-                       frame->set_position(vfpos-leftmost_frame);
+                       frame->set_position(vfpos);
                        frame->set_videoframe(vframeno, rightend);
                }
        }
@@ -454,7 +444,8 @@ VideoTimeLine::video_file_info (std::string filename, bool local)
 {
 
        local_file = local;
-       if (filename.at(0) == G_DIR_SEPARATOR || !local_file) {
+       if (Glib::path_is_absolute(filename) || !local_file)
+       {
                video_filename = filename;
        }  else {
                video_filename = Glib::build_filename (_session->session_directory().video_path(), filename);
@@ -553,7 +544,7 @@ VideoTimeLine::check_server ()
                        , video_server_url.c_str()
                        , (video_server_url.length()>0 && video_server_url.at(video_server_url.length()-1) == '/')?"":"/"
                        );
-       char *res=a3_curl_http_get(url, NULL);
+       char* res = ArdourCurl::http_get (url, NULL);
        if (res) {
                if (strstr(res, "status: ok, online.")) { ok = true; }
                free(res);
@@ -575,7 +566,7 @@ VideoTimeLine::check_server_docroot ()
                        , video_server_url.c_str()
                        , (video_server_url.length()>0 && video_server_url.at(video_server_url.length()-1) == '/')?"":"/"
                        );
-       char *res=a3_curl_http_get(url, NULL);
+       char* res = ArdourCurl::http_get (url, NULL);
        if (!res) {
                return false;
        }
@@ -585,7 +576,7 @@ VideoTimeLine::check_server_docroot ()
                        || lines.at(0).empty()
                        || lines.at(0).at(0) != video_get_docroot(Config)) {
                warning << string_compose(
-                               _("Video-server docroot mismatch. %1: '%2', video-server: '%3'. This usually means that the video server was not started by ardour and uses a different document-root."),
+                               _("Video-server docroot mismatch. %1: '%2', video-server: '%3'. This usually means that the video server was not started by %1 and uses a different document-root."),
                                PROGRAM_NAME, video_get_docroot(Config), lines.at(0).at(0))
                << endmsg;
                ok = false; // TODO allow to override
@@ -671,7 +662,7 @@ VideoTimeLine::flush_cache () {
                        , video_server_url.c_str()
                        , (video_server_url.length()>0 && video_server_url.at(video_server_url.length()-1) == '/')?"":"/"
                        );
-       char *res=a3_curl_http_get(url, NULL);
+       char* res = ArdourCurl::http_get (url, NULL);
        if (res) {
                free (res);
        }
@@ -714,30 +705,120 @@ VideoTimeLine::set_video_server_docroot(std::string vsr) {
 }
 
 /* video-monitor for this timeline */
+void
+VideoTimeLine::xjadeo_readversion (std::string d, size_t /* s */) {
+       xjadeo_version += d;
+}
+
 void
 VideoTimeLine::find_xjadeo () {
-       std::string xjadeo_file_path;
-       if (getenv("XJREMOTE")) {
-               _xjadeo_bin = strdup(getenv("XJREMOTE")); // XXX TODO: free it?!
-       } else if (find_file_in_search_path (Searchpath(Glib::getenv("PATH")), X_("xjremote"), xjadeo_file_path)) {
-               _xjadeo_bin = xjadeo_file_path;
+       if (!ArdourVideoToolPaths::xjadeo_exe(_xjadeo_bin)) {
+               warning << _("Video-monitor 'xjadeo' was not found. Please install http://xjadeo.sf.net/ "
+                               "(a custom path to xjadeo can be specified by setting the XJREMOTE environment variable. "
+                               "It should point to an application compatible with xjadeo's remote-control interface 'xjremote').\n"
+                               "\n"
+                               "see also http://manual.ardour.org/video-timeline/setup/")
+                       << endmsg;
+       }
+
+       if (found_xjadeo ()) {
+               ARDOUR::SystemExec version_check(_xjadeo_bin, X_("--version"));
+               xjadeo_version = "";
+               version_check.ReadStdout.connect_same_thread (*this, boost::bind (&VideoTimeLine::xjadeo_readversion, this, _1 ,_2));
+               version_check.Terminated.connect_same_thread (*this, boost::bind (&VideoTimeLine::xjadeo_readversion, this, "\n" ,1));
+               if (version_check.start(2)) {
+                       warning << _(
+                                       "Video-monitor 'xjadeo' cannot be launched."
+                                       ) << endmsg;
+                       _xjadeo_bin = X_("");
+                       return;
+               }
+
+#ifdef PLATFORM_WINDOWS
+               version_check.wait (); // 40ms timeout
+#else
+               version_check.wait (WNOHANG);
+#endif
+
+               int timeout = 300;
+               while (xjadeo_version.empty() && --timeout) {
+                       Glib::usleep(10000);
+               }
+
+               bool v_ok = false;
+               size_t vo = xjadeo_version.find(" version ");
+               if (vo != string::npos) {
+                       int v_major, v_minor, v_micro;
+                       if(sscanf(xjadeo_version.substr(vo + 9, string::npos).c_str(),"%d.%d.%d",
+                                               &v_major, &v_minor, &v_micro) == 3)
+                       {
+                               if (v_major >= 1) v_ok = true;
+                               else if (v_major == 0 && v_minor >= 8) v_ok = true;
+                               else if (v_major == 0 && v_minor >= 7 && v_micro >= 7) v_ok = true;
+                       }
+               }
+               if (!v_ok) {
+                       _xjadeo_bin = X_("");
+                       warning << _(
+                                       "Video-monitor 'xjadeo' is too old. "
+                                       "Please install xjadeo version 0.7.7 or later. http://xjadeo.sf.net/"
+                                       ) << endmsg;
+               }
+       }
+}
+
+void
+VideoTimeLine::harvid_readversion (std::string d, size_t /* s */) {
+       harvid_version += d;
+}
+
+void
+VideoTimeLine::find_harvid () {
+       /* This is mainly for the benefit of the windows version:
+        * harvid >= 0.8.2 allows an empty docroot and ardour can
+        * pass the drive-letter along.
+        *
+        * It is a chicken/egg w.r.t. the video-server dialog
+        * but needed for default preferences and initial settings.
+        */
+       std::string harvid_bin;
+       if (VideoUtils::harvid_version != 0x0) {
+               return;
+       }
+       if (!ArdourVideoToolPaths::harvid_exe(harvid_bin)) {
+               return;
        }
-       else if (Glib::file_test(X_("/Applications/Jadeo.app/Contents/MacOS/xjremote"), Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_EXECUTABLE)) {
-               _xjadeo_bin = X_("/Applications/Jadeo.app/Contents/MacOS/xjremote");
+       if (harvid_bin.empty ()) {
+               return;
        }
-       /* TODO: win32: allow to configure PATH to xjremote */
-       else if (Glib::file_test(X_("C:\\Program Files\\xjadeo\\xjremote.exe"), Glib::FILE_TEST_EXISTS)) {
-               _xjadeo_bin = X_("C:\\Program Files\\xjadeo\\xjremote.exe");
+       ARDOUR::SystemExec version_check(harvid_bin, X_("--version"));
+       harvid_version = "";
+       version_check.ReadStdout.connect_same_thread (*this, boost::bind (&VideoTimeLine::harvid_readversion, this, _1 ,_2));
+       version_check.Terminated.connect_same_thread (*this, boost::bind (&VideoTimeLine::harvid_readversion, this, "\n" ,1));
+       if (version_check.start(2)) {
+               return;
        }
-       else if (Glib::file_test(X_("C:\\Program Files\\xjadeo\\xjremote.bat"), Glib::FILE_TEST_EXISTS)) {
-               _xjadeo_bin = X_("C:\\Program Files\\xjadeo\\xjremote.bat");
+
+#ifdef PLATFORM_WINDOWS
+       version_check.wait (); // 40ms timeout
+#else
+       version_check.wait (WNOHANG);
+#endif
+
+       int timeout = 300;
+       while (harvid_version.empty() && --timeout) {
+               Glib::usleep(10000);
        }
-       else  {
-               _xjadeo_bin = X_("");
-               warning << _("Video-monitor 'xjadeo' was not found. Please install http://xjadeo.sf.net/ "
-                               "(a custom path to xjadeo can be specified by setting the XJREMOTE environment variable. "
-                               "It should point to an application compatible with xjadeo's remote-control interface 'xjremote').")
-                       << endmsg;
+
+       size_t vo = harvid_version.find("harvid v");
+       if (vo != string::npos) {
+               int v_major, v_minor, v_micro;
+               if(sscanf(harvid_version.substr(vo + 8, string::npos).c_str(),"%d.%d.%d",
+                                       &v_major, &v_minor, &v_micro) == 3)
+               {
+                       VideoUtils::harvid_version = (v_major << 16) | (v_minor << 8) | v_micro;
+                       info << "harvid version: "<< hex << VideoUtils::harvid_version << endmsg;
+               }
        }
 }
 
@@ -766,7 +847,7 @@ VideoTimeLine::open_video_monitor() {
                /* load mask from Session */
                XMLNode* node = _session->extra_xml (X_("XJRestoreSettings"));
                if (node) {
-                       const XMLProperty* prop = node->property (X_("mask"));
+                       XMLProperty const * prop = node->property (X_("mask"));
                        if (prop) {
                                xj_settings_mask = atoi(prop->value());
                        }
@@ -787,8 +868,10 @@ VideoTimeLine::open_video_monitor() {
                if (_session) {
                        XMLNode* node = _session->extra_xml (X_("Videomonitor"));
                        if (node) {
-                               const XMLProperty* prop = node->property (X_("active"));
-                               if (prop && prop->value() != "yes") _session->set_dirty ();
+                               bool active;
+                               if (node->get_property (X_("active"), active) && !active) {
+                                       _session->set_dirty ();
+                               }
                        } else {
                                _session->set_dirty ();
                        }