audio-river/river/io/NodeAEC.cpp

/** @file
 * @author Edouard DUPIN 
 * @copyright 2015, Edouard DUPIN, all right reserved
 * @license APACHE v2.0 (see license file)
 */

#include <river/io/NodeAEC.h>
#include <river/debug.h>
#include <etk/types.h>
#include <etk/memory.h>
#include <etk/functional.h>

#undef __class__
#define __class__ "io::NodeAEC"

std11::shared_ptr<river::io::NodeAEC> river::io::NodeAEC::create(const std::string& _name, const std11::shared_ptr<const ejson::Object>& _config) {
	return std11::shared_ptr<river::io::NodeAEC>(new river::io::NodeAEC(_name, _config));
}

std11::shared_ptr<river::Interface> river::io::NodeAEC::createInput(float _freq,
                                                                    const std::vector<audio::channel>& _map,
                                                                    audio::format _format,
                                                                    const std::string& _objectName,
                                                                    const std::string& _name) {
	// check if the output exist
	const std11::shared_ptr<const ejson::Object> tmppp = m_config->getObject(_objectName);
	if (tmppp == nullptr) {
		RIVER_ERROR("can not open a non existance virtual interface: '" << _objectName << "' not present in : " << m_config->getKeys());
		return std11::shared_ptr<river::Interface>();
	}
	std::string streamName = tmppp->getStringValue("map-on", "error");
	
	m_nbChunk = m_config->getNumberValue("nb-chunk", 1024);
	// check if it is an Output:
	std::string type = tmppp->getStringValue("io", "error");
	if (    type != "input"
	     && type != "feedback") {
		RIVER_ERROR("can not open in output a virtual interface: '" << streamName << "' configured has : " << type);
		return std11::shared_ptr<river::Interface>();
	}
	// get global hardware interface:
	std11::shared_ptr<river::io::Manager> manager = river::io::Manager::getInstance();
	// get the output or input channel :
	std11::shared_ptr<river::io::Node> node = manager->getNode(streamName);
	// create user iterface:
	std11::shared_ptr<river::Interface> interface;
	interface = river::Interface::create(_freq, _map, _format, node, tmppp);
	if (interface != nullptr) {
		interface->setName(_name);
	}
	return interface;
}


river::io::NodeAEC::NodeAEC(const std::string& _name, const std11::shared_ptr<const ejson::Object>& _config) :
  Node(_name, _config),
  m_P_attaqueTime(1),
  m_P_releaseTime(100),
  m_P_minimumGain(10),
  m_P_threshold(2),
  m_P_latencyTime(100) {
	drain::IOFormatInterface interfaceFormat = getInterfaceFormat();
	drain::IOFormatInterface hardwareFormat = getHarwareFormat();
	m_sampleTime = std11::chrono::nanoseconds(1000000000/int64_t(hardwareFormat.getFrequency()));
	/**
		# connect in input mode
		map-on-microphone:{
			# generic virtual definition
			io:"input",
			map-on:"microphone",
			resampling-type:"speexdsp",
			resampling-option:"quality=10"
		},
		# connect in feedback mode
		map-on-feedback:{
			io:"feedback",
			map-on:"speaker",
			resampling-type:"speexdsp",
			resampling-option:"quality=10",
		},
		# AEC algo definition
		algo:"river-remover",
		algo-mode:"cutter",
	*/
	std::vector<audio::channel> feedbackMap;
	feedbackMap.push_back(audio::channel_frontCenter);
	RIVER_INFO("Create FEEDBACK : ");
	m_interfaceFeedBack = createInput(hardwareFormat.getFrequency(),
	                                  feedbackMap,
	                                  hardwareFormat.getFormat(),
	                                  "map-on-feedback",
	                                  _name + "-AEC-feedback");
	if (m_interfaceFeedBack == nullptr) {
		RIVER_ERROR("Can not opne virtual device ... map-on-feedback in " << _name);
		return;
	}
	RIVER_INFO("Create MICROPHONE : ");
	m_interfaceMicrophone = createInput(hardwareFormat.getFrequency(),
	                                    hardwareFormat.getMap(),
	                                    hardwareFormat.getFormat(),
	                                    "map-on-microphone",
	                                    _name + "-AEC-microphone");
	if (m_interfaceMicrophone == nullptr) {
		RIVER_ERROR("Can not opne virtual device ... map-on-microphone in " << _name);
		return;
	}
	
	// set callback mode ...
	m_interfaceFeedBack->setInputCallback(std11::bind(&river::io::NodeAEC::onDataReceivedFeedBack,
	                                                  this,
	                                                  std11::placeholders::_1,
	                                                  std11::placeholders::_2,
	                                                  std11::placeholders::_3,
	                                                  std11::placeholders::_4,
	                                                  std11::placeholders::_5,
	                                                  std11::placeholders::_6));
	// set callback mode ...
	m_interfaceMicrophone->setInputCallback(std11::bind(&river::io::NodeAEC::onDataReceivedMicrophone,
	                                                    this,
	                                                    std11::placeholders::_1,
	                                                    std11::placeholders::_2,
	                                                    std11::placeholders::_3,
	                                                    std11::placeholders::_4,
	                                                    std11::placeholders::_5,
	                                                    std11::placeholders::_6));
	
	m_bufferMicrophone.setCapacity(std11::chrono::milliseconds(1000),
	                               audio::getFormatBytes(hardwareFormat.getFormat())*hardwareFormat.getMap().size(),
	                               hardwareFormat.getFrequency());
	m_bufferFeedBack.setCapacity(std11::chrono::milliseconds(1000),
	                             audio::getFormatBytes(hardwareFormat.getFormat()), // only one channel ...
	                             hardwareFormat.getFrequency());
	
	m_process.updateInterAlgo();
}

