feat: added support for ani-skip to skip episode intros

[AzureOrange404]

Pull Request

Type of change

• [ ] Bug fix
• [x] Feature
• [ ] Documentation update

Description

I saw the issue #1223 and sympathized with the idea of skipping intros. So implemented the skipping function into ani-cli (it still needs ani-skip to be installed though.)

Skipping does not work for all anime I've tested, but does for some. If ani-skip fails, ani-cli just prints a message stating, that it failed and proceeds as normal.

Also it only works with mpv (due to how ani-skip works) and this is noted in the help function as well as the man page.

Checklist

• [x] any anime playing

• [x] bumped version

• [x] next, prev and replay work
• [x] -c history and continue work
• [x] -d downloads work
• [x] -s syncplay works
• [x] -q quality works
• [x] -v vlc works
• [x] -e select episode works
• [x] -S select index works
• [x] -r range selection works
• [x] --dub and regular (sub) mode both work

• [x] all providers return links (not necessarily on a single anime, use debug mode to confirm)

• [x] -h help info is up to date
• [x] Readme is up to date
• [x] Man page is up to date

Additional Testcases

• The safe bet: One Piece
• Episode 0: Saenai Heroine no Sodatekata ♭
• Unicode: Saenai Heroine no Sodatekata ♭
• Non-whole episodes: Tensei shitara slime datta ken (ep. 24.5, ep. 24.9)

[synacktraa]

You did a nice job implementing the feature in a way that's consistent to the other parts of the script. There's just one thing missing: ani-skip install instructions in the readme. There should be a reference to their instructions with some description on what it does

Hi, I am opening a pull request to include the ani-skip directly into ani-cli. There's no need to include ani-skip as a dependency.

It would be nice, If this PR is merged first. I'll only have to replace the function.

[synacktraa]

I've also wrote a lua script for vlc player. VLC is not as flexible as MPV, We'll need to find a suitable way to pass in options or hard-code them.

[lasersPew]

Before you accept this pr, it would be better if you add ani-skip onto the features and the dependency requirements. Additionally, warn windows users as I get ani-skip not installed and there's no official app for it.

[synacktraa]

Before you accept this pr, it would be better if you add ani-skip onto the features and the dependency requirements. Additionally, warn windows users as I get ani-skip not installed and there's no official app for it.

I'll include the code directly into ani-cli script, you won't have to install ani-skip explicitly

[Derisis13]

Hi, I am opening a pull request to include the ani-skip directly into ani-cli. There's no need to include ani-skip as a dependency.

It would be nice, If this PR is merged first. I'll only have to replace the function.

I'm against including lines of code instead of an available solution: just as we outsourced our ui to fzf and rofi, I see no point in re-implementing ani-skip. The reason is we have to maintain our code, but dependencies take care of themselves.

This PR looks fine as is.

[Derisis13]

I've also wrote a lua script for vlc player. VLC is not as flexible as MPV, We'll need to find a suitable way to pass in options or hard-code them.

This is welcome once the PR is merged

[AzureOrange404]

Sorry about the thousend commits on the readme, it's definitely to late to work now ... haha. Is there a script or something to do all the checks before commiting them?

You did a nice job implementing the feature in a way that's consistent to the other parts of the script. There's just one thing missing: ani-skip install instructions in the readme. There should be a reference to their instructions with some description on what it does

I did update the README as well, I've put everything under the dependencies section (should be fine I guess).

Before you accept this pr, it would be better if you add ani-skip onto the features and the dependency requirements. Additionally, warn windows users as I get ani-skip not installed and there's no official app for it.

I added a warning to the ani-skip description. I should work under Android and MacOS right? (Not shure about iOS though.)

[port19x]

I can test mac compatibility tomorrow, code and readme looks good. I'm also against inclusion of ani-skip code in mainline, unless the expansion over the currently proposed solution would be negligible. Either way I'm in favour of merging early and making concessions to windows users later.

[Derisis13]

I'm also against inclusion of ani-skip code in mainline, unless the expansion over the currently proposed solution would be negligible

it's 27 lines of shell scripting and another 27 lines of lua. Since we can't include the lua scrip anyway I'd leave ani-skip in the hands of its current maintainer.

[synacktraa]

I'm also against inclusion of ani-skip code in mainline, unless the expansion over the currently proposed solution would be negligible

it's 27 lines of shell scripting and another 27 lines of lua. Since we can't include the lua scrip anyway I'd leave ani-skip in the hands of its current maintainer.

Yes, lua scripts are another issue.

[71zenith]

Pls add the copying of ani-skip shell script to $PATH in the readme install instructions

[synacktraa]

Pls add the copying of ani-skip shell script to $PATH in the readme install instructions

I have updated it, do tell me If there are any more issues with ani-skip.

Update the ani-cli's get_skip_times, as I've updated ani-skip script. So now you'll have to just call ani-skip, it will handle the errors itself.

