Merge branch 'main' of https://www.github.com/abir-tx/ffmpeg-coder

Author: Abir-Tx

.clang-format

@@ -0,0 +1,10 @@
+IndentWidth: 4
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: true
+AlignConsecutiveBitFields: true
+AlignConsecutiveMacros: true
+AlignTrailingComments: true
+AllowShortBlocksOnASingleLine: Empty
+AllowShortCaseLabelsOnASingleLine: true
+AllowShortFunctionsOnASingleLine: Empty
+AllowShortLoopsOnASingleLine: true

.github/docs_res/project_tree.png

@@ -0,0 +1,32 @@
+name: C/C++ CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build-linux:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: make-dir
+        run: make dir
+      - name: linux-build
+        run: make build
+      - name: make run
+        run: make run
+
+  build-windows:
+    runs-on: windows-2019
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: install-make
+        run: choco install make
+      - name: make-directory
+        run: make dir
+      - name: windows-build
+        run: make winbuild

.github/workflows/c-cpp.yml

@@ -36,4 +36,5 @@
 #project extras
 bin/*
 passphrase.bin
-s_lockValue.bin
+s_lockValue.bin
+release-configs/*

.gitignore

@@ -12,7 +12,7 @@ APPNAME := ffmpeg-coder
 
 .PHONY: all
 
-all: dir build run
+all: build run
 
 .PHONY: build
 build:
@@ -22,14 +22,26 @@ build:
 clean:
 	echo Deleting the binaries....
 	rm ${BUILDDIR}/*
-	rm usrData/*
-	rm appData/*
-
+	rm ffmpeg-coder/usr/bin/ffmpeg-coder
+	
 .PHONY: run
 run:
-	echo "Running the built program...."
+	echo Running the built program....
 	./${BUILDDIR}/${APPNAME}.o
 
+.PHONY: dir
+dir:
+	echo Creating directories.....
+	mkdir bin
+
+.PHONY: debpackage
+debpackage: build
+	echo Creating the debian package of ffmpeg-coder
+	mv bin/ffmpeg-coder.o bin/ffmpeg-coder
+	cp bin/ffmpeg-coder ffmpeg-coder/usr/bin/
+	fakeroot dpkg-deb -v --build ffmpeg-coder bin
+	echo The deb package has been created in the bin folder
+	
 
 # Windows Configs for make
 .PHONY: winbuild
@@ -38,10 +50,5 @@ winbuild:
 
 .PHONY: winrun
 winrun:
-	echo "Running the built program...."
+	echo Running the built program....
 	./${BUILDDIR}/${APPNAME}.exe
-
-.PHONY: dir
-dir:
-	echo Creating directories.....
-	mkdir bin usrData appData

Makefile

@@ -0,0 +1,84 @@
+# How to contribute to **ffmpeg-coder**
+
+I'm really happy that you are here & reading this. If you are interested in contributing to this project and make it larger then this section will help you get started.
+
+This project needs more contributors. And any beginner **C++** programmer will be able to contribute to this project.
+
+### Some important links & resources
+- In case you need more details, you can [mail](mailto:abirtx@yandex.com) me at this address abirtx@yandex.com
+
+- If you want to test the tool or use it in your system before contributing [here](https://github.com/Abir-Tx/ffmpeg-coder#installation) is the installation guide for different OS
+
+- My goal is to add all the ffmpeg options to this tool with easy instructions so that users can generate commands without any hassle or knowing.
+
+- You can contribute by submitting issues, or by fixing a problem/bugs or by implementing new features by submitting **Pull requests**.
+
+- As the project is based on ffmpeg commands generation you should have a basic knowledge about **ffmpeg** CLI and how to create commands for converting videos with different options using ffmpeg command line interface. You can get to know about ffmpeg from [here](https://ffmpeg.org/ffmpeg.html).
+
+## Found Bugs ?
+- Submit the issue [here](https://github.com/Abir-Tx/ffmpeg-coder/issues/new/choose)
+
+Read more from the [**Having Issues**](https://github.com/Abir-Tx/ffmpeg-coder#having-issues-) section.
+
+## Did you find patch or a fix for a Bug?
+
+- Open a [new GitHub Pull Request](https://github.com/Abir-Tx/ffmpeg-coder/compare) with your patch or code changes.
+
+- Describe the problem and your fix/code changes clearly. Include the relevant issue number if applicable.
+
+## Contributing to documentations?
+
+You can also contribute to the project by adding documentation as the projects documentation or wiki is not completed yet. So if you are interested to enhance the documentation then you are most welcome.
+
+Just creare a pull request with your documentation changes or you can email me too.
+
+## Adding new features or extending the tool
+
+If you really want to contribute to this project, the best way is to get familiar with the project structure and files and then implement the features needed. So much features are left to add to this project as **ffmpeg** is a very powerfull tool and has so many commands to offer. So you can add any ffmpeg video converting command generation feature to this project. 
+
+- First you need to know some basics of ffmpeg CLI commands so that you can use those commands in this project to add features
+
+- Get familiar with the source code and project structure so that is becomes easier for you to implement the features. The project structure & source code is described [here](https://github.com/Abir-Tx/ffmpeg-coder/blob/main/docs/source-code.md)
+
+- Add your code/feature by forking this project first & then write your codes & then submit the changes by creating a pull request
+
+- Further discussions can be done with me using my mail address provided above.
+
+## Submitting chnages
+Please follow the projects coding conventions (below) and make sure all of your commits are atomic (one feature per commit).
+
+Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
+
+    $ git commit -m "A brief summary of the commit
+    > 
+    > A paragraph describing what changed and its impact."
+
+## Building/compiling the source code
+
+When writing codes for this project you will need to test the code first before submitting. To test the code you will need to compile the code. I have made it easier to compile the whole source code with all the header files using **Makefile**. So first ensure that **make** is installed in your system.
+
+The build process is described in the projects readme in the installation section. 
+
+- [Get to know about the build process](https://github.com/Abir-Tx/ffmpeg-coder#install-from-source)
+
+
+## Coding Conventions
+The project uses a [```.clang-format```](https://github.com/Abir-Tx/ffmpeg-coder/blob/main/.clang-format) file to maintain the coding convention across the whole project for all the cpp & hpp (source & header) files. 
+
+After you finished your code writing for this project always try to format your code/file using the projects [```.clang-format```](https://github.com/Abir-Tx/ffmpeg-coder/blob/main/.clang-format) file.
+
+To do so - 
+
+- Install clang-format in you system & set up. Know more about [clang-format](https://clang.llvm.org/docs/ClangFormat.html)
+
+- Use this command to use this projects clang format file while formatting the source code 
+
+```bash
+clang-format -style=file -i your-changed-file.cpp
+```
+
+----
+
+***Thanks for your contibution***
+
+**Abir-Tx**

README.md

@@ -0,0 +1,166 @@
+[![Download ffmpeg-coder](https://sourceforge.net/sflogo.php?type=11&group_id=3333544)](https://sourceforge.net/p/ffmpeg-coder/)
+
+[![Download ffmpeg-coder](https://img.shields.io/sourceforge/dt/ffmpeg-coder.svg)](https://sourceforge.net/projects/ffmpeg-coder/files/latest/download) [![C/C++ CI](https://github.com/Abir-Tx/ffmpeg-coder/actions/workflows/c-cpp.yml/badge.svg)](https://github.com/Abir-Tx/ffmpeg-coder/actions/workflows/c-cpp.yml)
+
+# FFMPEG-Coder
+
+A small **_cross platform_** CLI tool which will help in producing different types video converting codes quickly for new ffmpeg CLI users. The tool will make it easy to generate ffmpeg commands for them. If you don't use or know about **FFMPEG** then this tool might not be for you.
+
+# Who is this tool for ?
+
+This tool is created for those who find it difficult to understand or find the appropriate commands for converting a video as they want using the FFMPEG CLI tool.
+
+Also those who are new to Command Lines they can also use this tool to generate ffmpeg commands very easily. Many new ffmpeg users find it difficult to find the appropriate ffmpeg commands to convert their videos to with their desired configs. So, as a result they end up googling a lot and wasting their time. So this tool is for them.
+
+# Pre-requisites
+
+The user should have really basic knowledge about ffmpeg like how to run ffmpeg in a directory and how to issue the commands. Thats it !!
+
+# Features
+
+- Supports **Windows, Linux** & **Mac OS**.
+- Does not dpeend on any other dependencies.
+- Very small, fast and lightweight.
+- Supports options for **h264** and **libx265**.
+
+# Downloads
+
+- Downloads are available in **sourceforge** -
+
+[![Download ffmpeg-coder](https://a.fsdn.com/con/app/sf-download-button)](https://sourceforge.net/projects/ffmpeg-coder/files/latest/download)
+
+- You can download the latest version from the [release](https://github.com/Abir-Tx/ffmpeg-coder/releases/latest) section.
+
+# Installation
+
+## Windows
+
+- First download the windows installer file from the release or from [here](https://github.com/Abir-Tx/ffmpeg-coder/releases/download/v1.0/ffmpeg-coder_1.0_win.zip).
+- Extract or Unzip the **ffmpeg-coder_1.0_win.zip**
+- Go into the unzipped folder and double click on **ffmpeg-coder_1.0_win.exe** file.
+- The installer will start & then just follow the onscreen instructions and ffmpeg-coder will be installed on your machine
+- After installation, from the start menu search for **_ffmpeg-coder_** and open the tool.
+
+## Linux (Debian based distros)
+
+This installation process works on ubuntu, kali linux, linux mint, debian and other debian based distros.
+
+### Automatic One Click Process
+
+- Just copy and paste this script below and **_voila_**
+
+```bash
+wget https://raw.githubusercontent.com/Abir-Tx/ffmpeg-coder/main/scripts/debian_install.sh && chmod +x debian_install.sh &&./debian_install.sh
+```
+
+### Manual Download Process
+
+- First download the **ffmpeg-coder_1.0_all.deb** from the release or from [here](https://github.com/Abir-Tx/ffmpeg-coder/releases/download/v1.0/ffmpeg-coder_1.0_all.deb).
+- Then open terminal to the folder where the .deb file is downloaded.
+- Now from the terminal run -
+
+```bash
+chmod +x ffmpeg-coder_1.0_all.deb
+sudo apt install ./ffmpeg-coder_1.0_all.deb
+```
+
+- **_ffmpeg-coder_** should be installed now. Now run `ffmpeg-coder` in your terminal. Sometime if running just after installation the tool might not start. In that case run `ffmpeg-coder` in terminal twice.
+
+## Install from source
+
+Users other than Debian based distro can use the tool by compiling the tool from the source code easily. Also any distro or windows users can compile and use the tool if they are having problems using the binary packages provided in the release.
+
+**Steps for compiling from the source -**
+
+- Download the [**Source Code.zip**](https://github.com/Abir-Tx/ffmpeg-coder/archive/v1.0.zip) from the release section for the stable version or using git for the latest devlopement version. In Terminal for Linux or CMD for Windows run -
+
+```bash
+git clone https://github.com/Abir-Tx/ffmpeg-coder.git
+```
+
+- Then `cd` into the `ffmpeg-coder` directory.
+
+```bahs
+cd ffmpeg-coder
+```
+
+## Using Make
+
+- **Linux**
+
+Now if you are in linux & have build-essentian installed then just run -
+
+```bash
+make dir
+make build
+```
+
+The tool will be compiled to the `bin` folder inside ffmpeg-coder folder. You can also run `make run` to run the tool from there -
+
+```bash
+make run
+```
+
+- **Windows**
+
+If you are windows user and have **\*GNU Make** installed or configured in your system then run -
+
+```batch
+make dir
+make winbuild
+```
+
+The tool will be compiled to the `bin` folder inside ffmpeg-coder folder. You can also run `make winrun` to run the tool from there -
+
+```batch
+make winrun
+```
+
+## Using G++
+
+- **In Linux run -**
+
+```bash
+g++ src/ffmpeg-coder.cpp -I include/ffmpeg-coder -I lib/ -o bin/ffmpeg-coder
+./bin/ffmpeg-coder
+```
+
+- **In Windows run -**
+
+```batch
+g++ src/ffmpeg-coder.cpp -I include/ffmpeg-coder -I lib/ -o bin/ffmpeg-coder.exe
+./bin/ffmpeg-coder
+```
+
+By following the above steps you will have a compiled version of **_ffmpeg-coder_** for your device.
+
+---
+
+# Troubleshooting
+
+- ### **App not openning after first installaton**:
+
+  Sometime on some platforms (Specially Linux) the open does not open after installion when run. In that case run the app twice or more and the app will start.
+
+- ### **App lock feature not working on Linux**:
+  The startup lock feature is currently disabled in source code as it is creating some issues so the **App lock** feature will not work in linux as of now.
+
+**_Future fix is planned_**
+
+# Having issues ?
+
+If you are having any issue related to this tool or if you face any bug/problem while using the tool, please let us know by creating an **_issue_** from the [issue](https://github.com/Abir-Tx/ffmpeg-coder/issues) tab or by clicking [here](https://github.com/Abir-Tx/ffmpeg-coder/issues/new/choose). In the issue form describe what problems you face or what features you want next.
+
+I will try to fix and add features as much as I can.
+
+# Maintainers & Contributors
+
+**Maintainers**
+
+- [Abir-Tx](https://www.github.com/abir-tx)
+
+# Contribute
+
+See [Contribution guidelines for this project](/docs/CONTRIBUTING.md)
+
+> Pull requests are always welcomed !! :-)