Various adjustments to make more operations respect the Edit property on route groups.
[ardour.git] / libs / ardour / session_time.cc
index 453f5d6d27452853a18c4d3b27d9e8c175dd8c54..32a94adee106c4d3e5da729953e453a382a4a25d 100644 (file)
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-  $Id$
 */
 
 #include <iostream>
 #include <cmath>
 #include <unistd.h>
 
-#include <ardour/timestamps.h>
+#include "ardour/timestamps.h"
 
-#include <pbd/error.h>
+#include "pbd/error.h"
+#include "pbd/enumwriter.h"
+#include "pbd/stacktrace.h"
 
-#include <ardour/ardour.h>
-#include <ardour/configuration.h>
-#include <ardour/audioengine.h>
-#include <ardour/session.h>
-#include <ardour/tempo.h>
+#include "ardour/ardour.h"
+#include "ardour/configuration.h"
+#include "ardour/audioengine.h"
+#include "ardour/session.h"
+#include "ardour/tempo.h"
 
 #include "i18n.h"
 
+using namespace std;
 using namespace ARDOUR;
-//using namespace sigc;
+using namespace PBD;
 
 /* BBT TIME*/
 
 void
-Session::bbt_time (jack_nframes_t when, BBT_Time& bbt)
+Session::bbt_time (nframes_t when, BBT_Time& bbt)
 {
        _tempo_map->bbt_time (when, bbt);
 }
 
 /* SMPTE TIME */