[71zenith]

@synacktraa pls make the script in the repo an executable to reduce the install steps

[synacktraa]

@synacktraa pls make the script in the repo an executable to reduce the install steps

Done. Interesting, I had no idea it could be done like that

[AzureOrange404]

ani-cli should not exit on a failed retrieval of skip_argument. get_skip_times may be omitted as per review of @synacktraa

it is only exiting if the dependency is missing, otherwise it prints a warning, but still runs. I'll look in to the rest of the suggestions though.

Edit: Ah I see, the error is now printed by ani-skip directly, I'll include the changes.

[AzureOrange404]

I have updated it, do tell me If there are any more issues with ani-skip.

Update the ani-cli's get_skip_times, as I've updated ani-skip script. So now you'll have to just call ani-skip, it will handle the errors itself.

I don't know if it's just me, but now the player jumps to 0:00 after skipping. I get this mpv error:

[skip] Error: Can't convert '301.499 --script=/home/azure/.config/mpv/scripts/skip.lua' to number!
[skip] script-opts: error converting value '301.499 --script=/home/azure/.config/mpv/scripts/skip.lua' for key 'end_time'

[synacktraa]

I have updated it, do tell me If there are any more issues with ani-skip.

Update the ani-cli's get_skip_times, as I've updated ani-skip script. So now you'll have to just call ani-skip, it will handle the errors itself.

I don't know if it's just me, but now the player jumps to 0:00 after skipping.

I get this mpv error:

[skip] Error: Can't convert '301.499 --script=/home/azure/.config/mpv/scripts/skip.lua' to number!

[skip] script-opts: error converting value '301.499 --script=/home/azure/.config/mpv/scripts/skip.lua' for key 'end_time'

Wait, I'll look into it

[AzureOrange404]

Wait, I'll look into it

If mpv is run manually, it works. It's just the implementation via ani-cli. I guess somehow due to variable handling.

Try:

mpv "$(ani-skip "Ansatsu Kyoushitsu (TV) (22 episodes)" 1)" https://video.wixstatic.com/video/f5c58e_f62ec058c47d41798e86987023d35063/1080p/mp4/file.mp4

[synacktraa]

If mpv is run manually, it works. It's just the implementation via ani-cli. I guess somehow due to variable handling.

Try:

mpv "$(ani-skip "Ansatsu Kyoushitsu (TV) (22 episodes)" 1)" https://video.wixstatic.com/video/f5c58e_f62ec058c47d41798e86987023d35063/1080p/mp4/file.mp4

Can you once show how is it being in your ani-cli?

[AzureOrange404]

Can you once show how is it being in your ani-cli?

I implemeted your changes:

mpv*) nohup "$player_function" "$skip_flag" --force-media-title="${allanime_title}Episode ${ep_no}" "$episode" >/dev/null 2>&1 & ;;

[synacktraa]

Can you once show how is it being in your ani-cli?

I implemeted your changes:

mpv*) nohup "$player_function" "$skip_flag" --force-media-title="${allanime_title}Episode ${ep_no}" "$episode" >/dev/null 2>&1 & ;;

remove quotes from $skip_flag, as it has two flags

[AzureOrange404]

remove quotes from $skip_flag, as it has two flags

That's the problem, shellcheck will complain if the quotes are removed. There is no way (I know of) in POSIX to pass two flags to a command using one variable. (That's why I had two variables before, I guess.)

[synacktraa]

remove quotes from $skip_flag, as it has two flags

That's the problem, shellcheck will complain if the quotes are removed. There is no way (I know of) in POSIX to pass two flags to a command using one variable. (That's why I had two variables before, I guess.)

Yeah, I get it. My previous script was not even including the lua script but I thought ani-skip script should be the one to return the script and script-opts flag together. let's see what maintainers say and then I'll update ani-skip accordingly.

[AzureOrange404]

Yeah, I get it. My previous script was not even including the lua script but I thought ani-skip script should be the one to return the script and script-opts flag together. let's see what maintainers say and then I'll update ani-skip accordingly.

I could just split your output to two variables, would be no problem.

at all I just saw that, if there is no output (e. g. anime missing) and the flag is empty '', mpv throws the following error:

[file] Cannot open file '': No such file or directory
Failed to open .

But if everyone's fine with this, it can just be ignored.

[synacktraa]

I could just split your output to two variables, would be no problem.

at all I just saw that, if there is no output (e. g. anime missing) and the flag is empty '', mpv throws the following error:

[file] Cannot open file '': No such file or directory
Failed to open .

But if everyone's fine with this, it can just be ignored.

Or we can just call it like this:

mpv*) nohup "$player_function" --force-media-title="${allanime_title}Episode ${ep_no}" "$episode" "$skip_flag" >/dev/null 2>&1 & ;;

[AzureOrange404]

Or we can just call it like this:

