about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorgennyble <gen@nyble.dev>2023-11-17 05:15:33 -0600
committergennyble <gen@nyble.dev>2023-11-17 05:15:33 -0600
commit4c9a87939c97247d182293ff696de1355ba06194 (patch)
tree78f5620cafbe9e3740d79e5900ff35b3d0fb7e47 /README.md
parentce77e890520116915d0082c12a43c4aa388bba74 (diff)
downloadlri-rs-4c9a87939c97247d182293ff696de1355ba06194.tar.gz
lri-rs-4c9a87939c97247d182293ff696de1355ba06194.zip
add some docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md49
1 files changed, 32 insertions, 17 deletions
diff --git a/README.md b/README.md
index 5ba1c46..ba0c9d6 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,32 @@
-Still early days. It's usable, to some degree, but nothing is stable, everything is broken, and I will scream.
-
-### LRI File Structure
-The file is made up if blocks each with a short header, a protobuf message, and possibly some associated data.
-
-Things seem to be **little endian**
-
-#### Block Header
-The header is 32 bytes long. and goes as follows:  
-| bytes | meaning |
-| ----- | ------- |
-| 4     | Magic Number: "LELR" |
-| 8     | block length |
-| 8     | protobuf message offset from the start of the block |
-| 4     | protobuf message length |
-| 1     | message type. 0 for `LightHeader` *(as described in lightheader.proto)*, 1 for `view_preferences.proto`, or 2 for gps data  |
-| 7     | reserved |
+Still early days. Some things work, some things don't.
+
+I've details what I know about the LRI format in [LRI.md](LRI.md).
+
+And details about a weird format they use called Bayer JPEG described in [bayer_jpeg.md](bayer_jpeg.md)
+
+I took some notes as I worked on this that are in [NOTES.md](NOTES.md) if you're interested in that.
+
+## lri-rs
+A Rust crate for parsing LRI files. This library isn't perfect, but it works enough to be able to grab image data from the filee.
+
+## prism
+Breaks an LRI into the individual images it contains.
+
+TODO: I'd like to, one day, be able to write DNG files from prism, but currently it just spits out PNG.
+
+## lri-proto
+This is a gently modified version of the [dllu/lri.rs](https://github.com/dllu/lri-rs) repository. Without the work from Daniel pulling the protobuf definitions from the Lumen software I truly don't know if I could've got as far as I did.
+
+MIT Copyright Daniel Lawrence Lu
+
+## lri-study
+Run with the arguments `gather <path>` to print information about the LRI files in the directory to stdout.
+
+This was very useful to me while developing lri-rs to be able to see if patterns repeated across many different images so I could make some assumptions.
+
+### Licensing?
+`lri-proto` is MIT Copyright Daniel Lawrence Lu.
+
+everything else is ISC copyright gennyble <gen@nyble.dev>.
+
+Just means you have to provide attribution to the correct person if you use this code and that you're free to do with it what you like.
\ No newline at end of file