Dev branch rebase ( freeze feat, etc ) #90

Shinyzenith · 2024-02-28T08:29:54Z

TODO:

Integrate waysip
Investigate surface scaling issue
Document all changes

…egion

* Renames `clap.rs` to `cli.rs` because otherwise there's confusion between the `clap` crate and local module. * `Cli` struct added that almost identically represents the current state of the CLI with no logical changes. --- ## `--help` Comparison Before: https://gist.github.com/AndreasBackx/5945b366e989159f4669e7ba30c13239 After: https://gist.github.com/AndreasBackx/8929c8bde080eac0cafd33128210b0cc Diff (ignoring whitespace changes due to table alignment): ```diff 1c1 < Screenshot tool for compositors implementing zwlr_screencopy_v1. --- > Screenshot tool for wlroots based compositors implementing the zwlr_screencopy_v1 protocol. 9d8 < -c, --cursor Enable cursor in screenshots 10a10 > -c, --cursor Enable cursor in screenshots 12c12 < -l, --listoutputs List all valid outputs --- > -l, --list-outputs List all valid outputs 14c14 < --chooseoutput Present a fuzzy selector for outputs --- > --choose-output Present a fuzzy selector for outputs 16a17 > ``` You can see that the only changes are: - About is longer, this is now using the value from Cargo.toml instead of a duplicate text that was shorter. - Some have a dash where the English words would have a space, e.g: "list-outputs" instead of "listoutputs". I've also made the old still work via an alias: https://gist.github.com/AndreasBackx/6025e91844e3d766d4264a01ae4d1a71 This seems like a tiny improvement? I plan to make further changes later, but I want to keep PRs separate.

This "improves" (and that is subjective) the design of the CLI. I am aiming to get some feedback on what people think of the new design: ``` Screenshot tool for wlroots based compositors implementing the zwlr_screencopy_v1 protocol. Usage: wayshot [OPTIONS] [OUTPUT] Arguments: [OUTPUT] Where to save the screenshot, "-" for stdout. Defaults to "$UNIX_TIMESTAMP-wayshot.$EXTENSION" Options: --log-level <LOG_LEVEL> Log level to be used for printing to stderr [default: info] [possible values: trace, debug, info, warn, error] -s, --slurp <SLURP_ARGS> Arguments to call slurp with for selecting a region -c, --cursor Enable cursor in screenshots --encoding <FILE_EXTENSION> Set image encoder, if output file contains an extension, that will be used instead [default: png] [aliases: extension, format, output-format] Possible values: - jpg: JPG/JPEG encoder - png: PNG encoder - ppm: PPM encoder - qoi: Qut encoder -l, --list-outputs List all valid outputs -o, --output <OUTPUT> Choose a particular output/display to screenshot --choose-output Present a fuzzy selector for output/display selection -h, --help Print help (see a summary with '-h') -V, --version Print version ``` The main changes are: 1. `--debug` is now `--log-level` because this makes it easy to select more specifically what log level to use. I considered using `-v`, `-vv`... to increase verbosity but the `clap-verbosity-crate` uses `log` and not `tracing`. We could use it somewhat, but we'd pull in `log` (which seems fine) and we'd need to map from `log`'s Level to `tracing`'s Level enums (they use inverse ordering). 2. `--stdout` and `--file` has been made an optional positional argument. This because it's what other CLIs often do and I wasn't sure what to call the option otherwise because `--output` and `-O`/`-o` is often what others use but we use it here to refer to displays/monitors/Wayland outputs. This avoids that confusion hopefully and I've also clarified this in the documentation. * Additionally if a path is given, its extension will always be used. So you cannot save `jpg` to `foo.png`. Perhaps this behaviour can be changed, though I don't see a reason to support this weird edge case? When is someone saving `png` to `jpg`? 3. `--extension` is `--encoding` with aliases like `extension`. Again, let me know what you think.

Let's bubble up errors instead of panicking and also not use `exit(...)` because it does not call destructors which might give issues.

We use different structs/fields to store the same three types of data everywhere: - Position (x,y) - Size (width,height) - Region(position, size) This makes it so they all reuse the same information.

Introduce freeze feature

Shinyzenith · 2024-02-28T08:30:34Z

CC: @Decodetalkers I am returning back to my workstation in the next 3 days, can we work on the waysip integration together? Since you know more about the waysip internals I thought I'll ping you in the thread.

Decodetalkers · 2024-02-28T09:32:49Z

ok , I will be free these days

Shinyzenith · 2024-03-13T16:22:46Z

TODO: All CLI changes need to be documented along with the libwayshot changes

