IInputEssence: rename functions

Clement Champetier · Clement Champetier · commit 977a2953ad9d · 2015-01-12T10:40:50.000+01:00
* readNextFrame to decodeNextFrame.
* setFrame to setNextFrame.
diff --git a/app/avTranscoder/avTranscoder.cpp b/app/avTranscoder/avTranscoder.cpp
@@ -65,7 +65,7 @@ void transcodeVideo( const char* inputfilename, const char* outputFilename )
 
 	size_t frame = 1;
 
-	while( inputVideo.readNextFrame( sourceImage ) )
+	while( inputVideo.decodeNextFrame( sourceImage ) )
 	{
 		std::cout << "\rprocess frame " << frame << std::flush;
 		
diff --git a/app/avplay/AvReader.hpp b/app/avplay/AvReader.hpp
@@ -70,7 +70,7 @@ class AvReader : public Reader
 	const char* readNextFrame()
 	{
 		++_currentFrame;
-		_inputVideo->readNextFrame( *_sourceImage );
+		_inputVideo->decodeNextFrame( *_sourceImage );
 		_videoTransform.convert( *_sourceImage, *_imageToDisplay );
 		return (const char*)_imageToDisplay->getPtr();
 	}
diff --git a/src/AvTranscoder/essenceStream/AvInputAudio.cpp b/src/AvTranscoder/essenceStream/AvInputAudio.cpp
@@ -79,7 +79,7 @@ void AvInputAudio::setup()
 	}
 }
 
-bool AvInputAudio::readNextFrame( Frame& frameBuffer )
+bool AvInputAudio::decodeNextFrame( Frame& frameBuffer )
 {
 	if( ! decodeNextFrame() )
 		return false;
@@ -107,7 +107,7 @@ bool AvInputAudio::readNextFrame( Frame& frameBuffer )
 	return true;
 }
 
-bool AvInputAudio::readNextFrame( Frame& frameBuffer, const size_t subStreamIndex )
+bool AvInputAudio::decodeNextFrame( Frame& frameBuffer, const size_t subStreamIndex )
 {
 	if( ! decodeNextFrame() )
 		return false;
diff --git a/src/AvTranscoder/essenceStream/AvInputAudio.hpp b/src/AvTranscoder/essenceStream/AvInputAudio.hpp
@@ -19,8 +19,8 @@ class AvExport AvInputAudio : public IInputEssence
 
 	void setup();
 
-	bool readNextFrame( Frame& frameBuffer );
-	bool readNextFrame( Frame& frameBuffer, const size_t subStreamIndex );
+	bool decodeNextFrame( Frame& frameBuffer );
+	bool decodeNextFrame( Frame& frameBuffer, const size_t subStreamIndex );
 
 private:
 	bool decodeNextFrame();
diff --git a/src/AvTranscoder/essenceStream/AvInputVideo.cpp b/src/AvTranscoder/essenceStream/AvInputVideo.cpp
@@ -75,7 +75,7 @@ void AvInputVideo::setup()
 	}
 }
 
-bool AvInputVideo::readNextFrame( Frame& frameBuffer )
+bool AvInputVideo::decodeNextFrame( Frame& frameBuffer )
 {
 	if( ! decodeNextFrame() )
 		return false;
@@ -95,7 +95,7 @@ bool AvInputVideo::readNextFrame( Frame& frameBuffer )
 	return true;
 }
 
-bool AvInputVideo::readNextFrame( Frame& frameBuffer, const size_t subStreamIndex )
+bool AvInputVideo::decodeNextFrame( Frame& frameBuffer, const size_t subStreamIndex )
 {
 	return false;
 }
diff --git a/src/AvTranscoder/essenceStream/AvInputVideo.hpp b/src/AvTranscoder/essenceStream/AvInputVideo.hpp
@@ -20,8 +20,8 @@ class AvExport AvInputVideo : public IInputEssence
 	
 	void setup();
 
-	bool readNextFrame( Frame& frameBuffer );
-	bool readNextFrame( Frame& frameBuffer, const size_t subStreamIndex );
+	bool decodeNextFrame( Frame& frameBuffer );
+	bool decodeNextFrame( Frame& frameBuffer, const size_t subStreamIndex );
 
 	void flushDecoder();
 	