mpv*) nohup "$player_function" --force-media-title="${allanime_title}Episode ${ep_no}" "$episode" "$skip_flag" >/dev/null 2>&1 & ;;

Yeah, then the errors just appear after the video finished, but it doesn't matter as they are suppressed by nohup anyways.

[synacktraa]

Or we can just call it like this:

mpv*) nohup "$player_function" --force-media-title="${allanime_title}Episode ${ep_no}" "$episode" "$skip_flag" >/dev/null 2>&1 & ;;

Yeah, then the errors just appear after the video finished, but it doesn't matter as they are suppressed by nohup anyways.

You already pushed the changes :), I was planning to do something about it.

[AzureOrange404]

You already pushed the changes :), I was planning to do something about it.

Oh haha, yeah you still can, I guess. I'll just annoy everyone with another commit. :)

[port19x]

remove quotes from $skip_flag, as it has two flags

That's the problem, shellcheck will complain if the quotes are removed. There is no way (I know of) in POSIX to pass two flags to a command using one variable. (That's why I had two variables before, I guess.)

That's because this is one of the few instances where you actually want shell word splitting. You can add a shellcheck ignore directive as found in a few other places in the script

[synacktraa]

That's because this is one of the few instances where you actually want shell word splitting.

You can add a shellcheck ignore directive as found in a few other places in the script

If quotes can be omitted, it will also get rid of the empty $skip_flag issue

[synacktraa]

@port19x Is this the correct shellcheck? # shellcheck disable=SC2086

[CoolnsX]

if your shellcheck complains, you can run shellcheck outside of script like this --

shellcheck ani-cli

it will spit out warnings/errors and also those SCXXXX error codes, just copy and paste them just above the line of code where you want to disable it.

[CoolnsX]

@port19x Is this the correct shellcheck? # shellcheck disable=SC2086

yes

[synacktraa]

if your shellcheck complains, you can run shellcheck outside of script like this --

shellcheck ani-cli

it will spit out warnings/errors and also those SCXXXX error codes, just copy and paste them just above the line of code where you want to disable it.

@AzureOrange404 Update it accordingly, you should have waited for the solution before committing :>

[AzureOrange404]

That's because this is one of the few instances where you actually want shell word splitting. You can add a shellcheck ignore directive as found in a few other places in the script

Didn't know, didn't look it up. But now it's implemented and it works, thanks.

@AzureOrange404 Update it accordingly, you should have waited for the solution before committing :>

Yeah, maybe I should have, haha.

[justchokingaround]

dick, and additionally, balls

[AzureOrange404]

@synacktraa Could you change printf in ani-skip line 37 to die? Otherwise it'll still output. ;)

[justchokingaround]

also why tf are we using an external script with ani-skip. i get why the lua script is needed, but why call another script inside of ani-cli ?

(this can probably be answered if i backread the whole thread, but i won't be doing that)

[synacktraa]

@synacktraa Could you change printf in ani-skip line 37 to die? Otherwise it'll still output. ;)

Yeah, what a stupid mistake

[port19x]

also why tf are we using an external script with ani-skip. i get why the lua script is needed, but why call another script inside of ani-cli ?

(this can probably be answered if i backread the whole thread, but i won't be doing that)

Because it's a preexisting solution from what I've gathered and we delegate responsibility and locs that way

[port19x]

Perhaps tomorrow I'll finally get around to the mac testing I promised

[71zenith]

Since we are using the unquoted variable approach, it would be much better to implement a proper player argument option and integrate ani-skip in it. however that can be left to 4.7.x

[71zenith]

@synacktraa can u state a testcase anime and episode for ani-skip

[71zenith]

@synacktraa also pls implement skipping for outro as well

[71zenith]

modify the script to redirect stderr if the script cannot find the anime dont rely on a edge case

[71zenith]

did none of u check if this runs, modify ani-cli or ani-skip to discard the (n episodes) MAL is already extremely picky and does not have the best search engine, it will never give the right results if we add unnecessary metadata to the query

[synacktraa]

modify the script to redirect stderr if the script cannot find the anime

dont rely on a edge case

Isn't die function already redirecting it to stderr?

[synacktraa]

did none of u check if this runs, modify ani-cli or ani-skip to discard the (n episodes)

MAL is already extremely picky and does not have the best search engine, it will never give the right results if we add unnecessary metadata to the query

I haven't tested ani-skip with ani-cli yet, been just resolving ani-skip issues

[71zenith]

my bad, it looks like it does discard the (n episodes) however it seems that u try to match the exact title name in the mal results. this however will more than likely not work for anime with >1 seasons and those which are named differently in allanime

[synacktraa]

did none of u check if this runs, modify ani-cli or ani-skip to discard the (n episodes)

MAL is already extremely picky and does not have the best search engine, it will never give the right results if we add unnecessary metadata to the query

I haven't tested ani-skip with ani-cli yet, been just resolving ani-skip issues

Tell me if you're modifying ani-cli, else I'll do something with ani-skip