Tucil2_13523027_13523090 - Quadtree Compresser

This repository contains an image compression application that leverages a Quadtree data structure, built in C++ using OpenCV and ImageMagick that implements various Divide and Conquer and Decrease and Conquer algorithms. This program also incorporates multiple error measurement methods—including variance, mean absolute deviation (MAD), maximum pixel difference, entropy, and Structural Similarity Index (SSIM)—to decide when to subdivide image regions. Additionally, it can generate Graphics Interchange Format (GIF) files to visualize the compression process, providing an intuitive demonstration of how the quadtree structure evolves during compression.

---

////////// Project Black Lock 🔐 //////////

SIN	Name	GitHub
13523027	Fajar Kurniawan	@Fajar2k5
13523090	Nayaka Ghana Subrata	@Nayekah

////////// Tech Stacks and Languages //////////

---

📦 Installation & Setup

✅ Requirements

• Git
• Any IDE (recommended: VSCode)
• Chocolatey (for Windows)
• CMake
• OpenCV
• ImageMagick
• FFmpeg
• C++ Compiler

---

⬇️ Installing Dependencies

🪟 Windows

1. Git

   https://git-scm.com/download/win

2. VSCode

   winget install microsoft.visualstudiocode

3. Mingw (C++ Compiler)

   # Install and setup for Windows (see the docs below)
   
   https://www.mingw-w64.org/downloads/

4. Chocolatey (Package installer for Windows)

   # Install and setup (see the docs below)
   
   https://chocolatey.org/install

5. Dependecies

   # Run it in administrator mode (cmd/powershell)
   
   choco install cmake -y
   choco install opencv -y
   choco install imagemagick -y

🐧 Linux

1. Git

   sudo apt-get install git

2. VSCode

   sudo apt install software-properties-common apt-transport-https wget
   wget -q https://packages.microsoft.com/keys/microsoft.asc -O- | sudo apt-key add -
   sudo add-apt-repository "deb [arch=amd64] https://packages.microsoft.com/repos/vscode stable main"
   sudo apt update
   sudo apt install code

3. Mingw (C++ Compiler)

   # Install and setup for your Linux distro (see the docs below)
   
   https://www.mingw-w64.org/downloads/

4. Dependecies

   sudo apt update
   sudo apt install cmake
   sudo apt install libopencv-dev
   sudo apt install imagemagick
   sudo apt install ffmpeg

---

🔧 How To Setup

🪟 Windows

🛠️ Build (If you want to build it from the beginning)

1. Open a terminal
2. Clone the repository (if not already cloned)

   git clone https://github.com/Nayekah/Tucil2_13523027_13523090.git

3. Make Tucil2_13523027_13523090 as root directory:

   cd .\Tucil2_13523027_13523090

4. Install the dependencies first (if not already installed)
5. Do:

   build.bat
   
   # or
   
   .\build.bat

🧹 Clean

1. Open a terminal
2. Clone the repository (if not already cloned)

   git clone https://github.com/Nayekah/Tucil2_13523027_13523090.git

3. Make Tucil2_13523027_13523090 as root directory:

   cd .\Tucil2_13523027_13523090

4. Do:

   clean.bat
   
   # or
   
   .\clean.bat

---

🐧 Linux

🛠️ Build (If you want to build it from the beginning)

1. Open a terminal
2. Clone the repository (if not already cloned)

   git clone https://github.com/Nayekah/Tucil2_13523027_13523090.git

3. Make Tucil2_13523027_13523090 as root directory:

   cd Tucil2_13523027_13523090/

4. Install the dependencies first (if not already installed)
5. Do:

   ./build.sh

🧹 Clean

1. Open a terminal
2. Clone the repository (if not already cloned)

   git clone https://github.com/Nayekah/Tucil2_13523027_13523090.git

3. Make Tucil2_13523027_13523090 as root directory:

   cd Tucil2_13523027_13523090/

4. Do:

   ./clean.sh

---

✨ How to Run

🐧 Linux

📰 Default Mode

1. Open a terminal
2. Clone the repository (if not already cloned)

   git clone https://github.com/Nayekah/Tucil2_13523027_13523090.git

3. Make Tucil2_13523027_13523090 as root directory:

   cd Tucil2_13523027_13523090/

4. Install the dependencies first (if not already installed)
5. Do:

   ./run.sh basic

📟 Paging Mode

1. Open a terminal
2. Clone the repository (if not already cloned)

   git clone https://github.com/Nayekah/Tucil2_13523027_13523090.git

3. Make Tucil2_13523027_13523090 as root directory:

   cd Tucil2_13523027_13523090/

