Merge branch 'ngscopeclient:master' into stream-browser-dialog-update

Author: fredzo

CMakeLists.txt

@@ -186,6 +186,17 @@ if(NOT SIGCXX_FOUND)
 	message(FATAL_ERROR "Unable to find any version of sigc++; this is required to build ngscopeclient.")
 endif()
 
+# Check if the user has provided a path for nvtx3 (not autodetected currently)
+include(CheckIncludeFileCXX)
+if(NVTX_PATH)
+	check_include_file_cxx("${NVTX_PATH}/include/nvtx3/nvtx3.hpp" NVTX_FOUND)
+	if(NVTX_FOUND)
+		message("-- Found NVIDIA NVTX3: ${NVTX_PATH}")
+		include_directories("${NVTX_PATH}/include")
+		add_compile_definitions(HAVE_NVTX=1)
+	endif()
+endif()
+
 # We still use gtk on Linux for the file browser dialog in "native" mode)
 if(LINUX)
 	pkg_check_modules(GTK QUIET IMPORTED_TARGET REQUIRED gtk+-3.0)

README.md

@@ -1,10 +1,14 @@
-# scopehal-apps
+# ngscopeclient and scopehal-apps
 
-https://www.ngscopeclient.org
+This is the top level repository for ngscopeclient, as well as the unit tests for libscopehal.
 
