Fix animation framerate #1683

Lomadriel · 2019-03-09T06:07:25Z

As it may be seen in the code, the animation need to be synchronized with the thread that calls the broadcast function in order to keep a stable framerate.
To synchronize the thread and the animation, I moved the "animation update" in the subthread method.
Although this fix the bug, I don't like to move the "animation update" responsibility to another class. The modules should not have to update the animation. Moreover it could be easy to forget the call to increment that updates the animation. (when the code is refactored or simply when a new module will need this class).

This is why I also implemented a version with an animation_manager, but since this is a big refactor, I put this version in another branch.
=> https://github.com/Lomadriel/polybar/tree/refactor/animation
This commit (Lomadriel@1dc8949) is the diff between this PR and the branch refactor/animation

In this version a module only store an animation_manager, that manages the animations. Once launched the animation_manager will process as follow:

Call a functor to let the module choose the current animation.
Sleep if no animation has been chosen.
Otherwise, increments the animation
Call a callback to let the module do whatever needs to be done (mostly call broadcast)
Sleep until the remaining time between two steps of the animation is passed.

As it really changes the way animations work, I let you choose which version you want.

TEAM EDIT: Closes #1213

Lomadriel · 2019-04-05T01:38:27Z

I fixed a bug and replaced system_clock by steady_clock

patrick96

Good job! Animations are much smoother now :D

Although this fix the bug, I don't like to move the "animation update" responsibility to another class. The modules should not have to update the animation. Moreover it could be easy to forget the call to increment that updates the animation. (when the code is refactored or simply when a new module will need this class).

I completely agree. I also had the thought while reviewing that all these animation subthreads do the exact same thing, so why not generalize it.

I think we should first merge this PR to fix the bug and then you can submit the animation manager as a PR. There is a merge conflict, so you need to fix that first before I can merge this.

I have quickly skimmed through the animation manager code. Couldn't we have each animation manage its own subthread, so there wouldn't even be a need to have an extra animation manager class?

Lomadriel · 2020-01-23T19:41:06Z

Conflict fixed

codecov · 2020-01-23T19:51:20Z

Codecov Report

Merging #1683 into master will decrease coverage by <.01%.
The diff coverage is 0%.

@@            Coverage Diff            @@
##           master   #1683      +/-   ##
=========================================
- Coverage    9.22%   9.21%   -0.01%     
=========================================
  Files         180     180              
  Lines       10921   10923       +2     
=========================================
  Hits         1007    1007              
- Misses       9914    9916       +2

Flag	Coverage Δ
#unittests	`9.21% <0%> (-0.01%)`	⬇️

