Skip to content

[docs] descriptive comments of the decoder C++ api #3754

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

Merged
merged 13 commits into from
Aug 16, 2021

Conversation

bjuncek
Copy link
Contributor

@bjuncek bjuncek commented Apr 29, 2021

Adding a more descriptive commenting of parts of the decoder API in an effort to move the documentation forward. No actually code has been changed.

@fmassa
Copy link
Member

fmassa commented May 6, 2021

FYI clang-format is failing

@bjuncek
Copy link
Contributor Author

bjuncek commented Jun 4, 2021

Clang is now passing; @prabhat00155 could you give it a pass for a merge once the rebase checks are done?

@prabhat00155 prabhat00155 self-requested a review June 4, 2021 14:17
// fill it with minimal information about the format (codecs are not opened
// here). Function reads in intformation about the streams from the container
// into inputCtx and then passes it to decoder::openStreams. Finally, if seek is
// specified, it seeks into the correct frame (note, the seek defined here is
Copy link
Contributor

Choose a reason for hiding this comment

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

How do we specify seek here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There is a flag for fast seek implementation within decoder metadata. You can see the implementation (and we should try fbsync it once we're back from vacation here) #3179

@datumbox datumbox merged commit 8e2bd0e into pytorch:master Aug 16, 2021
@github-actions
Copy link

Hey @datumbox!

You merged this PR, but no labels were added.

facebook-github-bot pushed a commit that referenced this pull request Aug 20, 2021
Summary:
* document video_sampler.

* minor docs for decoder.cpp

* descriptive comments for the stream.c

* descriptive comments for decoder.cpp

* per-stream descriptive comments

* Fixing CLANG hopefully

* addressing prabhat's comments

* typo I think

Reviewed By: NicolasHug

Differential Revision: D30417191

fbshipit-source-id: bde05093540de56b65b20900aa252b597768f00d

Co-authored-by: Francisco Massa <[email protected]>
Co-authored-by: Vasilis Vryniotis <[email protected]>
@bjuncek bjuncek deleted the bkorbar/docs/decoder branch August 22, 2021 18:33
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.

5 participants