Add reading and writing of GP6 (.gpx) and GP7 (.gp) files#62
Closed
knoguchi wants to merge 6 commits into
Closed
Conversation
GP6 and GP7 store the score as a score.gpif XML document inside a container: GP6 uses a BCFZ-compressed BCFS virtual filesystem, while GP7 is a plain ZIP archive. This adds a reader for both. - gpx.py: BCFZ bitstream decompression (based on the algorithm from the feature/gpx branch contributed by J. Jorgen von Bargen), the BCFS sector archive reader, and GP7 ZIP extraction. - gpif.py: maps the score.gpif XML into the existing Song model, resolving the format's cross-referenced bars/voices/beats/notes/rhythms lists. Covers song info, tracks, tunings, master bars and time signatures, voices, beats, durations and notes. - io.py: parse() now detects the BCFZ/BCFS/ZIP magic and dispatches to the new reader; the binary GP3/4/5 path is unchanged. Writing GP6/GP7 is not supported. Advanced note/beat effects are not yet translated. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The BCFZ payload may end mid-byte, so the last compression token can require bits beyond the end of the stream. Yield zero padding bits past end-of-stream instead of raising IndexError, matching the reference decoder's EOF handling. Add "Dear Song.gpx" which exercises this path. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Synthesize a GP7 archive from an existing .gpx score's score.gpif and assert it parses into an identical Song, covering the ZIP extraction branch without committing a binary GP7 fixture. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
guitarpro.write can now produce GP6 and GP7 files, completing the read/write parity the library offers for GP3/4/5. - gpif.py: GPIFWriter serializes a Song into a score.gpif document, hoisting the measure/voice/beat/note tree into the format's flat, cross-referenced Bars/Voices/Beats/Notes/Rhythms lists. - gpx.py: BCFZ compression (literal-run encoding, which is valid BCFZ and keeps the encoder linear) and a BCFS image builder; GP7 is written as a ZIP archive. - io.py: write() dispatches to the GPX writer for version (6,0,0)/(7,0,0) or a .gpx/.gp extension. Round-trips parse -> write -> parse with full Song equality. Writes cover the same subset of the model that reading populates; advanced effects are not yet serialized. Also tightened voice reading to skip unused (-1) voice slots so the voice count is deterministic across a round-trip. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Buffer non-seekable streams before the magic peek so parse() works on pipes and other non-seekable file-like objects. - Raise GPException (not KeyError) when a GP6 container has no score.gpif. - Emit one Bar per track in every MasterBar so the Bars reference list has a consistent length. - Drop the internal buildBCFS helper from the module's public __all__. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Author
|
I'd like someone to test GP7 files. Also I'm working on another PR to support GP6/GP7 effects such as hammer/pull, slides, harmonics, fingering, accent, beat text. |
The declared uncompressed length is only an upper bound: real GP6 streams that use back-references end before reaching it, with the final byte zero-padded. The previous code padded past end-of-stream with zero bits, which decode to empty literal runs and made decompression loop forever on any such file (the literal-heavy sample files happened to hit the declared length exactly and so were unaffected). Raise at end-of-stream and stop, matching the reference decoder. Verified against the alphaTab GP6 test corpus: all 35 files now decompress, parse and round-trip. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Author
|
just saw #58 for the same purpose and closed. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds support for the GP6 (
.gpx) and GP7 (.gp) container formats to bothguitarpro.parseandguitarpro.write, giving the library read/write coverage for these formats alongside the existing GP3/GP4/GP5 binary support.gpx.py— the container layer: BCFZ bitstream (de)compression, the BCFS sector archive reader/writer, and GP7 ZIP handling. The decompression algorithm is based on code contributed by J. Jørgen von Bargen on the oldfeature/gpxbranch.gpif.py— maps the embeddedscore.gpifXML into and out of the existingSongmodel. The model is a tree (Measure → Voice → Beat → Note) while GPIF stores flat, cross-referenced lists joined byid; the reader resolves those references and the writer hoists the tree back into them.io.py—parse()detects theBCFZ/BCFS/PKmagic and dispatches to the new reader;write()dispatches to the new writer forversion=(6, 0, 0)/(7, 0, 0)or a.gpx/.gpextension. The binary GP3/4/5 path is unchanged.Coverage
Reads and writes the core musical content: song info, tracks and tunings, master bars and time signatures, repeats, voices, beats, durations (incl. dotted notes and tuplets), dynamics and notes (fret/string/tie). Advanced note and beat effects (bends, harmonics, slides, grace notes, palm mute, …) are not yet translated.
Tests
parse → write → parseround-trips with fullSongequality and hash equality, matching the existingtestReadWriteEqualspattern. New tests cover:compress/decompressidentityscore.gpifAll 208 tests pass.
Two caveats worth flagging
score.gpifis well-formed and self-consistent, but app-level compatibility is unverified.I'm aware the project previously listed GPX as out of scope — happy to adjust scope, naming, or the compression approach if you'd consider it.
🤖 Generated with Claude Code