+float
+Session::smpte_frames_per_second() const
+{
+       switch (config.get_smpte_format()) {
+               case smpte_23976: 
+                       return 23.976;
 
-int
-Session::set_smpte_type (float fps, bool drop_frames)
+                       break;
+               case smpte_24: 
+                       return 24;
+
+                       break;
+               case smpte_24976: 
+                       return 24.976;
+
+                       break;
+               case smpte_25: 
+                       return 25;
+
+                       break;
+               case smpte_2997: 
+                       return 29.97;
+
+                       break;
+               case smpte_2997drop: 
+                       return 29.97;
+
+                       break;
+               case smpte_30: 
+                       return 30;
+
+                       break;
+               case smpte_30drop: 
+                       return 30;
+
+                       break;
+               case smpte_5994: 
+                       return 59.94;
+
+                       break;
+               case smpte_60: 
+                       return 60;
+
+                       break;
+               default:
+                 cerr << "Editor received unexpected smpte type" << endl;
+       }
+       return 30.0;
+}
+bool
+Session::smpte_drop_frames() const
 {
-       smpte_frames_per_second = fps;
-       smpte_drop_frames = drop_frames;
-       _frames_per_smpte_frame = (double) _current_frame_rate / (double) smpte_frames_per_second;
-       _frames_per_hour = _current_frame_rate * 3600;
-       _smpte_frames_per_hour = (unsigned long) (smpte_frames_per_second * 3600.0);
+       switch (config.get_smpte_format()) {
+               case smpte_23976: 
+                       return false;
+
+                       break;
+               case smpte_24: 
+                       return false;
+
+                       break;
+               case smpte_24976: 
+                       return false;
+
+                       break;
+               case smpte_25: 
+                       return false;
+
+                       break;
+               case smpte_2997: 
+                       return false;
+
+                       break;
+               case smpte_2997drop: 
+                       return true;
+
+                       break;
+               case smpte_30: 
+                       return false;
+
+                       break;
+               case smpte_30drop: 
+                       return true;
+
+                       break;
+               case smpte_5994: 
+                       return false;
 
+                       break;
+               case smpte_60: 
+                       return false;
+
+                       break;
+               default:
+                       cerr << "Editor received unexpected smpte type" << endl;
+       }
+       return false;
+}
+void
+Session::sync_time_vars ()
+{
+       _current_frame_rate = (nframes_t) round (_base_frame_rate * (1.0 + (config.get_video_pullup()/100.0)));
+       _frames_per_smpte_frame = (double) _current_frame_rate / (double) smpte_frames_per_second();
+       if (smpte_drop_frames()) {
+         _frames_per_hour = (long)(107892 * _frames_per_smpte_frame);
+       } else {
+         _frames_per_hour = (long)(3600 * rint(smpte_frames_per_second()) * _frames_per_smpte_frame);
+       }
+       _smpte_frames_per_hour = (nframes_t)rint(smpte_frames_per_second() * 3600.0);
 
        last_smpte_valid = false;
        // smpte type bits are the middle two in the upper nibble
-       switch ((int) ceil (fps)) {
+       switch ((int) ceil (smpte_frames_per_second())) {
        case 24:
                mtc_smpte_bits = 0;
-               SMPTE::Time::default_rate = SMPTE::MTC_24_FPS;
                break;
 
        case 25:
                mtc_smpte_bits = 0x20;
-               SMPTE::Time::default_rate = SMPTE::MTC_25_FPS;
                break;
 
        case 30:
        default:
-               if (drop_frames) {
+               if (smpte_drop_frames()) {
                        mtc_smpte_bits = 0x40;
-                       SMPTE::Time::default_rate = SMPTE::MTC_30_FPS_DROP;
                } else {
                        mtc_smpte_bits =  0x60;
-                       SMPTE::Time::default_rate = SMPTE::MTC_30_FPS;
                }
                break;
        };
-
-       SMPTETypeChanged (); /* EMIT SIGNAL */
-
-       set_dirty();
-
-       return 0;
 }
 
 void
-Session::set_smpte_offset (jack_nframes_t off)
+Session::set_smpte_offset (nframes_t off)
 {
        _smpte_offset = off;
        last_smpte_valid = false;
+
        SMPTEOffsetChanged (); /* EMIT SIGNAL */
 }
 
@@ -103,14 +195,15 @@ Session::set_smpte_offset_negative (bool neg)
 {
        _smpte_offset_negative = neg;
        last_smpte_valid = false;
+
        SMPTEOffsetChanged (); /* EMIT SIGNAL */
 }
 
-
 void
-Session::smpte_to_sample( SMPTE::Time& smpte, jack_nframes_t& sample, bool use_offset, bool use_subframes ) const
+Session::smpte_to_sample( SMPTE::Time& smpte, nframes_t& sample, bool use_offset, bool use_subframes ) const
 {
-       if (smpte_drop_frames) {
+
+       if (smpte.drop) {
                // The drop frame format was created to better approximate the 30000/1001 = 29.97002997002997....
                // framerate of NTSC color TV. The used frame rate of drop frame is 29.97, which drifts by about
                // 0.108 frame per hour, or about 1.3 frames per 12 hours. This is not perfect, but a lot better
@@ -149,22 +242,29 @@ Session::smpte_to_sample( SMPTE::Time& smpte, jack_nframes_t& sample, bool use_o
                //  0:10:00:00        0.0             0                   600.000         26460000 (accurate)
                //
                //  Per Sigmond <per@sigmond.no>
-    
+
                // Samples inside time dividable by 10 minutes (real time accurate)
-               jack_nframes_t base_samples = ((smpte.hours * 60 * 60) + ((smpte.minutes / 10) * 10 * 60)) * frame_rate();
+               nframes_t base_samples = (nframes_t) (((smpte.hours * 107892) + ((smpte.minutes / 10) * 17982)) * _frames_per_smpte_frame);
+
                // Samples inside time exceeding the nearest 10 minutes (always offset, see above)
                long exceeding_df_minutes = smpte.minutes % 10;
                long exceeding_df_seconds = (exceeding_df_minutes * 60) + smpte.seconds;
                long exceeding_df_frames = (30 * exceeding_df_seconds) + smpte.frames - (2 * exceeding_df_minutes);
-               jack_nframes_t exceeding_samples = (jack_nframes_t) rint(exceeding_df_frames * _frames_per_smpte_frame);
+               nframes_t exceeding_samples = (nframes_t) rint(exceeding_df_frames * _frames_per_smpte_frame);
                sample = base_samples + exceeding_samples;
        } else {
-               // Non drop is easy:
-               sample = (((smpte.hours * 60 * 60) + (smpte.minutes * 60) + smpte.seconds) * frame_rate()) + (jack_nframes_t)rint(smpte.frames * _frames_per_smpte_frame);
+               /* 
+                  Non drop is easy.. just note the use of 
+                  rint(smpte.rate) * _frames_per_smpte_frame
+                  (frames per SMPTE second), which is larger than  
+                  frame_rate() in the non-integer SMPTE rate case.
+               */
+
+               sample = (nframes_t)rint((((smpte.hours * 60 * 60) + (smpte.minutes * 60) + smpte.seconds) * (rint(smpte.rate) * _frames_per_smpte_frame)) + (smpte.frames * _frames_per_smpte_frame));
        }
   
        if (use_subframes) {
-               sample += (long) (((double)smpte.subframes * _frames_per_smpte_frame) / 80.0);
+               sample += (long) (((double)smpte.subframes * _frames_per_smpte_frame) / config.get_subframes_per_frame());
        }
   
        if (use_offset) {
@@ -187,14 +287,15 @@ Session::smpte_to_sample( SMPTE::Time& smpte, jack_nframes_t& sample, bool use_o
                        }
                }
        }
+
 }
 
 
 void
-Session::sample_to_smpte( jack_nframes_t sample, SMPTE::Time& smpte, bool use_offset, bool use_subframes ) const
+Session::sample_to_smpte( nframes_t sample, SMPTE::Time& smpte, bool use_offset, bool use_subframes ) const
 {
-       jack_nframes_t offset_sample;
-  
+       nframes_t offset_sample;
+
        if (!use_offset) {
                offset_sample = sample;
                smpte.negative = false;
@@ -221,14 +322,14 @@ Session::sample_to_smpte( jack_nframes_t sample, SMPTE::Time& smpte, bool use_of
        // high sample numbers in the calculations that follow.
        smpte.hours = offset_sample / _frames_per_hour;
        offset_sample = offset_sample % _frames_per_hour;
-  
+
        // Calculate exact number of (exceeding) smpte frames and fractional frames
        smpte_frames_left_exact = (double) offset_sample / _frames_per_smpte_frame;
        smpte_frames_fraction = smpte_frames_left_exact - floor( smpte_frames_left_exact );
-       smpte.subframes = (long) rint(smpte_frames_fraction * 80.0);
+       smpte.subframes = (long) rint(smpte_frames_fraction * config.get_subframes_per_frame());
   
        // XXX Not sure if this is necessary anymore...
-       if (smpte.subframes == 80) {
+       if (smpte.subframes == config.get_subframes_per_frame()) {
                // This can happen with 24 fps (and 29.97 fps ?)
                smpte_frames_left_exact = ceil( smpte_frames_left_exact );
                smpte.subframes = 0;
@@ -237,7 +338,7 @@ Session::sample_to_smpte( jack_nframes_t sample, SMPTE::Time& smpte, bool use_of
        // Extract hour-exceeding frames for minute, second and frame calculations
        smpte_frames_left = ((long) floor( smpte_frames_left_exact ));
 
-       if (smpte_drop_frames) {
+       if (smpte_drop_frames()) {
                // See long explanation in smpte_to_sample()...
 
                // Number of 10 minute chunks
@@ -273,19 +374,22 @@ Session::sample_to_smpte( jack_nframes_t sample, SMPTE::Time& smpte, bool use_of
                }
        } else {
                // Non drop is easy
-               smpte.minutes = smpte_frames_left / ((long) smpte_frames_per_second * 60);
-               smpte_frames_left = smpte_frames_left % ((long) smpte_frames_per_second * 60);
-               smpte.seconds = smpte_frames_left / (long) smpte_frames_per_second;
-               smpte.frames = smpte_frames_left % (long) smpte_frames_per_second;
+               smpte.minutes = smpte_frames_left / ((long) rint (smpte_frames_per_second ()) * 60);
+               smpte_frames_left = smpte_frames_left % ((long) rint (smpte_frames_per_second ()) * 60);
+               smpte.seconds = smpte_frames_left / (long) rint(smpte_frames_per_second ());
+               smpte.frames = smpte_frames_left % (long) rint(smpte_frames_per_second ());
        }
 
        if (!use_subframes) {
                smpte.subframes = 0;
        }
+       /* set frame rate and drop frame */
+       smpte.rate = smpte_frames_per_second ();
+       smpte.drop = smpte_drop_frames();
 }
 
 void
-Session::smpte_time (jack_nframes_t when, SMPTE::Time& smpte)
+Session::smpte_time (nframes_t when, SMPTE::Time& smpte)
 {
        if (last_smpte_valid && when == last_smpte_when) {
                smpte = last_smpte;
@@ -300,7 +404,7 @@ Session::smpte_time (jack_nframes_t when, SMPTE::Time& smpte)
 }
 
 void
-Session::smpte_time_subframes (jack_nframes_t when, SMPTE::Time& smpte)
+Session::smpte_time_subframes (nframes_t when, SMPTE::Time& smpte)
 {
        if (last_smpte_valid && when == last_smpte_when) {
                smpte = last_smpte;
@@ -315,18 +419,18 @@ Session::smpte_time_subframes (jack_nframes_t when, SMPTE::Time& smpte)
 }
 
 void
-Session::smpte_duration (jack_nframes_t when, SMPTE::Time& smpte) const
+Session::smpte_duration (nframes_t when, SMPTE::Time& smpte) const
 {
        sample_to_smpte( when, smpte, false /* use_offset */, true /* use_subframes */ );
 }
 
 void
-Session::smpte_duration_string (char* buf, jack_nframes_t when) const
+Session::smpte_duration_string (char* buf, nframes_t when) const
 {
        SMPTE::Time smpte;
 
        smpte_duration (when, smpte);
-       snprintf (buf, sizeof (buf), "%02ld:%02ld:%02ld:%02ld", smpte.hours, smpte.minutes, smpte.seconds, smpte.frames);
+       snprintf (buf, sizeof (buf), "%02" PRIu32 ":%02" PRIu32 ":%02" PRIu32 ":%02" PRIu32, smpte.hours, smpte.minutes, smpte.seconds, smpte.frames);
 }
 
 void
@@ -378,7 +482,7 @@ Session::jack_sync_callback (jack_transport_state_t state,
 
 void
 Session::jack_timebase_callback (jack_transport_state_t state,
-                                jack_nframes_t nframes,
+                                nframes_t nframes,
                                 jack_position_t* pos,
                                 int new_position)
 {
@@ -410,15 +514,21 @@ Session::jack_timebase_callback (jack_transport_state_t state,
                pos->valid = jack_position_bits_t (pos->valid | JackPositionBBT);
        }
 
+#ifdef HAVE_JACK_VIDEO_SUPPORT
+       //poke audio video ratio so Ardour can track Video Sync
+       pos->audio_frames_per_video_frame = frame_rate() / smpte_frames_per_second();
+       pos->valid = jack_position_bits_t (pos->valid | JackAudioVideoRatio);
+#endif
+
 #if 0
        /* SMPTE info */
 
        t.smpte_offset = _smpte_offset;
-       t.smpte_frame_rate = smpte_frames_per_second;
+       t.smpte_frame_rate = smpte_frames_per_second();
 
        if (_transport_speed) {
 
-               if (auto_loop) {
+               if (play_loop) {
 
                        Location* location = _locations.auto_loop_location();
 
@@ -450,8 +560,8 @@ Session::jack_timebase_callback (jack_transport_state_t state,
 #endif         
 }
 
-jack_nframes_t
-Session::convert_to_frames_at (jack_nframes_t position, AnyTime& any)
+ARDOUR::nframes_t
+Session::convert_to_frames_at (nframes_t position, AnyTime const & any)
 {
        double secs;
        
@@ -465,19 +575,19 @@ Session::convert_to_frames_at (jack_nframes_t position, AnyTime& any)
                secs = any.smpte.hours * 60 * 60;
                secs += any.smpte.minutes * 60;
                secs += any.smpte.seconds;
-               secs += any.smpte.frames / smpte_frames_per_second;
+               secs += any.smpte.frames / smpte_frames_per_second();
                if (_smpte_offset_negative) 
                {
-                       return (jack_nframes_t) floor (secs * frame_rate()) - _smpte_offset;
+                       return (nframes_t) floor (secs * frame_rate()) - _smpte_offset;
                }
                else
                {
-                       return (jack_nframes_t) floor (secs * frame_rate()) + _smpte_offset;
+                       return (nframes_t) floor (secs * frame_rate()) + _smpte_offset;
                }
                break;
 
        case AnyTime::Seconds:
-               return (jack_nframes_t) floor (any.seconds * frame_rate());
+               return (nframes_t) floor (any.seconds * frame_rate());
                break;
 
        case AnyTime::Frames: