Autres/audacity
1
0
Fork 0
mirror of https://github.com/cookiengineer/audacity synced 2025-07-17 09:07:41 +02:00
Code Issues Releases Wiki Activity

add more detailed documentation of these functions based on email from Martyn

Browse Source
This commit is contained in:
richardash1981 2013-01-01 18:28:01 +00:00
parent e3b89fe55c
commit d9177348c2
1 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/WaveTrack.h
View File

@ -266,10 +266,25 @@ class AUDACITY_DLL_API WaveTrack: public Track {
bool CloseLock(); //similar to Lock but should be called when the project closes. bool CloseLock(); //similar to Lock but should be called when the project closes.
bool Unlock(); bool Unlock();
// Utility functions to convert between times in seconds /** @brief Convert correctly between an (absolute) time in seconds and a number of samples.
// and sample positions *
* This method will not give the correct results if used on a relative time (difference of two
* times). Each absolute time must be converted and the numbers of samples differenced:
* sampleCount start = track->TimeToLongSamples(t0);
* sampleCount end = track->TimeToLongSamples(t1);
* sampleCount len = (sampleCount)(end - start);
* NOT the likes of:
* sampleCount len = track->TimeToLongSamples(t1 - t0);
* See also WaveTrack::TimeToLongSamples().
* @param t0 The time (floating point seconds) to convert
* @return The number of samples from the start of the track which lie before the given time.
*/
sampleCount TimeToLongSamples(double t0) const; sampleCount TimeToLongSamples(double t0) const;
/** @brief Convert correctly between an number of samples and an (absolute) time in seconds.
*
* @param pos The time number of samples from the start of the track to convert.
* @return The time in seconds.
*/
double LongSamplesToTime(sampleCount pos); double LongSamplesToTime(sampleCount pos);
// Get access to the clips in the tracks. This is used by // Get access to the clips in the tracks. This is used by