Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

Added explicit production quality flag. (#529)

Julian van Doornd8dab7857d49
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
index 0c5efe7e7..e200cb095 100644
--- a/docs/source/changelog.rst
+++ b/docs/source/changelog.rst
@@ -32,7 +32,7 @@ Command line
#. You can save the logs to a file by using :code:`--log_to_file`
#. Read :code:`tex_template` from config file if not specified by :code:`--tex_template`.
#. Add experimental javascript rendering with :code:`--use_js_renderer`
-#. Add :code:`-q/--quality [k|h|m|l]` flag and removed :code:`-m/-l` flags.
+#. Add :code:`-q/--quality [k|p|h|m|l]` flag and removed :code:`-m/-l` flags.
#. Removed :code:`--sound` flag
diff --git a/docs/source/tutorials/configuration.rst b/docs/source/tutorials/configuration.rst
index a6fb43f7e..a1e89d3d7 100644
--- a/docs/source/tutorials/configuration.rst
+++ b/docs/source/tutorials/configuration.rst
@@ -47,8 +47,8 @@ The output looks as follows.
:options: -ELLIPSIS, +NORMALIZE_WHITESPACE
usage: manim [-h] [-o OUTPUT_FILE] [-p] [-f] [--leave_progress_bars] [-a] [-w] [-s] [-g] [-i] [--disable_caching] [--flush_cache] [--log_to_file] [-c BACKGROUND_COLOR]
- [--background_opacity BACKGROUND_OPACITY] [--media_dir MEDIA_DIR] [--log_dir LOG_DIR] [--tex_template TEX_TEMPLATE] [--dry_run] [-t] [-q {k,h,m,l}] [--low_quality] [--medium_quality]
- [--high_quality] [--fourk_quality] [-r RESOLUTION] [-n FROM_ANIMATION_NUMBER] [--use_js_renderer] [--js_renderer_path JS_RENDERER_PATH] [--config_file CONFIG_FILE] [--custom_folders]
+ [--background_opacity BACKGROUND_OPACITY] [--media_dir MEDIA_DIR] [--log_dir LOG_DIR] [--tex_template TEX_TEMPLATE] [--dry_run] [-t] [-q {k,p,h,m,l}] [--low_quality] [--medium_quality]
+ [--high_quality] [--production_quality] [--fourk_quality] [-r RESOLUTION] [-n FROM_ANIMATION_NUMBER] [--use_js_renderer] [--js_renderer_path JS_RENDERER_PATH] [--config_file CONFIG_FILE] [--custom_folders]
[-v {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--progress_bar True/False]
{cfg} ... file [scene_names [scene_names ...]]
@@ -88,11 +88,12 @@ optional arguments:
Specify a custom TeX template file
--dry_run Do a dry run (render scenes but generate no output files)
-t, --transparent Render a scene with an alpha channel
- -q {k,h,m,l}, --quality {k,h,m,l}
+ -q {k,p,h,m,l}, --quality {k,p,h,m,l}
Render at specific quality, short form of the --*_quality flags
--low_quality Render at low quality
--medium_quality Render at medium quality
--high_quality Render at high quality
+ --production_quality Render at default production quality
--fourk_quality Render at 4K quality
-r RESOLUTION, --resolution RESOLUTION
Resolution, passed as "height,width". Overrides any quality flags, if present
diff --git a/manim/config/config.py b/manim/config/config.py
index 7a3eb432d..3e7481c0d 100644
--- a/manim/config/config.py
+++ b/manim/config/config.py
@@ -86,7 +86,7 @@ def _parse_config(config_parser, args):
# and are stored in 'camera_config'. Note the highest resolution
# passed as argument will be used.
quality = _determine_quality(args)
- section = config_parser[quality if quality != "production" else "CLI"]
+ section = config_parser[quality if quality != constants.DEFAULT_QUALITY else "CLI"]
# Loop over low quality for the keys, could be any quality really
config = {opt: section.getint(opt) for opt in config_parser["low_quality"]}
diff --git a/manim/config/config_utils.py b/manim/config/config_utils.py
index ba728334f..d97b8215a 100644
--- a/manim/config/config_utils.py
+++ b/manim/config/config_utils.py
@@ -343,6 +343,7 @@ def _parse_cli(arg_list, input=True):
"-q",
"--quality",
choices=constants.QUALITIES.values(),
+ default=constants.DEFAULT_QUALITY_SHORT,
help="Render at specific quality, short form of the --*_quality flags",
)
parser.add_argument(
@@ -360,6 +361,11 @@ def _parse_cli(arg_list, input=True):
action="store_true",
help="Render at high quality",
)
+ parser.add_argument(
+ "--production_quality",
+ action="store_true",
+ help="Render at default production quality",
+ )
parser.add_argument(
"--fourk_quality",
action="store_true",
@@ -650,7 +656,10 @@ def _determine_quality(args):
}
for quality in constants.QUALITIES.keys():
- if getattr(args, quality) or (
+ if quality == constants.DEFAULT_QUALITY:
+ # Skip so we prioritize anything that overwrites the default quality.
+ pass
+ elif getattr(args, quality) or (
hasattr(args, "quality") and args.quality == constants.QUALITIES[quality]
):
return quality
@@ -662,4 +671,4 @@ def _determine_quality(args):
)
return old_qualities[quality]
- return "production"
+ return constants.DEFAULT_QUALITY
diff --git a/manim/constants.py b/manim/constants.py
index 75d4d70f0..b1d64ce3c 100644
--- a/manim/constants.py
+++ b/manim/constants.py
@@ -130,7 +130,11 @@ JS_RENDERER_INFO = (
# Video qualities
QUALITIES = {
"fourk_quality": "k",
+ "production_quality": "p",
"high_quality": "h",
"medium_quality": "m",
"low_quality": "l",
}
+
+DEFAULT_QUALITY = "production_quality"
+DEFAULT_QUALITY_SHORT = QUALITIES[DEFAULT_QUALITY]
diff --git a/tests/test_cli_flags.py b/tests/test_cli_flags.py
index 4c45471b2..1ed0b17f9 100644
--- a/tests/test_cli_flags.py
+++ b/tests/test_cli_flags.py
@@ -3,10 +3,11 @@ from manim.config.config_utils import _determine_quality, _parse_cli
def test_quality_flags():
- # Assert that quality is None when not specifying it
+ # Assert that quality is the default when not specifying it
parsed = _parse_cli([], False)
- assert not parsed.quality
+ assert parsed.quality == constants.DEFAULT_QUALITY_SHORT
+ assert _determine_quality(parsed) == constants.DEFAULT_QUALITY
for quality in constants.QUALITIES.keys():
# Assert that quality is properly set when using -q*
@@ -41,4 +42,4 @@ def test_quality_flags():
parsed = _parse_cli([], False)
assert not getattr(parsed, quality)
- assert "production" == _determine_quality(parsed)
+ assert _determine_quality(parsed) == constants.DEFAULT_QUALITY