* feat(clipboard): implement clipboard integration Add the --clipboard flag and implement functionality to make image available on the clipboard using wl-clipboard-rs. * style(format): apply code formatting to cli.rs * feat(clipboard): implement fork wait for clipboard Add functionality offering image on clipboard persistently in the background * feat(clipboard): inform user about wayshot persisting in background with --clipboard * feat(clipboard): use tracing::warn instead of print if fork fails * feat(clipboard): Switch from the fork crate to the nix crate for daemonization * style(format): code formatting to wayshot.rs * style(typo): corrected a typo in the comments

Signed-off-by: Shinyzenith <[email protected]>

* feat: added time_stamp flag * Syntax Refactor and filename format fixed * file name format fixes * wayshot-{timestamp}.{extension} as default filename * chore: Update Cargo.lock Signed-off-by: Shinyzenith <[email protected]> --------- Signed-off-by: Shinyzenith <[email protected]> Authored-by: rachancheet <[email protected]> Co-authored-by: Shinyzenith <[email protected]>

Signed-off-by: Shinyzenith <[email protected]>

Signed-off-by: Shinyzenith <[email protected]> --------- Signed-off-by: Shinyzenith <[email protected]> Co-authored-by: Shinyzenith <[email protected]>

* refactor: remove unnecessary to_string() * refactor: fix clippy warnings * refactor: remove 1 level of indirection via &Vec<T> -> &[T] Typically `&Vec<T>` isn't something you want when you need a read-only view over a Vec, because it adds another level of indirection: Vec already stores a pointer to heap-allocated buffer internally. Using slices `&[T]` removes such unnecessary level of indirection and is considered a cleaner design. It is cache friendlier and can be better optimized by the compiler (not that it should matter in this case).

Signed-off-by: Shinyzenith <[email protected]> --------- Signed-off-by: Shinyzenith <[email protected]> Authored-by: rachancheet <[email protected]> Co-authored-by: Shinyzenith <[email protected]>

* feat(clipboard): fix issue #106 clipboard flag ignored if path is qualified to file * feat(clipboard): clarify flag description of --clipboard * feat(clipboard): enable multiline comment description for --clipboard feature flag Signed-off-by: Shinyzenith <[email protected]> * feat(clipboard): reduce buffer allocations for encoding image * feat(clipboard): improve code quality * feat(clipboard): code style change: perform match inside function call --------- Signed-off-by: Shinyzenith <[email protected]> Co-authored-by: Shinyzenith <[email protected]>

…#109 (#110) * feat(clipboard): fix interaction with freeze and select feature: Issue #109 * feat(clipboard): handle callback fails

Shinyzenith · 2024-04-06T19:26:58Z

I think it's time to merge this rebase after the cleanups mentioned in the first comment. I'd like to merge #104 into main instead of here.

Shinyzenith · 2024-04-06T19:27:13Z

We can address scale later once we figure out an ideal way of hinting the surface scale.

* [fix] unmap layer shell surfaces before destroying them

* [docs] update manpage (1) with changes in freeze-feat * [fix] make arguments to slurp optional * [docs] update manpage(7) with cli changes * [docs] update README with new cli

* [feat] rough MVP for screencpy+dmabuf * [feat] refactor MVP into libwayshot - create new constructor * [refactor] first draft of dmabuf API * [refactor] - Add error handling - Add example/demo for wayshot dmabuf API * [feat] import wayland-egl-ctx for use as MVP for dmabuf import functionality * [fix] correct modifier_lo parameter in waymirror-egl MVP * [feat] get waymirror-egl dmabuf MVP demo working * [feat] refactored dmabuf->eglImage API into libwayshot * [feat] - Implemented clean dropping of EGLImage - Improved API docs for dmabuf functions * [fix] libwayshot build error fixed * [fix] remove hardcoded GPU path from libwayshot constructor * [fix]] remove reduntant dmabuf_to_texture call from waymirror-egl * [docs] document WayshotConnection dmabuf constructor * [feat] Added helper/wrapper function to convert screencapture EGLImages into GL textures * [fix] improved logging in dmabuf API code * [doc] update waymirror-egl Readme * [fix] change logging level in waymirror-egl to Debug * [fix] remove unnecessary .gitignore in waymirror-egl * [ci/cd] attempting to fix the build * [ci\cd] add libegl system deps to fix github CI * [fix] remove unused egl_image struct field in Waymirror demo

* fix: I find out a smart way to fix scale problem * Update libwayshot/src/lib.rs Co-authored-by: Aakash Sen Sharma <[email protected]> --------- Co-authored-by: Aakash Sen Sharma <[email protected]>

Shinyzenith · 2024-10-10T08:59:23Z

