aboutsummaryrefslogtreecommitdiff
path: root/vpx/vpx_codec.h
diff options
context:
space:
mode:
authorJames Zern <jzern@google.com>2024-01-22 22:04:42 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>2024-01-22 22:04:42 +0000
commitdbf4b9b450ddb4c197998f9b7ff668081708066f (patch)
tree7f7370f69833b55ad06e2247f03f4b4c59393823 /vpx/vpx_codec.h
parent0305f663bc314d883ae1033dc4e4f006c5802a59 (diff)
parentb469e8f789e4d59075c477caaa87154e53e992b4 (diff)
downloadlibvpx-dbf4b9b450ddb4c197998f9b7ff668081708066f.tar.gz
Merge "Merge commit '602e2e8979d111b02c959470da5322797dd96a19' into aosp/main" into main am: b469e8f789
Original change: https://android-review.googlesource.com/c/platform/external/libvpx/+/2920688 Change-Id: I521b49f0c60299465a8032fe31ddc265b50e6636 Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
Diffstat (limited to 'vpx/vpx_codec.h')
-rw-r--r--vpx/vpx_codec.h16
1 files changed, 10 insertions, 6 deletions
diff --git a/vpx/vpx_codec.h b/vpx/vpx_codec.h
index b0a931e01..0d61b0738 100644
--- a/vpx/vpx_codec.h
+++ b/vpx/vpx_codec.h
@@ -318,19 +318,21 @@ const char *vpx_codec_err_to_string(vpx_codec_err_t err);
* \param[in] ctx Pointer to this instance's context.
*
*/
-const char *vpx_codec_error(vpx_codec_ctx_t *ctx);
+const char *vpx_codec_error(const vpx_codec_ctx_t *ctx);
/*!\brief Retrieve detailed error information for codec context
*
* Returns a human readable string providing detailed information about
- * the last error.
+ * the last error. The returned string is only valid until the next
+ * vpx_codec_* function call (except vpx_codec_error and
+ * vpx_codec_error_detail) on the codec context.
*
* \param[in] ctx Pointer to this instance's context.
*
* \retval NULL
* No detailed information is available.
*/
-const char *vpx_codec_error_detail(vpx_codec_ctx_t *ctx);
+const char *vpx_codec_error_detail(const vpx_codec_ctx_t *ctx);
/* REQUIRED FUNCTIONS
*
@@ -345,9 +347,11 @@ const char *vpx_codec_error_detail(vpx_codec_ctx_t *ctx);
* \param[in] ctx Pointer to this instance's context
*
* \retval #VPX_CODEC_OK
- * The codec algorithm initialized.
- * \retval #VPX_CODEC_MEM_ERROR
- * Memory allocation failed.
+ * The codec instance has been destroyed.
+ * \retval #VPX_CODEC_INVALID_PARAM
+ * ctx is a null pointer.
+ * \retval #VPX_CODEC_ERROR
+ * Codec context not initialized.
*/
vpx_codec_err_t vpx_codec_destroy(vpx_codec_ctx_t *ctx);