Organize ReelMagic as a sub-module under hardwarekc/reelmagic-1

src/hardware/reelmagic/driver.cpp
src/hardware/reelmagic/mpeg_decoder.h
src/hardware/reelmagic/player.cpp
src/hardware/reelmagic/vga_passthrough.h
src/hardware/reelmagic/video_mixer.cpp

src/hardware/reelmagic/docs/...
src/hardware/reelmagic/tools/...

This matches the other multi-component modules that have
their own subdirectory like: mame, mouse, and serialport.

This allows for dropping the redundant filename prefixes, and
simply call the component-code was they represent within the
Reel Magic design.

It also co-locates the tools and documentation, and makes
small modifications to reflect the new paths and names.

25 files changed, 30 insertions, 30 deletions

diff --git a/scripts/verify-markdown.sh b/scripts/verify-markdown.sh
index f885db8b1..d2090131e 100755
--- a/scripts/verify-markdown.sh
+++ b/scripts/verify-markdown.sh
@@ -18,7 +18,7 @@ list_markdown_files () {
 	git ls-files -- \
 	  '*.md' \
 	  ':!:src/libs/*.md' \
-	  ':!:docs/ReelMagic/*.md' \
+	  ':!:src/hardware/reelmagic/docs/*.md' \
 	  ':!:contrib/resources/*.md'
 }
 