@Decodetalkers should we merge?

Decodetalkers · 2024-10-10T09:01:16Z

I think it is ok

Decodetalkers and others added 8 commits February 2, 2024 19:18

Refactor: introduce FrameGuard, ScreenCapturer, and Logical/EmbeddedR…

68a5c6a

…egion

Add freeze functionality

a023ff1

Remove explicit panics and exits

7d6e20b

Let's bubble up errors instead of panicking and also not use `exit(...)` because it does not call destructors which might give issues.

Make region, sizing, and positioning data structs reusable

044910d

We use different structs/fields to store the same three types of data everywhere: - Position (x,y) - Size (width,height) - Region(position, size) This makes it so they all reuse the same information.

feat: Merge pull request #78

f2aa2b6

Introduce freeze feature

First version of scaling fix. (#85)

8f22e6d

Shinyzenith changed the title ~~Freeze Feat Rebase~~ Dev branch rebase ( freeze feat, etc ) Feb 28, 2024

shivkr6 and others added 13 commits March 23, 2024 19:37

chore: remove useless roundtrip (#105)

9e7919e

docs(ManPage): Fix capitalization issue

e43ab9f

Signed-off-by: Shinyzenith <[email protected]>

docs: Document clipboard interaction

440bd26

Signed-off-by: Shinyzenith <[email protected]>

chore: Update Cargo.lock

f7f134f

Signed-off-by: Shinyzenith <[email protected]>

chore: Update Cargo.lock

d7200c7

Signed-off-by: Shinyzenith <[email protected]>

feat: Add support for webp (#98)

017be62

Signed-off-by: Shinyzenith <[email protected]> --------- Signed-off-by: Shinyzenith <[email protected]> Co-authored-by: Shinyzenith <[email protected]>

feat: account for directories in file path (#96)

2afa5b0

Signed-off-by: Shinyzenith <[email protected]> --------- Signed-off-by: Shinyzenith <[email protected]> Authored-by: rachancheet <[email protected]> Co-authored-by: Shinyzenith <[email protected]>

chore: make clippy happy (#111)

2cb242c

feat(clipboard): fix interaction with freeze and select feature: Issue …

10b748f

…#109 (#110) * feat(clipboard): fix interaction with freeze and select feature: Issue #109 * feat(clipboard): handle callback fails

Shinyzenith linked an issue May 27, 2024 that may be closed by this pull request

libwayshot outputting garbage on other monitors #118

Open

CheerfulPianissimo and others added 2 commits May 29, 2024 03:14

Destroy layer shell surfaces

2dd8af6

* [fix] unmap layer shell surfaces before destroying them

Implement missing conversion from string to webp enum (#121)

7934fd2

Gigas002 and others added 4 commits June 18, 2024 15:06

Replace nix with rustix (#120)

1c3c802

Update documentation with changes in freeze-feat (#116)

5c3e220

* [docs] update manpage (1) with changes in freeze-feat * [fix] make arguments to slurp optional * [docs] update manpage(7) with cli changes * [docs] update README with new cli

fix: I find out a smart way to fix scale problem (#128)

b52532a

* fix: I find out a smart way to fix scale problem * Update libwayshot/src/lib.rs Co-authored-by: Aakash Sen Sharma <[email protected]> --------- Co-authored-by: Aakash Sen Sharma <[email protected]>

Decodetalkers approved these changes Oct 10, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dev branch rebase ( freeze feat, etc ) #90

Dev branch rebase ( freeze feat, etc ) #90

Shinyzenith commented Feb 28, 2024 •

edited

Loading

Shinyzenith commented Feb 28, 2024

Decodetalkers commented Feb 28, 2024

Shinyzenith commented Mar 13, 2024

Shinyzenith commented Apr 6, 2024

Shinyzenith commented Apr 6, 2024 •

edited

Loading

Shinyzenith commented Oct 10, 2024

Decodetalkers commented Oct 10, 2024

Dev branch rebase ( freeze feat, etc ) #90

Are you sure you want to change the base?

Dev branch rebase ( freeze feat, etc ) #90

Conversation

Shinyzenith commented Feb 28, 2024 • edited Loading

Shinyzenith commented Feb 28, 2024

Decodetalkers commented Feb 28, 2024

Shinyzenith commented Mar 13, 2024

Shinyzenith commented Apr 6, 2024

Shinyzenith commented Apr 6, 2024 • edited Loading

Shinyzenith commented Oct 10, 2024

Decodetalkers commented Oct 10, 2024

Shinyzenith commented Feb 28, 2024 •

edited

Loading

Shinyzenith commented Apr 6, 2024 •

edited

Loading