DecodeSignal: Rework samplerate handling

Before, running an acquisition, then changing the
samplerate and then running the acquisition again
would result in the wrong (i.e. previous) samplerate
to be used for SRD. This patch fixes this.

DecodeSignal: Use signals for new data notification, not session

DecodeSignal: Change srd session handling

Before, we would hold onto the global srd mutex until all data
was processed and then destroy the srd session, making it
necessary to re-create the srd session (and thus run all data
through the PD again) when new data comes in.

This patch changes this so that we keep the srd session around
when we wait for input data, allowing us to re-use the existing
session when new data comes in. Also, this enables us to
release the global srd mutex when waiting, which wasn't
possible before.

Implement logic data muxer thread

Multiple changes in one commit due to complexity:
1) data::decode::Decoder: Make use of the DecodeChannel struct for
channel assigments

2) DecodeSignal: Store DecodeChannel list in vector, not map

3) DecodeSignal: Remove unused get_data()

4) Remove boost::optional usage

5) Use DecodeSignal::segment_ as the container for muxed
logic data

6) Implement the DecodeSignal::logic_mux_proc thread and its
helper method mux_logic_samples()

7) Update DecodeSignal::decode_proc() to interface with the
logic muxer thread

8) Remove no longer needed DecodeSignal::wait_for_data()

SignalBase: Make ConversionBlockSize a class constant

Merge DecoderStack into DecodeSignal

Several changes make up this commit, which unfortunately
can't be separated:

1) Move decoder stack management from DecoderStack to
DecodeSignal, thereby making DecoderStack unnecessary

2) Change the decoder stack from std::list to an
std::vector for direct decoder access

3) Introduce logic_mux_thread which will take care
of muxing the individual SignalBases' logic data into
(cached) logic data that libsigrokdecode expects.
This is necessary as we can no longer do simple bit
mapping within a single logic data segment's logic
data as we now may feed from multiple logic data
segments at once

4) Refactored the creation of decode traces, making
it more streamlined and flexible while simplifying
the class interface

5) Refactored the auto-assignment of channels

6) Refactored is_decode_signal()

7) Reworked decode signal save/restore, allowing
proper handling and with the decoder stack now
being part of the signal, easier save/restore of
the stack and its settings

Rework decode sample count getters

Remove DecodeStack dependency from decode binding wrapper

Move more functionality into DecodeSignal

Rework decode channel auto-assignment

Re-use DecodeTrace::ChannelSelector as DecodeChannel

Shift more methods to DecodeSignal

Introduce DecodeSignal class

For starters, we equip it with some basic wrappers
around the decode stack, rework the annotation signal
a little and use the new DecodeSignal in favor of the
SignalBase class.

Revert 33d5aa61e77e61f700a8 to re-enable A2L conversion

INSTALL: Bump requirement to libsigrokcxx >= 0.6.0.

PulseView now uses APIs that are only available in
libsigrokcxx >= 0.6.0.

Minor Doxygen comment cosmetics.

doc: Update pulseview(1) manpage, add --driver option (-d)

main window: Prefer the user specified device in new sessions

Prefer the device that was found with user provided scan options when a
-d command line option was specified. Stick with the previous selection
of "genuine" devices before demo otherwise (when nothing was found, or
when -d was not specified).

device manager: Add support for -d cmdline option (driver scan options)

The previous implementation had support to auto-detect devices and to
connect to and pick devices by filling in dialogs, optionally providing
scan options that did not apply to auto-detection. This commit extends
the existing support by introducing a -d command line option similar to
sigrok-cli.

In the absence of the -d command line option, behaviour is identical to
the previous implementation. When -d is provided, the specified driver
is excluded from the auto-detection phase, and another scan is executed
afterwards where the user specified scan options take effect. This shall
result in least interaction and highest reliability of device detection,
while flexibility is increased.