Impacted Files	Coverage Δ
src/modules/battery.cpp	`0% <0%> (ø)`	⬆️
src/modules/network.cpp	`0% <0%> (ø)`	⬆️
include/drawtypes/animation.hpp	`0% <0%> (ø)`	⬆️
src/drawtypes/animation.cpp	`0% <0%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4ef2bd5...0530056. Read the comment docs.

patrick96 · 2020-01-23T22:46:09Z

Thanks a lot 🚀

PR polybar#1683 downgraded the xpp submodule

PR #1683 downgraded the xpp submodule

Breaking Changes: * The new config parser imposes some restrictions on which characters can be used in section and key names. Users shouldn't be affected by this unless they use one of the following characters in any section or key name: `"'=;#[](){}:.$\%` Please consult [`man 5 polybar`](https://polybar.readthedocs.io/en/latest/man/polybar.5.html) for a full reference of the new config rules. * `internal/temperature`: The first and last ramp element are now only used for `base-temperature` and below and `warn-temperature` and above respectively. This only slightly changes the ranges for which the different ramp levels are responsible for. (#2197) Changelog **Deprecations** * `[settings]`: `throttle-input-for` has been removed. It wasn't a useful option and could cause certain actions (e.g. click commands) to be ignored. (#2117) * All action names used by modules to handle click and scroll events are depercated (#1907). This change mainly affects users of the menu module. Please read the [documentation](https://polybar.readthedocs.io/en/latest/user/actions.html) for instructions on how to migrate. **New Config Options** The `include-directory` key can be used the same as `include-file` and includes all regular files in the given directory. In labels: * `label-NAME-minlen`, `label-NAME-alignment` can be used to pad labels with spaces to the right (alignment set to `left`), left (alignment set to `right`), and both sides (alignment set to `center`). In `internal/backlight`: * `enable-scroll` enables changing the brightness through scrolling. In `internal/github`: * `format-offline` is used when the module cannot connect to the server. * `label-offline` can be used in `format-offline`. * `api-url` can be used to connect to a custom github enterprise instance In `internal/pulseaudio`: * `click-right` and `click-middle` can be used to execute commands when right/middle clicking. * `%decibels%` token can be used in `label-volume` and `label-muted` to show the volume in decibels. **Changes To The Build System** * Allow users to specify python executable when building. (polybar/xpp#27, #2125) * The i3ipcpp submodule no longer rebuilds jsoncpp and just uses whatever version is available. (#2015, polybar/i3ipcpp#9) **Features** * New commandline argument: `-M` / `--list-all-monitors`. Will display all available monitors (even cloned ones). * New log level: `notice`. Used as the default and is used for non-warning messages the user should nevertheless be aware of. (#2027) * config: * New config parser (#1377) * `include-directory` key (#2196), see #1946 * Add error message when an entire section is missing. (#2195) * `-minlen` and `-alignment` properties for labels. (#1546) * Make the `seperator` key in the bar section a label. (#1918) * Better color validation. (#1290) * timer modules: Schedule module updates to be aligned with the update interval. For example, the date module now updates on the minute instead of in the middle of a minute if the interval is set to 60 seconds. (#2123), see #2064 * `custom/menu`: Multiple menu modules per bar (#1907) * `internal/backlight`: Support for changing the brightness through scrolling. This may require additional changes to the system running polybar. (#1957) * `internal/github`: * `format-offline` for when the module cannot connect to the server (#1825), see #1815 * Support for github enterprise instances. (#1841), see #1812 * `internal/network`: Support `Gbit/s` for `%linkspeed%` token. (#2055) * `internal/pulseaudio`: * `click-right` and `click-middle` keys (#1941) * `%decibels%` token (#1894), see #1886 * `internal/xworkspaces`: Proper implementation for `label-occupied`. (#822), see #874, #1444, #1033 **Fixes** * Polybar not executing commands that produce output. (#1680), see #916 * Polybar froze until click commands finished executing (#2248) * Polybar not properly working with mirrored monitors. (#1823), see #1192 and #1794 * Unstable animation framerate (#1683), see #568 * Multiple modules of the same type caused click events not to be delivered to the rigth one (#1907), see #1172 * config: * Seemingly unrelated error messages when BOM character appears in config. (#2166), see #2075 * Fall back to next possible config location if config file doesn't exist (except if `--config` was used). (#2026), see #2016 * iconset: `fuzzy-match` chose first match, even if exact match was available. (#2042), see #2041 * `custom/menu`: Spacing issue (#1656) * `internal/alsa`: Volume didn't go over 100% (#2184), see #2173 * `internal/backlight`: Use amdgpu workaround for all devices starting with `amdgpu_bl`. (#2122) * `internal/battery`: Battery not marked as full if over `full-at` percent. (#2019), see #1622 * `internal/cpu`: More accurate cpu load calculation. (#1955) * `internal/github`: Outdated GitHub API authentication. (#2029), see #2002 * `internal/memory`: Use the correct size prefixes (#2211), see #2023 * `internal/network`: * Wrong up- and downspeed values for non-integer intervals. (#2219) * tun/tap interfaces didn't query their IP addresses. (#1990), see #1986 * Don't crash module if linkspeed cannot be queried. (#1772), see #1211 * `internal/temperature`: * `format-warn` was not used if the temperature was *exactly* `warn-temperature`. (#1897) * `internal/xworkspaces`: * Multi-monitor issue (#1929), see #1764, #1849 * Module sometimes showed too many workspaces (#1984), see #1983 * build: * xpp submodule doesn't work with python 3.9 (polybar/xpp#26) * CMake 3.17+ developer warnings (#2089, polybar/xpp#24, polybar/xpp#25) * gtest compilation failure (#1993), see google/googletest#2678 * Compilation issue in GCC 6. (#1953)

