NAME
    App::SubtitleUtils - Utilities related to video subtitles

VERSION
    This document describes version 0.007 of App::SubtitleUtils (from Perl
    distribution App-SubtitleUtils), released on 2022-11-10.

DESCRIPTION
    This distributions provides the following command-line utilities:

    *   srtadjust

    *   srtcalc

    *   srtcheck

    *   srtcombinetext

    *   srtparse

    *   srtrenumber

    *   srtscale

    *   srtshift

    *   srtsplit

    *   subscale

    *   subshift

    *   vtt2srt

FUNCTIONS
  srtcheck
    Usage:

     srtcheck(%args) -> [$status_code, $reason, $payload, \%result_meta]

    Check the properness of SRT file.

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   filename* => *filename*

        (No description)

    Returns an enveloped result (an array).

    First element ($status_code) is an integer containing HTTP-like status
    code (200 means OK, 4xx caller error, 5xx function error). Second
    element ($reason) is a string containing error message, or something
    like "OK" if status is 200. Third element ($payload) is the actual
    result, but usually not present when enveloped result is an error
    response ($status_code is not 2xx). Fourth element (%result_meta) is
    called result metadata and is optional, a hash that contains extra
    information, much like how HTTP response headers provide additional
    metadata.

    Return value: (any)

  srtcombinetext
    Usage:

     srtcombinetext(%args) -> [$status_code, $reason, $payload, \%result_meta]

    Combine the text of two or more subtitle files (e.g. for different
    languages) into one.

    This function is not exported by default, but exportable.

    Arguments ('*' denotes required arguments):

    *   eval => *str*

        Perl code to evaluate on every text.

        This code will be evaluated for every text of each entry of each
        SRT. $_ will be set to the text, $entry to the entry hash, $j to the
        index of the files (starts at 0).

        The code is expected to modify $_.

    *   filenames* => *array[filename]*

        (No description)

    Returns an enveloped result (an array).

    First element ($status_code) is an integer containing HTTP-like status
    code (200 means OK, 4xx caller error, 5xx function error). Second
    element ($reason) is a string containing error message, or something
    like "OK" if status is 200. Third element ($payload) is the actual
    result, but usually not present when enveloped result is an error
    response ($status_code is not 2xx). Fourth element (%result_meta) is
    called result metadata and is optional, a hash that contains extra
    information, much like how HTTP response headers provide additional
    metadata.

    Return value: (any)

  srtdump
    Usage:

     srtdump(%args) -> [$status_code, $reason, $payload, \%result_meta]

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   parsed* => *hash*

        (No description)

    Returns an enveloped result (an array).

    First element ($status_code) is an integer containing HTTP-like status
    code (200 means OK, 4xx caller error, 5xx function error). Second
    element ($reason) is a string containing error message, or something
    like "OK" if status is 200. Third element ($payload) is the actual
    result, but usually not present when enveloped result is an error
    response ($status_code is not 2xx). Fourth element (%result_meta) is
    called result metadata and is optional, a hash that contains extra
    information, much like how HTTP response headers provide additional
    metadata.

    Return value: (any)

  srtparse
    Usage:

     srtparse(%args) -> [$status_code, $reason, $payload, \%result_meta]

    Parse SRT and return data structure.

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   filename => *filename*

        (No description)

    *   string => *str*

        (No description)

    Returns an enveloped result (an array).

    First element ($status_code) is an integer containing HTTP-like status
    code (200 means OK, 4xx caller error, 5xx function error). Second
    element ($reason) is a string containing error message, or something
    like "OK" if status is 200. Third element ($payload) is the actual
    result, but usually not present when enveloped result is an error
    response ($status_code is not 2xx). Fourth element (%result_meta) is
    called result metadata and is optional, a hash that contains extra
    information, much like how HTTP response headers provide additional
    metadata.

    Return value: (any)

HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/App-SubtitleUtils>.

SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-App-SubtitleUtils>.

SEE ALSO
HISTORY
    Most of them are scripts I first wrote in 2003 and first packaged as
    CPAN distribution in late 2020. They need to be rewritten to properly
    use Getopt::Long etc; someday.

AUTHOR
    perlancar <perlancar@cpan.org>

CONTRIBUTING
    To contribute, you can send patches by email/via RT, or send pull
    requests on GitHub.

    Most of the time, you don't need to build the distribution yourself. You
    can simply modify the code, then test via:

     % prove -l

    If you want to build the distribution (e.g. to try to install it locally
    on your system), you can install Dist::Zilla,
    Dist::Zilla::PluginBundle::Author::PERLANCAR,
    Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two
    other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps
    required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE
    This software is copyright (c) 2022, 2021, 2020 by perlancar
    <perlancar@cpan.org>.

    This is free software; you can redistribute it and/or modify it under
    the same terms as the Perl 5 programming language system itself.

BUGS
    Please report any bugs or feature requests on the bugtracker website
    <https://rt.cpan.org/Public/Dist/Display.html?Name=App-SubtitleUtils>

    When submitting a bug or request, please include a test-file or a patch
    to an existing test-file that illustrates the bug or desired feature.

