mm_avh_working_space/README.md

# <p align="center">✨MM_AVH✨<br>✨WORKING SPACE✨</p>

## Spis Treści

- [📝 Krótki Opis](#-krótki-opis)
- [📦 Zawartość](#-zawartość)
- [🔗 Linki](#-linki)
- [🔍 Wymagania](#-wymagania)
- [⚡ Instalacja](#-instalacja-windows)
- [📢 Aktualizacje](#-aktualizacje)
- [⚙️ Instrukcja](#-sposób-korzystania)
- [📝 Opis](#-opis-programów)
- [📸 Demonstracja](#-demonstracja)
- [📌 Uwagi](#-uwagi)
- [🙏 Podziękowania](#-podziękowania)
- [📄 Licencja](#-licencja)
- [📧 Kontakt](#-kontakt)

## 📝 Krótki Opis

**Multimedia Magic – Audio Visual Heaven (MM_AVH)** to zestaw narzędzi do przetwarzania i ulepszania multimediów. Repozytorium **_MM_AVH Working Space_** służy jako przestrzeń robocza do ciągłego pobierania, ulepszania i generowania multimediów.

**MM_AVH** składa się z wielu programów, które są stosowane sekwencyjnie, umożliwiając wielowarstwowe przetwarzanie multimediów. Narzędzia obejmują m.in:

- playery, readery, konwertery, edytory, wizualizatory, analizatory, generatory, itp.
- skalowanie
- interpolację
- zarządzanie napisami
- lektorowanie wideo (dubbingowanie w przyszłości)
- tworzenie audiobooków
- automatyczne tłumaczenie tekstów
  i wiele innych.

Celem **MM_AVH** jest udostępnienie zaawansowanych, łatwych w użyciu narzędzi do manipulacji multimediów. **_MM_AVH Working Space_** jest częścią większego projektu, który ma na celu udostępnienie darmowego dostępu do multimediów i ułatwienie ich ulepszania i modyfikacji. Praca nad ulepszaniem **MM_AVH** jest ciągła, a repozytorium jest miejscem, gdzie te ulepszenia są opracowywane i testowane. Projekt **MM_AVH** skupia się również na odkrywaniu i dzieleniu się programami, które mogą poprawić jakość i wygodę odbioru multimediów.

## 📦 Zawartość

Projekt **MM_AVH Working Space** składa się z następujących głównych plików i folderów:

- `assets`: Folder zawierający prezentacje i zrzuty ekranu. Ten folder nie jest niezbędny do działania projektu i może być usunięty.
- `bin`: W tym folderze znajdują się wszystkie pliki wykonywalne (exe) oraz modele używane w projekcie. Podfoldery obejmują:
  - `balabolka`
  - `esrgan`
  - `ffmpeg`
  - `mkvtoolnix`
  - `models`
- `data`: Folder zawierający proste ustawienia programu terminalowego.
- `modules`: Moduły stworzone specjalnie dla tego projektu.
- `tests`: Folder zawierający testy nowych rozwiązań. Ten folder nie jest niezbędny do działania projektu i może być usunięty.
- `utils`: Moduły, które mogą być używane w innych projektach.
- `working_space`: Folder roboczy, do którego przekazujemy pliki do przetworzenia. Zawiera podfoldery `output` i `temp`, które zawierają odpowiednio wyniki przetwarzania i pliki tymczasowe.
- `constants.py`: Plik zawierający stałe ustawienia programu, takie jak ścieżki do folderów i kolorystyka.
- `LICENSE`: Plik zawierający informacje o licencji projektu.
- `README.md`: Plik zawierający wszystkie informacje, które powinieneś wiedzieć o projekcie.
- `start.py`: Plik, który uruchamia proces przetwarzania.
- `requirements.txt`: Plik zawierający listę bibliotek wymaganych do działania projektu.

Struktura folderów projektu wygląda następująco:

```
mm_avh_working_space
├───assets ... ❌
├───bin
│   ├───balabolka
│   ├───esrgan
│   ├───ffmpeg ...
│   │   ├───bin
│   ├───mkvtoolnix ...
│   └───models
├───data
├───modules
├───tests ❌
├───utils
└───working_space ❗
    ├───output
    └───temp
        ├───alt_subs
        └───main_subs
```

Pliki na poziomie głównym to:

- `constants.py`
- `LICENSE`
- `README.md`
- `start.py` ❗
- `requirements.txt` ❗

❌ - zbędne po zapoznaiu się z urzwyaniem

❗ - ważne

## 🔗 Linki

- [Strona Główna - do zrobienia❗❗❗](https://mattymroz.github.io/mm_avh/)
- [Media Players](https://github.com/MattyMroz/mm_avh_media_players)
- [Web Players](https://github.com/MattyMroz/mm_avh_web_players)
- [Working Space **TU**](https://github.com/MattyMroz/mm_avh_working_space)

## 🔍 Wymagania

Tutaj powinieneś wymienić wszystko, co użytkownik musi zainstalować lub wiedzieć, zanim zacznie korzystać z Twojego projektu. Może to obejmować wymagania dotyczące oprogramowania, sprzętu, wiedzy lub zasobów.

Windows
FFmpeg zapisany w zmiennej środowiskowej PATH
Python >=10

## ⚡ Instalacja

W tej sekcji powinieneś opisać, jak zainstalować i skonfigurować Twój projekt. Krok po kroku instrukcje są tutaj bardzo pomocne.



## 📢 Aktualizacje

Tutaj możesz informować użytkowników o najnowszych aktualizacjach Twojego projektu.

## ⚙️ Sposób Korzystania

W tej sekcji powinieneś opisać, jak korzystać z Twojego projektu. Możesz tutaj umieścić przykłady użycia, wskazówki i triki.

## 📝 Opis Programów

Tutaj możesz opisać, jakie programy są używane w Twoim projekcie i do czego służą.

## 📸 Demonstracja

W tej sekcji możesz pokazać, jak działa Twój projekt. Możesz tutaj umieścić zrzuty ekranu, filmy lub gify.

## 📌 Uwagi

Tutaj możesz umieścić wszelkie dodatkowe uwagi, które mogą być ważne dla użytkowników Twojego projektu.

## 🙏 Podziękowania

Tutaj możesz podziękować osobom, które pomogły Ci w projekcie. Możesz podać ich imiona, role, jak pomogli.

## 📄 Licencja

W tej sekcji powinieneś podać, jaka licencja obowiązuje dla Twojego projektu. Możesz podać typ licencji i link do pełnego tekstu licencji.

## 📧 Kontakt

W tej sekcji powinieneś podać informacje kontaktowe, takie jak adres e-mail, profil na LinkedIn, strona internetowa itp.

<!-- Instalation:
git clone https://github.com/MattyMroz/mm_avh_working_space.git
cd mm_avh
pip install -r requirements.txt -->