Here are examples of what the -d command line option can do:

  $ pulseview -d ols:conn=/dev/ttyACM0
  $ pulseview -d fx2lafw
  $ pulseview -d demo:logic_channels=32:analog_channels=8

This fixes bug #953.

device manager: Move filter for supported devices to the scan routine

Move the check for supported monotonic rate devices from the call site
into the actual scan routine.

The scan routine already used to (store and) return a variable length
set of found devices including none, and call sites can cope with this
situation. Pending extensions may call the scan routine several times,
and callers shall not duplicate the extra test condition. While we
expect the specific test for what's supported to change in the future.

session: Add support for input format options (-I cmdline parameter)

The previous implementation supported the selection of an input format
by means of the -I command line option. This commit extends the feature
by adding support for colon separated input format options similar to
sigrok-cli.

This allows users to open files from the command line which previously
became only available after filling in dialogs, and resulted in errors
in the absence of options. Here is an example of how to use the option:

  $ pulseview -I csv:header:first-channel=2 -i filename.csv

This fixes bug #951.

util: Introduce string tokenize helper routine

Introduce a helper routine which splits a string into tokens that were
separated by a delimiter.

Fix #982 by correcting the bounding rect for the message

CMakeLists.txt: Bump package version to 0.5.0.

0.5.0 will be the next major release. Bump now, so that
there is no confusion of tarball 0.4.0 and 0.5.0-git snapshots.

HACKING: Prefer git pull requests over mailing list patches.

Also, drop the reference to gitorious.org (no longer available).

HACKING: Update URL to Linux kernel coding style.

NEWS: Add list of user-visible changes so far.

View: Prevent header from being resized when view is resized

CMakeLists.txt: Install the PulseView icons.

CMakeLists.txt: Install the AppData/AppStream file.

CMakeLists.txt: Install the desktop file.

Rename sigrok-logo-notext.ico to pulseview.ico.

Rename sigrok-logo-notext.svg to pulseview.svg.

Rename sigrok-logo-notext.png to pulseview.png.

This is more specific and prevents any potential issues e.g. when
multiple distro packages might ship with a generic file like
sigrok-logo-notext.png that's supposed to be installed in the same place.

contrib/sigrok_mimeinfo.xml: Drop, moved to libsigrok.

Adjust trace view namespace

Move trace view files

DeviceManager: Don't perform scans with DMM drivers

View: Improve 2a9fcd621 by using settings_restored_

The timer is no longer needed as the introduction of
settings_restored_ allows us to determine whether we
should resize the trace label header to its proper
width when the show event is received.
This is because the show event is received only after
all widget resizing took place. This means that the
header pane sizes will be reliable at this point,
making this solution much cleaner than relying on
a timer repeatedly calling expand_header_to_fit().

Settings: Add method to set settings defaults

Main(Window): Let the UI and sessions be restored after w.show()

View: Set scroll_needs_defaults_ to true by default

Settings: Refactor out a checkbox creator method

Settings: Only show initial pin config UI elements if enabled

Settings: Add decoder settings page

DecodeTrace: Change initial pin config description from ? to X

Fix #970 by making sure the session state handler can be called

Before, the session did call Session::stop_capture() and fired
the signal to notify of its capture state change. However, the
Session object was deleted before the next run of the Qt event
loop. As the Qt event loop dismisses signals originating from
deleted objects, the connected event handler
MainWindow::on_capture_state_changed() was never called.

To remedy this, we call Session::stop_capture() before the
destruction of the object and force a run of the event loop
immediately afterwards. This way, the event handler is called
and the run/stop button updated properly.

Fix #775 by catching and handling the thrown exception

MainWindow: Don't try to close a session when there is none

View: Introduce settings_restored_

This way, UI elements can decide whether they can change UI
settings or whether they are already using user-set values.

Update man page

Update cli usage hint and remove unnecessary description text