Breaking Changes: * The new config parser imposes some restrictions on which characters can be used in section and key names. Users shouldn't be affected by, this unless they use one of the following characters in any section or key name: `"'=;#[](){}:.$\%` Please consult [`man 5 polybar`](https://polybar.readthedocs.io/en/latest/man/polybar.5.html) for a full reference of the new config rules. * `internal/temperature`: The first and last ramp element are now only used for `base-temperature` and below and `warn-temperature` and above respectively. This only slightly changes the ranges for which the different ramp levels are responsible for. (#2197) Changelog **Deprecations** * `[settings]`: `throttle-input-for` has been removed. It wasn't a useful option and could cause certain actions (e.g. click commands) to be ignored. (#2117) * All action names used by modules to handle click and scroll events are deprecated (#1907). This change mainly affects users of the menu module. Please read the [documentation](https://polybar.readthedocs.io/en/latest/user/actions.html) for instructions on how to migrate. **New Config Options** The `include-directory` key can be used the same as `include-file` and includes all regular files in the given directory. In labels: * `label-NAME-minlen`, `label-NAME-alignment` can be used to pad labels with spaces to the right (alignment set to `left`), left (alignment set to `right`), and both sides (alignment set to `center`). In `internal/backlight`: * `enable-scroll` enables changing the brightness through scrolling. In `internal/github`: * `format-offline` is used when the module cannot connect to the server. * `label-offline` can be used in `format-offline`. * `api-url` can be used to connect to a custom github enterprise instance In `internal/pulseaudio`: * `click-right` and `click-middle` can be used to execute commands when right/middle clicking. * `%decibels%` token can be used in `label-volume` and `label-muted` to show the volume in decibels. **Changes To The Build System** * Allow users to specify python executable when building. (polybar/xpp#27, #2125) * The i3ipcpp submodule no longer rebuilds jsoncpp and just uses whatever version is available. (#2015, polybar/i3ipcpp#9) **Features** * New commandline argument: `-M` / `--list-all-monitors`. Will display all available monitors (even cloned ones). * New log level: `notice`. Used as the default and is used for non-warning messages the user should nevertheless be aware of. (#2027) * config: * New config parser (#1377) * `include-directory` key (#2196), see #1946 * Add error message when an entire section is missing. (#2195) * `-minlen` and `-alignment` properties for labels. (#1546) * Make the `seperator` key in the bar section a label. (#1918) * Better color validation. (#1290) * timer modules: Schedule module updates to be aligned with the update interval. For example, the date module now updates on the minute instead of in the middle of a minute if the interval is set to 60 seconds. (#2123), see #2064 * `custom/menu`: Multiple menu modules per bar (#1907) * `internal/backlight`: Support for changing the brightness through scrolling. This may require additional changes to the system running polybar. (#1957) * `internal/github`: * `format-offline` for when the module cannot connect to the server (#1825), see #1815 * Support for github enterprise instances. (#1841), see #1812 * `internal/network`: Support `Gbit/s` for `%linkspeed%` token. (#2055) * `internal/pulseaudio`: * `click-right` and `click-middle` keys (#1941) * `%decibels%` token (#1894), see #1886 * `internal/xworkspaces`: Proper implementation for `label-occupied`. (#822), see #874, #1444, #1033 **Fixes** * Polybar not executing commands that produce output. (#1680), see #916 * Polybar froze until click commands finished executing (#2248) * Polybar not properly working with mirrored monitors. (#1823), see #1192 and #1794 * Unstable animation framerate (#1683), see #568 * Multiple modules of the same type caused click events not to be delivered to the rigth one (#1907), see #1172 * config: * Seemingly unrelated error messages when BOM character appears in config. (#2166), see #2075 * Fall back to next possible config location if config file doesn't exist (except if `--config` was used). (#2026), see #2016 * iconset: `fuzzy-match` chose first match, even if exact match was available. (#2042), see #2041 * `custom/menu`: Spacing issue (#1656) * `internal/alsa`: Volume didn't go over 100% (#2184), see #2173 * `internal/backlight`: Use amdgpu workaround for all devices starting with `amdgpu_bl`. (#2122) * `internal/battery`: Battery not marked as full if over `full-at` percent. (#2019), see #1622 * `internal/cpu`: More accurate cpu load calculation. (#1955) * `internal/github`: Outdated GitHub API authentication. (#2029), see #2002 * `internal/memory`: Use the correct size prefixes (#2211), see #2023 * `internal/network`: * Wrong up- and downspeed values for non-integer intervals. (#2219) * tun/tap interfaces didn't query their IP addresses. (#1990), see #1986 * Don't crash module if linkspeed cannot be queried. (#1772), see #1211 * `internal/temperature`: * `format-warn` was not used if the temperature was *exactly* `warn-temperature`. (#1897) * `internal/xworkspaces`: * Multi-monitor issue (#1929), see #1764, #1849 * Module sometimes showed too many workspaces (#1984), see #1983 * build: * xpp submodule doesn't work with python 3.9 (polybar/xpp#26) * CMake 3.17+ developer warnings (#2089, polybar/xpp#24, polybar/xpp#25) * gtest compilation failure (#1993), see google/googletest#2678 * Compilation issue in GCC 6. (#1953)

