star-buffer

commit e69db656ac7a8aaa346fecb0ca453fef60905330
parent c3964a482a22e4d915dba525b53369330be2ab22
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Thu, 24 Mar 2022 15:29:17 +0100

Define the Star-Buffer fileformat

Diffstat:
A
doc/sbuf.5.scd
 | 
47
+++++++++++++++++++++++++++++++++++++++++++++++

1 file changed, 47 insertions(+), 0 deletions(-)
diff --git a/doc/sbuf.5.scd b/doc/sbuf.5.scd
@@ -0,0 +1,47 @@
+sbuf(5)
+
+; Copyright (C) 2022 |Méso|Star> (contact@meso-star.com)
+; 
+; This program is free software: you can redistribute it and/or modify
+; it under the terms of the GNU General Public License as published by
+; the Free Software Foundation, either version 3 of the License, or
+; (at your option) any later version.
+; 
+; This program is distributed in the hope that it will be useful,
+; but WITHOUT ANY WARRANTY; without even the implied warranty of
+; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+; GNU General Public License for more details.
+; 
+; You should have received a copy of the GNU General Public License
+; along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+# NAME
+
+sbuf - Star-Buffer file format
+
+# BINARY FILE
+
+Data are encoded with respect to the little endian bytes ordering, i.e. least
+significant bytes are stored first.
+
+```
+<sprp>          ::= <pagesize> <count> <size> <alignment>
+                    <padding>
+                    <list>
+                    <padding>
+
+<pagesize>      ::= UINT64
+<count>         ::= UINT64
+<size>          ::= UINT64
+<alignment>     ::= UINT64 # less than <pagesize>
+
+---
+
+<list>          ::= <element> <padding> [ <element> <padding> ]...
+<element>       ::= BYTE [ BYTE ... ]
+
+---
+
+<padding>       ::= [ BYTE ... ] # Ensure alignement
+```
+