I don't know any cli tool that shows a description text
on the same line as the usage and sigrok-cli doesn't do it
either, so it shouldn't be there.
As I don't see any other place where it would make sense,
I remove it completely.

Replace non-ASCII characters

Fix #862 by implementing -c / --clean

Fix #969 by scheduling another call after a small delay

Drop some trailing whitespace.

Fix sigrok spelling in two places.

permit file names not containing dots on import

Allow users to set initial pin states for decoders.

This uses the new srd_inst_initial_pins_set_all() libsigrokdecode API
which allows frontends to set the assumed initial pins (i.e., the assumed
state of the pins before the first sample of a capture) to user-specified
values.

The assumed initial pins can be either low, or high, or "use same value
as the first sample of the capture".

Installer: Whitespace consistency fixes.

Device: Minor whitespace change

Device: Make capability listing more robust

Installer: Rename Examples.lnk

Installer: Remove examples start menu entry when uninstalling

View: Optimize header pane sizing

Before, the header pane didn't resize to accomodate all signals
when a new session was created and a driver selected (e.g. demo).
To fix this, the header pane autosizing was put in a method of
its own and is now called when new signals are added.

Also, the name of header_fully_visible() needed adjustment
because it also returned true when it *wasn't* 100% visible
due to the margin of error that we permit. It's now called
header_was_shrunk() and its return value logic inverted.

Installer: Add "PulseView" to uninstaller/Zadig links.

Windows 10 merges all links of the same vendor ("sigrok" here) into one
section in the Start menu. If PulseView and sigrok-cli are installed,
there will be two "Uninstall" links and the user will not know which one
uninstalls which program.

Installer: Place set of example .sr files in separate section

Installer: Update icon cache also after uninstallation

Installer: Force icon cache refresh

Fix #964 by adding an option to register the .sr extension with PV

Don't use Q_EMIT, it's not needed anymore

The Q_EMIT macro (just like the regular Qt emit) is syntactic
sugar to let people who read the code know that a method call
placed somewhere is actually a signal.

We don't use Q_EMIT consistently throughout PV and I don't
think it's really needed anyway, so this patch removes the
few remaining instances.

View: Limit header pane width

View: Save/restore splitter state

Remove Header::BaselineOffset and move arrows as needed instead

The baseline offset was used to keep 5px of distance between
the tip of the arrow and the scroll area. This way, the shadow
that is drawn around the arrow when it's selected won't get
cropped.
However, we can do this differently: instead of always keeping
the empty space around, we make the arrows align at the edge
of the widget space as they should and when they're selected,
we push them aside to the left so the shadow can still be
painted without cropping.

Logically, one would assume that the arrow's label also should
be moving left but I decided against it because this way it
looks as if the arrow didn't actually move, keeping all arrow
labels lined up.

Fix #957 and #874 by implementing the pane splitter

Add a MIME info file for sigrok session files.

File template by Stefan Brüns, thanks!

This fixes bug #857.

org.sigrok.PulseView.appdata.xml: Add CC0-1.0 license comment.

org.sigrok.PulseView.appdata.xml: Drop <project_group> tag.

This currently causes issues with e.g. appstream-util validation:

  $ appstream-util validate-relax org.sigrok.PulseView.appdata.xml
  org.sigrok.PulseView.appdata.xml: FAILED:
  • tag-invalid           : <project_group> is not valid
  Validation of files failed

This is considered an appstream/tool bug, but for now we drop the tag in
order it to avoid issues.

https://github.com/hughsie/appstream-glib/issues/140

org.sigrok.PulseView.appdata.xml: Add <suggests> tags.

org.sigrok.PulseView.appdata.xml: Add <mimetype> tag.

org.sigrok.PulseView.appdata.xml: Add <launchable> tag.

desktop file: Add CC0-1.0 license comment.

desktop file: Add additional Development category.