4. Install the dependencies first (if not already installed)
5. Do:

   ./run.sh page

---

🪟 Windows

📰 Default Mode

1. Open a terminal
2. Clone the repository (if not already cloned)

   git clone https://github.com/Nayekah/Tucil2_13523027_13523090.git

3. Make Tucil2_13523027_13523090 as root directory:

   cd .\Tucil2_13523027_13523090

4. Install the dependencies first (if not already installed)
5. Do:

   run.bat basic
   
   or
   
   .\run.bat basic

📟 Paging Mode

1. Open a terminal
2. Clone the repository (if not already cloned)

   git clone https://github.com/Nayekah/Tucil2_13523027_13523090.git

3. Make Tucil2_13523027_13523090 as root directory:

   cd .\Tucil2_13523027_13523090

4. Install the dependencies first (if not already installed)
5. Do:

   run.bat page
   
   or
   
   .\run.bat page

---

‼️ Troubleshooting

if you encounter error when running in windows (or the binary can't be run), go to the run.bat:

# Set OpenCV path based on your device's path (change this line in run.bat)
if exist "C:\tools\opencv\build"

# Set ImageMagick path based on your device's path (change this line in run.bat)
if exist "C:\Program Files\ImageMagick*"
```

---

📱 Repository Structure

📂 Tucil2_13523027_13523090/
├── 📂 bin/
│   ├── .gitignore
│   ├── quadtree_compression
│   └── quadtree_compression.exe
│
├── 📂 doc/
│   ├── .gitkeep
│   └── Tucil2_13523027_13523090.pdf
│
├── 📂 src/
│   ├── 📂 comps/
│   │   ├── BasicInputManager.cpp
│   │   ├── CompressionAnalyzer.cpp
│   │   ├── ErrorCalculation.cpp
│   │   ├── GifGenerator.cpp
│   │   ├── ImageProcessor.cpp
│   │   ├── InputManager.cpp
│   │   ├── QuadTree.cpp
│   │   └── main.cpp
│   │
│   ├── 📂 header/
│   │   ├── BasicInputManager.hpp
│   │   ├── CompressionAnalyzer.hpp
│   │   ├── CompressionParams.hpp
│   │   ├── ErrorCalculator.hpp
│   │   ├── GifGenerator.hpp
│   │   ├── ImageProcessor.hpp
│   │   ├── InputManager.hpp
│   │   ├── Pixel.hpp
│   │   └── QuadTree.hpp
│   │
│   └── .gitkeep
│
├── 📂 test/
│   ├── 📂 input/
│   │   ├── W.jpg
│   │   ├── bocchi.jpg
│   │   ├── coffee.jpg
│   │   ├── flower.jpg
│   │   ├── isagi.jpg
│   │   ├── kaneki.jpeg
│   │   ├── kosong.png
│   │   ├── lappland.jpg
│   │   ├── misteri.jpg
│   │   ├── sample1.jpg
│   │   ├── texas.jpg
│   │   └── tragedy.png
│   │
│   └── 📂 output/
│   │   ├── W256.jpg
│   │   ├── W256gif.gif
│   │   ├── W64.jpg
│   │   ├── W64gif.gif
│   │   ├── Wlow.jpg
│   │   ├── Wlowgif.gif
│   │   ├── bocchlow.jpg
│   │   ├── bocchlowgif.gif
│   │   ├── flower.gif
│   │   ├── lappgif.gif
│   │   ├── lapplow.jpg
│   │   ├── mygoat.jpg
│   │   ├── mygoat2.jpg
│   │   ├── rcoffee.jpg
│   │   ├── rkaneki.jpeg
│   │   ├── rtragedy.png
│   │   ├── sample1a.jpg
│   │   └── texlow2.jpg
├── CMakeLists.txt
├── README.md
├── build.bat
├── build.sh
├── clean.bat
├── clean.sh
├── run.bat
└── run.sh

---

📃 Miscellaneous

No	Points	Yes	No
1	The program compiles successfully without errors.	✔️
2	The Program successfully executed.	✔️
3	The program successfully compresses the image according to the specified parameters.	✔️
4	Implement all mandatory error calculation methods.	✔️
5	[Bonus] Implementation of compression percentage as an additional parameter.	✔️
6	[Bonus] Implementation of Structural Similarity Index (SSIM) as an error measurement method.	✔️
7	[Bonus] Output as GIF Visualizing the Process of Quadtree formation in Image Compression.	✔️
8	Program and report made by ourself	✔️

Project Black Lock • © 2025 • 13523027-13523090