From caf56aab41c53b129491c986844de029e619ce27 Mon Sep 17 00:00:00 2001
From: Marcus Asteborg <maastebo@microsoft.com>
Date: Fri, 8 Jul 2022 18:25:46 -0700
Subject: [PATCH] update doc on custom mode

Signed-off-by: Jean-Marc Valin <jmvalin@jmvalin.ca>
---
 include/opus_custom.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/include/opus_custom.h b/include/opus_custom.h
index 2227be011..2f22d4b35 100644
--- a/include/opus_custom.h
+++ b/include/opus_custom.h
@@ -104,7 +104,8 @@ typedef struct OpusCustomDecoder OpusCustomDecoder;
 /** The mode contains all the information necessary to create an
     encoder. Both the encoder and decoder need to be initialized
     with exactly the same mode, otherwise the output will be
-    corrupted.
+    corrupted. The mode MUST NOT BE DESTROYED until the encoders and
+    decoders that use it are destroyed as well.
    @brief Mode configuration
  */
 typedef struct OpusCustomMode OpusCustomMode;
-- 
GitLab