diff --git a/src/AvTranscoder/essenceStream/AvOutputAudio.hpp b/src/AvTranscoder/essenceStream/AvOutputAudio.hpp
@@ -16,7 +16,7 @@ class AvExport AvOutputAudio : public IOutputEssence
 	void setup();
 
 	bool encodeFrame( const Frame& sourceFrame, Frame& codedFrame );
-	bool encodeFrame( Frame& codedFrame );  ///<  Encode delayed encoded frames
+	bool encodeFrame( Frame& codedFrame );
 
 	ICodec& getCodec() { return _codec; }
 	AudioCodec& getAudioCodec() { return _codec; }
diff --git a/src/AvTranscoder/essenceStream/AvOutputVideo.hpp b/src/AvTranscoder/essenceStream/AvOutputVideo.hpp
@@ -16,8 +16,7 @@ class AvExport AvOutputVideo : public IOutputEssence
 	void setup();
 
 	bool encodeFrame( const Frame& sourceFrame, Frame& codedFrame );
-	bool encodeFrame( Frame& codedFrame );  ///< Encode delayed encoded frames
-
+	bool encodeFrame( Frame& codedFrame );
 	
 	ICodec& getCodec() { return _codec; }
 	VideoCodec& getVideoCodec() { return _codec; }
diff --git a/src/AvTranscoder/essenceStream/GeneratorAudio.cpp b/src/AvTranscoder/essenceStream/GeneratorAudio.cpp
@@ -21,7 +21,7 @@ void GeneratorAudio::setFrame( Frame& inputFrame )
 	_inputFrame = &inputFrame;
 }
 
-bool GeneratorAudio::readNextFrame( Frame& frameBuffer )
+bool GeneratorAudio::decodeNextFrame( Frame& frameBuffer )
 {
 	if( ! _inputFrame )
 	{
@@ -45,7 +45,7 @@ bool GeneratorAudio::readNextFrame( Frame& frameBuffer )
 	return true;
 }
 
-bool GeneratorAudio::readNextFrame( Frame& frameBuffer, const size_t subStreamIndex )
+bool GeneratorAudio::decodeNextFrame( Frame& frameBuffer, const size_t subStreamIndex )
 {
 	return false;
 }
diff --git a/src/AvTranscoder/essenceStream/GeneratorAudio.hpp b/src/AvTranscoder/essenceStream/GeneratorAudio.hpp
@@ -19,8 +19,8 @@ class AvExport GeneratorAudio : public IInputEssence
 	
 	void setFrame( Frame& inputFrame );
 
-	bool readNextFrame( Frame& frameBuffer );
-	bool readNextFrame( Frame& frameBuffer, const size_t subStreamIndex );
+	bool decodeNextFrame( Frame& frameBuffer );
+	bool decodeNextFrame( Frame& frameBuffer, const size_t subStreamIndex );
 
 private:
 	Frame* _inputFrame;  ///< Has link (no ownership)
diff --git a/src/AvTranscoder/essenceStream/GeneratorVideo.cpp b/src/AvTranscoder/essenceStream/GeneratorVideo.cpp
@@ -17,12 +17,12 @@ void GeneratorVideo::setVideoFrameDesc( const VideoFrameDesc& frameDesc )
 	_frameDesc = frameDesc;
 }
 
-void GeneratorVideo::setFrame( Frame& inputFrame )
+void GeneratorVideo::setNextFrame( Frame& inputFrame )
 {
 	_inputFrame = &inputFrame;
 }
 
-bool GeneratorVideo::readNextFrame( Frame& frameBuffer )
+bool GeneratorVideo::decodeNextFrame( Frame& frameBuffer )
 {
 	// Generate black image
 	if( ! _inputFrame )
@@ -48,7 +48,7 @@ bool GeneratorVideo::readNextFrame( Frame& frameBuffer )
 	return true;
 }
 
-bool GeneratorVideo::readNextFrame( Frame& frameBuffer, const size_t subStreamIndex )
+bool GeneratorVideo::decodeNextFrame( Frame& frameBuffer, const size_t subStreamIndex )
 {
 	return false;
 }
