libs/surfaces/control_protocol/control_protocol/basic_ui.h

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3
   4     This program is free software; you can redistribute it
   5     and/or modify it under the terms of the GNU Lesser
   6     General Public License as published by the Free Software
   7     Foundation; either version 2 of the License, or (at your
   8     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
  21 #ifndef __ardour_basic_ui_h__
  22 #define __ardour_basic_ui_h__
  23
  24 #include <string>
  25 #include "pbd/signals.h"
  26
  27 #include <jack/types.h>
  28
  29 #include "control_protocol/timecode.h"
  30
  31 namespace ARDOUR {
  32         class Session;
  33         class SessionEvent;
  34 }
  35
  36 class BasicUI {
  37   public:
  38         BasicUI (ARDOUR::Session&);
  39         virtual ~BasicUI ();
  40
  41         void add_marker ();
  42
  43         void register_thread (std::string name);
  44
  45         /* transport control */
  46
  47         void loop_toggle ();
  48         void access_action ( std::string action_path );
  49         static PBD::Signal2<void,std::string,std::string> AccessAction;
  50         void goto_start ();
  51         void goto_end ();
  52         void rewind ();
  53         void ffwd ();
  54         void transport_stop ();
  55         void transport_play (bool jump_back = true);
  56         void set_transport_speed (double speed);
  57         double get_transport_speed ();
  58
  59         jack_nframes_t transport_frame ();
  60         void locate (jack_nframes_t frame, bool play = false);
  61         bool locating ();
  62         bool locked ();
  63
  64         void save_state ();
  65         void prev_marker ();
  66         void next_marker ();
  67         void undo ();
  68         void redo ();
  69         void toggle_punch_in ();
  70         void toggle_punch_out ();
  71
  72         void set_record_enable (bool yn);
  73         bool get_record_enabled ();
  74
  75         void rec_enable_toggle ();
  76         void toggle_all_rec_enables ();
  77
  78         jack_nframes_t timecode_frames_per_hour ();
  79
  80         void timecode_time (jack_nframes_t where, Timecode::Time&);
  81         void timecode_to_sample (Timecode::Time& timecode, jack_nframes_t& sample, bool use_offset, bool use_subframes) const;
  82         void sample_to_timecode (jack_nframes_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
  83
  84   protected:
  85         BasicUI ();
  86         ARDOUR::Session* session;
  87 };
  88
  89 #endif /* __ardour_basic_ui_h__ */