Creating the .sigmf archive format
#44
Conversation
sigmf-spec.md
Outdated
|
|
||
| The metadata and dataset files that comprise a SigMF recording may be combined | ||
| into a file archive. Multiple SigMF recordings may be stored in a single | ||
| archive. |
There was a problem hiding this comment.
I think we should discuss the idea of combining multiple recordings separately before putting it in the spec. It is a UI/API complication for anything that wants to read a SigMF recording because you then need more than a file-picker, and people will be tempted to create little languages for representing pathnames-plus-item-in-the-archive, which gets messy.
There was a problem hiding this comment.
Good point - this is perhaps a little more complex than I first anticipated.
sigmf-spec.md
Outdated
| 4. Each SigMF recording (comprised of a metadata file and a dataset file) MUST | ||
| be in separate directories. | ||
| 5. The metadata and dataset files within a directory must have the same | ||
| filenames as the directory itself. |
There was a problem hiding this comment.
I don't like how point 3 is written negatively; it does not rule out that you could have two levels of directories (which is another complication), or using absolute paths (which would be bad).
I would suggest something to the effect of (I don't know what language POSIX uses to describe tar files):
-
The archive MUST contain the following files: for each contained recording with some name given here metasyntactically as
N, files namedN(a directory),N/N.sigmf-meta, andN/N.sigmf-data. -
The archive MUST NOT contain any other files unless their pathnames begin with
N/N.for someNwhich has.sigmf-metaand.sigmf-datafiles as described above.
(The item 4 is to allow for extensions without allowing for arbitrary junk. More minimally, we could say that for now no other files are allowed.)
There was a problem hiding this comment.
I really like your suggestion, @kpreid. Nice work =)
|
Okay, PR updated with the comments from @kpreid, above. Please review & comment! |
This creates a SigMF archive format, per the discussion in #15.
I fleshed out some ideas not previously discussed in #15, including combining multiple recordings into a single SigMF archive, so please review.