OuputFile: rename streamId argument to streamIndex

Clement Champetier · Clement Champetier · commit cf8619f1dcd0 · 2015-10-30T12:06:29.000+01:00
diff --git a/src/AvTranscoder/file/IOutputFile.hpp b/src/AvTranscoder/file/IOutputFile.hpp
@@ -59,7 +59,9 @@ class AvExport IOutputFile
 	/**
 	 * @brief Wrap a packet of data in the output ressource
 	 * @param data coded packet information for the current stream
-	 * @param streamId refers to the stream in output ressource
+	 * @param streamIndex refers to the stream in output ressource
+	 * @return the wrapping status after wrapping
+	 * @see EWrappingStatus
 	**/
 	virtual IOutputStream::EWrappingStatus wrap( const CodedData& data, const size_t streamIndex ) = 0;
 
@@ -70,7 +72,7 @@ class AvExport IOutputFile
 	
 	/**
 	 * @brief Get the output stream
-	 * @param streamId select the output stream
+	 * @param streamIndex select the output stream
 	 * @return the output stream reference
 	**/
 	virtual IOutputStream& getStream( const size_t streamIndex ) = 0;
diff --git a/src/AvTranscoder/file/OutputFile.cpp b/src/AvTranscoder/file/OutputFile.cpp
@@ -101,11 +101,11 @@ IOutputStream& OutputFile::addDataStream( const DataCodec& dataDesc )
 	return *outputStream;
 }
 
-IOutputStream& OutputFile::getStream( const size_t streamId )
+IOutputStream& OutputFile::getStream( const size_t streamIndex )
 {
-	if( streamId >= _outputStreams.size() )
+	if( streamIndex >= _outputStreams.size() )
 		throw std::runtime_error( "unable to get output stream (out of range)" );
-	return *_outputStreams.at( streamId );
+	return *_outputStreams.at( streamIndex );
 }
 
 std::string OutputFile::getFilename() const
@@ -159,16 +159,16 @@ bool OutputFile::beginWrap( )
 	return true;
 }
 
