completed all functionality

Author: tikuma-lsuhsc

src/ffmpeg_downloader/__init__.py

@@ -1,10 +1,112 @@
 __version__ = "0.0.0"
+__all__ = [
+    "ffmpeg_dir",
+    "ffmpeg_version",
+    "ffmpeg_path",
+    "ffprobe_path",
+    "has_update",
+    "update",
+    "remove",
+]
 
+from os import listdir, path, rmdir, name as os_name
+from shutil import rmtree
 import sys
+from appdirs import user_data_dir
+
 
 if sys.platform in ("win32", "cygwin"):
-    from ._win32 import download_n_install, get_version
+    from ._win32 import (
+        download_n_install,
+        get_version as get_latest_version,
+        get_bindir,
+        home_url,
+    )
 elif sys.platform == "darwin":
-    from ._macos import download_n_install, get_version
+    from ._macos import (
+        download_n_install,
+        get_version as get_latest_version,
+        get_bindir,
+        home_url,
+    )
 else:
-    from ._linux import download_n_install, get_version
+    from ._linux import (
+        download_n_install,
+        get_version as get_latest_version,
+        get_bindir,
+        home_url,
+    )
+
+disclaimer_text = f"""
+You are about to download the latest FFmpeg release build from {home_url}. 
+Proceeding to download the file is done at your own discretion and risk and 
+with agreement that you will be solely responsible for any damage to your 
+computer system or loss of data that results from such activities. 
+
+Do you wish to proceed to download? [yN] """
+
+donation_text = f"""
+Start downloading...
+
+Please remember that to maintain and host the FFmpeg binaries is not free. 
+If you appreciate their effort, please consider donating to help them with 
+the upkeep of their website via {home_url}.
+"""
+
+
+def get_dir():
+    return user_data_dir("ffmpeg_downloader", "ffmpegio")
+
+
+def _ffmpeg_dir():
+    return get_bindir(get_dir())
+
+
+def _ffmpeg_version():
+    try:
+        with open(path.join(get_dir(), "VERSION"), "rt") as f:
+            return f.read()
+    except:
+        return None
+
+
+def __getattr__(name):  # per PEP 562
+    try:
+        return {
+            "ffmpeg_dir": _ffmpeg_dir(),
+            "ffmpeg_path": lambda: _ffmpeg_version()
+            and path.join(_ffmpeg_dir(), "ffmpeg" if os_name != "nt" else "ffmpeg.exe"),
+            "ffprobe_path": lambda: _ffmpeg_version()
+            and path.join(_ffmpeg_dir(), "ffprobe" if os_name != "nt" else "ffprobe.exe"),
+            "ffmpeg_version": _ffmpeg_version,
+        }[name]()
+    except:
+        raise AttributeError(f"module '{__name__}' has no attribute '{name}'")
+
+
+def has_update():
+    current = __getattr__("ffmpeg_version")
+    latest = get_latest_version()
+    return current != latest
+
+
+def update(skip_disclaimer=False, progress=None, **options):
+    if has_update():
+
+        if not skip_disclaimer:
+            ans = input(disclaimer_text)
+            if ans.lower() not in ("y", "yes"):
+                print("\ndownload canceled")
+                return
+            print(donation_text)
+        download_n_install(get_dir(), progress, **options)
+        return False
+    return True
+
+
+def remove(ignore_errors=True):
+    dir = get_dir()
+    rmtree(dir, ignore_errors=ignore_errors)
+    dir = path.dirname(dir)
+    if not len(listdir(dir)):
+        rmdir(dir)

src/ffmpeg_downloader/__main__.py

@@ -0,0 +1,63 @@
+import argparse
+import ffmpeg_downloader as ffdl
+import tqdm
+
+parser = argparse.ArgumentParser(description="Download latest FFmpeg release build")
+parser.add_argument(
+    "--update", "-U", "-u", action="store_true", help="Update to the latest release"
+)
+parser.add_argument(
+    "--remove",
+    "-r",
+    "-R",
+    "--delete",
+    "-d",
+    "-D",
+    action="store_true",
+    help="Remove downloaded FFmpeg build",
+)
+
+args = parser.parse_args()
+
+ver = ffdl.ffmpeg_version
+
+if args.remove:
+    if ver is None:
+        print("\nNo FFmpeg build has been downloaded.")
+    elif input(f"\nAre you sure to remove the FFmpeg build v{ver}? [yN]: ").lower() in (
+        "y",
+        "yes",
+    ):
+        try:
+            ffdl.remove(ignore_errors=False)
+            print("\nFFmpeg build successfully removed.")
+        except:
+            print(
+                f"\nFailed to delete FFmpeg build in {ffdl.ffmpeg_dir}. Please manually remove the directory."
+            )
+    else:
+        print("\nFFmpeg build removal canceled.")
+elif ver is None or args.update or ffdl.has_update():
+    prog_data = {}
+    try:
+
+        def progress(nread, nbytes):
+            if not len(prog_data):
+                prog_data["tqdm"] = tqdm.tqdm(
+                    desc="downloading", total=nbytes, unit=" bytes", leave=False
+                )
+                prog_data["last"] = 0
+            pbar = prog_data["tqdm"]
+            pbar.update(nread - prog_data["last"])
+            prog_data["last"] = nread
+
+        if ffdl.update(progress=progress):
+            print("\nLatest version")
+        else:
+            print(f"FFmpeg v{ffdl.ffmpeg_version} successfully installed in {ffdl.ffmpeg_dir}\n")
+    finally:
+        pbar = prog_data.get("tqdm", None)
+        if pbar:
+            pbar.close()
+else:
+    print(f"FFmpeg v{ffdl.ffmpeg_version} already installed")

