gtk2_ardour/video_timeline.h

   1 /*
   2     Copyright (C) 2010 Paul Davis
   3     Author: Robin Gareus <robin@gareus.org>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20 #ifndef __ardour_video_timeline_h__
  21 #define __ardour_video_timeline_h__
  22
  23 #include <string>
  24
  25 #include <sigc++/signal.h>
  26 #include "ardour/ardour.h"
  27 #include "ardour/session.h"
  28 #include "ardour/session_handle.h"
  29 #include "video_image_frame.h"
  30 #include "video_monitor.h"
  31 #include "pbd/signals.h"
  32 #include "canvas/container.h"
  33
  34 namespace ARDOUR {
  35         class Session;
  36 }
  37
  38 class PublicEditor;
  39
  40 /** @class VideoTimeLine
  41  *  @brief video-timline controller and display
  42  *
  43  *  The video-timeline can be displayed in a canvas-group. Given a filename
  44  *  it queries the video-server about file-information and
  45  *  creates \ref VideoImageFrame as neccesary (which
  46  *  query the server for image-data).
  47  *
  48  *  This class contains the algorithm to position the single frames
  49  *  on the timeline according to current-zoom level and video-file
  50  *  attributes. see \ref update_video_timeline()
  51  *
  52  *  The VideoTimeLine class includes functionality to launch a video-monitor
  53  *  corresponding to its currently diplayed file.
  54  */
  55 class VideoTimeLine : public sigc::trackable, public ARDOUR::SessionHandlePtr, public PBD::ScopedConnectionList, public PBD::StatefulDestructible
  56 {
  57         public:
  58         VideoTimeLine (PublicEditor*, ArdourCanvas::Container*, int);
  59         virtual ~VideoTimeLine ();
  60
  61         void set_session (ARDOUR::Session *s);
  62         void update_video_timeline ();
  63         void set_height (int);
  64
  65         void save_undo (void);
  66         XMLNode& get_state ();
  67         int set_state (const XMLNode&, int version);
  68
  69         bool video_file_info (std::string, bool);
  70         double get_video_file_fps () { return video_file_fps; }
  71         void set_update_session_fps (bool v=true) { auto_set_session_fps = v; }
  72
  73         void set_offset_locked (bool v);
  74         void toggle_offset_locked ();
  75         bool is_offset_locked () { return video_offset_lock; }
  76
  77         void open_video_monitor ();
  78         void close_video_monitor ();
  79         void control_video_monitor (int, int);
  80         void terminated_video_monitor ();
  81         void manual_seek_video_monitor (framepos_t pos);
  82
  83         void parameter_changed (std::string const & p);
  84         void set_video_server_url (std::string);
  85         void set_video_server_docroot (std::string);
  86
  87         bool found_xjadeo () { return ((_xjadeo_bin.empty())?false:true); }
  88         bool check_server ();
  89         bool check_server_docroot ();
  90         void flush_local_cache ();
  91         void vmon_update ();
  92         void flush_cache ();
  93         void save_session ();
  94         void close_session ();
  95         void sync_session_state (); /* video-monitor does not actively report window/pos changes, query it */
  96         float get_apv(); /* audio samples per video frame; */
  97         ARDOUR::framecnt_t get_duration () { return video_duration;}
  98         ARDOUR::frameoffset_t get_offset () { return video_offset;}
  99         ARDOUR::frameoffset_t quantify_frames_to_apv (ARDOUR::frameoffset_t offset) { return rint(offset/get_apv())*get_apv(); }
 100         void set_offset (ARDOUR::frameoffset_t offset) { video_offset = quantify_frames_to_apv(offset); } // this function does not update video_offset_p, call save_undo() to finalize changes to this! - this fn is currently only used from editor_drag.cc
 101
 102         protected:
 103
 104         PublicEditor *editor;
 105         ArdourCanvas::Container *videotl_group;
 106         int bar_height;
 107
 108         std::string _xjadeo_bin;
 109         void find_xjadeo ();
 110
 111
 112         ARDOUR::frameoffset_t video_start_offset; /**< unit: audio-samples - video-file */
 113         ARDOUR::frameoffset_t video_offset; /**< unit: audio-samples - session */
 114         ARDOUR::frameoffset_t video_offset_p; /**< used for undo from editor_drag.cc */
 115         framepos_t video_duration;     /**< unit: audio-samples */
 116         std::string video_filename;
 117         bool        local_file;
 118         double      video_aspect_ratio;
 119         double      video_file_fps;
 120         bool        auto_set_session_fps;
 121         bool        video_offset_lock;
 122
 123         std::string video_server_url;
 124         std::string server_docroot;
 125
 126         void xjadeo_readversion (std::string d, size_t s);
 127         std::string xjadeo_version;
 128
 129         typedef std::list<VideoImageFrame*> VideoFrames;
 130         VideoFrames video_frames;
 131         VideoImageFrame *get_video_frame (framepos_t vfn, int cut=0, int rightend = -1);
 132         bool        flush_frames;
 133         void        remove_frames ();
 134
 135         std::string translated_filename ();
 136
 137         VideoMonitor *vmonitor;
 138         bool reopen_vmonitor;
 139
 140         PBD::Signal0<void> VtlUpdate;
 141         PBD::Signal1<void,std::string> GuiUpdate;
 142         void gui_update (const std::string &);
 143
 144         PBD::ScopedConnection sessionsave;
 145 };
 146
 147 #endif /* __ardour_video_timeline_h__ */