cwhite92 / scene-release-parser-php
Requires (Dev)
- codeclimate/php-test-reporter: dev-master
- phpunit/phpunit: ^6.2
This package is not auto-updated.
Last update: 2024-11-07 01:59:18 UTC
README
PHP Library parsing a scene release name to retrieve title and tags (original from majestixx/scene-release-parser-php-lib).
The library is made of one class : thcolin\SceneReleaseParser\Release
, the constructor will try to extract all the tags from the release name and creates getters
for each one, remaining parts will construct the title of the media (movie or tv show).
Installation
Install with composer :
composer require thcolin/scene-release-parser dev-master
Release Example :
Easiest way to start using the lib is to instantiating a new Release
object with a scene release name as first argument, it will retrieve all the tags and the name :
use thcolin\SceneReleaseParser\Release; // Optionals arguments $strict = true; // if no tags found, it will throw an exception $defaults = []; // defaults values for : language, resolution and year $Release = new Release("Mr.Robot.S01E05.PROPER.VOSTFR.720p.WEB-DL.DD5.1.H264-ARK01", $strict, $defaults); // TYPE echo($Release -> getType()); // tvshow (::TVSHOW) // TITLE echo($Release -> getTitle()); // Mr Robot // LANGUAGE echo($Release -> getLanguage()); // VOSTFR // YEAR echo($Release -> getYear()); // null (no tag in the release name) echo($Release -> guessYear()); // 2015 (year of the system) echo($Release -> guess() -> getYear()); // 2015 (year of the system) // RESOLUTION echo($Release -> getResolution()); // 720p // SOURCE echo($Release -> getSource()); // WEB // DUB echo($Release -> getDub()); // null (no tag in the release name) // ENCODING echo($Release -> getEncoding()); // h264 // GROUP echo($Release -> getGroup()); // ARK01 // FLAGS print_r($Release -> getFlags()); // [PROPER, DD5.1] // SCORE echo($Release -> getScore()); // 7 (bigger is better, max : 7) // ONLY TVSHOW echo($Release -> getSeason()); // 1 echo($Release -> getEpisode()); // 5
Guess
Unknown informations of a current Release
can be guessed :
use thcolin\SceneReleaseParser\Release; $Release = new Release("Bataille a Seattle BDRip", false, [ 'language' => 'FRENCH' // default to Release::LANGUAGE_DEFAULT (VO) ]); // LANGUAGE echo($Release -> getLanguage()); // null echo($Release -> guessLanguage()); // FRENCH // RESOLUTION echo($Release -> getResolution()); // null echo($Release -> guessResolution()); // SD // YEAR echo($Release -> getYear()); // null echo($Release -> guessYear()); // 2017 (current year) // Will set guessed values to the Release $Release -> guess(); // LANGUAGE echo($Release -> getLanguage()); // FRENCH // RESOLUTION echo($Release -> getResolution()); // SD // YEAR echo($Release -> getYear()); // 2017 (current year)
Analyze
For best results, you can directly analyze a file
, the method will use mediainfo
:
use thcolin\SceneReleaseParser\Release; // Mhor\MediaInfo::setConfig arguments (default to empty) $mediainfo = [ // Optional, just for example 'command' => '/usr/local/bin/mediainfo' ]; $Release = Release::analyze('/home/downloads/Bataille a Seattle BDRip.avi', $mediainfo); // RELEASE echo($Release -> getRelease(Release::GENERATED_RELEASE)): // Bataille.A.Seattle.FRENCH.720p.BDRip.x264-NOTEAM // RESOLUTION echo($Release -> getResolution()); // 720p // ENCODING echo($Release -> getEncoding()); // x264 // LANGUAGE echo($Release -> getLanguage()); // FRENCH
Bin
Inside bin
folder, you got a scene-release-renamer
executable, which require a <path>
argument (default to current working directory). It will scan <path>
, searching for video files (avi, mp4, mkv, mov) and folders to rename (if dirty) with valid generated scene release name. Scene release name will be constructed with current file name and mediainfo
parsed informations (if available). If errors comes up, you'll be able to fix them manually.
Usage
php bin/scene-release-renamer <path> [--non-verbose] [--non-interactive] [--non-invasive] [--mediainfo=/usr/local/bin/mediainfo] [--default-(language|resolution|year)=value]
Results :
Tests
Use PHPUnit, there is a script to generate the json data for the tests in the folder /utils
, it will take the release names from the releases.txt
file in the same folder. Use it to generate the data needed for the tests, but before testing, make sure all the datas generated are valid, if not this would be useless.
Bugs
TODO
Release->guessResolution()
should consider$Release->source
- Add
Release::LANGUAGE_*
constants- Use them in
ReleaseTest
- And
README ## Guess
- Use them in
- Add
boolean $flags
forRelease::__toString
- implement option in
Release::getRelease
too - if
true
will addRelease->flags
to generated release name
- implement option in
- Resolve CodeCoverage issues