diff --git a/src/AvTranscoder/essenceStream/GeneratorVideo.hpp b/src/AvTranscoder/essenceStream/GeneratorVideo.hpp
@@ -17,10 +17,10 @@ class AvExport GeneratorVideo : public IInputEssence
 	
 	void setup() {}
 
-	void setFrame( Frame& inputFrame );
+	void setNextFrame( Frame& inputFrame );
 	
-	bool readNextFrame( Frame& frameBuffer );
-	bool readNextFrame( Frame& frameBuffer, const size_t subStreamIndex );
+	bool decodeNextFrame( Frame& frameBuffer );
+	bool decodeNextFrame( Frame& frameBuffer, const size_t subStreamIndex );
 
 private:
 	Frame* _inputFrame;  ///< Has link (no ownership)
diff --git a/src/AvTranscoder/essenceStream/IInputEssence.hpp b/src/AvTranscoder/essenceStream/IInputEssence.hpp
@@ -22,22 +22,22 @@ class AvExport IInputEssence
 	 * @param frameBuffer: the frame decoded
 	 * @return status of decoding
 	 */
-	virtual bool readNextFrame( Frame& frameBuffer ) = 0;
+	virtual bool decodeNextFrame( Frame& frameBuffer ) = 0;
 
 	/**
 	 * @brief Decode substream of next frame
 	 * @param frameBuffer: the frame decoded
 	 * @param subStreamIndex: index of substream to extract
 	 * @return status of decoding
 	 */
-	virtual bool readNextFrame( Frame& frameBuffer, const size_t subStreamIndex ) = 0;
+	virtual bool decodeNextFrame( Frame& frameBuffer, const size_t subStreamIndex ) = 0;
 
 	/**
 	 * Set the next frame of the input stream
 	 * @note Not yet implemented for AvInputVideo and AvInputAudio
 	 * @param inputFrame: the new next frame
 	 */
-	virtual void setFrame( Frame& inputFrame ) {}
+	virtual void setNextFrame( Frame& inputFrame ) {}
 };
 
 }
diff --git a/src/AvTranscoder/transcoder/StreamTranscoder.cpp b/src/AvTranscoder/transcoder/StreamTranscoder.cpp
@@ -343,9 +343,9 @@ bool StreamTranscoder::processTranscode( const int subStreamIndex )
 
 	bool decodingStatus = false;
 	if( subStreamIndex == -1 )
-		decodingStatus = _currentEssence->readNextFrame( *_sourceBuffer );
+		decodingStatus = _currentEssence->decodeNextFrame( *_sourceBuffer );
 	else
