OpenJPH
Open-source implementation of JPEG2000 Part-15
ojph_file.h
Go to the documentation of this file.
1//***************************************************************************/
2// This software is released under the 2-Clause BSD license, included
3// below.
4//
5// Copyright (c) 2019, Aous Naman
6// Copyright (c) 2019, Kakadu Software Pty Ltd, Australia
7// Copyright (c) 2019, The University of New South Wales, Australia
8//
9// Redistribution and use in source and binary forms, with or without
10// modification, are permitted provided that the following conditions are
11// met:
12//
13// 1. Redistributions of source code must retain the above copyright
14// notice, this list of conditions and the following disclaimer.
15//
16// 2. Redistributions in binary form must reproduce the above copyright
17// notice, this list of conditions and the following disclaimer in the
18// documentation and/or other materials provided with the distribution.
19//
20// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21// IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23// PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24// HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
26// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31//***************************************************************************/
32// This file is part of the OpenJPH software implementation.
33// File: ojph_file.h
34// Author: Aous Naman
35// Date: 28 August 2019
36//***************************************************************************/
37
38
39#ifndef OJPH_FILE_H
40#define OJPH_FILE_H
41
42#include <cstdlib>
43#include <cstdio>
44
45#include "ojph_arch.h"
46
47namespace ojph {
48
50#ifdef OJPH_OS_WINDOWS
51 int inline ojph_fseek(FILE* stream, si64 offset, int origin)
52 {
53 return _fseeki64(stream, offset, origin);
54 }
55
56 si64 inline ojph_ftell(FILE* stream)
57 {
58 return _ftelli64(stream);
59 }
60#else
61 int inline ojph_fseek(FILE* stream, si64 offset, int origin)
62 {
63 return fseeko(stream, offset, origin);
64 }
65
66 si64 inline ojph_ftell(FILE* stream)
67 {
68 return ftello(stream);
69 }
70#endif
71
72
75 {
76 public:
77 public:
78 enum seek : int {
79 OJPH_SEEK_SET = SEEK_SET,
80 OJPH_SEEK_CUR = SEEK_CUR,
81 OJPH_SEEK_END = SEEK_END
82 };
83 virtual ~outfile_base() {}
84
85 virtual size_t write(const void *ptr, size_t size) = 0;
86 virtual si64 tell() { return 0; }
87 virtual int seek(si64 offset, enum outfile_base::seek origin)
88 {
89 ojph_unused(offset); ojph_unused(origin);
90 return -1; /* always fail, to remind you to write an implementation */
91 }
92 virtual void flush() {}
93 virtual void close() {}
94 };
95
98 {
99 public:
100 j2c_outfile() { fh = 0; }
101 ~j2c_outfile() override { if (fh) fclose(fh); }
102
103 void open(const char *filename);
104 size_t write(const void *ptr, size_t size) override;
105 si64 tell() override;
106 void flush() override;
107 void close() override;
108
109 private:
110 FILE *fh;
111 };
112
113 //*************************************************************************/
127 {
128 public:
130 mem_outfile();
132 ~mem_outfile() override;
133
144 void open(size_t initial_size = 65536, bool clear_mem = false);
145
155 size_t write(const void *ptr, size_t size) override;
156
163 si64 tell() override { return cur_ptr - buf; }
164
171 int seek(si64 offset, enum outfile_base::seek origin) override;
172
177 void close() override;
178
187 const ui8* get_data() { return buf; }
188
198 const ui8* get_data() const { return buf; }
199
204 void write_to_file(const char *file_name) const;
205
206 private:
216 void expand_storage(size_t new_size, bool clear_all);
217
218 private:
221 size_t buf_size;
222 size_t used_size;
225 };
226
229 {
230 public:
231 enum seek : int {
232 OJPH_SEEK_SET = SEEK_SET,
233 OJPH_SEEK_CUR = SEEK_CUR,
234 OJPH_SEEK_END = SEEK_END
235 };
236
237 virtual ~infile_base() {}
238
239 //read reads size bytes, returns the number of bytes read
240 virtual size_t read(void *ptr, size_t size) = 0;
241 //seek returns 0 on success
242 virtual int seek(si64 offset, enum infile_base::seek origin) = 0;
243 virtual si64 tell() = 0;
244 virtual bool eof() = 0;
245 virtual void close() {}
246 };
247
250 {
251 public:
252 j2c_infile() { fh = 0; }
253 ~j2c_infile() override { if (fh) fclose(fh); }
254
255 void open(const char *filename);
256
257 //read reads size bytes, returns the number of bytes read
258 size_t read(void *ptr, size_t size) override;
259 //seek returns 0 on success
260 int seek(si64 offset, enum infile_base::seek origin) override;
261 si64 tell() override;
262 bool eof() override { return feof(fh) != 0; }
263 void close() override;
264
265 private:
266 FILE *fh;
267 };
268
271 {
272 public:
273 mem_infile() { close(); }
274 ~mem_infile() override { }
275
276 void open(const ui8* data, size_t size);
277
278 //read reads size bytes, returns the number of bytes read
279 size_t read(void *ptr, size_t size) override;
280 //seek returns 0 on success
281 int seek(si64 offset, enum infile_base::seek origin) override;
282 si64 tell() override { return cur_ptr - data; }
283 bool eof() override { return cur_ptr >= data + size; }
284 void close() override { data = cur_ptr = NULL; size = 0; }
285
286 private:
287 const ui8 *data, *cur_ptr;
288 size_t size;
289 };
290
291
292}
293
294#endif // !OJPH_FILE_H
virtual int seek(si64 offset, enum infile_base::seek origin)=0
virtual bool eof()=0
virtual void close()
Definition: ojph_file.h:245
virtual ~infile_base()
Definition: ojph_file.h:237
virtual si64 tell()=0
virtual size_t read(void *ptr, size_t size)=0
~j2c_infile() override
Definition: ojph_file.h:253
bool eof() override
Definition: ojph_file.h:262
~j2c_outfile() override
Definition: ojph_file.h:101
const ui8 * cur_ptr
Definition: ojph_file.h:287
bool eof() override
Definition: ojph_file.h:283
~mem_infile() override
Definition: ojph_file.h:274
void close() override
Definition: ojph_file.h:284
si64 tell() override
Definition: ojph_file.h:282
mem_outfile stores encoded j2k codestreams in memory
Definition: ojph_file.h:127
si64 tell() override
Call this function to know the file size (i.e., number of bytes used to store the file).
Definition: ojph_file.h:163
const ui8 * get_data()
Call this function to access memory file data.
Definition: ojph_file.h:187
const ui8 * get_data() const
Call this function to access memory file data (for const objects)
Definition: ojph_file.h:198
virtual void flush()
Definition: ojph_file.h:92
virtual ~outfile_base()
Definition: ojph_file.h:83
virtual void close()
Definition: ojph_file.h:93
virtual si64 tell()
Definition: ojph_file.h:86
virtual size_t write(const void *ptr, size_t size)=0
virtual int seek(si64 offset, enum outfile_base::seek origin)
Definition: ojph_file.h:87
int ojph_fseek(FILE *stream, si64 offset, int origin)
Definition: ojph_file.h:61
si64 ojph_ftell(FILE *stream)
Definition: ojph_file.h:66
int64_t si64
Definition: ojph_defs.h:57
uint8_t ui8
Definition: ojph_defs.h:50
#define OJPH_EXPORT
Definition: ojph_arch.h:119
#define ojph_unused(x)
Definition: ojph_defs.h:78