3 Copyright (C) 1999-2002 Paul Davis
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.
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.
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.
22 #include "libardour-config.h"
29 #include "ardour/timestamps.h"
31 #include "pbd/error.h"
32 #include "pbd/enumwriter.h"
33 #include "pbd/stacktrace.h"
35 #include "ardour/ardour.h"
36 #include "ardour/configuration.h"
37 #include "ardour/audioengine.h"
38 #include "ardour/session.h"
39 #include "ardour/tempo.h"
44 using namespace ARDOUR
;
50 Session::bbt_time (framepos_t when
, Timecode::BBT_Time
& bbt
)
52 _tempo_map
->bbt_time (when
, bbt
);
57 Session::timecode_frames_per_second() const
59 switch (config
.get_timecode_format()) {
80 case timecode_2997drop
:
101 cerr
<< "Editor received unexpected timecode type" << endl
;
106 Session::timecode_drop_frames() const
108 switch (config
.get_timecode_format()) {
129 case timecode_2997drop
:
137 case timecode_30drop
:
150 error
<< "Editor received unexpected timecode type" << endmsg
;
156 Session::sync_time_vars ()
158 _current_frame_rate
= (framecnt_t
) round (_base_frame_rate
* (1.0 + (config
.get_video_pullup()/100.0)));
159 _frames_per_timecode_frame
= (double) _current_frame_rate
/ (double) timecode_frames_per_second();
160 if (timecode_drop_frames()) {
161 _frames_per_hour
= (int32_t)(107892 * _frames_per_timecode_frame
);
163 _frames_per_hour
= (int32_t)(3600 * rint(timecode_frames_per_second()) * _frames_per_timecode_frame
);
165 _timecode_frames_per_hour
= rint(timecode_frames_per_second() * 3600.0);
167 last_timecode_valid
= false;
168 // timecode type bits are the middle two in the upper nibble
169 switch ((int) ceil (timecode_frames_per_second())) {
171 mtc_timecode_bits
= 0;
175 mtc_timecode_bits
= 0x20;
180 if (timecode_drop_frames()) {
181 mtc_timecode_bits
= 0x40;
183 mtc_timecode_bits
= 0x60;
190 Session::timecode_to_sample( Timecode::Time
& timecode
, framepos_t
& sample
, bool use_offset
, bool use_subframes
) const
194 // The drop frame format was created to better approximate the 30000/1001 = 29.97002997002997....
195 // framerate of NTSC color TV. The used frame rate of drop frame is 29.97, which drifts by about
196 // 0.108 frame per hour, or about 1.3 frames per 12 hours. This is not perfect, but a lot better
197 // than using 30 non drop, which will drift with about 1.8 frame per minute.
198 // Using 29.97, drop frame real time can be accurate only every 10th minute (10 minutes of 29.97 fps
199 // is exactly 17982 frames). One minute is 1798.2 frames, but we count 30 frames per second
200 // (30 * 60 = 1800). This means that at the first minute boundary (at the end of 0:0:59:29) we
201 // are 1.8 frames too late relative to real time. By dropping 2 frames (jumping to 0:1:0:2) we are
202 // approx. 0.2 frames too early. This adds up with 0.2 too early for each minute until we are 1.8
203 // frames too early at 0:9:0:2 (9 * 0.2 = 1.8). The 10th minute brings us 1.8 frames later again
204 // (at end of 0:9:59:29), which sums up to 0 (we are back to zero at 0:10:0:0 :-).
208 // Timecode value frames offset subframes offset seconds (rounded) 44100 sample (rounded)
209 // 0:00:00:00 0.0 0 0.000 0 (accurate)
210 // 0:00:59:29 1.8 144 60.027 2647177
211 // 0:01:00:02 -0.2 -16 60.060 2648648
212 // 0:01:59:29 1.6 128 120.020 5292883
213 // 0:02:00:02 -0.4 -32 120.053 5294354
214 // 0:02:59:29 1.4 112 180.013 7938588
215 // 0:03:00:02 -0.6 -48 180.047 7940060
216 // 0:03:59:29 1.2 96 240.007 10584294
217 // 0:04:00:02 -0.8 -64 240.040 10585766
218 // 0:04:59:29 1.0 80 300.000 13230000
219 // 0:05:00:02 -1.0 -80 300.033 13231471
220 // 0:05:59:29 0.8 64 359.993 15875706
221 // 0:06:00:02 -1.2 -96 360.027 15877177
222 // 0:06:59:29 0.6 48 419.987 18521411
223 // 0:07:00:02 -1.4 -112 420.020 18522883
224 // 0:07:59:29 0.4 32 478.980 21167117
225 // 0:08:00:02 -1.6 -128 480.013 21168589
226 // 0:08:59:29 0.2 16 539.973 23812823
227 // 0:09:00:02 -1.8 -144 540.007 23814294
228 // 0:09:59:29 0.0+ 0+ 599.967 26458529
229 // 0:10:00:00 0.0 0 600.000 26460000 (accurate)
231 // Per Sigmond <per@sigmond.no>
233 // Samples inside time dividable by 10 minutes (real time accurate)
234 framecnt_t base_samples
= (framecnt_t
) (((timecode
.hours
* 107892) + ((timecode
.minutes
/ 10) * 17982)) * _frames_per_timecode_frame
);
236 // Samples inside time exceeding the nearest 10 minutes (always offset, see above)
237 int32_t exceeding_df_minutes
= timecode
.minutes
% 10;
238 int32_t exceeding_df_seconds
= (exceeding_df_minutes
* 60) + timecode
.seconds
;
239 int32_t exceeding_df_frames
= (30 * exceeding_df_seconds
) + timecode
.frames
- (2 * exceeding_df_minutes
);
240 framecnt_t exceeding_samples
= (framecnt_t
) rint(exceeding_df_frames
* _frames_per_timecode_frame
);
241 sample
= base_samples
+ exceeding_samples
;
244 Non drop is easy.. just note the use of
245 rint(timecode.rate) * _frames_per_timecode_frame
246 (frames per Timecode second), which is larger than
247 frame_rate() in the non-integer Timecode rate case.
250 sample
= (framecnt_t
)rint((((timecode
.hours
* 60 * 60) + (timecode
.minutes
* 60) + timecode
.seconds
) * (rint(timecode
.rate
) * _frames_per_timecode_frame
)) + (timecode
.frames
* _frames_per_timecode_frame
));
254 sample
+= (int32_t) (((double)timecode
.subframes
* _frames_per_timecode_frame
) / config
.get_subframes_per_frame());
258 if (config
.get_timecode_offset_negative()) {
259 if (sample
>= config
.get_timecode_offset()) {
260 sample
-= config
.get_timecode_offset();
262 /* Prevent song-time from becoming negative */
266 if (timecode
.negative
) {
267 if (sample
<= config
.get_timecode_offset()) {
268 sample
= config
.get_timecode_offset() - sample
;
273 sample
+= config
.get_timecode_offset();
282 Session::sample_to_timecode (framepos_t sample
, Timecode::Time
& timecode
, bool use_offset
, bool use_subframes
) const
284 framepos_t offset_sample
;
287 offset_sample
= sample
;
288 timecode
.negative
= false;
290 if (config
.get_timecode_offset_negative()) {
291 offset_sample
= sample
+ config
.get_timecode_offset ();
292 timecode
.negative
= false;
294 if (sample
< config
.get_timecode_offset()) {
295 offset_sample
= (config
.get_timecode_offset() - sample
);
296 timecode
.negative
= true;
298 offset_sample
= sample
- config
.get_timecode_offset();
299 timecode
.negative
= false;
304 double timecode_frames_left_exact
;
305 double timecode_frames_fraction
;
306 uint32_t timecode_frames_left
;
308 // Extract whole hours. Do this to prevent rounding errors with
309 // high sample numbers in the calculations that follow.
310 timecode
.hours
= offset_sample
/ _frames_per_hour
;
311 offset_sample
= offset_sample
% _frames_per_hour
;
313 // Calculate exact number of (exceeding) timecode frames and fractional frames
314 timecode_frames_left_exact
= (double) offset_sample
/ _frames_per_timecode_frame
;
315 timecode_frames_fraction
= timecode_frames_left_exact
- floor( timecode_frames_left_exact
);
316 timecode
.subframes
= (int32_t) rint(timecode_frames_fraction
* config
.get_subframes_per_frame());
318 // XXX Not sure if this is necessary anymore...
319 if (timecode
.subframes
== config
.get_subframes_per_frame()) {
320 // This can happen with 24 fps (and 29.97 fps ?)
321 timecode_frames_left_exact
= ceil( timecode_frames_left_exact
);
322 timecode
.subframes
= 0;
325 // Extract hour-exceeding frames for minute, second and frame calculations
326 timecode_frames_left
= (uint32_t) floor (timecode_frames_left_exact
);
328 if (timecode_drop_frames()) {
329 // See int32_t explanation in timecode_to_sample()...
331 // Number of 10 minute chunks
332 timecode
.minutes
= (timecode_frames_left
/ 17982) * 10; // exactly 17982 frames in 10 minutes
333 // frames exceeding the nearest 10 minute barrier
334 int32_t exceeding_df_frames
= timecode_frames_left
% 17982;
336 // Find minutes exceeding the nearest 10 minute barrier
337 if (exceeding_df_frames
>= 1800) { // nothing to do if we are inside the first minute (0-1799)
338 exceeding_df_frames
-= 1800; // take away first minute (different number of frames than the others)
339 int32_t extra_minutes_minus_1
= exceeding_df_frames
/ 1798; // how many minutes after the first one
340 exceeding_df_frames
-= extra_minutes_minus_1
* 1798; // take away the (extra) minutes just found
341 timecode
.minutes
+= extra_minutes_minus_1
+ 1; // update with exceeding minutes
344 // Adjust frame numbering for dropped frames (frame 0 and 1 skipped at start of every minute except every 10th)
345 if (timecode
.minutes
% 10) {
346 // Every minute except every 10th
347 if (exceeding_df_frames
< 28) {
348 // First second, frames 0 and 1 are skipped
349 timecode
.seconds
= 0;
350 timecode
.frames
= exceeding_df_frames
+ 2;
352 // All other seconds, all 30 frames are counted
353 exceeding_df_frames
-= 28;
354 timecode
.seconds
= (exceeding_df_frames
/ 30) + 1;
355 timecode
.frames
= exceeding_df_frames
% 30;
358 // Every 10th minute, all 30 frames counted in all seconds
359 timecode
.seconds
= exceeding_df_frames
/ 30;
360 timecode
.frames
= exceeding_df_frames
% 30;
364 timecode
.minutes
= timecode_frames_left
/ ((int32_t) rint (timecode_frames_per_second ()) * 60);
365 timecode_frames_left
= timecode_frames_left
% ((int32_t) rint (timecode_frames_per_second ()) * 60);
366 timecode
.seconds
= timecode_frames_left
/ (int32_t) rint(timecode_frames_per_second ());
367 timecode
.frames
= timecode_frames_left
% (int32_t) rint(timecode_frames_per_second ());
370 if (!use_subframes
) {
371 timecode
.subframes
= 0;
373 /* set frame rate and drop frame */
374 timecode
.rate
= timecode_frames_per_second ();
375 timecode
.drop
= timecode_drop_frames();
379 Session::timecode_time (framepos_t when
, Timecode::Time
& timecode
)
381 if (last_timecode_valid
&& when
== last_timecode_when
) {
382 timecode
= last_timecode
;
386 sample_to_timecode( when
, timecode
, true /* use_offset */, false /* use_subframes */ );
388 last_timecode_when
= when
;
389 last_timecode
= timecode
;
390 last_timecode_valid
= true;
394 Session::timecode_time_subframes (framepos_t when
, Timecode::Time
& timecode
)
396 if (last_timecode_valid
&& when
== last_timecode_when
) {
397 timecode
= last_timecode
;
401 sample_to_timecode( when
, timecode
, true /* use_offset */, true /* use_subframes */ );
403 last_timecode_when
= when
;
404 last_timecode
= timecode
;
405 last_timecode_valid
= true;
409 Session::timecode_duration (framecnt_t when
, Timecode::Time
& timecode
) const
411 sample_to_timecode( when
, timecode
, false /* use_offset */, true /* use_subframes */ );
415 Session::timecode_duration_string (char* buf
, framepos_t when
) const
417 Timecode::Time timecode
;
419 timecode_duration (when
, timecode
);
420 snprintf (buf
, sizeof (buf
), "%02" PRIu32
":%02" PRIu32
":%02" PRIu32
":%02" PRIu32
, timecode
.hours
, timecode
.minutes
, timecode
.seconds
, timecode
.frames
);
424 Session::timecode_time (Timecode::Time
&t
)
427 timecode_time (_transport_frame
, t
);
431 Session::jack_sync_callback (jack_transport_state_t state
,
432 jack_position_t
* pos
)
434 bool slave
= synced_to_jack();
437 case JackTransportStopped
:
438 if (slave
&& _transport_frame
!= pos
->frame
&& post_transport_work() == 0) {
439 request_locate (pos
->frame
, false);
440 // cerr << "SYNC: stopped, locate to " << pos->frame << " from " << _transport_frame << endl;
446 case JackTransportStarting
:
447 // cerr << "SYNC: starting @ " << pos->frame << " a@ " << _transport_frame << " our work = " << post_transport_work() << " pos matches ? " << (_transport_frame == pos->frame) << endl;
449 return _transport_frame
== pos
->frame
&& post_transport_work() == 0;
455 case JackTransportRolling
:
456 // cerr << "SYNC: rolling slave = " << slave << endl;
463 error
<< string_compose (_("Unknown JACK transport state %1 in sync callback"), state
)
471 Session::jack_timebase_callback (jack_transport_state_t
/*state*/,
472 pframes_t
/*nframes*/,
473 jack_position_t
* pos
,
474 int /*new_position*/)
476 Timecode::BBT_Time bbt
;
478 if (pos
->frame
!= _transport_frame
) {
479 cerr
<< "ARDOUR says " << _transport_frame
<< " JACK says " << pos
->frame
<< endl
;
486 TempoMetric
metric (_tempo_map
->metric_at (_transport_frame
));
487 _tempo_map
->bbt_time_with_metric (_transport_frame
, bbt
, metric
);
490 pos
->beat
= bbt
.beats
;
491 pos
->tick
= bbt
.ticks
;
493 // XXX still need to set bar_start_tick
495 pos
->beats_per_bar
= metric
.meter().beats_per_bar();
496 pos
->beat_type
= metric
.meter().note_divisor();
497 pos
->ticks_per_beat
= Timecode::BBT_Time::ticks_per_beat
;
498 pos
->beats_per_minute
= metric
.tempo().beats_per_minute();
500 pos
->valid
= jack_position_bits_t (pos
->valid
| JackPositionBBT
);
503 #ifdef HAVE_JACK_VIDEO_SUPPORT
504 //poke audio video ratio so Ardour can track Video Sync
505 pos
->audio_frames_per_video_frame
= frame_rate() / timecode_frames_per_second();
506 pos
->valid
= jack_position_bits_t (pos
->valid
| JackAudioVideoRatio
);
512 pos
->timecode_offset
= config
.get_timecode_offset();
513 t
.timecode_frame_rate
= timecode_frames_per_second();
514 pos
->valid
= jack_position_bits_t (pos
->valid
| JackPositionTimecode
;
516 if (_transport_speed
) {
520 Location
* location
= _locations
.auto_loop_location();
524 t
.transport_state
= JackTransportLooping
;
525 t
.loop_start
= location
->start();
526 t
.loop_end
= location
->end();
527 t
.valid
= jack_transport_bits_t (t
.valid
| JackTransportLoop
);
533 t
.transport_state
= JackTransportRolling
;
541 t
.transport_state
= JackTransportRolling
;
550 Session::convert_to_frames (AnyTime
const & position
)
554 switch (position
.type
) {
556 return _tempo_map
->frame_time (position
.bbt
);
559 case AnyTime::Timecode
:
560 /* XXX need to handle negative values */
561 secs
= position
.timecode
.hours
* 60 * 60;
562 secs
+= position
.timecode
.minutes
* 60;
563 secs
+= position
.timecode
.seconds
;
564 secs
+= position
.timecode
.frames
/ timecode_frames_per_second();
565 if (config
.get_timecode_offset_negative()) {
566 return (framecnt_t
) floor (secs
* frame_rate()) - config
.get_timecode_offset();
568 return (framecnt_t
) floor (secs
* frame_rate()) + config
.get_timecode_offset();
572 case AnyTime::Seconds
:
573 return (framecnt_t
) floor (position
.seconds
* frame_rate());
576 case AnyTime::Frames
:
577 return position
.frames
;
581 return position
.frames
;
585 Session::any_duration_to_frames (framepos_t position
, AnyTime
const & duration
)
589 switch (duration
.type
) {
591 return (framecnt_t
) ( _tempo_map
->framepos_plus_bbt (position
, duration
.bbt
) - position
);
594 case AnyTime::Timecode
:
595 /* XXX need to handle negative values */
596 secs
= duration
.timecode
.hours
* 60 * 60;
597 secs
+= duration
.timecode
.minutes
* 60;
598 secs
+= duration
.timecode
.seconds
;
599 secs
+= duration
.timecode
.frames
/ timecode_frames_per_second();
600 if (config
.get_timecode_offset_negative()) {
601 return (framecnt_t
) floor (secs
* frame_rate()) - config
.get_timecode_offset();
603 return (framecnt_t
) floor (secs
* frame_rate()) + config
.get_timecode_offset();
607 case AnyTime::Seconds
:
608 return (framecnt_t
) floor (duration
.seconds
* frame_rate());
611 case AnyTime::Frames
:
612 return duration
.frames
;
616 return duration
.frames
;