added os-specific download & install functions

Author: tikuma-lsuhsc

.github/workflows/test_n_pub.yml

@@ -46,11 +46,9 @@ jobs:
 
       - name: Setup Python dependencies
         run: |
-          python -m pip install -U pip
-          pip install -U build pytest pytest-github-actions-annotate-failures 
-          pip install -U numpy
+          python -m pip install -U pip pytest pytest-github-actions-annotate-failures 
 
-      - name: Install ffmpegio_downloader package
+      - name: Install ffmpeg_downloader package
         run: pip install -q .
 
       - name: Run tests

pyproject.toml

@@ -1,3 +1,6 @@
 [build-system]
 requires = ["setuptools >= 40.9.0", "wheel"]
 build-backend = "setuptools.build_meta"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

tests/test_appdirs.py renamed to sandbox/test_appdirs.py

@@ -1 +1,10 @@
-__version__ = '0.0.0'
+__version__ = "0.0.0"
+
+import sys
+
+if sys.platform in ("win32", "cygwin"):
+    from ._win32 import download_n_install, get_version
+elif sys.platform == "darwin":
+    from ._macos import download_n_install, get_version
+else:
+    from ._linux import download_n_install, get_version

tests/test_py7z.py renamed to sandbox/test_py7z.py

@@ -0,0 +1,52 @@
+from urllib import request
+from contextlib import contextmanager
+import os, stat
+
+
+@contextmanager
+def download_base(url, content_type, ctx=None):
+    with request.urlopen(url, timeout=1.0, context=ctx) as response:
+        # pprint(response.headers.get_content_type())
+        if response.headers.get_content_type() != content_type:
+            raise RuntimeError(f'"{url}" is not the expected content type.')
+        try:
+            nbytes = int(response.getheader("content-length"))
+        except:
+            nbytes = 0
+        yield response, nbytes
+
+
+def download_info(url, content_type, ctx=None):
+    with download_base(url, content_type, ctx) as (response, nbytes):
+        info = response.read().decode("utf-8")
+    return info
+
+
+def download_file(outfile, url, content_type, ctx=None, progress=None):
+
+    if progress:
+        progress(0, 1)
+
+    with download_base(url, content_type, ctx) as (response, nbytes):
+
+        blksz = nbytes // 32 or 1024 * 1024
+        with open(outfile, "wb") as f:
+            nread = 0
+            while True:
+                b = response.read(blksz)
+                if not b:
+                    break
+                f.write(b)
+                nread += len(b)
+                if progress:
+                    progress(nread, nbytes)
+
+    return outfile
+
+
+def chmod(binfile):
+    # Set bits for execution and read for all users.
+    exe_bits = stat.S_IXOTH | stat.S_IXUSR | stat.S_IXGRP
+    read_bits = stat.S_IRUSR | stat.S_IRGRP | stat.S_IXGRP
+    write_bits = stat.S_IWUSR | stat.S_IWGRP | stat.S_IWGRP
+    os.chmod(binfile, exe_bits | read_bits | write_bits)

src/ffmpeg_downloader/__init__.py

@@ -0,0 +1,58 @@
+from tempfile import TemporaryDirectory
+from ._download_helper import download_info, download_file, chmod
+import re, ssl, tarfile, os, shutil
+from os import path
+
+ctx = ssl.create_default_context()
+ctx.check_hostname = False
+ctx.verify_mode = ssl.CERT_NONE
+
+
+def get_version():
+
+    return re.search(
+        r"version: (\d+\.\d+(?:\.\d+)?)",
+        download_info(
+            "https://johnvansickle.com/ffmpeg/release-readme.txt",
+            "text/plain",
+            ctx,
+        ),
+    )[1]
+
+
+def download_n_install(install_dir, progress=None, arch=None):
+    archs = ("amd64", "i686", "arm64", "armhf", "armel")
+    if arch is None:
+        arch = archs[0]
+    elif arch not in archs:
+        raise ValueError(f"Invalid arch specified. Must be one of {arch}")
+
+    with TemporaryDirectory() as tmpdir:
+        tarpath = path.join(tmpdir, "ffmpeg_linux.tar.xz")
+        url = f"https://johnvansickle.com/ffmpeg/releases/ffmpeg-release-{arch}-static.tar.xz"
+
+        with TemporaryDirectory() as tmpdir:
+            download_file(tarpath, url, "application/x-xz", ctx, progress=progress)
+
+        with tarfile.open(tarpath, "r") as f:
+            f.extractall(tmpdir)
+
+        _, (src_dir_name, *_), _ = next(os.walk(tmpdir))
+        src_dir_path = path.join(tmpdir, src_dir_name)
+
+        with open(path.join(src_dir_path, "VERSION"), "wt") as f:
+            f.write(get_version())
+
+        try:
+            shutil.rmtree(install_dir)
+        except:
+            pass
+
+        shutil.move(src_dir_path, install_dir)
+
+    ffmpegpath = path.join(install_dir, "ffmpeg")
+    ffprobepath = path.join(install_dir, "ffprobe")
+    chmod(ffmpegpath)
+    chmod(ffprobepath)
+
+    return ffmpegpath, ffprobepath

