23914eb13b374746701632e8f913c0bc9cf277a3
[libopusenc.git] / include / opusenc.h
1 /* Copyright (c) 2017 Jean-Marc Valin */
2 /*
3    Redistribution and use in source and binary forms, with or without
4    modification, are permitted provided that the following conditions
5    are met:
6
7    - Redistributions of source code must retain the above copyright
8    notice, this list of conditions and the following disclaimer.
9
10    - Redistributions in binary form must reproduce the above copyright
11    notice, this list of conditions and the following disclaimer in the
12    documentation and/or other materials provided with the distribution.
13
14    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
15    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
16    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
17    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
18    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
22    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
23    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27 #if !defined(_opusenc_h)
28 # define _opusenc_h (1)
29
30
31 # if defined(__cplusplus)
32 extern "C" {
33 # endif
34
35 #include "opus.h"
36
37 #define OPE_OK 0
38 #define OPE_ERROR_CANNOT_OPEN -10
39 #define OPE_ERROR_UNIMPLEMENTED -11
40
41 typedef int (*ope_write_func)(void *user_data, const unsigned char *ptr, int len);
42
43 typedef int (*ope_close_func)(void *user_data);
44
45 typedef struct {
46   ope_write_func write;
47   ope_close_func close;
48 } OpusEncCallbacks;
49
50 /** Opaque encoder struct. */
51 typedef struct OggOpusEnc OggOpusEnc;
52
53 /** Opaque header struct. */
54 typedef struct OggOpusComments OggOpusComments;
55
56 /** Create a new OggOpus file. */
57 OggOpusEnc *ope_create_file(const char *path, const OggOpusComments *comments,
58     int rate, int channels, int family, int *error);
59
60 /** Create a new OggOpus file (callback-based). */
61 OggOpusEnc *ope_create_callbacks(const OpusEncCallbacks *callbacks, void *user_data,
62     const OggOpusComments *comments, int rate, int channels, int family, int *error);
63
64 /** Add/encode any number of float samples to the file. */
65 int ope_write_float(OggOpusEnc *enc, float *pcm, int samples_per_channel);
66
67 /** Add/encode any number of int16 samples to the file. */
68 int ope_write(OggOpusEnc *enc, opus_int16 *pcm, int samples_per_channel);
69
70 /** Close/finalize the stream. */
71 int ope_close_and_free(OggOpusEnc *enc);
72
73 /** Ends the stream and create a new stream within the same file. */
74 int ope_chain_current(OggOpusEnc *enc, const OggOpusComments *comments);
75
76 /** Ends the stream and create a new file. */
77 int ope_continue_new_file(OggOpusEnc *enc, const OggOpusComments *comments, const char *path);
78
79 /** Ends the stream and create a new file (callback-based). */
80 int ope_continue_new_callbacks(OggOpusEnc *enc, const OggOpusComments *comments, void *user_data);
81
82 /** Goes straight to the libopus ctl() functions. */
83 int ope_encoder_ctl(OggOpusEnc *enc, int request, ...);
84
85 /** ctl()-type call for the OggOpus layer. */
86 int ope_set_params(OggOpusEnc *enc, int request, ...);
87
88 # if defined(__cplusplus)
89 }
90 # endif
91
92 #endif