From 1484a991e17bb3320fbf8d1cfbe92d7ba5d6ea01 Mon Sep 17 00:00:00 2001 From: Richard Mudgett Date: Tue, 10 Jan 2017 17:48:39 -0600 Subject: [PATCH] Add notes about embedded ast_frame structs holding a format ref. mod_format.h: Note ast_filestream.fr holds a format ref. translate.h: Note ast_trans_pvt.f holds a format ref. Change-Id: I86bda354d725207b41e08920355d7c31b2d7f749 --- include/asterisk/mod_format.h | 6 +++++- include/asterisk/translate.h | 2 +- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/include/asterisk/mod_format.h b/include/asterisk/mod_format.h index 7f17741fa1..d76be5eca2 100644 --- a/include/asterisk/mod_format.h +++ b/include/asterisk/mod_format.h @@ -114,7 +114,11 @@ struct ast_filestream { int lasttimeout; struct ast_channel *owner; FILE *f; - struct ast_frame fr; /*!< frame produced by read, typically */ + /*! + * \brief frame produced by read, typically + * \note This frame holds a fr.subclass.format ref. + */ + struct ast_frame fr; char *buf; /*!< buffer pointed to by ast_frame; */ void *_private; /*!< pointer to private buffer */ const char *orig_chan_name; diff --git a/include/asterisk/translate.h b/include/asterisk/translate.h index e2a4f300fb..ce46cd083a 100644 --- a/include/asterisk/translate.h +++ b/include/asterisk/translate.h @@ -208,7 +208,7 @@ struct ast_translator { */ struct ast_trans_pvt { struct ast_translator *t; - struct ast_frame f; /*!< used in frameout */ + struct ast_frame f; /*!< used in frameout. This frame holds a f.subclass.format ref. */ int samples; /*!< samples available in outbuf */ /*! \brief actual space used in outbuf */ int datalen; -- 2.47.2