1/* Copyright 2013 Google Inc. All Rights Reserved.
2
3   Licensed under the Apache License, Version 2.0 (the "License");
4   you may not use this file except in compliance with the License.
5   You may obtain a copy of the License at
6
7   http://www.apache.org/licenses/LICENSE-2.0
8
9   Unless required by applicable law or agreed to in writing, software
10   distributed under the License is distributed on an "AS IS" BASIS,
11   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12   See the License for the specific language governing permissions and
13   limitations under the License.
14
15   Functions for streaming input and output.
16*/
17
18#ifndef BROTLI_DEC_STREAMS_H_
19#define BROTLI_DEC_STREAMS_H_
20
21#include <stdio.h>
22#include "./types.h"
23
24#if defined(__cplusplus) || defined(c_plusplus)
25extern "C" {
26#endif
27
28/* Function pointer type used to read len bytes into buf. Returns the */
29/* number of bytes read or -1 on error. */
30typedef int (*BrotliInputFunction)(void* data, uint8_t* buf, size_t len);
31
32/* Input callback function with associated data. */
33typedef struct {
34  BrotliInputFunction cb_;
35  void* data_;
36} BrotliInput;
37
38/* Reads len bytes into buf, using the in callback. */
39static BROTLI_INLINE int BrotliRead(BrotliInput in, uint8_t* buf, size_t len) {
40  return in.cb_(in.data_, buf, len);
41}
42
43/* Function pointer type used to write len bytes into buf. Returns the */
44/* number of bytes written or -1 on error. */
45typedef int (*BrotliOutputFunction)(void* data, const uint8_t* buf, size_t len);
46
47/* Output callback function with associated data. */
48typedef struct {
49  BrotliOutputFunction cb_;
50  void* data_;
51} BrotliOutput;
52
53/* Writes len bytes into buf, using the out callback. */
54static BROTLI_INLINE int BrotliWrite(BrotliOutput out,
55                                     const uint8_t* buf, size_t len) {
56  return out.cb_(out.data_, buf, len);
57}
58
59/* Memory region with position. */
60typedef struct {
61  const uint8_t* buffer;
62  size_t length;
63  size_t pos;
64} BrotliMemInput;
65
66/* Input callback where *data is a BrotliMemInput struct. */
67int BrotliMemInputFunction(void* data, uint8_t* buf, size_t count);
68
69/* Returns an input callback that wraps the given memory region. */
70BrotliInput BrotliInitMemInput(const uint8_t* buffer, size_t length,
71                               BrotliMemInput* mem_input);
72
73/* Output buffer with position. */
74typedef struct {
75  uint8_t* buffer;
76  size_t length;
77  size_t pos;
78} BrotliMemOutput;
79
80/* Output callback where *data is a BrotliMemOutput struct. */
81int BrotliMemOutputFunction(void* data, const uint8_t* buf, size_t count);
82
83/* Returns an output callback that wraps the given memory region. */
84BrotliOutput BrotliInitMemOutput(uint8_t* buffer, size_t length,
85                                 BrotliMemOutput* mem_output);
86
87/* Input callback that reads from standard input. */
88int BrotliStdinInputFunction(void* data, uint8_t* buf, size_t count);
89BrotliInput BrotliStdinInput();
90
91/* Output callback that writes to standard output. */
92int BrotliStdoutOutputFunction(void* data, const uint8_t* buf, size_t count);
93BrotliOutput BrotliStdoutOutput();
94
95/* Output callback that writes to a file. */
96int BrotliFileOutputFunction(void* data, const uint8_t* buf, size_t count);
97BrotliOutput BrotliFileOutput(FILE* f);
98
99#if defined(__cplusplus) || defined(c_plusplus)
100}    /* extern "C" */
101#endif
102
103#endif  /* BROTLI_DEC_STREAMS_H_ */
104