src/ffmpeg_downloader/_download_helper.py

@@ -0,0 +1,57 @@
+from tempfile import TemporaryDirectory
+from os import path
+import json, os, zipfile
+from ._download_helper import download_info, download_file, chmod
+
+
+def get_version():
+    return json.loads(
+        download_info(
+            "https://evermeet.cx/ffmpeg/info/ffmpeg/release", "application/json"
+        )
+    )["version"]
+
+
+def download_n_install(install_dir, progress=None):
+
+    with TemporaryDirectory() as tmpdir:
+        zipffmpegpath = path.join(tmpdir, "ffmpeg_macos.zip")
+        download_file(
+            zipffmpegpath,
+            "https://evermeet.cx/ffmpeg/getrelease/ffmpeg/zip",
+            "application/zip",
+            progress=progress,
+        )
+        zipffprobepath = path.join(tmpdir, "ffprobe_macos.zip")
+        download_file(
+            zipffprobepath,
+            "https://evermeet.cx/ffmpeg/getrelease/ffprobe/zip",
+            "application/zip",
+            progress=progress,
+        )
+
+        with zipfile.ZipFile(zipffmpegpath, "r") as f:
+            f.extractall(tmpdir)
+        with zipfile.ZipFile(zipffprobepath, "r") as f:
+            f.extractall(tmpdir)
+
+        dst_ffmpeg = path.join(install_dir, "ffmpeg")
+        try:
+            os.remove(dst_ffmpeg)
+        except:
+            pass
+        os.rename(path.join(tmpdir, "ffmpeg"), dst_ffmpeg)
+        chmod(dst_ffmpeg)
+
+        dst_ffprobe = path.join(install_dir, "ffprobe")
+        try:
+            os.remove(dst_ffprobe)
+        except:
+            pass
+        os.rename(path.join(tmpdir, "ffprobe"), dst_ffprobe)
+        chmod(dst_ffprobe)
+
+        with open(path.join(install_dir, "VERSION"), "wt") as f:
+            f.write(get_version())
+
+    return dst_ffmpeg, dst_ffprobe

src/ffmpeg_downloader/_linux.py

@@ -0,0 +1,47 @@
+import os
+import shutil
+from ._download_helper import download_info, download_file
+from tempfile import TemporaryDirectory
+from os import path
+import zipfile
+
+
+def get_version():
+    return download_info(
+        "https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-essentials.zip.ver",
+        "text/plain",
+    )
+
+
+def download_n_install(install_dir, progress=None, build_type=None):
+
+    build_types = ("essentials", "full", "full-shared")
+    if build_type is None:
+        build_type = build_types[0]
+    elif build_type not in build_types:
+        raise ValueError(f"Invalid build_type specified. Must be one of {build_types}")
+
+    with TemporaryDirectory() as tmpdir:
+        zippath = path.join(tmpdir, "ffmpeg_win32.zip")
+        url = f"https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-{build_type}.zip"
+        download_file(zippath, url, "application/zip", progress=progress)
+
+        with zipfile.ZipFile(zippath, "r") as f:
+            f.extractall(tmpdir)
+
+        _, (src_dir_name, *_), _ = next(os.walk(tmpdir))
+        src_dir_path = path.join(tmpdir, src_dir_name)
+
+        with open(path.join(src_dir_path, "VERSION"), "wt") as f:
+            f.write(get_version())
+
+        try:
+            shutil.rmtree(install_dir)
+        except:
+            pass
+
+        shutil.move(src_dir_path, install_dir)
+
+    return path.join(install_dir, "bin", "ffmpeg"), path.join(
+        install_dir, "bin", "ffprobe"
+    )