IInputStream: refactore order of functions

Clement Champetier · Clement Champetier · commit 2b5d09ecf8e0 · 2015-01-12T10:38:00.000+01:00
* Getters and setters together.
* Same thing for its implementation.
diff --git a/src/AvTranscoder/codedStream/AvInputStream.cpp b/src/AvTranscoder/codedStream/AvInputStream.cpp
@@ -89,17 +89,6 @@ bool AvInputStream::readNextPacket( CodedData& data )
 	return true;
 }
 
-void AvInputStream::addPacket( AVPacket& packet )
-{
-	// Do not cache data if the stream is declared as unused in process
-	if( ! _isActivated )
-		return;
-
-	CodedData data;
-	_streamCache.push( data );
-	_streamCache.back().copyData( packet.data, packet.size );
-}
-
 VideoCodec& AvInputStream::getVideoCodec()
 {
 	assert( _streamIndex <= _inputFile->getAVFormatContext().nb_streams );
@@ -146,6 +135,17 @@ double AvInputStream::getDuration() const
 	return 1.0 * _inputFile->getAVFormatContext().duration / AV_TIME_BASE;
 }
 
+void AvInputStream::addPacket( AVPacket& packet )
+{
+	// Do not cache data if the stream is declared as unused in process
+	if( ! _isActivated )
+		return;
+
+	CodedData data;
+	_streamCache.push( data );
+	_streamCache.back().copyData( packet.data, packet.size );
+}
+
 void AvInputStream::clearBuffering()
 {
 	_streamCache = std::queue<CodedData>();
diff --git a/src/AvTranscoder/codedStream/AvInputStream.hpp b/src/AvTranscoder/codedStream/AvInputStream.hpp
@@ -17,28 +17,27 @@ class AvExport AvInputStream : public IInputStream
 public:
 	AvInputStream( InputFile& inputFile, const size_t streamIndex );
 	AvInputStream( const AvInputStream& inputStream );
-
 	~AvInputStream( );
 
-	size_t getStreamIndex() const { return _streamIndex; }
-
 	bool readNextPacket( CodedData& data );
 
-	// Stream properties
+	size_t getStreamIndex() const { return _streamIndex; }
+	double getDuration() const;
+	AVMediaType getStreamType() const;
+
 	VideoCodec& getVideoCodec();
 	AudioCodec& getAudioCodec();
 	DataCodec& getDataCodec();
 
-	AVMediaType getStreamType() const;
-
-	double getDuration() const;
-
-	void addPacket( AVPacket& packet );
-
+	//@{
+	/**
+	 * @brief Functions about buffering
+	 */
 	void activate( const bool activate = true ){ _isActivated = activate; };
 	bool isActivated() const { return _isActivated; };
-
+	void addPacket( AVPacket& packet );
 	void clearBuffering();
+	//@}
 
 private:
 	AVStream* getAVStream() const;
diff --git a/src/AvTranscoder/codedStream/IInputStream.hpp b/src/AvTranscoder/codedStream/IInputStream.hpp
@@ -14,24 +14,33 @@ class IInputStream
 public:
 	virtual ~IInputStream() {};
 
-	virtual size_t getStreamIndex() const = 0;
-
+	/**
+	 * @brief Read the next packet of the stream
+	 * @param data: data of next packet read
+	 * @return if next packet was read succefully
+	 **/
 	virtual bool readNextPacket( CodedData& data ) = 0;
 
-	// Stream properties
+	virtual size_t getStreamIndex() const = 0;
+	virtual double getDuration() const = 0;
+	virtual AVMediaType getStreamType() const = 0;
+
+	//@{
+	/**
+	 * Return the codec informations of the stream
+	 * @exception Raise a runtime error if the stream is not of the corresponding type
+         */
 	virtual VideoCodec& getVideoCodec() = 0;
 	virtual AudioCodec& getAudioCodec() = 0;
 	virtual DataCodec& getDataCodec() = 0;
-	
-	virtual AVMediaType getStreamType() const = 0;
-
-	virtual double getDuration() const = 0;
+	//@}
 
+	/** 
+	 * @brief Activate the stream will buffered its data when read packets.
+	 **/
 	virtual void activate( const bool activate = true ) = 0;
 	virtual bool isActivated() const = 0;
-
 	virtual void clearBuffering() = 0;
-
 };
 
 }