diff --git a/src/hardware/meson.build b/src/hardware/meson.build
index 9dc536ade..c620379c9 100644
--- a/src/hardware/meson.build
+++ b/src/hardware/meson.build
@@ -48,9 +48,9 @@ libhardware_sources = files(
     'pcspeaker_impulse.cpp',
     'pic.cpp',
     'ps1audio.cpp',
-    'reelmagic_driver.cpp',
-    'reelmagic_player.cpp',
-    'reelmagic_videomixer.cpp',
+    'reelmagic/driver.cpp',
+    'reelmagic/player.cpp',
+    'reelmagic/video_mixer.cpp',
     'sblaster.cpp',
     'ston1_dac.cpp',
     'tandy_sound.cpp',
diff --git a/docs/ReelMagic/driver_api.md b/src/hardware/reelmagic/docs/driver_api.md
index 45b9a6905..66e2fc12e 100644
--- a/docs/ReelMagic/driver_api.md
+++ b/src/hardware/reelmagic/docs/driver_api.md
@@ -18,7 +18,7 @@ When loaded, this DOS device driver file responds to some INT 2F / DOS Multiplex
 purpose is to tell applications where they can find the driver as well as some other things about
 the hardware. It also handles the audio mixer interfaces.
 
-Note: The ReelMagic DOSBox code `reelmagic_driver.cpp` emulates this file's functionality and
+Note: The ReelMagic DOSBox code `driver.cpp` emulates this file's functionality and
 therefore is not required for using the DOSBox ReelMagic emulator. Like many emulated functionalities
 within DOSBox, there is no actual "RMDEV.SYS" file. Its functionality is permanently resident when
 ReelMagic support is enabled.
@@ -195,7 +195,7 @@ This file must always be named "FMPDRV.EXE" but can exist in any path. The path
 provided by an INT 2F function AX=9803h call to RMDEV.SYS as documented above.
 
 
-Note: The ReelMagic DOSBox code `reelmagic_driver.cpp` emulates this file's functionality. Since an actual
+Note: The ReelMagic DOSBox code `driver.cpp` emulates this file's functionality. Since an actual
 "FMPDRV.EXE" file must exist somewhere for things to work smoothly, a functional "Z:\FMPDRV.EXE" file is
 provided when ReelMagic support is enabled.
 
diff --git a/docs/ReelMagic/emulation_overview.md b/src/hardware/reelmagic/docs/emulation_overview.md
index b349b69f8..70b1994e1 100644
--- a/docs/ReelMagic/emulation_overview.md
+++ b/src/hardware/reelmagic/docs/emulation_overview.md
@@ -84,7 +84,7 @@ The parameters are:
 * `alwaysresident`  -- This forces `FMPDRV.EXE` to always be loaded.  By default this is `false`
 * `vgadup5hack`     -- Duplicate every 5th VGA line to help give output a 4:3 ratio. By default this is `false`
 * `initialmagickey` -- Provides and alternate value for the initial global "magic key" value in hex. Defaults to 40044041.
-* `magicfhack`      -- Use for MPEG video debugging purposes only. See `reelmagic_player.cpp` for what exactly this does to the MPEG decoder.
+* `magicfhack`      -- Use for MPEG video debugging purposes only. See `player.cpp` for what exactly this does to the MPEG decoder.
 * `a204debug`       -- Controls FMPDRV.EXE function Ah subfunction 204h debug logging. Only applicable in "heavy debugging" build.
 * `a206debug`       -- Controls FMPDRV.EXE function Ah subfunction 206h debug logging. Only applicable in "heavy debugging" build.
 
@@ -104,9 +104,8 @@ The following existing DOSBox source code files have been modified for ReelMagic
 * `include/logging.h`                     -- Added `REELMAGIC` logging type + quick fix for variable length logging args
 * `src/debug/debug_gui.cpp`               -- Added `REELMAGIC` logging type.
 * `src/dosbox.cpp`                        -- ReelMagic init hook-in and config section.
-* `src/hardware/Makefile.am`              -- Declared new ReelMagic *.cpp source code files
 
-The following files have been modified to include the ReelMagic override header to redirect all VGA output from DOSBox RENDER to ReelMagic:
+The following files have been modified to include the ReelMagic VGA passthrough header to redirect all VGA output from DOSBox RENDER to ReelMagic:
 
 * `src/hardware/vga_dac.cpp`              
 * `src/hardware/vga_draw.cpp`             
@@ -117,12 +116,12 @@ The following files have been modified to include the ReelMagic override header
 
 The following new DOSBox source code files have been added for ReelMagic emulation functionality:
 
-* `include/reelmagic.h`                   -- Header file for all ReelMagic stuff
-* `include/vga_reelmagic_override.h`      -- Header file used to redirect all VGA output from DOSBox RENDER to ReelMagic
-* `src/hardware/reelmagic_driver.cpp`     -- Implements the Driver + Hardware Emulation
-* `src/hardware/reelmagic_pl_mpeg.cpp`    -- Modified version of PHOBOSLAB's `PL_MPEG` library found here: `https://github.com/phoboslab/pl_mpeg`
-* `src/hardware/reelmagic_player.cpp`     -- Implements MPEG Media Decoder/Player Functionality
-* `src/hardware/reelmagic_videomixer.cpp` -- Intercepts the VGA output and mixes in the decoded MPEG video.
+* `include/reelmagic.h`                      -- Header file for all ReelMagic stuff
+* `src/hardware/reelmagic/vga_passthrough.h` -- Header file used to redirect all VGA output from DOSBox RENDER to ReelMagic
+* `src/hardware/reelmagic/driver.cpp`        -- Implements the Driver + Hardware Emulation
+* `src/hardware/reelmagic/mpeg_decoder.cpp`  -- Modified version of PHOBOSLAB's `PL_MPEG` library found here: `https://github.com/phoboslab/pl_mpeg`
+* `src/hardware/reelmagic/player.cpp`        -- Implements MPEG Media Decoder/Player Functionality
+* `src/hardware/reelmagic/video_mixer.cpp`   -- Intercepts the VGA output and mixes in the decoded MPEG video.
 
 
 # ReelMagic Emulator Architecture
@@ -155,8 +154,9 @@ ReelMagic emulation software components are wired up as such:
                                                                                     |---------------|
 ```
 
+# Building DOSBox Staging
 
-
+See the README.md and BUILD.md notes.
 
 
 # Building DOSBox
@@ -174,6 +174,7 @@ sudo apt install build-essential autoconf automake-1.15 autotools-dev m4
 make
 ```
 
+
 ## Enabling DOSBox Debugger
 ```
 ./configure --enable-debug
diff --git a/docs/ReelMagic/hardware_io_ports.md b/src/hardware/reelmagic/docs/hardware_io_ports.md
index a95a80890..a95a80890 100644
--- a/docs/ReelMagic/hardware_io_ports.md
+++ b/src/hardware/reelmagic/docs/hardware_io_ports.md
diff --git a/docs/ReelMagic/known_game_bugs.md b/src/hardware/reelmagic/docs/known_game_bugs.md
index 9deb2d158..9deb2d158 100644
--- a/docs/ReelMagic/known_game_bugs.md
+++ b/src/hardware/reelmagic/docs/known_game_bugs.md
diff --git a/docs/ReelMagic/mpeg_decoder.md b/src/hardware/reelmagic/docs/mpeg_decoder.md
index c5ffb3ddf..c5ffb3ddf 100644
--- a/docs/ReelMagic/mpeg_decoder.md
+++ b/src/hardware/reelmagic/docs/mpeg_decoder.md
diff --git a/src/hardware/reelmagic_driver.cpp b/src/hardware/reelmagic/driver.cpp
index 369580c15..369580c15 100644
--- a/src/hardware/reelmagic_driver.cpp
+++ b/src/hardware/reelmagic/driver.cpp
diff --git a/src/hardware/reelmagic_pl_mpeg.h b/src/hardware/reelmagic/mpeg_decoder.h
index 31a3c8dfd..31a3c8dfd 100644
--- a/src/hardware/reelmagic_pl_mpeg.h
+++ b/src/hardware/reelmagic/mpeg_decoder.h
diff --git a/src/hardware/reelmagic_player.cpp b/src/hardware/reelmagic/player.cpp
index 3e13fcc5d..03df7926a 100644
--- a/src/hardware/reelmagic_player.cpp
+++ b/src/hardware/reelmagic/player.cpp
@@ -35,7 +35,7 @@
 
 //bring in the MPEG-1 decoder library...
 #define PL_MPEG_IMPLEMENTATION
-#include "./reelmagic_pl_mpeg.h"
+#include "mpeg_decoder.h"
 
 //global config
 static ReelMagic_PlayerConfiguration _globalDefaultPlayerConfiguration;
diff --git a/contrib/reelmagic/Makefile b/src/hardware/reelmagic/tools/Makefile
index df7f198ad..df7f198ad 100644
--- a/contrib/reelmagic/Makefile
+++ b/src/hardware/reelmagic/tools/Makefile
diff --git a/contrib/reelmagic/find_magical_f_code.c b/src/hardware/reelmagic/tools/find_magical_f_code.c
index 0fc35191b..9cbe5e1b0 100644
--- a/contrib/reelmagic/find_magical_f_code.c
+++ b/src/hardware/reelmagic/tools/find_magical_f_code.c
@@ -19,7 +19,7 @@
 #include <stdio.h>
 
 #define PL_MPEG_IMPLEMENTATION
-#include "./original_pl_mpeg.h"
+#include "../mpeg_decoder.h"
 
 
 int
diff --git a/contrib/reelmagic/is_magical_asset.c b/src/hardware/reelmagic/tools/is_magical_asset.c
index 5b036c4f4..d2a2e71e1 100644
--- a/contrib/reelmagic/is_magical_asset.c
+++ b/src/hardware/reelmagic/tools/is_magical_asset.c
@@ -19,7 +19,7 @@
 #include <stdio.h>
 
 #define PL_MPEG_IMPLEMENTATION
-#include "./original_pl_mpeg.h"
+#include "../mpeg_decoder.h"
 
 
 int
diff --git a/contrib/reelmagic/original_pl_mpeg.h b/src/hardware/reelmagic/tools/original_pl_mpeg.h
index b69c3b935..b69c3b935 100644
--- a/contrib/reelmagic/original_pl_mpeg.h
+++ b/src/hardware/reelmagic/tools/original_pl_mpeg.h
diff --git a/contrib/reelmagic/superanalyze_mpeg_ps.c b/src/hardware/reelmagic/tools/superanalyze_mpeg_ps.c
index c558a2af2..c558a2af2 100644
--- a/contrib/reelmagic/superanalyze_mpeg_ps.c
+++ b/src/hardware/reelmagic/tools/superanalyze_mpeg_ps.c
diff --git a/contrib/reelmagic/superanalyze_mpeg_ps_f_code.pl b/src/hardware/reelmagic/tools/superanalyze_mpeg_ps_f_code.pl
index 58fa7b696..58fa7b696 100755
--- a/contrib/reelmagic/superanalyze_mpeg_ps_f_code.pl
+++ b/src/hardware/reelmagic/tools/superanalyze_mpeg_ps_f_code.pl
diff --git a/contrib/reelmagic/unlock_the_magic_mpeg_ps.c b/src/hardware/reelmagic/tools/unlock_the_magic_mpeg_ps.c
index f84b5c928..f84b5c928 100644
--- a/contrib/reelmagic/unlock_the_magic_mpeg_ps.c
+++ b/src/hardware/reelmagic/tools/unlock_the_magic_mpeg_ps.c
diff --git a/contrib/reelmagic/wincompat.h b/src/hardware/reelmagic/tools/wincompat.h
index f16ec03ba..f16ec03ba 100644
--- a/contrib/reelmagic/wincompat.h
+++ b/src/hardware/reelmagic/tools/wincompat.h
diff --git a/include/vga_reelmagic_override.h b/src/hardware/reelmagic/vga_passthrough.h
index 94c538e31..94c538e31 100644
--- a/include/vga_reelmagic_override.h
+++ b/src/hardware/reelmagic/vga_passthrough.h
diff --git a/src/hardware/reelmagic_videomixer.cpp b/src/hardware/reelmagic/video_mixer.cpp
index cbd6ca280..3c334e50a 100644
--- a/src/hardware/reelmagic_videomixer.cpp
+++ b/src/hardware/reelmagic/video_mixer.cpp
@@ -28,7 +28,7 @@
 #include <exception>
 #include <string>
 
-#include "../gui/render_scalers.h" //SCALER_MAXWIDTH SCALER_MAXHEIGHT
+#include "../../gui/render_scalers.h" //SCALER_MAXWIDTH SCALER_MAXHEIGHT
 #include "render.h"
 #include "rgb16.h"
 #include "setup.h"
diff --git a/src/hardware/vga_dac.cpp b/src/hardware/vga_dac.cpp
index 0534deb60..2890bf652 100644
--- a/src/hardware/vga_dac.cpp
+++ b/src/hardware/vga_dac.cpp
@@ -24,8 +24,7 @@
 #include "render.h"
 #include "vga.h"
 #include "mem.h"
-
-#include "vga_reelmagic_override.h"
+#include "reelmagic/vga_passthrough.h"
 
 /*
 3C6h (R/W):  PEL Mask
diff --git a/src/hardware/vga_draw.cpp b/src/hardware/vga_draw.cpp
index 5bd33af73..2496ac56c 100644
--- a/src/hardware/vga_draw.cpp
+++ b/src/hardware/vga_draw.cpp
@@ -29,7 +29,7 @@
 #include "../gui/render_scalers.h"
 #include "vga.h"
 #include "video.h"
-#include "vga_reelmagic_override.h"
+#include "reelmagic/vga_passthrough.h"
 
 //#undef C_DEBUG
 //#define C_DEBUG 1
diff --git a/src/hardware/vga_other.cpp b/src/hardware/vga_other.cpp
index 8e7f2ddb0..b6f1b741b 100644
--- a/src/hardware/vga_other.cpp
+++ b/src/hardware/vga_other.cpp
@@ -33,7 +33,7 @@
 #include "pic.h"
 #include "render.h"
 #include "vga.h"
-#include "vga_reelmagic_override.h"
+#include "reelmagic/vga_passthrough.h"
 
 // CHECK_NARROWING();
 
diff --git a/vs/dosbox.vcxproj b/vs/dosbox.vcxproj
index 030cf6448..4d6bf34a3 100644
--- a/vs/dosbox.vcxproj
+++ b/vs/dosbox.vcxproj
@@ -606,9 +606,9 @@ IF %ERRORLEVEL% LSS 8 SET ERRORLEVEL = 0</Command>
     <ClCompile Include="..\src\hardware\pcspeaker_impulse.cpp" />
     <ClCompile Include="..\src\hardware\pic.cpp" />
     <ClCompile Include="..\src\hardware\ps1audio.cpp" />
-    <ClCompile Include="..\src\hardware\reelmagic_driver.cpp" />
-    <ClCompile Include="..\src\hardware\reelmagic_player.cpp" />
-    <ClCompile Include="..\src\hardware\reelmagic_videomixer.cpp" />
+    <ClCompile Include="..\src\hardware\reelmagic\driver.cpp" />
+    <ClCompile Include="..\src\hardware\reelmagic\player.cpp" />
+    <ClCompile Include="..\src\hardware\reelmagic\video_mixer.cpp" />
     <ClCompile Include="..\src\hardware\sblaster.cpp" />
     <ClCompile Include="..\src\hardware\serialport\directserial.cpp" />
     <ClCompile Include="..\src\hardware\serialport\libserial.cpp" />
diff --git a/vs/dosbox.vcxproj.filters b/vs/dosbox.vcxproj.filters
index 9960cd056..38eca10b0 100644
--- a/vs/dosbox.vcxproj.filters
+++ b/vs/dosbox.vcxproj.filters
@@ -229,13 +229,13 @@
     <ClCompile Include="..\src\hardware\pci_bus.cpp">
       <Filter>src\hardware</Filter>
     </ClCompile>
-    <ClCompile Include="..\src\hardware\reelmagic_driver.cpp">
+    <ClCompile Include="..\src\hardware\reelmagic\driver.cpp">
       <Filter>src\hardware</Filter>
     </ClCompile>
-    <ClCompile Include="..\src\hardware\reelmagic_player.cpp">
+    <ClCompile Include="..\src\hardware\reelmagic\player.cpp">
       <Filter>src\hardware</Filter>
     </ClCompile>
-    <ClCompile Include="..\src\hardware\reelmagic_videomixer.cpp">
+    <ClCompile Include="..\src\hardware\reelmagic\video_mixer.cpp">
       <Filter>src\hardware</Filter>
     </ClCompile>
     <ClCompile Include="..\src\hardware\pcspeaker.cpp">