API update
authorJean-Marc Valin <jmvalin@jmvalin.ca>
Mon, 24 Apr 2017 21:21:18 +0000 (17:21 -0400)
committerJean-Marc Valin <jmvalin@jmvalin.ca>
Mon, 24 Apr 2017 21:21:18 +0000 (17:21 -0400)
include/opusenc.h

index c91ecd2..3c0bf9a 100644 (file)
@@ -1,4 +1,28 @@
-
+/* Copyright (c) 2017 Jean-Marc Valin */
+/*
+   Redistribution and use in source and binary forms, with or without
+   modification, are permitted provided that the following conditions
+   are met:
+
+   - Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+
+   - Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+   OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
 
 #if !defined(_opusenc_h)
 # define _opusenc_h (1)
@@ -20,10 +44,12 @@ typedef struct OggOpusEnc OggOpusEnc;
 typedef struct OggOpusComments OggOpusComments;
 
 /* Create a new OggOpus file. */
-OggOpusEnc *ope_create_file(const char *path, int rate, int channels, int family, int *error);
+OggOpusEnc *ope_create_file(const char *path, const OggOpusComments *comments,
+  int rate, int channels, int family, int *error);
 
 /* Create a new OggOpus file (callback-based). */
-OggOpusEnc *ope_create_callbacks(OpusEncCallbacks *callbacks, void *user_data, int rate, int channels, int family, int *error);
+OggOpusEnc *ope_create_callbacks(OpusEncCallbacks *callbacks, const OggOpusComments *comments,
+  void *user_data, int rate, int channels, int family, int *error);
 
 /* Add/encode any number of float samples to the file. */
 int ope_write_float(OggOpusEnc *enc, float *pcm, int samples_per_channel);
@@ -32,16 +58,16 @@ int ope_write_float(OggOpusEnc *enc, float *pcm, int samples_per_channel);
 int ope_write(OggOpusEnc *enc, opus_int16 *pcm, int samples_per_channel);
 
 /* Close/finalize the stream. */
-int ope_free(OggOpusEnc *enc);
+int ope_close_and_free(OggOpusEnc *enc);
 
 /* Ends the stream and create a new stream within the same file. */
 int ope_chain_current(OggOpusEnc *enc);
 
 /* Ends the stream and create a new file. */
-int ope_chain_new_file(OggOpusEnc *enc, const char *path);
+int ope_continue_new_file(OggOpusEnc *enc, const OggOpusComments *comments, const char *path);
 
 /* Ends the stream and create a new file (callback-based). */
-int ope_chain_new_callbacks(OggOpusEnc *enc, void *user_data);
+int ope_continue_new_callbacks(OggOpusEnc *enc, const OggOpusComments *comments, void *user_data);
 
 /* Goes straight to the libopus ctl() functions. */
 int ope_encoder_ctl(OggOpusEnc *enc, int request, ...);