src/ffmpeg_downloader/_download_helper.py

@@ -24,10 +24,9 @@ def download_info(url, content_type, ctx=None):
 
 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):
+        if progress:
+            progress(0, nbytes)
 
         blksz = nbytes // 32 or 1024 * 1024
         with open(outfile, "wb") as f:
@@ -41,7 +40,7 @@ def download_file(outfile, url, content_type, ctx=None, progress=None):
                 if progress:
                     progress(nread, nbytes)
 
-    return outfile
+    return nbytes
 
 
 def chmod(binfile):

src/ffmpeg_downloader/_linux.py

@@ -3,17 +3,19 @@
 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
+home_url = "https://johnvansickle.com/ffmpeg"
 
 
 def get_version():
 
+    ctx = ssl.create_default_context()
+    ctx.check_hostname = False
+    ctx.verify_mode = ssl.CERT_NONE
+
     return re.search(
         r"version: (\d+\.\d+(?:\.\d+)?)",
         download_info(
-            "https://johnvansickle.com/ffmpeg/release-readme.txt",
+            f"{home_url}/release-readme.txt",
             "text/plain",
             ctx,
         ),
@@ -27,9 +29,13 @@ def download_n_install(install_dir, progress=None, arch=None):
     elif arch not in archs:
         raise ValueError(f"Invalid arch specified. Must be one of {arch}")
 
+    ctx = ssl.create_default_context()
+    ctx.check_hostname = False
+    ctx.verify_mode = ssl.CERT_NONE
+
     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"
+        url = f"{home_url}/releases/ffmpeg-release-{arch}-static.tar.xz"
 
         with TemporaryDirectory() as tmpdir:
             download_file(tarpath, url, "application/x-xz", ctx, progress=progress)
@@ -50,9 +56,9 @@ def download_n_install(install_dir, progress=None, arch=None):
 
         shutil.move(src_dir_path, install_dir)
 
-    ffmpegpath = path.join(install_dir, "ffmpeg")
-    ffprobepath = path.join(install_dir, "ffprobe")
-    chmod(ffmpegpath)
-    chmod(ffprobepath)
+    for cmd in ("ffmpeg", "ffprobe"):
+        chmod(path.join(install_dir, cmd))
+
 
-    return ffmpegpath, ffprobepath
+def get_bindir(install_dir):
+    return install_dir

src/ffmpeg_downloader/_macos.py

@@ -1,57 +1,58 @@
 from tempfile import TemporaryDirectory
 from os import path
 import json, os, zipfile
-from ._download_helper import download_info, download_file, chmod
+from ._download_helper import download_info, download_file, chmod, download_base
+
+home_url = "https://evermeet.cx/ffmpeg"
 
 
 def get_version():
     return json.loads(
-        download_info(
-            "https://evermeet.cx/ffmpeg/info/ffmpeg/release", "application/json"
-        )
+        download_info(f"{home_url}/info/ffmpeg/release", "application/json")
     )["version"]
 
 
 def download_n_install(install_dir, progress=None):
 
+    ntotal = 0
+
+    nfiles = [
+        download_base(f"{home_url}/getrelease/{cmd}/zip")
+        for cmd in ("ffmpeg", "ffprobe")
+    ]
+    ntotal = sum(nfiles)
+    n1 = nfiles[0]
+    prog = (
+        lambda nread, nbytes: progress((nread + n1) if nbytes != n1 else nread, ntotal)
+        if progress is not None
+        else 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)
+
+        for cmd in ("ffmpeg", "ffprobe"):
+            zippath = path.join(tmpdir, f"{cmd}.zip")
+            download_file(
+                zippath,
+                f"{home_url}/getrelease/{cmd}/zip",
+                "application/zip",
+                progress=prog,
+            )
+
+            with zipfile.ZipFile(zippath, "r") as f:
+                f.extractall(tmpdir)
+
+            dst_path = path.join(install_dir, cmd)
+            try:
+                os.remove(dst_path)
+            except:
+                pass
+            os.rename(path.join(tmpdir, cmd), dst_path)
+            chmod(dst_path)
 
         with open(path.join(install_dir, "VERSION"), "wt") as f:
             f.write(get_version())
 
-    return dst_ffmpeg, dst_ffprobe
+
+def get_bindir(install_dir):
+    return install_dir

src/ffmpeg_downloader/_win32.py

@@ -5,10 +5,12 @@
 from os import path
 import zipfile
 
+home_url = "https://www.gyan.dev/ffmpeg/builds"
+
 
 def get_version():
     return download_info(
-        "https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-essentials.zip.ver",
+        f"{home_url}/ffmpeg-release-essentials.zip.ver",
         "text/plain",
     )
 
@@ -23,7 +25,7 @@ def download_n_install(install_dir, progress=None, build_type=None):
 
     with TemporaryDirectory() as tmpdir:
         zippath = path.join(tmpdir, "ffmpeg_win32.zip")
-        url = f"https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-{build_type}.zip"
+        url = f"{home_url}/ffmpeg-release-{build_type}.zip"
         download_file(zippath, url, "application/zip", progress=progress)
 
         with zipfile.ZipFile(zippath, "r") as f:
@@ -42,6 +44,6 @@ def download_n_install(install_dir, progress=None, build_type=None):
 
         shutil.move(src_dir_path, install_dir)
 
-    return path.join(install_dir, "bin", "ffmpeg"), path.join(
-        install_dir, "bin", "ffprobe"
-    )
+
+def get_bindir(install_dir):
+    return path.join(install_dir, "bin")

tests/requirements.txt

@@ -0,0 +1 @@
+pytest