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
  26 #include <jack/types.h>
  27 #include "control_protocol/timecode.h"
  28
  29 namespace ARDOUR {
  30         class Session;
  31 }
  32
  33 class BasicUI {
  34   public:
  35         BasicUI (ARDOUR::Session&);
  36         virtual ~BasicUI ();
  37
  38         void add_marker ();
  39
  40         void register_thread (std::string name);
  41
  42         /* transport control */
  43
  44         void loop_toggle ();
  45         void access_action ( std::string action_path );
  46         static sigc::signal<void,std::string,std::string> AccessAction;
  47         void goto_start ();
  48         void goto_end ();
  49         void rewind ();
  50         void ffwd ();
  51         void transport_stop ();
  52         void transport_play (bool jump_back = true);
  53         void set_transport_speed (double speed);
  54         double get_transport_speed ();
  55
  56         jack_nframes_t transport_frame ();
  57         void locate (jack_nframes_t frame, bool play = false);
  58         bool locating ();
  59         bool locked ();
  60
  61         void save_state ();
  62         void prev_marker ();
  63         void next_marker ();
  64         void undo ();
  65         void redo ();
  66         void toggle_punch_in ();
  67         void toggle_punch_out ();
  68
  69         void set_record_enable (bool yn);
  70         bool get_record_enabled ();
  71
  72         void rec_enable_toggle ();
  73         void toggle_all_rec_enables ();
  74
  75         jack_nframes_t timecode_frames_per_hour ();
  76
  77         void timecode_time (jack_nframes_t where, Timecode::Time&);
  78         void timecode_to_sample (Timecode::Time& timecode, jack_nframes_t& sample, bool use_offset, bool use_subframes) const;
  79         void sample_to_timecode (jack_nframes_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
  80
  81   protected:
  82         BasicUI ();
  83         ARDOUR::Session* session;
  84 };
  85
  86 #endif /* __ardour_basic_ui_h__ */