river::io::NodeAEC::~NodeAEC() {
	RIVER_INFO("close input stream");
	stop();
	m_interfaceFeedBack.reset();
	m_interfaceMicrophone.reset();
};

void river::io::NodeAEC::start() {
	std11::unique_lock<std11::mutex> lock(m_mutex);
	RIVER_INFO("Start stream : '" << m_name << "' mode=" << (m_isInput?"input":"output") );
	if (m_interfaceFeedBack != nullptr) {
		RIVER_INFO("Start FEEDBACK : ");
		m_interfaceFeedBack->start();
	}
	if (m_interfaceMicrophone != nullptr) {
		RIVER_INFO("Start Microphone : ");
		m_interfaceMicrophone->start();
	}
}

void river::io::NodeAEC::stop() {
	std11::unique_lock<std11::mutex> lock(m_mutex);
	if (m_interfaceFeedBack != nullptr) {
		m_interfaceFeedBack->stop();
	}
	if (m_interfaceMicrophone != nullptr) {
		m_interfaceMicrophone->stop();
	}
}


void river::io::NodeAEC::onDataReceivedMicrophone(const void* _data,
                                                  const std11::chrono::system_clock::time_point& _time,
                                                  size_t _nbChunk,
                                                  enum audio::format _format,
                                                  uint32_t _frequency,
                                                  const std::vector<audio::channel>& _map) {
	RIVER_DEBUG("Microphone Time=" << _time << " _nbChunk=" << _nbChunk << " _map=" << _map << " _format=" << _format << " freq=" << _frequency);
	RIVER_DEBUG("           next=" << _time + std11::chrono::nanoseconds(_nbChunk*1000000000LL/int64_t(_frequency)) );
	if (_format != audio::format_int16) {
		RIVER_ERROR("call wrong type ... (need int16_t)");
	}
	// push data synchronize
	std11::unique_lock<std11::mutex> lock(m_mutex);
	m_bufferMicrophone.write(_data, _nbChunk, _time);
	//RIVER_SAVE_FILE_MACRO(int16_t, "REC_Microphone.raw", _data, _nbChunk*_map.size());
	process();
}

void river::io::NodeAEC::onDataReceivedFeedBack(const void* _data,
                                                const std11::chrono::system_clock::time_point& _time,
                                                size_t _nbChunk,
                                                enum audio::format _format,
                                                uint32_t _frequency,
                                                const std::vector<audio::channel>& _map) {
	RIVER_DEBUG("FeedBack   Time=" << _time << " _nbChunk=" << _nbChunk << " _map=" << _map << " _format=" << _format << " freq=" << _frequency);
	RIVER_DEBUG("           next=" << _time + std11::chrono::nanoseconds(_nbChunk*1000000000LL/int64_t(_frequency)) );
	if (_format != audio::format_int16) {
		RIVER_ERROR("call wrong type ... (need int16_t)");
	}
	// push data synchronize
	std11::unique_lock<std11::mutex> lock(m_mutex);
	m_bufferFeedBack.write(_data, _nbChunk, _time);
	//RIVER_SAVE_FILE_MACRO(int16_t, "REC_FeedBack.raw", _data, _nbChunk*_map.size());
	process();
}