Apparently, e.g. on KDE Plasma, having PulseView only in the Electronics
category (which seems to not necessarily exist) leads to PulseView
showing up in a "Lost&Found" category instead.

We're adding the Development category in addition to Electronics
(e.g. Kicad does the same) to have PulseView in Development if there's
no Electronics category.

desktop file: Add MimeType field.

This fixes bug #858.

desktop file: Rename to org.sigrok.PulseView.desktop.

desktop file: Minor rewording.

Fix #859: Add Appdata definition for PulseView

To be visible in KDE's Discover and GNOME Software,
an appdata definition is required.

Signed-off-by: Stefan Brüns <redacted>

View: Adjust top margin when needed

When the view is big and the traces are vertically centered,
there will be blank space above and below the block of traces.
When the user then resizes the window and makes it smaller,
the white space stays, pushing traces out of the view that
could fit on-screen if the blank space was adjusted properly.

This is what we do with this patch.

If there is still enough space to make everything fit, we
center the traces vertically. If there's not enough space
to make everything fit, we make sure that the top traces
are shown.

TraceView: Improve the way we do the initial scrolling setup

The two commits
ae5f66281c38a76dcb7011907d7a86a99b9dd4dd and
66e4eae9ce743016c3f6d4974bceb9b7fc0ae7d7

Were okay but it showed that there was one case they didn't
cover: the first session receives a resize notification upon
startup whereas all other sessions don't. This means that
sessions restored from a previous run suddenly see the
size_finalized_ variable always staying at false - until the
user resizes the window.

While figuring out how to cover this case, I realized that
there is actually an easier way to perform all this:
instead of keeping an internal state of when and how we
received useless and useful resize notifications, we just
act upon the "show" event, which always comes after all
the widget resizing has been performed. This way, we can
remove the size_finalized_ variable completely and as it
is definitely always received when a session is shown,
we always end up in a sane and correct state.

Note: to reproduce, open up a 2nd session and use demo.
Then, when using the group handle to move the analog traces
upwards, you'll notice that the logic traces will move down
at the same time. This is because size_finalized_ is false
and the view will always center the traces vertically.

Paint sampling points on the actual trace, not the center line

Bump requirements to libsigrok/libsigrokdecode 0.5.0.

We use various new API calls from the upcoming 0.5.0 releases and are
not compatible with the respective 0.4.x anymore.

viewport: Allow smoother zoom using vertical scroll events

The zoom supports 'double' as input type but since delta() and 120 are
integer, this wasn't used and any event with a delta lower than 120 was
ignored.

With this mod, the zoom level changes are _much_ smoother on trackpads

Signed-off-by: Sylvain Munaut <redacted>

AnalogSegment: Speed up processing of interleaved sample data

AnalogSignal: Temporarily disable analog signal conversion

This feature isn't ready yet, so hide it for now.

Fix #958 by using new method that auto-converts analog samples

SignalBase: Always hook into signal data, not just for analog

DeviceManager: Show progress dialog while scanning for devices

We don't want users to wonder why nothing happens when they
start PV and no window shows up. Providing this dialog lets
them know that PV is starting and doing something.

Settings Dialog: Visually break up items in the about listing

Rework signaling mechanism for trace repainting

Before, analog traces would request a repaint of the entire
view when they receive data. To understand how bad this was,
consider 4 enabled analog channels during capture. Every time
one channel would receive a bunch of sample data, it would
force a repaint of the view, resulting in 4 unnecessary
repaints.

To fix this, the analog traces no longer request a repaint
on incoming sample data. Instead, the mechanism now is such
that the view "collates" repaint requests from all used
signalbases by means of a one-shot timer, i.e. any repaint
request is ignored if the timer is already running.

With the timer, we can also establish an upper bound on
how often the trace should update at most, currently 25Hz.

Since this functionality is very useful for any kind of
view, the existing one-shot timer was moved to the ViewBase
and then extended as explained.

AnalogSignal: Only report an extent change when there is one