Jackalope / jrf (public) (License: GPLv3 or later version) (since 2019-11-21) (hash sha1)
Libriary for reading and writing resource files: vertices, indices, meshes, images, models and scene data.
Supports reading from filesystem as well as from zip files.
It uses unique binary container format for those resources.
It is used in tool for converting popular formats like wavefront .obj file, TARGA image to this container and also used in resource loader as part of graphics framework.

It requires jlib libriary (see my user repositories) and libzip.
It is possible to remove libzip dependency.
Clone URLs: https://rocketgit.com/user/Jackalope/jrf ssh://rocketgit@ssh.rocketgit.com/user/Jackalope/jrf git://git.rocketgit.com/user/Jackalope/jrf
v0.1.0 v0.1.1 v0.2.0 v0.2.1 v0.2.2 v0.3.0 master tool
List of commits:
Subject Hash Author Date (UTC)
removed dead code f4ddde689122f1b96fda5292e69f612bf2ca327d jp.larry 2019-12-26 14:38:06
removed forgotten vertex data_size writing 25244188b395b6cca35502f4156d3e78cc1e74ec jp.larry 2019-12-26 13:19:31
better read errors d6d7bc5df695d694ea0dee225905212ef1dfe41b jp.larry 2019-12-26 13:18:55
changed vertices file structure to prevent undefined behaviour 603e283ccf234f87f6e8c38a669280be36a5aafb jp.larry 2019-12-26 12:35:05
vertex attributes is separated, not inteleaved now d3e7b79c74e9fae7b8b788d1a55db2e664feb107 jp.larry 2019-12-26 01:19:17
compiled on windows with mingw 51eacaf02dd542415cea1edd615d88234fb5b344 Jackalope 2019-12-15 07:05:58
added mesh to read and write functions 173144a8516441420feb4327a66d26fa3f57376d Your Name 2019-12-07 22:09:04
warning hidden by implicit cast f49b32439aa1e8719bd340da9fc3bb7e9b906d0d Your Name 2019-12-07 21:01:08
Vertices have vertices count value cf3b63932cdcdb88b72e70df93a4dd8b478d163b jp.larry 2019-12-07 16:02:55
removed IndicesArrays, added Mesh resource and Vertices attributes is not dynamically allocated a54a61cfc285bbec4246b1affdc5fe9251c059d0 jp.larry 2019-12-06 17:04:06
new obj file error f4385161fdd1ad8038e2d0924e1d3de2a6506cc9 Your Name 2019-12-01 10:26:18
scene issues solved cef4ba84d44cbdc6690c87e553df9fbfba60059f Your Name 2019-12-01 04:19:29
changed transformation matrix to 4x4 from 3x3 5b5728dabefb471cf126bf4b524f5079a14c0735 Your Name 2019-11-30 15:16:50
added missing return 94644ed6f61207f664ac4675fa015afbe017ddea jp.larry 2019-11-29 09:03:14
scene improvements, changed shift type to unsigned, set default-value funtions, model must be path a2708b94b88eb0ede73b9aab396e7a13f13baa52 Your Name 2019-11-29 09:27:32
separate function for str reading 9127f9a18f9f4974975fa35d58f596952b6aa4e5 Your Name 2019-11-29 09:26:43
new result errors ef56e017e2e761fdf23c6a64ed33277c98569e13 Your Name 2019-11-29 09:26:12
new types for Scene e2fde0d2b66e125ba3bfd86b8f51c81ecb5ab047 Your Name 2019-11-29 00:38:27
shift scale added to Scene 974752944e73bbc2949ff399ab9d806baeeab751 Your Name 2019-11-29 00:38:06
new resource type - scene - list of models f3eea43135dad8b3e24cf6683e5abc1a5e2e57ad Your Name 2019-11-28 07:59:59
Commit f4ddde689122f1b96fda5292e69f612bf2ca327d - removed dead code
Author: jp.larry
Author date (UTC): 2019-12-26 14:38
Committer name: jp.larry
Committer date (UTC): 2019-12-26 14:38
Parent(s): a2539376e73c0979930c10752537a5b4049e4f21
Signing key:
Tree: 0a27102efb9af16a7867d4acb7563fef4d068e29
File Lines added Lines deleted
include/jrf/indices.h 43 149
File include/jrf/indices.h changed (mode: 100644) (index 7bae4b6..3513cff)
6 6
7 7 namespace jrf namespace jrf
8 8 { {
9 enum IndexFormat : uint32_t { U16 = 2, U32 = 4 };
10
11 struct Indices
12 {
13 uint8_t *p_data;
14 uint64_t size;
15 IndexFormat format;
16
17 inline void destroy() {
18 jl::deallocate(&p_data);
19 }
20
21 template<typename IO = jl::io_agent>
22 [[nodiscard]] Result read(IO *p_mediator)
23 {
24 auto *p_io = jl::io_agent_p_alt_cast(p_mediator);
25 if (not p_io->read_items(&format))
26 return Result::MEDIATOR_ERROR;
27 if (not p_io->read_items(&size))
28 return Result::MEDIATOR_ERROR;
29
30 if (size == 0)
31 p_data = nullptr;
32 else
33 {
34 if (not jl::allocate_bytes(&p_data, size))
35 return Result::MEDIATOR_ERROR;
36 if (not p_io->read_bytes(p_data, size))
37 return this->destroy(), Result::MEDIATOR_ERROR;
38 }
39 return Result::SUCCESS;
40 }
41
42 template<typename IO = jl::io_agent>
43 [[nodiscard]] Result write(IO *p_mediator) const
44 {
45 auto *p_io = jl::io_agent_p_alt_cast(p_mediator);
46 if (not p_io->write_items(&format))
47 return Result::MEDIATOR_ERROR;
48 if (not p_io->write_items(&size))
49 return Result::MEDIATOR_ERROR;
50 if (not p_io->write_bytes(p_data, size))
51 return Result::MEDIATOR_ERROR;
52
53 return Result::SUCCESS;
54 }
55 };
56
57 /*
58 struct IndicesArrays
59 {
60 uint32_t array_count;
61 IndexFormat format;
62 union
63 {
64 Indices *p_indices;
65 Indices indices;
66 } u;
67 bool is_allocated;
68
69 void destroy()
9 enum IndexFormat : uint32_t { U16 = 2, U32 = 4 };
10
11 struct Indices
12 {
13 uint8_t *p_data;
14 uint64_t size;
15 IndexFormat format;
16
17 void destroy() { jl::deallocate(&p_data); }
18
19 template<typename IO = jl::io_agent>
20 [[nodiscard]] Result read(IO *p_mediator)
21 {
22 auto *p_io = jl::io_agent_p_alt_cast(p_mediator);
23 if (not p_io->read_items(&format))
24 return Result::MEDIATOR_ERROR;
25 if (not p_io->read_items(&size))
26 return Result::MEDIATOR_ERROR;
27
28 if (size == 0)
29 p_data = nullptr;
30 else
70 31 { {
71 if (is_allocated)
72 {
73 if (u.p_indices != nullptr)
74 {
75 for (uint32_t i = 0; i < array_count; ++i)
76 jl::deallocate(&u.p_indices[i].p_data);
77 jl::deallocate(&u.p_indices);
78 }
79 }
80 else u.indices.destroy();
81 }
82
83 template<typename IO = jl::io_agent>
84 [[nodiscard]] Result read(IO *p_mediator)
85 {
86 if (p_mediator->read(&format, sizeof(format)) != sizeof(format))
87 return Result::MEDIATOR_ERROR;
88 if (p_mediator->read(&array_count, sizeof (array_count)) != sizeof(array_count))
89 return Result::MEDIATOR_ERROR;
90
91 if (array_count == 0)
92 u.p_indices = nullptr;
93 else
94 {
95 Indices *p_ind;
96 is_allocated = array_count > 1;
97 if (is_allocated)
98 {
99 if (not jl::allocate(&u.p_indices, array_count))
100 return Result::ALLOCATION_FAIL;
101 p_ind = u.p_indices;
102 }
103 else p_ind = &u.indices;
104
105 for (uint32_t i = 0; i < array_count; ++i)
106 {
107 p_ind[i].p_data = nullptr;
108 if (p_mediator->read(&p_ind[i].size, sizeof(Indices::size)) != sizeof(Indices::size))
109 {
110 jl::deallocate(&u.p_indices);
111 return Result::MEDIATOR_ERROR;
112 }
113 }
114
115 for (uint32_t i = 0; i < array_count; ++i)
116 {
117 Result res;
118 auto &array = p_ind[i];
119 if (not jl::allocate_bytes(&array.p_data, array.size))
120 {
121 res = Result::ALLOCATION_FAIL;
122 goto CANCEL;
123 }
124 if (p_mediator->read(array.p_data, array.size) != array.size)
125 {
126 res = Result::MEDIATOR_ERROR;
127 CANCEL: destroy();
128 return res;
129 }
130 }
131 }
132 return Result::SUCCESS;
133 }
134
135 template<typename IO = jl::io_agent>
136 [[nodiscard]] Result write(IO *p_mediator) const
137 {
138 if (p_mediator->write(&format, sizeof(format)) != sizeof(format))
139 return Result::MEDIATOR_ERROR;
140 if (p_mediator->write(&array_count, sizeof (array_count)) != sizeof (array_count))
141 return Result::MEDIATOR_ERROR;
142
143 const Indices *p_ind;
144 if (is_allocated)
145 p_ind = u.p_indices;
146 else p_ind = &u.indices;
147
148 for (uint32_t i = 0; i < array_count; ++i)
149 if (p_mediator->write(&p_ind[i].size, sizeof(Indices::size)) != sizeof(Indices::size))
150 return Result::MEDIATOR_ERROR;
151
152 for (uint32_t i = 0; i < array_count; ++i)
153 if (p_mediator->write(p_ind[i].p_data, p_ind[i].size) != int64_t(p_ind[i].size))
154 return Result::MEDIATOR_ERROR;
155
156 return Result::SUCCESS;
32 if (not jl::allocate_bytes(&p_data, size))
33 return Result::MEDIATOR_ERROR;
34 if (not p_io->read_bytes(p_data, size))
35 return this->destroy(), Result::MEDIATOR_ERROR;
157 36 } }
158 };
159 */
37 return Result::SUCCESS;
38 }
39
40 template<typename IO = jl::io_agent>
41 [[nodiscard]] Result write(IO *p_mediator) const
42 {
43 auto *p_io = jl::io_agent_p_alt_cast(p_mediator);
44 if (not p_io->write_items(&format))
45 return Result::MEDIATOR_ERROR;
46 if (not p_io->write_items(&size))
47 return Result::MEDIATOR_ERROR;
48 if (not p_io->write_bytes(p_data, size))
49 return Result::MEDIATOR_ERROR;
50
51 return Result::SUCCESS;
52 }
53 };
160 54 } }
Hints:
Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://rocketgit.com/user/Jackalope/jrf

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@ssh.rocketgit.com/user/Jackalope/jrf

Clone this repository using git:
git clone git://git.rocketgit.com/user/Jackalope/jrf

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a merge request:
... clone the repository ...
... make some changes and some commits ...
git push origin main