void river::io::NodeAEC::process() {
	if (    m_bufferMicrophone.getSize() <= m_nbChunk
	     || m_bufferFeedBack.getSize() <= m_nbChunk) {
		return;
	}
	std11::chrono::system_clock::time_point MicTime = m_bufferMicrophone.getReadTimeStamp();
	std11::chrono::system_clock::time_point fbTime = m_bufferFeedBack.getReadTimeStamp();
	std11::chrono::nanoseconds delta;
	if (MicTime < fbTime) {
		delta = fbTime - MicTime;
	} else {
		delta = MicTime - fbTime;
	}
	
	RIVER_INFO("check delta " << delta.count() << " > " << m_sampleTime.count());
	if (delta > m_sampleTime) {
		// Synchronize if possible
		if (MicTime < fbTime) {
			RIVER_INFO("micTime < fbTime : Change Microphone time start " << fbTime);
			RIVER_INFO("                                 old time stamp=" << m_bufferMicrophone.getReadTimeStamp());
			m_bufferMicrophone.setReadPosition(fbTime);
			RIVER_INFO("                                 new time stamp=" << m_bufferMicrophone.getReadTimeStamp());
		}
		if (MicTime > fbTime) {
			RIVER_INFO("micTime > fbTime : Change FeedBack time start " << MicTime);
			RIVER_INFO("                               old time stamp=" << m_bufferFeedBack.getReadTimeStamp());
			m_bufferFeedBack.setReadPosition(MicTime);
			RIVER_INFO("                               new time stamp=" << m_bufferFeedBack.getReadTimeStamp());
		}
	}
	// check if enought time after synchronisation ...
	if (    m_bufferMicrophone.getSize() <= m_nbChunk
	     || m_bufferFeedBack.getSize() <= m_nbChunk) {
		return;
	}
	
	MicTime = m_bufferMicrophone.getReadTimeStamp();
	fbTime = m_bufferFeedBack.getReadTimeStamp();
	
	if (MicTime-fbTime > m_sampleTime) {
		RIVER_ERROR("Can not synchronize flow ... : " << MicTime << " != " << fbTime << "  delta = " << (MicTime-fbTime).count()/1000 << " µs");
		return;
	}
	std::vector<uint8_t> dataMic;
	std::vector<uint8_t> dataFB;
	dataMic.resize(m_nbChunk*sizeof(int16_t)*2, 0);
	dataFB.resize(m_nbChunk*sizeof(int16_t), 0);
	while (true) {
		MicTime = m_bufferMicrophone.getReadTimeStamp();
		fbTime = m_bufferFeedBack.getReadTimeStamp();
		RIVER_INFO(" process 256 samples ... micTime=" << MicTime << " fbTime=" << fbTime << " delta = " << (MicTime-fbTime).count());
		m_bufferMicrophone.read(&dataMic[0], m_nbChunk);
		m_bufferFeedBack.read(&dataFB[0], m_nbChunk);
		RIVER_SAVE_FILE_MACRO(int16_t, "REC_Microphone_sync.raw", &dataMic[0], m_nbChunk*getHarwareFormat().getMap().size());
		RIVER_SAVE_FILE_MACRO(int16_t, "REC_FeedBack_sync.raw", &dataFB[0], m_nbChunk);
		// if threaded : send event / otherwise, process ...
		processAEC(&dataMic[0], &dataFB[0], m_nbChunk, MicTime);
		if (    m_bufferMicrophone.getSize() <= m_nbChunk
		     || m_bufferFeedBack.getSize() <= m_nbChunk) {
			return;
		}
	}
}