-Applications for libscopehal
+Project website: [https://www.ngscopeclient.org](https://www.ngscopeclient.org)
 
-[C++ coding policy](https://github.com/azonenberg/coding-policy/blob/master/cpp-coding-policy.md)
+## Policies
+
+* [C++ coding policy](https://github.com/azonenberg/coding-policy/blob/master/cpp-coding-policy.md)
+* [Code of Conduct](https://github.com/ngscopeclient/scopehal-apps/blob/master/CODE_OF_CONDUCT.md)
+* We are a proudly AI-free project. Only human created code is acceptable for contribution.
 
 ## Installation
 

lib

@@ -4,11 +4,26 @@ This is a running list of significant bug fixes and new features since the last
 
 ## New features since v0.1.1
 
-* Filters: Eye pattern is now GPU accelerated for the common case (DDR clock on uniformly sampled input) and runs about 25x faster than before (no github ticket)
-* Filters: CDR PLL is now GPU accelerated for the common case (no gating, deep waveform) and runs about 7.5x faster than before (https://github.com/ngscopeclient/scopehal/issues/977)
+* Core: Changed rate limiting sleep in InstrumentThread loop from 10ms to 1ms to avoid bogging down high performance instruments like the ThunderScope
+* Drivers: ThunderScope now overlaps socket IO and GPU processing of waveforms giving a significant increase in WFM/s rate
+* Filters: Added GPU acceleration for several filters including CDR PLL (7.5x speedup), 100baseTX (2.5x speedup), eye pattern (25x speedup), histogram (12x speedup), TIE (5.3x speedup) and more (https://github.com/ngscopeclient/scopehal/issues/977).
+* Filters: CDR PLL now outputs the input signal sampled by the recovered clock in a second data stream.
+* Filters: Peak detector for FFT etc now does quadratic interpolation for sub-sample peak fitting
 * Filters: Horizontal bathtub curve now works properly with MLT-3 / PAM-3 eyes as well as NRZ. No PAM-4 or higher support yet.
+* Filters: PcapNG export now has an additional mode selector for use with named pipes, allowing live streaming of PcapNG formatted data to WireShark
 * GUI: enabled mouseover BER measurements on MLT-3 / PAM-3 eyes as well as NRZ. No PAM-4 or higher support yet.
 
+## Breaking changes since v0.1.1
+
+We try to maintain compatibility with older versions of ngscopeclient but occasionally we have no choice to change the interface of a block in a way that requires old filter graphs to be updated.
+
+* Many serial protocol filters (currently 100baseTX) no longer take the input signal and recovered clock as separate inputs. Instead, they take the new sampled output from the CDR block. This eliminates redundant sampling and is significantly faster but was not possible to do in a fully backwards compatible fashion.
+
 ## Bugs fixed since v0.1.1
 
+* Filters: PcapNG export did not handle named pipes correctly (no github ticket)
+* Filters: FFT waveforms were shifted one bin to the right of the correct position
+* Filters: Frequency and period measurement had a rounding error during integer-to-floating-point conversion causing half a cycle of the waveform to be dropped under some circumstances leading to an incorrect result, with worse error at low frequencies and short memory depths. This only affected the "summary" output not the trend plot.
+* GUI: Pressing middle mouse on the Y axis to autoscale would fail, setting the full scale range to zero volts, if the waveform was resident in GPU memory and the CPU-side copy of the buffer was stale
+
 ## Other changes since v0.1.1

release-notes/CHANGELOG.md

@@ -2,7 +2,7 @@
 *                                                                                                                      *
 * ngscopeclient                                                                                                        *
 *                                                                                                                      *
-* Copyright (c) 2012-2025 Andrew D. Zonenberg and contributors                                                         *
+* Copyright (c) 2012-2026 Andrew D. Zonenberg and contributors                                                         *
 * All rights reserved.                                                                                                 *
 *                                                                                                                      *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
@@ -43,6 +43,10 @@ void InstrumentThread(InstrumentThreadArgs args)
 {
 	pthread_setname_np_compat("InstrumentThread");
 
+	#ifdef HAVE_NVTX
+		NVTX3_FUNC_RANGE();
+	#endif
+
 	auto inst = args.inst;
 	if(!inst)
 	{
@@ -79,7 +83,7 @@ void InstrumentThread(InstrumentThreadArgs args)
 	while(!*args.shuttingDown)
 	{
 		//Flush any pending commands
-		inst->GetTransport()->FlushCommandQueue();
+		inst->BackgroundProcessing();
 
 		//Scope processing
 		if(scope)
@@ -389,9 +393,9 @@ void InstrumentThread(InstrumentThreadArgs args)
 		//TODO: does this make sense to do in the instrument thread?
 		session->RefreshDirtyFiltersNonblocking();
 
-		//Rate limit to 100 Hz to avoid saturating CPU with polls
+		//Rate limit to 1 kHz to avoid saturating CPU with polls
 		//(this also provides a yield point for the gui thread to get mutex ownership etc)
-		this_thread::sleep_for(chrono::milliseconds(10));
+		this_thread::sleep_for(chrono::milliseconds(1));
 	}
 
 	LogTrace("Shutting down instrument thread\n");

src/ngscopeclient/InstrumentThread.cpp

@@ -80,10 +80,6 @@ DisplayedChannel::DisplayedChannel(StreamDescriptor stream, Session& session)
 	m_rasterizedWaveform.SetCpuAccessHint(AcceleratorBuffer<float>::HINT_LIKELY);
 	m_rasterizedWaveform.SetGpuAccessHint(AcceleratorBuffer<float>::HINT_LIKELY);
 
-	//Use pinned memory for index buffer since it should only be read once
-	m_indexBuffer.SetCpuAccessHint(AcceleratorBuffer<uint32_t>::HINT_LIKELY);
-	m_indexBuffer.SetGpuAccessHint(AcceleratorBuffer<uint32_t>::HINT_UNLIKELY);
-
 	//Create tone map pipeline depending on waveform type
 	switch(m_stream.GetType())
 	{
@@ -111,6 +107,23 @@ DisplayedChannel::DisplayedChannel(StreamDescriptor stream, Session& session)
 			m_toneMapPipe = make_shared<ComputePipeline>(
 				"shaders/WaveformToneMap.spv", 1, sizeof(WaveformToneMapArgs), 1);
 	}
+
+	//If we have native int64 support we can do the index search for sparse waveforms on the GPU
+	if(g_hasShaderInt64)
+	{
+		m_indexSearchComputePipeline = make_shared<ComputePipeline>(
+				"shaders/IndexSearch.spv", 2, sizeof(IndexSearchConstants));
+
+		//Use GPU local memory for index buffer
+		m_indexBuffer.SetCpuAccessHint(AcceleratorBuffer<uint32_t>::HINT_LIKELY);
+		m_indexBuffer.SetGpuAccessHint(AcceleratorBuffer<uint32_t>::HINT_LIKELY);
+	}
+	else
+	{
+		//Use pinned memory for index buffer since it should only be read once
+		m_indexBuffer.SetCpuAccessHint(AcceleratorBuffer<uint32_t>::HINT_LIKELY);
+		m_indexBuffer.SetGpuAccessHint(AcceleratorBuffer<uint32_t>::HINT_UNLIKELY);
+	}
 }
 
 DisplayedChannel::~DisplayedChannel()
@@ -1339,7 +1352,6 @@ ImVec2 WaveformArea::ClosestPointOnLineSegment(ImVec2 lineA, ImVec2 lineB, ImVec
 void WaveformArea::RenderSpectrumPeaks(ImDrawList* list, shared_ptr<DisplayedChannel> channel)
 {
 	auto stream = channel->GetStream();
-	auto data = stream.GetData();
 	auto& peaks = dynamic_cast<PeakDetectionFilter*>(stream.m_channel)->GetPeaks();
 
 	//TODO: add a preference for peak circle color and size?
@@ -1378,9 +1390,8 @@ void WaveformArea::RenderSpectrumPeaks(ImDrawList* list, shared_ptr<DisplayedCha
 	for(auto p : peaks)
 	{
 		//Draw the circle for the peak
-		auto x = (p.m_x * data->m_timescale) + data->m_triggerPhase;
 		list->AddCircle(
-			ImVec2(m_group->XAxisUnitsToXPosition(x), YAxisUnitsToYPosition(p.m_y)),
+			ImVec2(m_group->XAxisUnitsToXPosition(p.m_x), YAxisUnitsToYPosition(p.m_y)),
 			radius,
 			circleColor,
 			0,
@@ -1390,11 +1401,11 @@ void WaveformArea::RenderSpectrumPeaks(ImDrawList* list, shared_ptr<DisplayedCha
 		bool hit = false;
 		for(size_t i=0; i<channel->m_peakLabels.size(); i++)
 		{
-			if( llabs(channel->m_peakLabels[i].m_peakXpos - x) < neighborThresholdXUnits )
+			if( llabs(channel->m_peakLabels[i].m_peakXpos - p.m_x) < neighborThresholdXUnits )
 			{
 				//This peak is close enough we'll call it the same. Update the position.
 				hit = true;
-				channel->m_peakLabels[i].m_peakXpos = x;
+				channel->m_peakLabels[i].m_peakXpos = p.m_x;
 				channel->m_peakLabels[i].m_peakYpos = p.m_y;
 				channel->m_peakLabels[i].m_peakAlpha = 255;
 				channel->m_peakLabels[i].m_fwhm = p.m_fwhm;
@@ -1408,8 +1419,8 @@ void WaveformArea::RenderSpectrumPeaks(ImDrawList* list, shared_ptr<DisplayedCha
 			PeakLabel npeak;
 
 			//Initial X position is just left of the peak
-			npeak.m_labelXpos = x - m_group->PixelsToXAxisUnits(5 * ImGui::GetFontSize());
-			npeak.m_peakXpos = x;
+			npeak.m_labelXpos = p.m_x - m_group->PixelsToXAxisUnits(5 * ImGui::GetFontSize());
+			npeak.m_peakXpos = p.m_x;
 			npeak.m_peakYpos = p.m_y;
 			npeak.m_fwhm = p.m_fwhm;
 
@@ -2108,38 +2119,72 @@ void WaveformArea::RasterizeAnalogOrDigitalWaveform(
 	}
 
 	//Bind input buffers
-	if(uadata)
-		comp->BindBufferNonblocking(1, uadata->m_samples, cmdbuf);
-	if(uddata)
-		comp->BindBufferNonblocking(1, uddata->m_samples, cmdbuf);
 	if(sdata)
 	{
+		//Calculate indexes for X axis
+		auto& ibuf = channel->GetIndexBuffer();
+
+		//FIXME: what still depends on m_offsets CPU side??
+		//If we don't copy this, nothing is drawn
+		sdata->m_offsets.PrepareForCpuAccessNonblocking(cmdbuf);
+
+		//If we have native int64, do this on the GPU
+		if(g_hasShaderInt64)
+		{
+			IndexSearchConstants cfg;
+			cfg.len = data->size();
+			cfg.w = w;
+			cfg.xscale = xscale;
+			cfg.offset_samples = offset_samples;
+
+			const uint32_t threadsPerBlock = 64;
+			const uint32_t numBlocks = (w | (threadsPerBlock - 1)) / threadsPerBlock;
+
+			auto ipipe = channel->GetIndexSearchPipeline();
+			ipipe->BindBufferNonblocking(0, sdata->m_offsets, cmdbuf);
+			ipipe->BindBufferNonblocking(1, ibuf, cmdbuf, true);
+			ipipe->Dispatch(cmdbuf, cfg, numBlocks);
+			ipipe->AddComputeMemoryBarrier(cmdbuf);
+			ibuf.MarkModifiedFromGpu();
+		}
+
+		//otherwise CPU fallback
+		else
+		{
+			ibuf.PrepareForCpuAccess();
+			sdata->m_offsets.PrepareForCpuAccess();
+			for(size_t i=0; i<w; i++)
+			{
+				int64_t target = floor(i / xscale) + offset_samples;
+				ibuf[i] = BinarySearchForGequal(
+					sdata->m_offsets.GetCpuPointer(),
+					data->size(),
+					target);
+
+				if(i < 16)
+					LogDebug("ibuf[%zu] = %d\n", i, ibuf[i]);
+			}
+			ibuf.MarkModifiedFromCpu();
+		}
+
+		//Bind the buffers
 		if(sadata)
 			comp->BindBufferNonblocking(1, sadata->m_samples, cmdbuf);
 		if(sddata)
 			comp->BindBufferNonblocking(1, sddata->m_samples, cmdbuf);
 
 		//Map offsets and, if requested, durations
 		comp->BindBufferNonblocking(2, sdata->m_offsets, cmdbuf);
+		comp->BindBufferNonblocking(3, ibuf, cmdbuf);
 		if(channel->ShouldMapDurations())
 			comp->BindBufferNonblocking(4, sdata->m_durations, cmdbuf);
-
-		//Calculate indexes for X axis
-		auto& ibuf = channel->GetIndexBuffer();
-		ibuf.PrepareForCpuAccess();
-		sdata->m_offsets.PrepareForCpuAccess();
-		for(size_t i=0; i<w; i++)
-		{
-			int64_t target = floor(i / xscale) + offset_samples;
-			ibuf[i] = BinarySearchForGequal(
-				sdata->m_offsets.GetCpuPointer(),
-				data->size(),
-				target);
-		}
-		ibuf.MarkModifiedFromCpu();
-		comp->BindBufferNonblocking(3, ibuf, cmdbuf);
 	}
 
+	if(uadata)
+		comp->BindBufferNonblocking(1, uadata->m_samples, cmdbuf);
+	if(uddata)
+		comp->BindBufferNonblocking(1, uddata->m_samples, cmdbuf);
+
 	//Bind output texture and bail if there's nothing there
 	auto& imgOut = channel->GetRasterizedWaveform();
 	if(imgOut.empty())
@@ -2745,6 +2790,7 @@ void WaveformArea::RenderYAxis(ImVec2 size, map<float, float>& gridmap, float vb
 			for(auto& c : m_displayedChannels)
 			{
 				auto data = c->GetStream().GetData();
+				data->PrepareForCpuAccess();
 				auto sdata = dynamic_cast<SparseAnalogWaveform*>(data);
 				auto udata = dynamic_cast<UniformAnalogWaveform*>(data);
 				if(!sdata && !udata)

src/ngscopeclient/WaveformArea.cpp

@@ -2,7 +2,7 @@
 *                                                                                                                      *
 * ngscopeclient                                                                                                        *
 *                                                                                                                      *
-* Copyright (c) 2012-2025 Andrew D. Zonenberg and contributors                                                         *
+* Copyright (c) 2012-2026 Andrew D. Zonenberg and contributors                                                         *
 * All rights reserved.                                                                                                 *
 *                                                                                                                      *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
@@ -145,10 +145,21 @@ struct ConfigPushConstants
 	float persistScale;
 };
 
+class IndexSearchConstants
+{
+public:
+	int64_t offset_samples;
+	float xscale;
+	uint32_t len;
+	uint32_t w;
+};
+
 /**
 	@brief State for a single peak label
 
 	All positions/sizes are in waveform units, not screen units, so that they scale/move correctly with the waveform
+
+	X axis positions are in base units, not scaled by timebase
  */
 struct PeakLabel
 {
@@ -333,6 +344,9 @@ class DisplayedChannel
 	std::shared_ptr<ComputePipeline> GetToneMapPipeline()
 	{ return m_toneMapPipe; }
 
+	std::shared_ptr<ComputePipeline> GetIndexSearchPipeline()
+	{ return m_indexSearchComputePipeline; }
+
 	bool ZeroHoldFlagSet()
 	{
 		return m_stream.GetFlags() & Stream::STREAM_DO_NOT_INTERPOLATE;
@@ -430,6 +444,9 @@ class DisplayedChannel
 	///@brief Compute pipeline for rendering sparse digital waveforms
 	std::shared_ptr<ComputePipeline> m_sparseDigitalComputePipeline;
 
+	///@brief Compute pipeline for index searching
+	std::shared_ptr<ComputePipeline> m_indexSearchComputePipeline;
+
 	///@brief Y axis position of our button within the view
 	float m_yButtonPos;
 

src/ngscopeclient/WaveformArea.h

@@ -2,7 +2,7 @@
 *                                                                                                                      *
 * ngscopeclient                                                                                                        *
 *                                                                                                                      *
-* Copyright (c) 2012-2024 Andrew D. Zonenberg and contributors                                                         *
+* Copyright (c) 2012-2026 Andrew D. Zonenberg and contributors                                                         *
 * All rights reserved.                                                                                                 *
 *                                                                                                                      *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
@@ -57,6 +57,9 @@ void RenderAllWaveforms(vk::raii::CommandBuffer& cmdbuf, Session* session, share
 void WaveformThread(Session* session, atomic<bool>* shuttingDown)
 {
 	pthread_setname_np_compat("WaveformThread");
+	#ifdef HAVE_NVTX
+		nvtx3::scoped_range range("WaveformThread");
+	#endif
 
 	LogTrace("Starting\n");
 
@@ -125,6 +128,10 @@ void WaveformThread(Session* session, atomic<bool>* shuttingDown)
 		//Wait for data to be available from all scopes
 		if(!session->CheckForPendingWaveforms())
 		{
+			#ifdef HAVE_NVTX
+				nvtx3::scoped_range range2("No data ready");
+			#endif
+
 			this_thread::sleep_for(chrono::milliseconds(1));
 			continue;
 		}
@@ -146,6 +153,10 @@ void WaveformThread(Session* session, atomic<bool>* shuttingDown)
 
 void RenderAllWaveforms(vk::raii::CommandBuffer& cmdbuf, Session* session, shared_ptr<QueueHandle> queue)
 {
+	#ifdef HAVE_NVTX
+		nvtx3::scoped_range range("RenderAllWaveforms");
+	#endif
+
 	double tstart = GetTime();
 
 	//Must lock mutexes in this order to avoid deadlock

src/ngscopeclient/WaveformThread.cpp

@@ -31,6 +31,7 @@ add_compute_shaders(
 	SOURCES
 		ConstellationToneMap.glsl
 		EyeToneMap.glsl
+		IndexSearch.glsl
 		ScopeDeskewUniform4xRate.glsl
 		ScopeDeskewUniformUnequalRate.glsl
 		ScopeDeskewUniformEqualRate.glsl