-		decodingStatus = _currentEssence->readNextFrame( *_sourceBuffer, subStreamIndex );
+		decodingStatus = _currentEssence->decodeNextFrame( *_sourceBuffer, subStreamIndex );
 
 	if( decodingStatus )
 	{
diff --git a/test/pyTest/testSetFrame.py b/test/pyTest/testSetFrame.py
@@ -17,7 +17,7 @@ def testSetVideoFrame():
 	# create video frame and codec
 	inputVideoCodec = av.VideoCodec( av.eCodecTypeEncoder, "mpeg2video" );
 	imageDesc = av.VideoFrameDesc( 1920, 1080, "rgb24" )
-	inputVideoCodec.setImageParameters( imageDesc );
+	inputVideoCodec.setImageParameters( imageDesc )
 
 	# create transcoder and add a video stream
 	transcoder = av.Transcoder( ouputFile )
@@ -34,7 +34,7 @@ def testSetVideoFrame():
 		# set video frame
 		frame = av.VideoFrame( imageDesc )
 		frame.getBuffer().assign(frame.getBuffer().size(), i)
-		videoEssence.setFrame( frame )
+		videoEssence.setNextFrame( frame )
 
 	# end process
 	ouputFile.endWrap()
@@ -83,7 +83,7 @@ def testSetAudioFrame():
 		# set video frame
 		frame = av.AudioFrame( audioDesc )
 		frame.getBuffer().assign(frame.getBuffer().size(), i)
-		audioEssence.setFrame( frame )
+		audioEssence.setNextFrame( frame )
 
 	# end process
 	ouputFile.endWrap()

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ void transcodeVideo( const char* inputfilename, const char* outputFilename )`
`65`	`65`
`66`	`66`	`size_t frame = 1;`
`67`	`67`
`68`		`- while( inputVideo.readNextFrame( sourceImage ) )`
	`68`	`+ while( inputVideo.decodeNextFrame( sourceImage ) )`
`69`	`69`	`{`
`70`	`70`	`std::cout << "\rprocess frame " << frame << std::flush;`
`71`	`71`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ class AvReader : public Reader`
`70`	`70`	`const char* readNextFrame()`
`71`	`71`	`{`
`72`	`72`	`++_currentFrame;`
`73`		`- _inputVideo->readNextFrame( *_sourceImage );`
	`73`	`+ _inputVideo->decodeNextFrame( *_sourceImage );`
`74`	`74`	`_videoTransform.convert( _sourceImage, _imageToDisplay );`
`75`	`75`	`return (const char*)_imageToDisplay->getPtr();`
`76`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ void AvInputAudio::setup()`
`79`	`79`	`}`
`80`	`80`	`}`
`81`	`81`
`82`		`-bool AvInputAudio::readNextFrame( Frame& frameBuffer )`
	`82`	`+bool AvInputAudio::decodeNextFrame( Frame& frameBuffer )`
`83`	`83`	`{`
`84`	`84`	`if( ! decodeNextFrame() )`
`85`	`85`	`return false;`
`@@ -107,7 +107,7 @@ bool AvInputAudio::readNextFrame( Frame& frameBuffer )`
`107`	`107`	`return true;`
`108`	`108`	`}`
`109`	`109`
`110`		`-bool AvInputAudio::readNextFrame( Frame& frameBuffer, const size_t subStreamIndex )`
	`110`	`+bool AvInputAudio::decodeNextFrame( Frame& frameBuffer, const size_t subStreamIndex )`
`111`	`111`	`{`
`112`	`112`	`if( ! decodeNextFrame() )`
`113`	`113`	`return false;`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ void AvInputVideo::setup()`
`75`	`75`	`}`
`76`	`76`	`}`
`77`	`77`
`78`		`-bool AvInputVideo::readNextFrame( Frame& frameBuffer )`
	`78`	`+bool AvInputVideo::decodeNextFrame( Frame& frameBuffer )`
`79`	`79`	`{`
`80`	`80`	`if( ! decodeNextFrame() )`
`81`	`81`	`return false;`
`@@ -95,7 +95,7 @@ bool AvInputVideo::readNextFrame( Frame& frameBuffer )`
`95`	`95`	`return true;`
`96`	`96`	`}`
`97`	`97`
`98`		`-bool AvInputVideo::readNextFrame( Frame& frameBuffer, const size_t subStreamIndex )`
	`98`	`+bool AvInputVideo::decodeNextFrame( Frame& frameBuffer, const size_t subStreamIndex )`
`99`	`99`	`{`
`100`	`100`	`return false;`
`101`	`101`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ void GeneratorAudio::setFrame( Frame& inputFrame )`
`21`	`21`	`_inputFrame = &inputFrame;`
`22`	`22`	`}`
`23`	`23`
`24`		`-bool GeneratorAudio::readNextFrame( Frame& frameBuffer )`
	`24`	`+bool GeneratorAudio::decodeNextFrame( Frame& frameBuffer )`
`25`	`25`	`{`
`26`	`26`	`if( ! _inputFrame )`
`27`	`27`	`{`
`@@ -45,7 +45,7 @@ bool GeneratorAudio::readNextFrame( Frame& frameBuffer )`
`45`	`45`	`return true;`
`46`	`46`	`}`
`47`	`47`
`48`		`-bool GeneratorAudio::readNextFrame( Frame& frameBuffer, const size_t subStreamIndex )`
	`48`	`+bool GeneratorAudio::decodeNextFrame( Frame& frameBuffer, const size_t subStreamIndex )`
`49`	`49`	`{`
`50`	`50`	`return false;`
`51`	`51`	`}`