shithub: libvpx

Info  •  Files  •  Log

Update comments on nonexistent vpx_codec_init

Update comments on the nonexistent vpx_codec_init() function. Replace it
with vpx_codec_dec_init() and vpx_codec_enc_init().

based on the change in libaom:
b1b8c68e8 Update comments on nonexistent aom_codec_init

Change-Id: I63d3f6c87706a98f631457b5f6ce51e8b0c5cfb1

--- a/vpx/internal/vpx_codec_internal.h

+++ b/vpx/internal/vpx_codec_internal.h

@@ -27,13 +27,15 @@

  *     </pre>

  *

  * An application instantiates a specific decoder instance by using

- * vpx_codec_init() and a pointer to the algorithm's interface structure:

+ * vpx_codec_dec_init() and a pointer to the algorithm's interface structure:

  *     <pre>

  *     my_app.c:

  *       extern vpx_codec_iface_t my_codec;

  *       {

  *           vpx_codec_ctx_t algo;

- *           res = vpx_codec_init(&algo, &my_codec);

+ *           int threads = 4;

+ *           vpx_codec_dec_cfg_t cfg = { threads, 0, 0 };

+ *           res = vpx_codec_dec_init(&algo, &my_codec, &cfg, 0);

  *       }

  *     </pre>

  *

--- a/vpx/vpx_codec.h

+++ b/vpx/vpx_codec.h

@@ -22,13 +22,16 @@

  * video codec algorithm.

  *

  * An application instantiates a specific codec instance by using

- * vpx_codec_init() and a pointer to the algorithm's interface structure:

+ * vpx_codec_dec_init() or vpx_codec_enc_init() and a pointer to the

+ * algorithm's interface structure:

  *     <pre>

  *     my_app.c:

  *       extern vpx_codec_iface_t my_codec;

  *       {

  *           vpx_codec_ctx_t algo;

- *           res = vpx_codec_init(&algo, &my_codec);

+ *           int threads = 4;

+ *           vpx_codec_dec_cfg_t cfg = { threads, 0, 0 };

+ *           res = vpx_codec_dec_init(&algo, &my_codec, &cfg, 0);

  *       }

  *     </pre>

  *