Prepare 0.2.1

Author: donmai-me

CHANGELOG.md

@@ -4,10 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.2.1] - 2021-09-01
 ### Added
 - This changelog
 
+### Fixed
+- Fixed bug in non-encrypted USM creation by [@emoose](https://github.com/emoose).
+
 ## [0.2.0] - 2021-08-11
 ### Added
 - __main__.py.
@@ -24,5 +27,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed bug in extractusm that causes it to fail when output directory doesn't exist.
 - Fixed bug where program fails when directory exists.
 
-[Unreleased]: https://github.com/donmai-me/WannaCRI/compare/0.2.0...HEAD
+[0.2.1]: https://github.com/donmai-me/WannaCRI/compare/0.2.0...0.2.1
 [0.2.0]: https://github.com/donmai-me/WannaCRI/compare/0.1.0...0.2.0

README.md

@@ -5,12 +5,32 @@ WannaCRI
 A (WIP) Python library for parsing, extracting, and generating Criware's various audio and video file formats.
 If you're interested in reading more about USM, you can read my write-up about it [here](https://listed.to/@donmai/24921/criware-s-usm-format-part-1)
 
-Currently supports the following formats with more planned:
-* USM (encrypted and plaintext)
-    * VP9
-    * H.264 (in-progress)
+Support
+=======
+This currently supports the following formats with more planned:
+
+✅: Implemented and tested ❓: Should work but not tested ❌: Not implemented
+
+x/y: Extract support / Create support
+
+## USM
+
+### Video
+
+| Codec | Not-encrypted | Encrypted |
+| ----- | ----- | ----- |
+| VP9 | ✅ / ✅  | ✅ / ✅  |
+| H.264 | ✅ / ❌ | ❓ / ❌ |
+| Prime | ❓ / ❌ | ❓ / ❌ |
+
+### Audio
 
+| Codec | Not-encrypted | Encrypted |
+| ----- | ----- | ----- |
+| CRI HCA | ✅ / ❌ | ✅ / ❌ |
 
+Requirements
+============
 This library has the following requirements:
 
 A working FFmpeg and FFprobe installation. On Windows, you can download official ffmpeg and ffprobe binaries and place them on your path.

wannacri/codec.py

@@ -14,7 +14,7 @@ def from_file(path: str, ffprobe_path: str = "ffprobe") -> Sofdec2Codec:
         info = ffmpeg.probe(path, cmd=ffprobe_path)
 
         if len(info.get("streams")) == 0:
-            raise ValueError("File has no videos streams.")
+            raise ValueError("File has no video streams.")
 
         codec_name = info.get("streams")[0].get("codec_name")
         if codec_name == "vp9":
@@ -26,7 +26,7 @@ def from_file(path: str, ffprobe_path: str = "ffprobe") -> Sofdec2Codec:
             # TODO: Check if we need to have extra checks on h264 bitstreams
             return Sofdec2Codec.H264
         if codec_name == "mpeg2video":
-            # TODO: Check if we need to have extra checks on h264 bitstreams
+            # TODO: Check if we need to have extra checks on MPEG2 bitstreams
             return Sofdec2Codec.PRIME
 
         raise ValueError(f"Unknown codec {codec_name}")