Added video filter NTSC CRT LMP88959 (https://github.com/LMP88959/NTS…

…C-CRT).

src/extra/NTSC-CRT/CMakeLists.txt

@@ -0,0 +1,100 @@
+cmake_minimum_required(VERSION 3.14...3.25)
+
+get_property(is_multi_config GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
+if(NOT is_multi_config AND NOT (CMAKE_BUILD_TYPE OR DEFINED ENV{CMAKE_BUILD_TYPE}))
+	set(CMAKE_BUILD_TYPE Release CACHE STRING "Release default")
+endif()
+
+project(NTSC-CRT LANGUAGES C)
+
+option(LIVE "Live video using PL3D-KC" OFF)
+option(VIDEO "Convert video (series of frames) instead of single image" OFF)
+set(CRT_SYSTEM "0" CACHE STRING "The system to be compiled (0 - CRT_SYSTEM_NTSC - standard NTSC, 5 - CRT_SYSTEM_NTSCVHS - standard NTSC VHS)")
+
+include(ExternalProject)
+include(GNUInstallDirs)
+
+if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
+	set(CMAKE_INSTALL_PREFIX "${PROJECT_BINARY_DIR}" CACHE PATH "default install path" FORCE)
+endif()
+
+# --- PL3D-KC
+if(LIVE)
+	if(UNIX)
+		find_package(X11 REQUIRED)
+	endif()
+
+	set(fw_url https://github.com/LMP88959/PL3D-KC.git)
+	set(fw_tag 3fa35ad)
+	set(fw_args
+	-DCMAKE_INSTALL_PREFIX:PATH=${CMAKE_INSTALL_PREFIX}
+	-DCMAKE_BUILD_TYPE=Release
+	-DBUILD_SHARED_LIBS:BOOL=${BUILD_SHARED_LIBS}
+	-DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
+	)
+
+	set(FW_LIBRARY ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/${CMAKE_STATIC_LIBRARY_PREFIX}fw${CMAKE_STATIC_LIBRARY_SUFFIX})
+	set(FW_INCLUDE_DIR ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_INCLUDEDIR})
+
+
+	ExternalProject_Add(fw
+	GIT_REPOSITORY ${fw_url}
+	GIT_TAG ${fw_tag}
+	GIT_SHALLOW true
+	CMAKE_ARGS ${fw_args}
+	BUILD_BYPRODUCTS ${FW_LIBRARY}
+	TLS_VERIFY true
+	INACTIVITY_TIMEOUT 60
+	CONFIGURE_HANDLED_BY_BUILD ON
+	)
+
+	file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/include)
+	add_library(fw::fw INTERFACE IMPORTED)
+	target_link_libraries(fw::fw INTERFACE ${FW_LIBRARY}
+	$<$<BOOL:${UNIX}>:X11::Xext>
+	$<$<BOOL:${WIN32}>:winmm>
+	)
+	target_include_directories(fw::fw INTERFACE ${FW_INCLUDE_DIR})
+
+	add_dependencies(fw::fw fw)
+endif()
+
+# --- NTSC program
+# --- Check CRT_SYSTEM value
+if((CRT_SYSTEM LESS 0) OR (CRT_SYSTEM GREATER 5))
+	message(FATAL_ERROR "Wrong CRT_SYSTEM value! Possible values: 0 - 5")
+endif()
+
+# --- video_convert
+if(VIDEO)
+	add_executable(ntsc_video video_convert.c crt_core.c crt_ntsc.c crt_ntscvhs.c crt_pv1k.c crt_template.c bmp_rw.c)
+	target_include_directories(ntsc_video PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
+	target_compile_definitions(ntsc_video PRIVATE CRT_SYSTEM=${CRT_SYSTEM})
+	target_compile_definitions(ntsc_video PRIVATE
+	CMD_LINE_VERSION=$<NOT:$<BOOL:${LIVE}>>
+	$<$<BOOL:${MSVC}>:_CRT_SECURE_NO_WARNINGS>
+	)
+	target_link_libraries(ntsc_video PRIVATE
+	$<$<BOOL:${LIVE}>:fw::fw>
+	$<$<BOOL:${WIN32}>:winmm>
+	)
+
+# --- default
+else()
+	add_executable(ntsc crt_core.c crt_ntsc.c crt_nes.c crt_pv1k.c crt_template.c crt_snes.c crt_main.c ppm_rw.c bmp_rw.c)
+	target_include_directories(ntsc PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
+	target_compile_definitions(ntsc PRIVATE CRT_SYSTEM=${CRT_SYSTEM})
+	target_compile_definitions(ntsc PRIVATE
+	CMD_LINE_VERSION=$<NOT:$<BOOL:${LIVE}>>
+	$<$<BOOL:${MSVC}>:_CRT_SECURE_NO_WARNINGS>
+	)
+	target_link_libraries(ntsc PRIVATE
+	$<$<BOOL:${LIVE}>:fw::fw>
+	$<$<BOOL:${WIN32}>:winmm>
+	)
+endif()
+
+# --- auto-ignore build directory
+if(NOT EXISTS ${PROJECT_BINARY_DIR}/.gitignore)
+	file(WRITE ${PROJECT_BINARY_DIR}/.gitignore "*")
+endif()

src/extra/NTSC-CRT/LICENSE

@@ -0,0 +1,9 @@
+Feel free to use the code in any way you would like, however, if you release anything with it,
+a comment in your code/README saying where you got this code would be a nice gesture but it’s not mandatory.
+
+The software is provided "as is", without warranty of any kind, express or implied,
+including but not limited to the warranties of merchantability,
+fitness for a particular purpose and noninfringement.
+In no event shall the authors or copyright holders be liable for any claim,
+damages or other liability, whether in an action of contract, tort or otherwise,
+arising from, out of or in connection with the software or the use or other dealings in the software.

src/extra/NTSC-CRT/README.md

@@ -0,0 +1,224 @@
+# NTSC-CRT
+NTSC video signal encoding / decoding emulation by EMMIR 2018-2023
+================================================================
+
+### Click the image to see a YouTube video of it running in real time:
+[![alt text](/scube.png?raw=true)](https://www.youtube.com/watch?v=ucfPRtV6--c)
+### Click the image to see a YouTube video of it running in real time:
+[![alt text](/kc.png?raw=true)](https://www.youtube.com/watch?v=ucfPRtV6--c)
+### Example of artifact colors being used purposely by specially designed art (not my own)
+![alt text](/artifactcolor.png?raw=true)
+### Example of artifact colors creating a rainbow by specially designed art (not my own)
+![alt text](/rainbow.png?raw=true)
+
+### Example of dot crawl in a standard interlaced NTSC video
+https://user-images.githubusercontent.com/109979235/212872851-38d0558e-b4bb-4011-8090-046e585093c9.mov
+
+
+### NES mode  
+YouTube video of the filter running in an NES emulator:
+https://www.youtube.com/watch?v=giML77yy7To
+
+### Description
+The result of going down a very deep rabbit hole.
+I learned a lot about analog signal processing, television, and the NTSC standard in the process.
+Written to be compatible with C89.
+
+Just like King's Crook (my from-scratch 3D game), this code follows the same restrictions:
+
+1. Everything must be done in software, no explicit usage of hardware acceleration.
+2. No floating point types or literals, everything must be integer only.
+3. No 3rd party libraries, only C standard library and OS libraries for window, input, etc.
+4. No languages used besides C.
+5. No compiler specific features and no SIMD.
+6. Single threaded.
+
+This program performs relatively well and can be easily used in real-time applications
+to emulate NTSC output. It is by no means fully optimized (mainly for readability), so  
+there is a lot of room for performance gains.
+
+------
+### Feature List:
+
+- Relatively accurate composite NTSC image output  
+  -- with bandlimited luma/chroma  
+  -- color artifacts (extends to being able to show specially patterned b/w images as color)  
+  -- accurate dot crawl  
+- VSYNC and HSYNC
+- Signal noise (optional)
+- Interlaced and progressive scan
+- Monochrome and full color
+- Highly customizable signal encoding (see crt_template.h to make your own)
+- NES decoding support
+
+## Important
+The command line program provided does not let you mess with all the settings
+like black/white point, hue, brightness, saturation, and contrast.
+
+In the crt_main.c file, there are two main()'s.
+One is for a command line program and the other uses my FW library (found here https://github.com/LMP88959/PL3D-KC)
+to provide real-time NTSC emulation with adjustable parameters.
+
+The famous waterfall 'rainbow' effect created as a result of dithering will show if it is compiled with `CRT_CHROMA_PATTERN` set to 0.
+Specially patterned black and white images can be encoded/decoded with color just like a real composite NTSC display.
+
+## Regarding NES Mode
+
+NES Mode is a separate version of NTSC-CRT that has adjusted timings to match the non-standard NES specifications.  
+https://www.nesdev.org/wiki/NTSC_video  
+These timings and extra NES specific features were incorporated into the NES version by Persune.  
+Extra features include the NES-specific NTSC frame pulses, dot skipping every odd frame, and border colors.
+
+#### `Massive thank you to Persune for helping improve the NES version!`
+
+## Compiling
+
+```sh
+cd NTSC-CRT
+
+cc -O3 -o ntsc *.c
+```
+
+or using CMake on Linux, macOS, or Windows:
+
+**Note:** There are 3 available flags / variables:
+- `LIVE` (default: `off`) - Set to `on` to enable rendering to a video window from an input PPM/BMP image file
+- `VIDEO` (default: `off`) - Set to `on` to enable rendering of sequence of frames. See `video_convert.c` for details
+- `CRT_SYSTEM` (default: `0`) - 0 - CRT_SYSTEM_NTSC (standard NTSC), 5 - CRT_SYSTEM_NTSCVHS (standard NTSC VHS). See `crt_core.h` for details
+
+```sh
+cmake -B build -DLIVE=off -DVIDEO=on -DCRT_SYSTEM=5
+cmake --build build --config Release
+```
+
+The default command line takes a single PPM or BMP image file and outputs a processed PPM or BMP file:
+
+```
+usage: ./ntsc -m|o|f|p|r|h|a outwidth outheight noise artifact_hue infile outfile
+sample usage: ./ntsc -op 640 480 24 0 in.ppm out.ppm
+sample usage: ./ntsc - 832 624 0 90 in.ppm out.ppm
+-- NOTE: the - after the program name is required
+	artifact_hue is [0, 359]
+------------------------------------------------------------
+	m : monochrome
+	o : do not prompt when overwriting files
+	f : odd field (only meaningful in progressive mode)
+	p : progressive scan (rather than interlaced)
+	r : raw image (needed for images that use artifact colors)
+	a : save analog signal as image instead of decoded image
+	h : print help
+
+by default, the image will be full color, interlaced, and scaled to the output dimensions
+```
+
+If `-DVIDEO=on` is specified, the command line output will look like this:
+
+```
+NTSC/CRT v2.2.1 by EMMIR 2018-2023
+This program does not operate on video files, only sequences of
+images. Please make sure you have the FFMPEG command line tools
+installed and follow these instructions to convert a video
+using the NTSC/CRT library:
+  mkdir frames
+  mkdir output
+  ffmpeg -r 1 -i your_video.mov -r 1 ./frames/$frame%06d.bmp
+  ./ntsc_video.exe <arguments>
+  ffmpeg -r 30 -f image2 -s 640x480 -i ./output/%06d.bmp -vcodec libx264 -crf 10 -pix_fmt yuv420p out.mp4
+
+------------------------------------------------------------
+usage: ntsc_video.exe -m|o|p|s|h num_frames outwidth outheight noise
+sample usage: ntsc_video.exe -oa 5000 640 480 0
+sample usage: ntsc_video.exe - 1400 832 624 12
+-- NOTE: the - after the program name is required
+------------------------------------------------------------
+        m : monochrome
+        o : do not prompt when overwriting files
+        a : mess up the bottom of the frame (useful for the VHS look)
+        s : fill in gaps between scan lines
+        p : progressive scan (rather than interlaced)
+        h : print help
+
+by default, the image will be full color and interlaced
+```
+
+### Adding NTSC-CRT to your C/C++ project:
+
+Global variables:
+```c
+#include "crt_core.h"
+
+static struct CRT crt;
+static struct NTSC_SETTINGS ntsc;
+static int color = 1;
+static int noise = 12;
+static int field = 0;
+static int raw = 0;
+static int hue = 0;
+```
+
+In your initialization function:
+```c
+/* pass it the buffer to be drawn on screen */
+crt_init(&crt, screen_width, screen_height, CRT_PIX_FORMAT_BGRA, screen_buffer);
+/* specify some settings */
+crt.blend = 1;
+crt.scanlines = 1;
+
+```
+
+In your drawing loop:
+```c
+ntsc.data = video_buffer; /* buffer from your rendering */
+ntsc.format = CRT_PIX_FORMAT_BGRA;
+ntsc.w = video_width;
+ntsc.h = video_height;
+ntsc.as_color = color;
+ntsc.field = field & 1;
+ntsc.raw = raw;
+ntsc.hue = hue;
+if (ntsc.field == 0) {
+  ntsc.frame ^= 1;
+}
+crt_modulate(&crt, &ntsc);
+crt_demodulate(&crt, noise);
+field ^= 1;
+```
+------
+## Writing a port for a certain system
+
+Check out crt_template.h and crt_template.c  
+Most modifications should only be to the constants defined in crt_template.h
+
+------
+
+### Other Information
+Web version by @binji (might not be up to date):  
+https://binji.github.io/NTSC-CRT/  
+To use the web version, drag a PPM image into the web browser.
+#### Related projects
+https://github.com/LMP88959/PAL-CRT - my PAL modem written in a similar fashion to this library  
+https://github.com/F33RNI/NTSC-VHS-Renderer - Intuitive rendering and GUI for this project  
+https://github.com/svofski/CRT - PAL/SECAM modem in Python/GLSL by @svofski  
+
+------
+If you have any questions feel free to leave a comment on YouTube OR
+join the King's Crook Discord server :)
+
+YouTube: https://www.youtube.com/@EMMIR_KC/videos
+
+Discord: https://discord.gg/hdYctSmyQJ
+
+itch.io: https://kingscrook.itch.io/kings-crook
+
+## License
+Feel free to use the code in any way you would like, however, if you release anything with it,
+a comment in your code/README saying where you got this code would be a nice gesture but it’s not mandatory.
+
+The software is provided "as is", without warranty of any kind, express or implied,
+including but not limited to the warranties of merchantability,
+fitness for a particular purpose and noninfringement.
+In no event shall the authors or copyright holders be liable for any claim,
+damages or other liability, whether in an action of contract, tort or otherwise,
+arising from, out of or in connection with the software or the use or other dealings in the software.
+------
+Thank you for your interest!