https://github.com/federicobond/python-fseq

A Falcon Pi Player fseq (v2) sequence file parser.
https://github.com/federicobond/python-fseq

dmx falcon-pi-player fseq xlights

Last synced: 3 months ago
JSON representation

A Falcon Pi Player fseq (v2) sequence file parser.

• Host: GitHub
• URL: https://github.com/federicobond/python-fseq
• Owner: federicobond
• License: mit
• Created: 2019-03-08T21:53:10.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-19T08:26:13.000Z (about 1 year ago)
• Last Synced: 2023-12-19T11:07:41.534Z (about 1 year ago)
• Topics: dmx, falcon-pi-player, fseq, xlights
• Language: Python
• Homepage:
• Size: 81.3 MB
• Stars: 5
• Watchers: 4
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
python-fseq

===========

A Falcon Pi Player fseq (v2) sequence file parser.

### Installation

    pip install fseq

### Usage

To use the project:

    import fseq

    f = open('filename.fseq')

    fseq.parse(f)

The `parse` function returns a `Fseq` object with the following properties:

 * `file`: the underlying file object

 * `version`: a 2-tuple of numbers containing major and minor version

 * `minor_version`: the minor version number

 * `major_version`: the major version number

 * `channel_count_per_frame`: the amount of channels in each frame

 * `number_of_frames`: the total number of frames in this sequence

 * `step_time_in_ms`: the number of milliseconds between each frame

 * `unique_id`: a unique indentified

 * `compression_type`: the compression type used for frames, either `none`, `zstd`, `zlib`

 * `variable_headers`: an array of 2-tuples containing key-value pairs describing additional headers for the sequence file

To access a single frame data use the `get_frame(index)` method on the `Fseq`

object. Use index access to read channel values:

    frame = fseq_file.get_frame(index)

    value = frame[channel_num]

### Development

To run the all tests run:

    tox

### TODO

 * Add support for fseq files without compression

 * Add support for fseq files with Zlib compression

 * Add support for fseq files with sparse ranges

 * Add support for writing fseq files

### License

MIT

## Author

Federico Bond