Autres/audacity
1
0
Fork 0
mirror of https://github.com/cookiengineer/audacity synced 2025-06-16 16:10:06 +02:00
Code Issues Releases Wiki Activity

Convert existing comments to Doxygen so they show up in the documentation and less reading of source code is required. Also document some important behavious previously only discoverable by reading the source code

Browse Source
This commit is contained in:
richardash1981 2011-08-28 19:42:17 +00:00
parent 6128684055
commit 88c9e4720a
2 changed files with 38 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/Mix.h
View File

@ -21,6 +21,18 @@
class DirManager;
/** @brief Mixes together all input tracks, applying any envelopes, amplitude
* gain, panning, and real-time effects in the process.
*
* Takes one or more tracks as input; of all the WaveTrack s that are selected,
* it mixes them together, applying any envelopes, amplitude gain, panning, and
* real-time effects in the process. The resulting pair of tracks (stereo) are
* "rendered" and have no effects, gain, panning, or envelopes. Other sorts of
* tracks are ignored.
* If the start and end times passed are the same this is taken as meaning
* no explicit time range to process, and the whole occupied length of the
* input tracks is processed.
*/
bool MixAndRender(TrackList * tracks, TrackFactory *factory,
double rate, sampleFormat format,
double startTime, double endTime,

32
src/WaveTrack.h
View File

@ -88,10 +88,17 @@ class AUDACITY_DLL_API WaveTrack: public Track {
virtual double GetOffset();
virtual void SetOffset (double o);
// Start time is the earliest time there is a clip
/** @brief Get the time at which the first clip in the track starts
*
* @return time in seconds, or zero if there are no clips in the track
*/
double GetStartTime();
// End time is where the last clip ends, plus recorded stuff
/** @brief Get the time at which the last clip in the track ends, plus
* recorded stuff
*
* @return time in seconds, or zero if there are no clips in the track.
*/
double GetEndTime();
//
@ -157,10 +164,20 @@ class AUDACITY_DLL_API WaveTrack: public Track {
virtual bool SyncLockAdjust(double oldT1, double newT1);
// Returns true if there are no WaveClips in that region
/** @brief Returns true if there are no WaveClips in the specified region
*
* @return true if no clips in the track overlap the specified time range,
* false otherwise.
*/
bool IsEmpty(double t0, double t1);
/// You must call Flush after the last Append
/** @brief Append the sample data to the WaveTrack. You must call Flush()
* after the last Append.
*
* If there is an existing WaveClip in the WaveTrack then the data is
* appended to that clip. If there are no WaveClips in the track, then a new
* one is created.
*/
bool Append(samplePtr buffer, sampleFormat format,
sampleCount len, unsigned int stride=1,
XMLWriter* blockFileLog=NULL);
@ -264,8 +281,11 @@ class AUDACITY_DLL_API WaveTrack: public Track {
// to the newly created clip.
WaveClip* CreateClip();
// Get access to the last clip, or create a clip, if there is not
// already one.
/** @brief Get access to the last clip, or create a clip, if there is not
* already one.
*
* @return a pointer to a WaveClip at the end of the track
*/
WaveClip* GetLastOrCreateClip();
// Get the linear index of a given clip (-1 if the clip is not found)