From 3171441eb609b9ecd83c71f352503541613277c4 Mon Sep 17 00:00:00 2001 From: Justin Turner Arthur Date: Thu, 9 Mar 2023 01:42:03 -0600 Subject: [PATCH] Doc and metadata updates for 2.0.0 --- README.md | 3 ++- docs/_static/css/piccolo_overrides.css | 14 +++++++------- docs/changelog.rst | 8 ++++---- docs/usage.rst | 8 ++++++-- vsfieldkit/__init__.py | 2 +- 5 files changed, 20 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 4b8ce68..f7f672b 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ Included functions: `vsfieldkit.resample_as_progressive(clip)` `vsfieldkit.scan_interlaced(clip)` `vsfieldkit.telecine(clip)` -`vsfieldkit.upsample_as_progressive(clip)` +`vsfieldkit.upsample_as_progressive(clip)` +`vsfieldkit.weave_fields(clip)` See [the documentation](https://vsfieldkit.justinarthur.com/) for more information. diff --git a/docs/_static/css/piccolo_overrides.css b/docs/_static/css/piccolo_overrides.css index 2abbd07..7d489fb 100644 --- a/docs/_static/css/piccolo_overrides.css +++ b/docs/_static/css/piccolo_overrides.css @@ -1,33 +1,33 @@ div#right_sidebar { - width: 20rem; + width: 18rem; } -@media (min-width: 55rem) { +@media (min-width: 53rem) { div#top_nav nav p.mobile_search_link { display: none; } } -@media (max-width: 55rem) { +@media (max-width: 53rem) { div#top_nav nav div.searchbox_wrapper { display: none; } } -@media (max-width: 55rem) { +@media (max-width: 53rem) { div.document { margin-left: 0; margin-right: 0; } } -@media (max-width: 55rem) { +@media (max-width: 53rem) { div.sphinxsidebar { display: none; } } -@media (max-width: 55rem) { +@media (max-width: 53rem) { div#right_sidebar { display: none; } } -@media (max-width: 55rem) { +@media (max-width: 53rem) { div.button_nav_wrapper { margin-left: 0; margin-right: 0; diff --git a/docs/changelog.rst b/docs/changelog.rst index f109ac6..b80e5ff 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -1,7 +1,7 @@ Changelog ========= -2.0.0-upcoming --------------- +2.0.0 +----- New Features ^^^^^^^^^^^^ * Interlacing! Targeting deinterlacer testers and engineers in the broadcast @@ -23,6 +23,8 @@ Changed APIs * :py:func:`vsfieldkit.resample_as_progressive` ``kernel`` argument renamed to ``subsampling_kernel`` for clarity. ``upsampling_kernel`` argument added. + It also now fakes luma-co-sited chroma during upsampling to avoid lossy + chroma re-siting. * :py:func:`vsfieldkit.resample_as_progressive` and :py:func:`vsfieldkit.upsample_as_progressive` now default to Spline 36 for any chroma subsampling or upsampling using the new @@ -31,8 +33,6 @@ Changed APIs ``upsample_horizontally`` argument. Defaults to ``False``. :py:func:`vsfieldkit.resample_as_progressive` uses this as ``True`` internally. -* :py:func:`vsfieldkit.resample_as_progressive` fakes luma-co-sited chroma - during upsampling to avoid lossy chroma site shift operation. 1.1.0 ----- diff --git a/docs/usage.rst b/docs/usage.rst index 2316303..ef4ee85 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -323,16 +323,20 @@ Interlacing :param typing.Union[str, PulldownPattern, None] pulldown_pattern: A string of numbers seperated by colons, where each number - indicates for how many field duration to include each frame from + indicates for how many field durations to include each frame from the original clip in the new interlaced clip. A field duration is half the interlaced frame duration. For example, the popular "2:3" pattern will include the first original progressive frame for 2 field durations in the new interlaced clip. It will then include parts of the second original - frame for 3 field durations. The pattern repeats so the third + frame for 3 field durations. The pattern repeats, so the third original frame is included for 2 field durations of the new clip and so-on. + + Some common pulldown pattern enumerations are available on the + top level module or the :py:class:`~vsfieldkit.PulldownPattern` enum. + They can be supplied instead of a ``str``. Either ``pulldown_pattern`` or ``fpsnum`` must be supplied diff --git a/vsfieldkit/__init__.py b/vsfieldkit/__init__.py index aa34258..7bcecd3 100644 --- a/vsfieldkit/__init__.py +++ b/vsfieldkit/__init__.py @@ -10,7 +10,7 @@ assume_progressive, assume_tff, double, group_by_combed, group_by_field_order) -VERSION = 1, 1, 0 +VERSION = 2, 0, 0 SCAN_BLENDED = ChromaSubsampleScanning.SCAN_BLENDED SCAN_LATEST = ChromaSubsampleScanning.SCAN_LATEST