lacing resize
[libopusenc.git] / src / ogg_packer.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(_oggpacker_h)
28 # define _oggpacker_h (1)
29
30
31 # if defined(__cplusplus)
32 extern "C" {
33 # endif
34
35 typedef unsigned long long oggp_uint64;
36 typedef unsigned oggp_uint32;
37 typedef int oggp_int32;
38
39 typedef struct oggpacker oggpacker;
40
41 /** Allocates an oggpacker object */
42 oggpacker *oggp_create(int serialno);
43
44 /** Frees memory associated with an oggpacker object */
45 void oggp_destroy(oggpacker *oggp);
46
47 /** Sets the maximum muxing delay in granulepos units. Pages will be auto-flushed
48     to enforce the delay and to avoid continued pages if possible. */
49 void oggp_set_muxing_delay(oggpacker *oggp, oggp_uint64 delay);
50
51 /** Get a buffer where to write the next packet. The buffer will have
52     size "bytes", but fewer bytes can be written. The buffer remains valid through
53     a call to oggp_close_page() or oggp_get_next_page(), but is invalidated by
54     another call to oggp_get_packet_buffer() or by a call to oggp_commit_packet(). */
55 unsigned char *oggp_get_packet_buffer(oggpacker *oggp, int bytes);
56
57 /** Tells the oggpacker that the packet buffer obtained from
58     oggp_get_packet_buffer() has been filled and the number of bytes written
59     has to be no more than what was originally asked for. */
60 int oggp_commit_packet(oggpacker *oggp, int bytes, oggp_uint64 granulepos, int eos);
61
62 /** Create a page from the data written so far (and not yet part of a previous page).
63     If there is too much data for one page, then all page continuations will be closed too. */
64 int oggp_flush_page(oggpacker *oggp);
65
66 /** Get a pointer to the contents of the next available page. Pointer is
67     invalidated on the next call to oggp_get_next_page() or oggp_commit_packet(). */
68 int oggp_get_next_page(oggpacker *oggp, unsigned char **page, int *bytes);
69
70 /** Creates a new (chained) stream. This closes all outstanding pages. These
71     pages remain available with oggp_get_next_page(). */
72 int oggp_chain(oggpacker *oggp, int serialno);
73
74 # if defined(__cplusplus)
75 }
76 # endif
77
78 #endif