-
Notifications
You must be signed in to change notification settings - Fork 27
fix(flac): write a valid last metadata block header #113
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mathiiiiiis
wants to merge
1
commit into
ClementBeal:main
Choose a base branch
from
mathiiiiiis:fix/flac-block-header
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+160
−95
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Binary file not shown.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| import 'dart:io'; | ||
|
|
||
| import 'package:audio_metadata_reader/audio_metadata_reader.dart'; | ||
| import 'package:test/test.dart'; | ||
|
|
||
| typedef _Header = ({bool isLast, int type, int length}); | ||
|
|
||
| List<_Header> _readBlocks(File file) { | ||
| final bytes = file.readAsBytesSync(); | ||
| expect(String.fromCharCodes(bytes.sublist(0, 4)), equals('fLaC')); | ||
|
|
||
| final headers = <_Header>[]; | ||
| var pos = 4; | ||
| while (true) { | ||
| final isLast = bytes[pos] >> 7 == 1; | ||
| final type = bytes[pos] & 0x7F; | ||
| final length = bytes[pos + 3] | bytes[pos + 2] << 8 | bytes[pos + 1] << 16; | ||
| headers.add((isLast: isLast, type: type, length: length)); | ||
| pos += 4 + length; | ||
| if (isLast) break; | ||
| expect(pos, lessThan(bytes.length), reason: 'ran past end of file'); | ||
| } | ||
| return headers; | ||
| } | ||
|
|
||
| void main() { | ||
| for (final fixture in ['no_picture.flac', 'picture_last.flac']) { | ||
| group(fixture, () { | ||
| late File target; | ||
|
|
||
| setUp(() { | ||
| final dir = Directory.systemTemp.createTempSync(); | ||
| addTearDown(() => dir.deleteSync(recursive: true)); | ||
| target = File('${dir.path}/track.flac'); | ||
| target.writeAsBytesSync(File('test/flac/$fixture').readAsBytesSync()); | ||
| }); | ||
|
|
||
| test('every block header carries a valid type', () { | ||
| updateMetadata(target, (m) => m.setTitle('Updated title')); | ||
|
|
||
| for (final block in _readBlocks(target)) { | ||
| expect(block.type, lessThan(7), | ||
| reason: 'type ${block.type} is reserved'); | ||
| expect(block.type, isNot(equals(127))); | ||
| } | ||
| }); | ||
|
|
||
| test('exactly one last block flag and it is on the final block', () { | ||
| updateMetadata(target, (m) => m.setTitle('Updated title')); | ||
|
|
||
| final blocks = _readBlocks(target); | ||
| expect(blocks.where((b) => b.isLast).length, equals(1)); | ||
| expect(blocks.last.isLast, isTrue); | ||
| }); | ||
|
|
||
| test('repeated writes stay valid', () { | ||
| for (var i = 0; i < 3; i++) { | ||
| updateMetadata(target, (m) => m.setTitle('Pass $i')); | ||
| } | ||
| expect(readMetadata(target, getImage: false).title, equals('Pass 2')); | ||
| expect(_readBlocks(target).last.isLast, isTrue); | ||
| }); | ||
|
|
||
| test('date is written as ISO 8601', () { | ||
| updateMetadata(target, (m) => m.setYear(DateTime(2012, 8, 22))); | ||
|
|
||
| final bytes = target.readAsBytesSync(); | ||
| expect(String.fromCharCodes(bytes).contains('DATE=2012-08-22'), isTrue); | ||
| expect( | ||
| String.fromCharCodes(bytes).contains('DATE=2012/08/22'), isFalse); | ||
| }); | ||
|
|
||
| test('blocks other than comment and picture survive', () { | ||
| final before = | ||
| _readBlocks(target).where((b) => b.type != 4 && b.type != 6); | ||
| updateMetadata(target, (m) => m.setTitle('Updated title')); | ||
| final after = | ||
| _readBlocks(target).where((b) => b.type != 4 && b.type != 6); | ||
|
|
||
| expect(after.map((b) => b.type).toList(), | ||
| equals(before.map((b) => b.type).toList())); | ||
| }); | ||
| }); | ||
| } | ||
| } |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you explain why we should change the date format from YYYY/MM/DD to YYYY-MM-DD?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Xiph's VorbisComments spec says that date fields must be ISO 8601 (YYYY-MM-DD, YYYY-MM or YYYY), the previous YYYY/MM/DD is not one of them
As an example: Android's MediaStore doesn't parse the slash form, so a file loses the release date as soon as it's written. That's how I found it
The parser already handles both, so older files still read back normally