OutputFile: add documentation

Clement Champetier · Clement Champetier · commit f8863f007adc · 2015-01-12T10:42:39.000+01:00
* Also remove unused attribute _packetCount.
diff --git a/src/AvTranscoder/file/OutputFile.cpp b/src/AvTranscoder/file/OutputFile.cpp
@@ -15,11 +15,10 @@ namespace avtranscoder
 {
 
 OutputFile::OutputFile( const std::string& filename )
-	: _outputFormat  ( NULL )
-	, _formatContext ( NULL )
+	: _formatContext ( NULL )
+	, _outputFormat  ( NULL )
 	, _stream        ( NULL )
 	, _filename      ( filename )
-	, _packetCount   ( 0 )
 	, _previousProcessedStreamDuration( 0.0 )
 	, _verbose       ( false )
 {
@@ -194,7 +193,6 @@ IOutputStream::EWrappingStatus OutputFile::wrap( const CodedData& data, const si
 
 	_previousProcessedStreamDuration = currentStreamDuration;
 	
-	_packetCount++;
 	_frameCount.at( streamId )++;
 	return IOutputStream::eWrappingSuccess;
 }
diff --git a/src/AvTranscoder/file/OutputFile.hpp b/src/AvTranscoder/file/OutputFile.hpp
@@ -113,21 +113,18 @@ class AvExport OutputFile
 	virtual double getProgressDuration();
 
 private:
-	std::vector<AvOutputStream*> _outputStreams;
-	AVOutputFormat*  _outputFormat;
-	AVFormatContext* _formatContext;
-
+	std::vector<AvOutputStream*> _outputStreams;  ///< Has ownership
+	AVFormatContext* _formatContext;  ///< Has ownership
+	AVOutputFormat*  _outputFormat;   ///< Output format (has link, no ownership)
 	AVStream*        _stream;
 
-	std::vector<size_t> _frameCount;
+	std::vector<size_t> _frameCount;  ///< Number of wrapped frames
 
-	std::string      _filename;
+	std::string _filename;  ///< Output filename
 
-	size_t           _packetCount;
-	
-	double           _previousProcessedStreamDuration;
+	double _previousProcessedStreamDuration;  ///< To manage process streams order
 
-	bool             _verbose;
+	bool _verbose;
 };
 
 }

Original file line number	Diff line number	Diff line change
`@@ -15,11 +15,10 @@ namespace avtranscoder`
`15`	`15`	`{`
`16`	`16`
`17`	`17`	`OutputFile::OutputFile( const std::string& filename )`
`18`		`- : _outputFormat ( NULL )`
`19`		`- , _formatContext ( NULL )`
	`18`	`+ : _formatContext ( NULL )`
	`19`	`+ , _outputFormat ( NULL )`
`20`	`20`	`, _stream ( NULL )`
`21`	`21`	`, _filename ( filename )`
`22`		`- , _packetCount ( 0 )`
`23`	`22`	`, _previousProcessedStreamDuration( 0.0 )`
`24`	`23`	`, _verbose ( false )`
`25`	`24`	`{`
`@@ -194,7 +193,6 @@ IOutputStream::EWrappingStatus OutputFile::wrap( const CodedData& data, const si`
`194`	`193`
`195`	`194`	`_previousProcessedStreamDuration = currentStreamDuration;`
`196`	`195`
`197`		`- _packetCount++;`
`198`	`196`	`_frameCount.at( streamId )++;`
`199`	`197`	`return IOutputStream::eWrappingSuccess;`
`200`	`198`	`}`