void river::io::NodeAEC::processAEC(void* _dataMic, void* _dataFB, uint32_t _nbChunk, const std11::chrono::system_clock::time_point& _time) {
	drain::IOFormatInterface hardwareFormat = getHarwareFormat();
	// TODO : Set all these parameter in the parameter configuration section ...
	int32_t attaqueTime = std::min(std::max(0,m_P_attaqueTime),1000);
	int32_t releaseTime = std::min(std::max(0,m_P_releaseTime),1000);
	int32_t min_gain = 32767 * std::min(std::max(0,m_P_minimumGain),1000) / 1000;
	int32_t threshold = 32767 * std::min(std::max(0,m_P_threshold),1000) / 1000;
	
	int32_t latencyTime = std::min(std::max(0,m_P_latencyTime),1000);
	int32_t nb_sample_latency = (hardwareFormat.getFrequency()/1000)*latencyTime;
	
	int32_t increaseSample = 32767;
	if (attaqueTime != 0) {
		increaseSample = 32767/(hardwareFormat.getFrequency() * attaqueTime / 1000);
	}
	int32_t decreaseSample = 32767;
	if (attaqueTime != 0) {
		decreaseSample = 32767/(hardwareFormat.getFrequency() * releaseTime / 1000);
	}
	// Process section:
	int16_t* dataMic = static_cast<int16_t*>(_dataMic);
	int16_t* dataFB = static_cast<int16_t*>(_dataFB);
	for (size_t iii=0; iii<_nbChunk; ++iii) {
		if (abs(*dataFB++) > threshold) {
			m_sampleCount = 0;
		} else {
			m_sampleCount++;
		}
		if (m_sampleCount > nb_sample_latency) {
			m_gainValue += decreaseSample;
			if (m_gainValue >= 32767) {
				m_gainValue = 32767;
			}
		} else {
			if (m_gainValue <= increaseSample) {
				m_gainValue = 0;
			} else {
				m_gainValue -= increaseSample;
			}
			if (m_gainValue < min_gain) {
				m_gainValue = min_gain;
			}
		}
		for (size_t jjj=0; jjj<hardwareFormat.getMap().size(); ++jjj) {
			*dataMic = static_cast<int16_t>((*dataMic * m_gainValue) >> 15);
			dataMic++;
		}
	}
		RIVER_SAVE_FILE_MACRO(int16_t, "REC_Microphone_clean.raw", _dataMic, _nbChunk*getHarwareFormat().getMap().size());
	// simply send to upper requester...
	newInput(_dataMic, _nbChunk, _time);
}


void river::io::NodeAEC::generateDot(etk::FSNode& _node) {
	_node << "	subgraph clusterNode_" << m_uid << " {\n";
	_node << "		color=blue;\n";
	_node << "		label=\"[" << m_uid << "] IO::Node : " << m_name << "\";\n";
		_node << "			NODE_" << m_uid << "_HW_AEC [ label=\"AEC\\n channelMap=" << etk::to_string(getInterfaceFormat().getMap()) << "\" ];\n";
		std::string nameIn;
		std::string nameOut;
		m_process.generateDot(_node, 3, m_uid, nameIn, nameOut, false);
		_node << "		node [shape=square];\n";
		_node << "			NODE_" << m_uid << "_demuxer [ label=\"DEMUXER\\n format=" << etk::to_string(m_process.getOutputConfig().getFormat()) << "\" ];\n";
		// Link all nodes :
		_node << "			NODE_" << m_uid << "_HW_AEC -> " << nameIn << ";\n";
		_node << "			" << nameOut << " -> NODE_" << m_uid << "_demuxer;\n";
	_node << "	}\n";
	if (m_interfaceMicrophone != nullptr) {
		_node << "	" << m_interfaceMicrophone->getDotNodeName() << " -> NODE_" << m_uid << "_HW_AEC;\n";
	}
	if (m_interfaceFeedBack != nullptr) {
		_node << "	" << m_interfaceFeedBack->getDotNodeName() << " -> NODE_" << m_uid << "_HW_AEC;\n";
	}
	_node << "	\n";
	
	for (size_t iii=0; iii< m_listAvaillable.size(); ++iii) {
		if (m_listAvaillable[iii].expired() == true) {
			continue;
		}
		std11::shared_ptr<river::Interface> element = m_listAvaillable[iii].lock();
		if (element == nullptr) {
			continue;
		}
		bool isLink = false;
		for (size_t jjj=0; jjj<m_list.size(); ++jjj) {
			if (element == m_list[jjj]) {
				isLink = true;
			}
		}
		if (element != nullptr) {
			if (element->getMode() == modeInterface_input) {
				element->generateDot(_node, "NODE_" + etk::to_string(m_uid) + "_demuxer", isLink);
			} else if (element->getMode() == modeInterface_output) {
				element->generateDot(_node, "NODE_" + etk::to_string(m_uid) + "_muxer", isLink);
			} else if (element->getMode() == modeInterface_feedback) {
				element->generateDot(_node, "NODE_" + etk::to_string(m_uid) + "_demuxer", isLink);
			} else {
				
			}
		}
	}
}