Skip to content

Users/rrawther/rocdecode: Update api comments for rocdecDecode sample - #6076

Merged
rrawther merged 6 commits into
developfrom
users/rrawther/rocdecode-update-doc
May 13, 2026
Merged

rrawther merged 6 commits into
developfrom
users/rrawther/rocdecode-update-doc

Conversation

@rrawther

Copy link
Copy Markdown
Contributor

Motivation

Some of the comments were not correct

Technical Details

Will be more clear for the user

JIRA ID

Test Plan

CTest should pass

Test Result

Test project /home/rajy/work/rocm-systems/projects/rocdecode/build
Start 1: video_decodeRaw-HEVC
1/6 Test #1: video_decodeRaw-HEVC ............. Passed 2.67 sec
Start 2: video_decodeRaw-AVC
2/6 Test #2: video_decodeRaw-AVC .............. Passed 1.68 sec
Start 3: video_decodeRaw-AV1
3/6 Test #3: video_decodeRaw-AV1 .............. Passed 1.77 sec
Start 4: video_decodeRaw-VP9
4/6 Test #4: video_decodeRaw-VP9 .............. Passed 1.82 sec
Start 5: rocdec_Decode-HEVC
5/6 Test #5: rocdec_Decode-HEVC ............... Passed 0.72 sec
Start 6: rocDecode_Negative_API_Tests
6/6 Test #6: rocDecode_Negative_API_Tests ..... Passed 0.53 sec

100% tests passed, 0 tests failed out of 6

Submission Checklist

Copilot AI review requested due to automatic review settings May 13, 2026 17:05

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR updates comments in the rocdecDecode sample to better describe the intent of a few hard-coded defaults and the purpose of helper functions, improving readability for users of the sample.

Changes:

  • Clarified the rationale for DEFAULT_WIDTH/DEFAULT_HEIGHT being used during initial decoder creation.
  • Added/updated helper function comments for chroma factor helpers and codec-type mapping.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

rrawther and others added 4 commits May 13, 2026 10:31
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@rrawther
rrawther merged commit 96b1f52 into develop May 13, 2026
13 checks passed
@rrawther
rrawther deleted the users/rrawther/rocdecode-update-doc branch May 13, 2026 22:07
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.

3 participants