Transcoder/StreamTranscoder: add documentation

Clement Champetier · Clement Champetier · commit 6a1d191364ab · 2015-02-04T15:52:36.000+01:00
diff --git a/src/AvTranscoder/transcoder/StreamTranscoder.cpp b/src/AvTranscoder/transcoder/StreamTranscoder.cpp
@@ -329,10 +329,10 @@ bool StreamTranscoder::processTranscode( const int subStreamIndex )
 	assert( _frameBuffer    != NULL );
 	assert( _transform      != NULL );
 
-	CodedData data;
 	if( _verbose )
 		std::cout << "transcode a frame " << std::endl;
 
+	// check offset
 	if( _offset &&
 		_frameProcessed > _offset &&
 		! _offsetPassed &&
@@ -348,6 +348,7 @@ bool StreamTranscoder::processTranscode( const int subStreamIndex )
 	else
 		decodingStatus = _currentDecoder->decodeNextFrame( *_sourceBuffer, subStreamIndex );
 
+	CodedData data;
 	if( decodingStatus )
 	{
 		if( _verbose )
@@ -375,7 +376,6 @@ bool StreamTranscoder::processTranscode( const int subStreamIndex )
 		std::cout << "wrap (" << data.getSize() << " bytes)" << std::endl;
 
 	IOutputStream::EWrappingStatus wrappingStatus = _outputStream->wrap( data );
-
 	switch( wrappingStatus )
 	{
 		case IOutputStream::eWrappingSuccess:
diff --git a/src/AvTranscoder/transcoder/StreamTranscoder.hpp b/src/AvTranscoder/transcoder/StreamTranscoder.hpp
@@ -79,18 +79,18 @@ class AvExport StreamTranscoder
 	bool processTranscode( const int subStreamIndex = -1 );  ///< By default transcode all channels
 
 private:
-	IInputStream*   _inputStream;
-	IOutputStream*  _outputStream;
+	IInputStream* _inputStream;  ///< Input stream to read next packet (has link, no ownership)
+	IOutputStream* _outputStream;  ///< Output stream to wrap next packet (has link, no ownership)
 
-	Frame*         _sourceBuffer;
-	Frame*         _frameBuffer;
+	Frame* _sourceBuffer;  ///< Has ownership
+	Frame* _frameBuffer;  ///< Has ownership
 
-	IDecoder* _inputDecoder;
-	IDecoder* _generator;
-	IDecoder* _currentDecoder;
-	IEncoder* _outputEncoder;
+	IDecoder* _inputDecoder;  ///< Decoder of packets read from _inputStream (has ownership)
+	IDecoder* _generator;  ///< Generator of audio or video packets (has ownership)
+	IDecoder* _currentDecoder;  ///< Link to _inputDecoder or _generator
+	IEncoder* _outputEncoder;  ///< Encoder of packets which will be wrapped by _outputStream (has ownership)
 
-	ITransform* _transform;
+	ITransform* _transform;  ///< Video or audio transform (has ownership)
 
 	int  _subStreamIndex;  ///< Index of channel that is processed from the input stream (-1 if no demultiplexing).
 
diff --git a/src/AvTranscoder/transcoder/Transcoder.hpp b/src/AvTranscoder/transcoder/Transcoder.hpp
@@ -172,16 +172,15 @@ class AvExport Transcoder
 	void manageInfinityStreamFromProcessMethod();
 
 private:
-	IOutputFile& _outputFile;  ///< The output media file after process.
-	std::vector< InputFile* >        _inputFiles;  ///< The list of input files which contain added streams.
+	IOutputFile& _outputFile;  ///< The output media file after process (has link)
+	std::vector< InputFile* > _inputFiles;  ///< The list of input files which contain added streams (has ownership)
 
 	std::vector< StreamTranscoder* > _streamTranscoders;  ///< All streams of the output media file after process.
-	std::vector< StreamTranscoder* > _streamTranscodersAllocated;  ///< Streams allocated inside the Transcoder.
+	std::vector< StreamTranscoder* > _streamTranscodersAllocated;  ///< Streams allocated inside the Transcoder (has ownership)
 
 	ProfileLoader _profileLoader;  ///< Objet to get existing profiles, and add new ones for the Transcoder.
 
-	EProcessMethod _eProcessMethod;
-
+	EProcessMethod _eProcessMethod;  ///< Transcoding policy
 	size_t _mainStreamIndex;  ///< Index of stream used to stop the process of transcode in case of eProcessMethodBasedOnStream.
 
 	bool    _verbose;