Lomadriel force-pushed the issues/568 branch from 4b1f531 to b7582ac Compare April 5, 2019 01:36

Lomadriel force-pushed the issues/568 branch 2 times, most recently from 553ac17 to d0a10f5 Compare April 5, 2019 02:03

Lomadriel force-pushed the issues/568 branch from d0a10f5 to a288e69 Compare April 19, 2019 19:37

Lomadriel added the bug label Jul 28, 2019

Lomadriel mentioned this pull request Jan 21, 2020

refactor(battery): simplify animation subthread #1213

Closed

patrick96 requested changes Jan 23, 2020

View reviewed changes

Christoph Schiessl and others added 3 commits January 23, 2020 20:40

refactor(battery): simplify animation subthread

46ff241

fix(battery): animation framerate

45b7136

use steady clock instead of system clock

0530056

Lomadriel force-pushed the issues/568 branch from a288e69 to 0530056 Compare January 23, 2020 19:40

polybar deleted a comment from codecov bot Jan 23, 2020

Lomadriel requested a review from patrick96 January 23, 2020 19:40

patrick96 approved these changes Jan 23, 2020

View reviewed changes

patrick96 merged commit 982a22c into polybar:master Jan 23, 2020

patrick96 added a commit to patrick96/polybar that referenced this pull request Jan 31, 2020

build: Update xpp submodule

fdf9ba0

PR polybar#1683 downgraded the xpp submodule

patrick96 mentioned this pull request Jan 31, 2020

build: Update xpp submodule #2001

Merged

patrick96 added a commit that referenced this pull request Jan 31, 2020

build: Update xpp submodule

8d07f2a

PR #1683 downgraded the xpp submodule

patrick96 mentioned this pull request Nov 29, 2020

Release 3.5.0 #2253

Merged

28 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Fix animation framerate #1683

Fix animation framerate #1683

Uh oh!

Lomadriel commented Mar 9, 2019 •

edited by patrick96

Loading

Uh oh!

Lomadriel commented Apr 5, 2019

Uh oh!

patrick96 left a comment

Uh oh!

Lomadriel commented Jan 23, 2020

Uh oh!

codecov bot commented Jan 23, 2020

Uh oh!

patrick96 commented Jan 23, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Fix animation framerate #1683

Fix animation framerate #1683

Uh oh!

Conversation

Lomadriel commented Mar 9, 2019 • edited by patrick96 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Lomadriel commented Apr 5, 2019

Uh oh!

patrick96 left a comment

Choose a reason for hiding this comment

Uh oh!

Lomadriel commented Jan 23, 2020

Uh oh!

codecov bot commented Jan 23, 2020

Codecov Report

Uh oh!

patrick96 commented Jan 23, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Lomadriel commented Mar 9, 2019 •

edited by patrick96

Loading