-IOutputStream::EWrappingStatus OutputFile::wrap( const CodedData& data, const size_t streamId )
+IOutputStream::EWrappingStatus OutputFile::wrap( const CodedData& data, const size_t streamIndex )
 {
 	if( ! data.getSize() )
 		return IOutputStream::eWrappingSuccess;
 
-	LOG_DEBUG( "Wrap on stream " << streamId << " (" << data.getSize() << " bytes for frame " << _frameCount.at( streamId ) << ")" )
+	LOG_DEBUG( "Wrap on stream " << streamIndex << " (" << data.getSize() << " bytes for frame " << _frameCount.at( streamIndex ) << ")" )
 
 	AVPacket packet;
 	av_init_packet( &packet );
-	packet.stream_index = streamId;
+	packet.stream_index = streamIndex;
 	packet.data = (uint8_t*)data.getData();
 	packet.size = data.getSize();
 
@@ -177,15 +177,15 @@ IOutputStream::EWrappingStatus OutputFile::wrap( const CodedData& data, const si
 	// free packet.side_data, set packet.data to NULL and packet.size to 0
 	av_free_packet( &packet );
 
-	const double currentStreamDuration = _outputStreams.at( streamId )->getStreamDuration();
+	const double currentStreamDuration = _outputStreams.at( streamIndex )->getStreamDuration();
 	if( currentStreamDuration < _previousProcessedStreamDuration )
 	{
 		// if the current stream is strictly shorter than the previous, wait for more data
 		return IOutputStream::eWrappingWaitingForData;
 	}
 
 	_previousProcessedStreamDuration = currentStreamDuration;
-	_frameCount.at( streamId )++;
+	_frameCount.at( streamIndex )++;
 
 	return IOutputStream::eWrappingSuccess;
 }
diff --git a/src/AvTranscoder/file/OutputFile.hpp b/src/AvTranscoder/file/OutputFile.hpp
@@ -37,10 +37,10 @@ class AvExport OutputFile : public IOutputFile
 	 * @brief Open ressource, write header, and setup specific wrapping options given when call setupWrapping.
 	 * @note Need to add the streams to mux before calling this method.
 	 * @note After this call, a new list of AVOption, relative to the format choosen, will be available for the OutputFile.
-         */
+	 */
 	bool beginWrap();
 
-	IOutputStream::EWrappingStatus wrap( const CodedData& data, const size_t streamId );
+	IOutputStream::EWrappingStatus wrap( const CodedData& data, const size_t streamIndex );
 
 	/**
 	 * @brief Close ressource and write trailer.
@@ -54,7 +54,7 @@ class AvExport OutputFile : public IOutputFile
 	void addMetadata( const PropertyVector& data );
 	void addMetadata( const std::string& key, const std::string& value );
 	
-	IOutputStream& getStream( const size_t streamId );
+	IOutputStream& getStream( const size_t streamIndex );
 
 	std::string getFilename() const;
 

Original file line number	Diff line number	Diff line change
`@@ -101,11 +101,11 @@ IOutputStream& OutputFile::addDataStream( const DataCodec& dataDesc )`
`101`	`101`	`return *outputStream;`
`102`	`102`	`}`
`103`	`103`
`104`		`-IOutputStream& OutputFile::getStream( const size_t streamId )`
	`104`	`+IOutputStream& OutputFile::getStream( const size_t streamIndex )`
`105`	`105`	`{`
`106`		`- if( streamId >= _outputStreams.size() )`
	`106`	`+ if( streamIndex >= _outputStreams.size() )`
`107`	`107`	`throw std::runtime_error( "unable to get output stream (out of range)" );`
`108`		`- return *_outputStreams.at( streamId );`
	`108`	`+ return *_outputStreams.at( streamIndex );`
`109`	`109`	`}`
`110`	`110`
`111`	`111`	`std::string OutputFile::getFilename() const`
`@@ -159,16 +159,16 @@ bool OutputFile::beginWrap( )`
`159`	`159`	`return true;`
`160`	`160`	`}`
`161`	`161`
`162`		`-IOutputStream::EWrappingStatus OutputFile::wrap( const CodedData& data, const size_t streamId )`
	`162`	`+IOutputStream::EWrappingStatus OutputFile::wrap( const CodedData& data, const size_t streamIndex )`
`163`	`163`	`{`
`164`	`164`	`if( ! data.getSize() )`
`165`	`165`	`return IOutputStream::eWrappingSuccess;`
`166`	`166`
`167`		`- LOG_DEBUG( "Wrap on stream " << streamId << " (" << data.getSize() << " bytes for frame " << _frameCount.at( streamId ) << ")" )`
	`167`	`+ LOG_DEBUG( "Wrap on stream " << streamIndex << " (" << data.getSize() << " bytes for frame " << _frameCount.at( streamIndex ) << ")" )`
`168`	`168`
`169`	`169`	`AVPacket packet;`
`170`	`170`	`av_init_packet( &packet );`
`171`		`- packet.stream_index = streamId;`
	`171`	`+ packet.stream_index = streamIndex;`
`172`	`172`	`packet.data = (uint8_t*)data.getData();`
`173`	`173`	`packet.size = data.getSize();`
`174`	`174`
`@@ -177,15 +177,15 @@ IOutputStream::EWrappingStatus OutputFile::wrap( const CodedData& data, const si`
`177`	`177`	`// free packet.side_data, set packet.data to NULL and packet.size to 0`
`178`	`178`	`av_free_packet( &packet );`
`179`	`179`
`180`		`- const double currentStreamDuration = _outputStreams.at( streamId )->getStreamDuration();`
	`180`	`+ const double currentStreamDuration = _outputStreams.at( streamIndex )->getStreamDuration();`
`181`	`181`	`if( currentStreamDuration < _previousProcessedStreamDuration )`
`182`	`182`	`{`
`183`	`183`	`// if the current stream is strictly shorter than the previous, wait for more data`
`184`	`184`	`return IOutputStream::eWrappingWaitingForData;`
`185`	`185`	`}`
`186`	`186`
`187`	`187`	`_previousProcessedStreamDuration = currentStreamDuration;`
`188`		`- _frameCount.at( streamId )++;`
	`188`	`+ _frameCount.at( streamIndex )++;`
`189`	`189`
`190`	`190`	`return IOutputStream::eWrappingSuccess;`
`191`	`191`	`}`