Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove TensorBuffer::JPEG, DecodedTensor, TensorDecodeCache #6884

Merged
merged 8 commits into from
Jul 15, 2024

Conversation

emilk
Copy link
Member

@emilk emilk commented Jul 14, 2024

⚠️ This breaks any existing JPEG-encoded RRDs

Rust API

  • Removed TensorBuffer::JPEG
  • Removed TensorData::from_jpeg_bytes
  • Deprecated Image::from_file_path and from_file_contents

For all of these, use ImageEncoded instead.

PR train

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!
  • If have noted any breaking changes to the log API in CHANGELOG.md and the migration guide

To run all checks from main, comment on the PR with @rerun-bot full-check.

@emilk emilk added 🦀 Rust API Rust logging API do-not-merge Do not merge this PR labels Jul 14, 2024
Copy link

github-actions bot commented Jul 14, 2024

Deployed docs

Commit Link
4c682ed https://landing-1e4s8nqbd-rerun.vercel.app/docs

@emilk emilk force-pushed the emilk/remove-old-jpeg branch from f992894 to 86547fb Compare July 14, 2024 16:08
@emilk emilk changed the title Remove TensorBuffer::JPEG, DecodedTensor, TensorDecodeCache [4/4] Remove TensorBuffer::JPEG, DecodedTensor, TensorDecodeCache Jul 14, 2024
@Wumpf Wumpf self-requested a review July 15, 2024 08:20
Copy link
Member

@Wumpf Wumpf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looking great!

@@ -393,19 +377,13 @@ pub fn tensor_summary_ui_grid_contents(
| TensorBuffer::F16(_)
| TensorBuffer::F32(_)
| TensorBuffer::F64(_) => {}
TensorBuffer::Jpeg(jpeg_bytes) => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this makes me realize that there's no custom data ui for EncodedImage yet unless I missed a blob of code along the way.
Needs to be put on the todo list!

Edit: Ah this is a much deeper problem obviously. There's no EncodedImage component, so this whole line of work makes us loose the ability to see images in the property view. We may want to come up with something new here short or long term. Worth discussing today or later this week :)
image

emilk added a commit that referenced this pull request Jul 15, 2024
### What
* Part of #6844
* Next PR: #6874
* Next +1: #6883 (where we rename
it to `ImageChromaDownsampled`)
* Next +2: #6884

This is a temporary measure to make room for a new
`archetypes.ImageEncoded` without name collision.
I plan to remove `ImageEncodedHelper` fully before 0.18.

`ImageEncodedHelper` handles both image files (JPEG, PNG, …) and chroma
sub-sampled data (NV12, YUY2).

In the new design, the former will be handled by `ImageEncoded`, but
chroma-subsampled images will be stored directly as `Image`s, with a
special `PixelFormat`.

This means that once 0.18 is done, only users using chroma subsampling
will have to update their code. I'll make sure the new `ImageEncoded`
archetype ctor supports all of the same parameters as the old helper, so
that there are helpful runtime error messages for our users.


### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6882?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6882?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!
* [x] If have noted any breaking changes to the log API in
`CHANGELOG.md` and the migration guide

- [PR Build Summary](https://build.rerun.io/pr/6882)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.
emilk added a commit that referenced this pull request Jul 15, 2024
)

### What
* Part of #6844
* Part of #3803

Has `do-no-merge` because of current merge-target.

### PR train
* Prev: #6882
* Next: #6883
* Next: #6884

### Coming in follow-up PRs:
* Fix image picking, hovering, and visualization in spatial view
* Switch to using `ImageEncoded` in all examples
* Remove old code for storing JPEGs in tensors

### Fixes
* Fixes #6520 

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6874?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6874?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!
* [x] If have noted any breaking changes to the log API in
`CHANGELOG.md` and the migration guide

- [PR Build Summary](https://build.rerun.io/pr/6874)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.

---------

Co-authored-by: Andreas Reich <andreas@rerun.io>
@emilk emilk force-pushed the emilk/use-image-encoded branch from 209e0d2 to b54fbbd Compare July 15, 2024 10:11
emilk added a commit that referenced this pull request Jul 15, 2024
### What
* Part of #6844
* Closes #3803

This switches us to use the new `archetype.ImageEncoded` in all
examples.

Logging chroma-downsampled images (NV12/YUY2) is now done with the new
`ImageChromaDownsampled` helper (which will probably go away before
0.18).

### PR train
* Prev: #6882
* Prev: #6874
* Next: #6884

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [ ] I have tested the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6883?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6883?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!
* [x] If have noted any breaking changes to the log API in
`CHANGELOG.md` and the migration guide

- [PR Build Summary](https://build.rerun.io/pr/6883)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.
Base automatically changed from emilk/use-image-encoded to main July 15, 2024 10:12
An error occurred while trying to automatically change base from emilk/use-image-encoded to main July 15, 2024 10:12
@emilk emilk force-pushed the emilk/remove-old-jpeg branch from be70c25 to 7a7eb05 Compare July 15, 2024 10:13
@emilk emilk removed the do-not-merge Do not merge this PR label Jul 15, 2024
@rerun-io rerun-io deleted a comment from github-actions bot Jul 15, 2024
@emilk
Copy link
Member Author

emilk commented Jul 15, 2024

@rerun-bot full-check

Copy link

@emilk emilk merged commit 8124967 into main Jul 15, 2024
73 checks passed
@emilk emilk deleted the emilk/remove-old-jpeg branch July 15, 2024 11:09
@teh-cmc teh-cmc changed the title [4/4] Remove TensorBuffer::JPEG, DecodedTensor, TensorDecodeCache Remove TensorBuffer::JPEG, DecodedTensor, TensorDecodeCache Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace TensorBuffer::JPEG with ImageEncoded archetype
2 participants