Autres/audacity
1
0
Fork 0
mirror of https://github.com/cookiengineer/audacity synced 2025-10-26 07:13:49 +01:00
Code Issues Releases Wiki Activity

fix some comments

Browse Source
This commit is contained in:
Paul Licameli
2016-12-26 09:03:14 -05:00
parent 6665370f61
commit 3e51fd5078
8 changed files with 28 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/blockfile/ODDecodeBlockFile.cpp
View File

@@ -156,8 +156,8 @@ bool ODDecodeBlockFile::Read64K(float *buffer, size_t start, size_t len)
}
/// If the summary has been computed,
/// Construct a NEW PCMAliasBlockFile based on this one.
/// otherwise construct an ODPCMAliasBlockFile that still needs to be computed.
/// Construct a NEW SimpleBlockFile based on this one.
/// otherwise construct an ODDecodeBlockFile that still needs to be computed.
/// @param newFileName The filename to copy the summary data to.
BlockFilePtr ODDecodeBlockFile::Copy(wxFileNameWrapper &&newFileName)
{
@@ -219,8 +219,8 @@ void ODDecodeBlockFile::SaveXML(XMLWriter &xmlFile)
UnlockRead();
}
/// Constructs a ODPCMAliasBlockFile from the xml output of WriteXML.
/// Also schedules the ODPCMAliasBlockFile for OD loading.
/// Constructs a ODDecodeBlockFile from the xml output of WriteXML.
/// Also schedules the ODDecodeBlockFile for OD loading.
// BuildFromXML methods should always return a BlockFile, not NULL,
// even if the result is flawed (e.g., refers to nonexistent file),
// as testing will be done in DirManager::ProjectFSCK().

9
src/blockfile/ODDecodeBlockFile.h
View File

@@ -14,7 +14,7 @@
\brief ODDecodeBlockFile is a special type of SimpleBlockFile that does not necessarily have summary OR audio data available
The summary and audio is eventually computed and written to a file in a background thread.
Load On-Demand implementation of the SimpleBlockFIle for audio files that need to be decoded (mp3,flac,etc..).
Load On-Demand implementation of the SimpleBlockFile for audio files that need to be decoded (mp3,flac,etc..).
Also, see ODPCMAliasBlockFile for a similar file.
*//*******************************************************************/
@@ -76,19 +76,18 @@ class ODDecodeBlockFile final : public SimpleBlockFile
///Makes NEW ODPCMAliasBlockFile or PCMAliasBlockFile depending on summary availability
///Makes NEW ODDecodeBlockFile or SimpleBlockFile depending on summary availability
BlockFilePtr Copy(wxFileNameWrapper &&fileName) override;
///Saves as xml ODPCMAliasBlockFile or PCMAliasBlockFile depending on summary availability
///Saves as xml ODDecodeBlockFile or SimpleBlockFile depending on summary availability
void SaveXML(XMLWriter &xmlFile) override;
///Reconstructs from XML a ODPCMAliasBlockFile and reschedules it for OD loading
///Reconstructs from XML a ODDecodeBlockFile and reschedules it for OD loading
static BlockFilePtr BuildFromXML(DirManager &dm, const wxChar **attrs);
///Writes the summary file if summary data is available
void Recover(void) override;
///A public interface to WriteSummary
int DoWriteBlockFile(){return WriteODDecodeBlockFile();}
int WriteODDecodeBlockFile();

2
src/blockfile/ODPCMAliasBlockFile.cpp
View File

@@ -224,7 +224,7 @@ BlockFilePtr ODPCMAliasBlockFile::Copy(wxFileNameWrapper &&newFileName)
/// Writes the xml as a PCMAliasBlockFile if we can (if we have a summary file)
/// Otherwise writes XML as a subset of attributes with 'odpcmaliasblockfile as the start tag.
/// Most notably, the summaryfile attribute refers to a file that does not yet, so when the project file is read back in
/// Most notably, the summaryfile attribute refers to a file that does not yet exist, so when the project file is read back in
/// and this object reconstructed, it needs to avoid trying to open it as well as schedule itself for OD loading
void ODPCMAliasBlockFile::SaveXML(XMLWriter &xmlFile)
{

4
src/blockfile/ODPCMAliasBlockFile.h
View File

@@ -16,10 +16,10 @@ The summary is eventually computed and written to a file in a background thread.
Load On-Demand implementation of the AliasBlockFile for PCM files.
to load large files more quickly, we take skip computing the summary data and put
to load large files more quickly, we skip computing the summary data and put
ODPCMAliasBlockFiles in the sequence as place holders. A background thread loads and
computes the summary data into these classes.
ODPCMAliasBlockFiles are unlike all other BlockFiles are not immutable (for the most part,) because when NEW
ODPCMAliasBlockFiles unlike all other BlockFiles are not immutable (for the most part,) because when NEW
summary data is computed for an existing ODPCMAliasBlockFile we save the buffer then and write the Summary File.
All BlockFile methods that treat the summary data as a buffer that exists in its BlockFile