├── data └── .gitkeep ├── audios └── .gitkeep ├── videos └── .gitkeep ├── modules ├── __init__.py ├── voiceCloning.py ├── helperFunctions.py └── FlaskAPIRouting.py ├── Assets └── logo.jpg ├── requirements.txt ├── .vscode └── settings.json ├── .devcontainer ├── welcome.txt └── devcontainer.json ├── .github ├── .devcontainer │ └── devcontainer.json └── workflows │ ├── python-app.yml │ └── devcontainer-build-and-push.yml ├── main.py ├── LICENSE ├── tests └── unit_test.py ├── docs ├── API.md ├── CONTRIBUTING.md └── LICENSE ├── README.md └── .gitignore /data/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /audios/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /videos/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /modules/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /Assets/logo.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AdiKsOnDev/YouTranslate/HEAD/Assets/logo.jpg -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | youtube-transcript-api 2 | pytube 3 | moviepy 4 | elevenlabs 5 | googletrans==3.1.0a0 6 | requests 7 | flask 8 | jsonify 9 | python-dotenv -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "python.testing.unittestArgs": [ 3 | "-v", 4 | "-s", 5 | "./tests", 6 | "-p", 7 | "*test.py" 8 | ], 9 | "python.testing.pytestEnabled": false, 10 | "python.testing.unittestEnabled": true 11 | } -------------------------------------------------------------------------------- /.devcontainer/welcome.txt: -------------------------------------------------------------------------------- 1 | Welcome to YouTranslate! 💻 You're currently on a custom Dev Container for GitHub Codespaces! 2 | 3 | To get started, make sure you have your API Key for the ElevenLab's speech synthesis 4 | ElevenLabs API: https://docs.elevenlabs.io/api-reference/quick-start/introduction 5 | 6 | Have fun! 😊 7 | -------------------------------------------------------------------------------- /.github/.devcontainer/devcontainer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "YouTranslate Dev Container", 3 | // Reference: https://github.com/devcontainers/images/tree/main/src/python 4 | "image": "mcr.microsoft.com/devcontainers/python:3", 5 | "features": { 6 | "ghcr.io/devcontainers/features/git-lfs:1": { 7 | "version": "latest" 8 | }, 9 | "ghcr.io/devcontainers/features/github-cli:1": { 10 | "version": "latest" 11 | } 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /.github/workflows/python-app.yml: -------------------------------------------------------------------------------- 1 | # This workflow will install Python dependencies, run tests and lint with a single version of Python 2 | # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python 3 | 4 | name: Python application 5 | 6 | on: 7 | push: 8 | branches: [ "main" ] 9 | pull_request: 10 | branches: [ "main" ] 11 | 12 | permissions: 13 | contents: read 14 | 15 | jobs: 16 | build: 17 | 18 | runs-on: ubuntu-latest 19 | 20 | steps: 21 | - uses: actions/checkout@v3 22 | - name: Set up Python 3.11 23 | uses: actions/setup-python@v3 24 | with: 25 | python-version: "3.11" 26 | - name: Install dependencies 27 | run: | 28 | python -m pip install --upgrade pip 29 | pip install flake8 pytest 30 | if [ -f requirements.txt ]; then pip install -r requirements.txt; fi 31 | - name: Test with unittest 32 | run: | 33 | python -m unittest discover -s "./tests/" -p '*_test.py' 34 | -------------------------------------------------------------------------------- /.github/workflows/devcontainer-build-and-push.yml: -------------------------------------------------------------------------------- 1 | name: Dev Container Build and Push Image 2 | 3 | on: 4 | push: 5 | paths: 6 | - '.github/**' 7 | 8 | concurrency: 9 | group: ${{ github.workflow }}-${{ github.ref }} 10 | cancel-in-progress: true 11 | 12 | jobs: 13 | build-and-push: 14 | runs-on: ubuntu-latest 15 | steps: 16 | - name: Checkout 17 | id: checkout 18 | uses: actions/checkout@v4 19 | - name: Login to GitHub Container Registry 20 | uses: docker/login-action@v3 21 | with: 22 | registry: ghcr.io 23 | username: ${{ github.actor }} 24 | password: ${{ secrets.GITHUB_TOKEN }} 25 | - name: Convert Repository name to lower case 26 | id: lowercase 27 | run: echo "REPO=$(echo "${{ github.repository }}" | tr '[:upper:]' '[:lower:]')" >> $GITHUB_ENV 28 | - name: Pre-build Dev Container image 29 | uses: devcontainers/ci@v0.3 30 | with: 31 | subFolder: .github 32 | imageName: ghcr.io/${{ env.REPO }} 33 | cacheFrom: ghcr.io/${{ github.repository }} 34 | push: always 35 | -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | from modules.helperFunctions import * 2 | from pytube import extract 3 | from modules.voiceCloning import * 4 | 5 | url = input("Paste the link to the video you want to translate: ") 6 | id = extract.video_id(url) 7 | target_audience = input("What lanuage do you wish to translate your video to? Supported languages are --> en (English)/de (German)/fr (French)/pl (Polish)/es (Spanish)/it (Italian) ") 8 | 9 | installVideo(url) 10 | get_transcript(id, "data/transcript.txt") # Get the video's transcript to translate it to a different language 11 | extract_audio("videos/Original_Video", "audios/sample.mp3") # Extract the audio to use it as a sample for voice cloning 12 | get_translation("data/transcript.txt", "data/translated_transcript.txt", target_audience) # Translate the transcript for recording a voice over for it 13 | 14 | with open("data/translated_transcript.txt", "r") as file: 15 | voiceOver(file.read(), "audios/VoiceOver.mp3") 16 | delete_cloned_voice() 17 | 18 | replace_audio("videos/Original_Video", "audios/VoiceOver.mp3", "videos/Final_Video.mp4") # Combine the final recording with the original video -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 Adil Alizada 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /.devcontainer/devcontainer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "YouTranslate Dev Container", 3 | // Reference: https://github.com/devcontainers/images/tree/main/src/python 4 | "image": "ghcr.io/adiksondev/youtranslate:latest", 5 | "customizations": { 6 | "vscode": { 7 | "extensions": [ 8 | "eamodio.gitlens", 9 | "ms-python.python", 10 | "ms-python.pylint", 11 | "vscode-icons-team.vscode-icons", 12 | "njpwerner.autodocstring", 13 | "aaron-bond.better-comments", 14 | "GitHub.copilot", 15 | "GitHub.copilot-chat", 16 | "bierner.github-markdown-preview", 17 | "VisualStudioExptTeam.vscodeintellicode", 18 | "ms-vsliveshare.vsliveshare", 19 | "EditorConfig.EditorConfig", 20 | "dotenv.dotenv-vscode" 21 | ] 22 | } 23 | }, 24 | "forwardPorts": [5000], 25 | "portsAttributes": { 26 | "5000": { 27 | "label": "Application", 28 | "onAutoForward": "notify" 29 | } 30 | }, 31 | 32 | "postCreateCommand": "sudo cp .devcontainer/welcome.txt /usr/local/etc/vscode-dev-containers/first-run-notice.txt", 33 | "postStartCommand": "pip install -r requirements.txt" 34 | } 35 | -------------------------------------------------------------------------------- /tests/unit_test.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | import sys 3 | import os 4 | 5 | path = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) 6 | print(path) 7 | sys.path.insert(0, path) 8 | 9 | from unittest.mock import patch, mock_open 10 | from modules.helperFunctions import get_transcript_no_delay, get_transcript, installVideo, extract_audio, replace_audio, get_translation 11 | 12 | class TestHelperFunctions(unittest.TestCase): 13 | 14 | @patch('modules.helperFunctions.YouTubeTranscriptApi.get_transcript') 15 | def test_get_transcript_no_delay(self, mock_get_transcript): 16 | mock_get_transcript.return_value = [{'text': 'test'}] 17 | with patch("builtins.open", mock_open()) as mock_file: 18 | get_transcript_no_delay('3JNEDnl8XXA', 'no_delay.txt') 19 | mock_file().write.assert_called_with('\n') 20 | 21 | @patch('modules.helperFunctions.get_transcript') 22 | def test_get_transcript(self, mock_get_transcript): 23 | mock_get_transcript.return_value = [{'text': 'test', 'start': 0, 'duration': 0}] 24 | with patch("builtins.open", mock_open()) as mock_file: 25 | get_transcript('3JNEDnl8XXA', 'no_delay.txt') 26 | mock_file().write.assert_called_with('\n') 27 | 28 | @patch('modules.helperFunctions.YouTube') 29 | def test_installVideo(self, mock_youtube): 30 | mock_youtube.return_value.streams.filter().first().download.return_value = None 31 | self.assertEqual(installVideo('https://www.youtube.com/watch?v=3JNEDnl8XXA'), 0) 32 | 33 | if __name__ == '__main__': 34 | unittest.main() -------------------------------------------------------------------------------- /modules/voiceCloning.py: -------------------------------------------------------------------------------- 1 | from elevenlabs import clone, generate, set_api_key, save, Voices, Voice 2 | from dotenv import dotenv_values 3 | from os import listdir, system 4 | 5 | import requests 6 | 7 | if not '.env' in listdir('.'): 8 | api_key = input("Please input your api key: ") 9 | system(f'echo "API_KEY={str(api_key)}" > .env') 10 | else: 11 | config = dotenv_values(".env") 12 | api_key = config['API_KEY'] 13 | 14 | def voiceOverNoClone(transcript:str, output_file:str): 15 | """ Function for recording the translated audio track. 16 | 17 | Arguments: 18 | transcript --> The transcript to be used for voice-over 19 | output_file --> Path to the output file 20 | 21 | No return type 22 | """ 23 | set_api_key(api_key) 24 | 25 | print("Generating a Voice Over...") 26 | 27 | 28 | 29 | 30 | audio = generate(text=transcript) 31 | 32 | save(audio, output_file) 33 | 34 | def voiceOver(transcript:str, output_file:str): 35 | """ Function for recording the translated audio track. 36 | 37 | Arguments: 38 | transcript --> The transcript to be used for voice-over 39 | output_file --> Path to the output file 40 | 41 | No return type 42 | """ 43 | set_api_key(api_key) 44 | 45 | print("Generating a Voice Over...") 46 | 47 | voice = clone( 48 | name="YouTuber", 49 | files=["audios/sample.mp3"], 50 | model='eleven_multilingual_v1' 51 | ) 52 | 53 | 54 | audio = generate(text=transcript, voice=voice) 55 | 56 | save(audio, output_file) 57 | 58 | def delete_cloned_voice(): 59 | """ Function for deleting the voice template form ElevenLabs API 60 | 61 | No Arguments 62 | 63 | No return type 64 | """ 65 | HEADERS = { 66 | "Accept": "application/json", 67 | "xi-api-key": api_key 68 | } 69 | 70 | voices = Voices.from_api() 71 | URL = f"https://api.elevenlabs.io/v1/voices/{voices[0].voice_id}" 72 | 73 | response = requests.delete(URL, headers=HEADERS) 74 | 75 | print(response) -------------------------------------------------------------------------------- /docs/API.md: -------------------------------------------------------------------------------- 1 | # TranslatorYoutube-API Documentation 2 | 3 | ## Introduction 4 | This API documentation provides details about the endpoints available in the application. 5 | The API allows users 2 routes, one of which returns the a translated voiceover of a YouTube video 6 | and the other which clones the voice in the YouTube video, layers it over the video and returns the new video 7 | 8 | ## Base URL 9 | The base URL for all API endpoints is `[http://127.0.0.1:5000]` when running the application locally with Flask. 10 | 11 | ## Endpoints 12 | 13 | ### `POST /translated_audio` 14 | An API route that translates the audio track of a YouTube video and returns the translated audio in MP3 format. 15 | 16 | #### Request Body 17 | The request body should be a JSON object with the following parameters: 18 | 19 | - `video_url` (string, required): The URL of the YouTube video for which the audio needs to be translated. 20 | - `language_code` (string, required): The language code for the desired translation language (e.g., 'en' for English, 'fr' for French, 21 | - 'de' for German, 'pl' for Polish, 'es' for Spanish, 'it' for Italian, 'pt' for Portuguese, 'hi' for Hindi. 22 | 23 | #### Response 24 | - `200 OK`: If the translation is successful, the API will respond with the translated audio in MP3 format. 25 | - `500 Internal Server Error`: If an error occurs during the translation process, the API will respond with an error message. 26 | 27 | ### `POST /translated_with_video` 28 | An API route that clones the voice used in a YouTube video, translates the cloned audio track of a YouTube video, creates a new video with the translated cloned audio track, and returns the final video in MP4 format. 29 | 30 | #### Request Body 31 | The request body should be a JSON object with the following parameters: 32 | 33 | - `video_url` (string, required): The URL of the YouTube video for which the audio needs to be translated and video created. 34 | - `language_code` (string, required): The language code for the desired translation language (e.g., 'en' for English, 'fr' for French). 35 | 36 | #### Response 37 | - `200 OK`: If the translation and video creation are successful, the API will respond with the final video in MP4 format. 38 | - `400 Bad Request`: If the YouTube video URL is invalid or cannot be accessed, the API will respond with an error message. 39 | - `500 Internal Server Error`: If an error occurs during the translation and video creation process, the API will respond with an error message. 40 | 41 | ## Running the Application 42 | To run the application, execute the following command: 43 | 44 | ```bash 45 | python FlaskAPIRouting.py 46 | ``` 47 | 48 | 49 | The application will be hosted locally on `http://127.0.0.1:5000`, and you can use the endpoints as described above. 50 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | Logo 3 |

4 |
5 | 6 | [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/AdiKsOnDev/YouTranslate) 7 | 8 | YouTranslate is a Python script that allows you to create multilingual YouTube videos by cloning the voice of the video's author and translating the video's transcript to a different language. The script then performs a voice-over using the translated script and cloned voice, enabling you to reach a broader audience by offering content in multiple languages! 9 | 10 | ## :open_file_folder: Installation 11 | 12 | 1. Go to the most recent production-ready release and install the zip with the source code 13 | 2. Ensure you have Python 3.11+ installed on your system. 14 | 3. Install the required dependencies by running the following command: 15 | 16 | ```bash 17 | pip install -r requirements.txt 18 | ``` 19 | 20 | ## :exclamation: Prerequisites 21 | 22 | To use YouTranslate, you will need the following: 23 | 24 | - An API Key for the ElevenLab's speech synthesis (See [ElevenLabs API](https://docs.elevenlabs.io/api-reference/quick-start/introduction)) 25 | - A YouTube video URL for which you want to create a multilingual version. 26 | 27 | ## :scroll: Usage 28 | 29 | 1. Run the Script: 30 | - Create a `.env` file and write `API_KEY = "Your elevenlabs api key"` in it 31 | - Open your terminal or command prompt. 32 | - Execute the following command: 33 | 34 | ```bash 35 | python main.py 36 | ``` 37 | 38 | 2. Review the Output: 39 | - The script will process the video, clone the voice, translate the transcript, and generate the final multilingual version. 40 | - After completion, you will find the multilingual video file in the `videos/` directory (`Final_Video.mp4`). 41 | - Add background sounds, polish the video. (If you are the author of the original video and you still have the video's assets on your computer) 42 | - Don't forget that the voice synthesis is not able to copy original author's pacing. You will have to edit the video to make it as good as possible 43 | 44 | 3. Upload to YouTube: 45 | - Upload the generated `Final_Video.mp4` to your YouTube channel and publish it to reach a wider audience. 46 | 47 | ## :question: How It Works 48 | 49 | YouTranslate utilizes ElevenLabs' voice cloning API and 'googletrans' python library to create multilingual YouTube videos. The steps involved are as follows: 50 | 51 | 1. Getting the video and Cloning the voice: 52 | - The script uses voice cloning technology to clone the voice of the video's author, based on the `sample.mp3` file (Original audio track from the video) 53 | 54 | 2. Transcript Translation: 55 | - The script leverages googletrans library to translate the script to the languages that ElevenLabs' API supports 56 | 57 | 3. Voice-Over and Video Generation: 58 | - The translated transcript is combined with the voice-over to create the final multilingual video, `Final_Video.mp4`. 59 | 60 | ## :medical_symbol: Contributing 61 | 62 | Contributions to YouTranslate are welcome! If you find any issues or want to improve the script, feel free to submit a pull request. For major changes or new features, please open an issue first to discuss the proposed changes. 63 | 64 | For more info, check out [**CONTRIBUTING.md**](./docs/CONTRIBUTING.md) 65 | -------------------------------------------------------------------------------- /docs/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # 📜 Conventions for contributions 2 | This file contains guidelines for creating *commits, PRs, branches, issues, and etc*. 3 | 4 | ## Index 5 | 6 | - [Commits](#➕-commits) 7 | - [Commit Message Structure](#🗃️-commit-message-structure) 8 | - [Example Commit](#example-commit) 9 | - [Commit Types](#📑-commit-types) 10 | - [Breaking Changes](#❗️-breaking-changes) 11 | - [Branching](#🌳-branching) 12 | - [Example Branch Name](#📄-example-branch-name) 13 | - [Pull Requests (PRs)](#pull-requests-prs) 14 | - [PR message structure](#🗃️-pr-message-structure) 15 | - [Example PR Message](#📄-example-pr-message) 16 | 17 | > [!NOTE] 18 | > **READ BEFORE CONTRIBUTING!**
19 | > If you have any questions on the following information, text me (Adil), I will take you through it. 20 | 21 | --- 22 | 23 | ## ➕ Commits 24 | First, let's answer the questions **"When do I commit? And how many files do I commit at once?"** 25 |
26 | The answer is very simple! Commit anytime you are done with ANY task. **For ex:** 27 |
28 |
29 | Let's say you are adding a login page. That's a big task, so you divide it on small ***sub-tasks***. (Make a login box, make a button, connect firebase, and etc.) 30 | 31 | Everytime you are done with a subtask, make a commit! 32 | 33 | > [!WARNING] 34 | > Please, don't stage all the files in one commit. Stage only the files that are relevant to the subtask you finished.
35 | > This is going to be unbelievably helpful down the road. 36 | 37 | ### 🗃️ Commit message Structure 38 | --- 39 | Commits should consist of **three** parts: 40 | ``` 41 | Message 42 | 43 | 44 | ``` 45 | 46 | ### Example Commit 47 | --- 48 | ``` 49 | fix: Fixed login button bug 50 | 51 | The bug where login button would successfully authenticate the user, but didn't take him to the homepage as needed. 52 | ``` 53 | 54 | ### 📑 Commit Types 55 | --- 56 | Is recommended to be one of the below items. Only **feat** and **fix** show up in the changelog, in addition to breaking changes (See breaking changes section below). 57 | 58 | * **feat**: A new feature 59 | * **fix**: A bug fix 60 | * **docs**: Documentation only changes 61 | * **refactor**: A code change that neither fixes a bug or adds a feature 62 | * **test**: Adding missing tests 63 | * **chore**: Changes to the build process or auxiliary tools and libraries such as documentation 64 | generation 65 | 66 | ### ❗️ Breaking Changes 67 | --- 68 | Put any breaking changes with migration instructions in the commit body. 69 | 70 | If there is a breaking change, put "BREAKING CHANGE:" in your ***commit body***, and it will show up in the **changelog**. 71 | 72 | ## 🌳 Branching 73 | Try to have 1 branch per 1 issue. When you take up an issue (task) to work on, assign it to yourself on the issue's page, and comment: "@AdiKsOnDev, I am working on this issue." 74 | 75 | 76 | The name of the branch has to be as follows: 77 | ``` 78 | - 79 | ``` 80 | 81 | ### 📄 Example branch name 82 | ``` 83 | 9-migrating-to-reactJS 84 | ``` 85 | 86 | ## Pull Requests (PRs) 87 | Make a pull request when you are completely done with your issue. Assign me as a reviewer & assignee, as the milestone choose the according milestone. 88 | 89 | ### 🗃️ PR message structure 90 | --- 91 | ``` 92 | 93 | 94 | 95 | TODO: (If something needs to be done further) 96 | 97 | Closes Issue #number-of-the-issue 98 | ``` 99 | 100 | ### 📄 Example PR message 101 | --- 102 | 103 | ``` 104 | Login Page finished 105 | 106 | Connected firebase, cookies are stored in the browser and are called "user_id", "user_login" 107 | 108 | TODO: Add login page to the Router in App.js 109 | 110 | Closes Issue #5 111 | ``` 112 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/#use-with-ide 110 | .pdm.toml 111 | 112 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 113 | __pypackages__/ 114 | 115 | # Celery stuff 116 | celerybeat-schedule 117 | celerybeat.pid 118 | 119 | # SageMath parsed files 120 | *.sage.py 121 | 122 | # Environments 123 | .env 124 | .venv 125 | env/ 126 | venv/ 127 | ENV/ 128 | env.bak/ 129 | venv.bak/ 130 | 131 | # Spyder project settings 132 | .spyderproject 133 | .spyproject 134 | 135 | # Rope project settings 136 | .ropeproject 137 | 138 | # mkdocs documentation 139 | /site 140 | 141 | # mypy 142 | .mypy_cache/ 143 | .dmypy.json 144 | dmypy.json 145 | 146 | # Pyre type checker 147 | .pyre/ 148 | 149 | # pytype static type analyzer 150 | .pytype/ 151 | 152 | # Cython debug symbols 153 | cython_debug/ 154 | 155 | # API keys 156 | apiKey.py 157 | 158 | # Audio and Video files 159 | audios/*.mp3 160 | videos/*.mp4 161 | videos/Original_Video 162 | 163 | # Transcripts 164 | data/*.txt 165 | 166 | # PyCharm 167 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 168 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 169 | # and can be added to the global gitignore or merged into this file. For a more nuclear 170 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 171 | #.idea/ -------------------------------------------------------------------------------- /modules/helperFunctions.py: -------------------------------------------------------------------------------- 1 | from pytube import YouTube 2 | from youtube_transcript_api import YouTubeTranscriptApi 3 | from moviepy.editor import VideoFileClip, AudioFileClip 4 | from googletrans import Translator 5 | 6 | def get_transcript_no_delay(video_id:str, file_name:str): 7 | """ Function will get the transcript of a video and write it down 8 | in "transcript.txt" WITHOUT adding any delays 9 | 10 | Arguments: 11 | video_id --> String containing the ID for a YouTube video 12 | 13 | No return type 14 | """ 15 | print("Getting the transcript...") 16 | 17 | transcript = YouTubeTranscriptApi.get_transcript(video_id) 18 | 19 | with open(file_name, "w", encoding= "utf-8") as file: 20 | for i in range(len(transcript)): 21 | subtitle = transcript[i] 22 | text = subtitle["text"] 23 | file.write(text) 24 | file.write("\n") 25 | 26 | def get_transcript(video_id:str, file_name:str): 27 | """ Function will get the transcript of a video and write it down 28 | in "transcript.txt" 29 | 30 | Arguments: 31 | video_id --> String containing the ID for a YouTube video 32 | 33 | No return type 34 | """ 35 | print("Getting the transcript...") 36 | 37 | transcript = YouTubeTranscriptApi.get_transcript(video_id) 38 | 39 | with open(file_name, "w", encoding= "utf-8") as file: 40 | x = transcript[0].get("start") 41 | x = int(x/0.04) 42 | file.write("uh") 43 | file.write(x*".") 44 | file.write("\n") 45 | for i in range(len(transcript)): 46 | subtitle = transcript[i] 47 | text = subtitle["text"] 48 | file.write(text) 49 | 50 | # Calculate time difference between this subtitle and the next one 51 | if i < len(transcript) - 1: 52 | current_end_time = subtitle["start"] + subtitle["duration"] 53 | next_start_time = transcript[i + 1]["start"] 54 | time_diff = current_end_time - next_start_time 55 | 56 | # Calculate the number of full stops (0.1 second per full stop) 57 | num_full_stops = int(time_diff / 0.1) 58 | 59 | if(num_full_stops > 27): 60 | print("adding a delay of ", num_full_stops, " seconds") 61 | file.write("." * int(num_full_stops/2)) 62 | 63 | file.write("\n") 64 | 65 | 66 | def installVideo(link:str): 67 | """ Function will install a video using the passed link 68 | 69 | Arguments: 70 | link --> String containing the link for a YouTube video 71 | 72 | No return type 73 | """ 74 | SAVE_PATH = "videos" 75 | 76 | try: 77 | yt = YouTube(link) 78 | except Exception as e: 79 | print(f"Connection Error {e}") 80 | raise e 81 | 82 | try: 83 | print("Installing the video...") 84 | 85 | # Filter out the .mp4 files from the youtube response and download the video 86 | yt.streams.filter( 87 | progressive = True, 88 | file_extension = "mp4" 89 | ).first().download( 90 | output_path = SAVE_PATH, 91 | filename = "Original_Video" 92 | ) 93 | 94 | return 0 95 | except Exception as e: 96 | print(f"!!ERROR!! {e}") 97 | return 1 98 | 99 | def extract_audio(input_file:str, output_file:str): 100 | """ Function for extracting the audio from a video. 101 | 102 | Arguments: 103 | input_file --> Path to the input file 104 | output_file --> Path to the output file 105 | 106 | No return type 107 | """ 108 | video_clip = VideoFileClip(input_file) 109 | audio_clip = video_clip.audio 110 | 111 | audio_clip.write_audiofile(output_file, codec='mp3') 112 | 113 | def replace_audio(input_file:str, audio_replacement_file:str, output_file:str): 114 | """ Function for replacing the audio track in a video with a new one. 115 | 116 | Arguments: 117 | input_file --> Path to the input file 118 | audio_replacament_file --> Path to the audio file that needs to be used in a video 119 | output_file --> Path to the output file 120 | 121 | No return type 122 | """ 123 | video_clip = VideoFileClip(input_file) 124 | audio_replacement_clip = AudioFileClip(audio_replacement_file) 125 | video_clip = video_clip.set_audio(audio_replacement_clip) 126 | 127 | video_clip.write_videofile(output_file, codec='libx264') 128 | 129 | def get_translation(input_file:str, output_file:str, language:str): 130 | """ Function for translating a text. 131 | 132 | Arguments: 133 | input_file --> Path to the input file 134 | output_file --> Path to the output file 135 | language --> The language that you need to translate the text to 136 | 137 | No return type 138 | """ 139 | translator = Translator() 140 | 141 | with open(input_file, "r", encoding="utf-8") as file: 142 | translation = translator.translate(file.read(), dest=language) 143 | 144 | with open(output_file, "w", encoding="utf-8") as file: 145 | file.write(translation.text) -------------------------------------------------------------------------------- /modules/FlaskAPIRouting.py: -------------------------------------------------------------------------------- 1 | from flask import Flask, request, jsonify 2 | from pytube import YouTube 3 | import modules.helperFunctions as hf 4 | import modules.voiceCloning as vc 5 | from flask_cors import CORS 6 | 7 | app = Flask(__name__) 8 | CORS(app) 9 | 10 | # API Routes 11 | @app.route('/voiceover_text', methods=['POST']) 12 | def voiceover_text(): 13 | """ An API route just for the audio file 14 | 15 | Returns: 16 | mp3: An .mp3 file 17 | HTTPS code: Depending on the result 18 | """ 19 | data = request.get_json() 20 | text = data.get('text') 21 | language_code = data.get('language_code') 22 | language_code = language_code.lower() 23 | 24 | print(text, language_code) 25 | 26 | if not text or not language_code: 27 | return jsonify({"error": "Invalid request data."}), 400 28 | 29 | try: 30 | # If a language code is provided, translate the text 31 | with open("data/transcript.txt", "w", encoding="utf-8") as file: 32 | file.write(text) 33 | if language_code != "en": 34 | hf.get_translation("data/transcript.txt", "data/translated_text.txt", language_code) 35 | with open("data/translated_text.txt", "r", encoding="utf-8") as file: 36 | text = file.read() 37 | if language_code == "en": 38 | with open("data/translated_text.txt", "w", encoding="utf-8") as file: 39 | file.write(text) 40 | 41 | 42 | # Generate voiceover audio from the given text 43 | vc.voiceOverNoClone(text, "audios/VoiceOver.mp3") 44 | 45 | # Read the generated audio and send it as a response 46 | with open("audios/VoiceOver.mp3", "rb") as file: 47 | audio_data = file.read() 48 | 49 | return audio_data, 200, {'Content-Type': 'audio/mpeg'} 50 | except Exception as e: 51 | return jsonify({"error": f"Error generating voice audio: {e}"}), 500 52 | 53 | @app.route('/translated_audio', methods=['POST']) 54 | def translated_audio(): 55 | """ An API route for the translated audio track 56 | 57 | Returns: 58 | mp3: An .mp3 file 59 | HTTPS code: Depending on the result 60 | """ 61 | data = request.get_json() 62 | video_url = data['video_url'] 63 | language_code = data['language_code'] 64 | 65 | try: 66 | yt = YouTube(video_url) 67 | except Exception as e: 68 | return jsonify({"error": f"Connection Error: {e}"}), 400 69 | try: 70 | 71 | video_id = video_url.split('=')[1] 72 | 73 | hf.get_transcript(video_id, "data/transcript.txt") 74 | hf.get_translation("data/transcript.txt", "data/translated_transcript.txt", language_code) 75 | 76 | with open("data/translated_transcript.txt", "r", encoding="utf-8") as file: 77 | vc.voiceOverNoClone(file.read(), "audios/VoiceOver.mp3") 78 | 79 | except Exception as e: 80 | return jsonify({"error": f"Error generating voice audio: {e}"}), 500 81 | # Read the generated audio and send it as a response 82 | with open("audios/VoiceOver.mp3", "rb") as file: 83 | audio_data = file.read() 84 | return audio_data, 200, {'Content-Type': 'audio/mpeg'} 85 | """ 86 | Route for getting the transcript as text 87 | """ 88 | @app.route('/transcript_text', methods=['POST']) 89 | def get_transcript_text(): 90 | """ An API route for the transcript 91 | 92 | Returns: 93 | .json: A json containing the transcript 94 | HTTPS code: Depending on the result 95 | """ 96 | data = request.get_json() 97 | video_url = data['video_url'] 98 | 99 | try: 100 | yt = YouTube(video_url) 101 | except Exception as e: 102 | return jsonify({"error": f"Connection Error: {e}"}), 400 103 | 104 | try: 105 | video_id = video_url.split('=')[1] 106 | 107 | hf.get_transcript_no_delay(video_id, "data/transcript.txt") 108 | 109 | with open("data/transcript.txt", "r", encoding="utf-8") as file: 110 | transcript_text = file.read() 111 | 112 | except Exception as e: 113 | return jsonify({"error": f"Error generating transcript: {e}"}), 500 114 | 115 | return jsonify({"transcript": transcript_text}), 200 116 | 117 | @app.route('/translated_video_clone', methods=['POST']) 118 | def translate_video_clone(): 119 | """ An API route for the final, translated video with a cloned voice 120 | 121 | Returns: 122 | .mp4: A .mp4 file containing the translated and narrated video 123 | HTTPS code: Depending on the result 124 | """ 125 | data = request.get_json() 126 | video_url = data['video_url'] 127 | language_code = data['language_code'] 128 | 129 | try: 130 | yt = YouTube(video_url) 131 | except Exception as e: 132 | return jsonify({"error": f"Connection Error: {e}"}), 400 133 | 134 | try: 135 | yt.streams.filter(progressive=True, file_extension="mp4").first().download(output_path="videos", filename="Original_Video") 136 | video_id = yt.video_id 137 | 138 | hf.get_transcript(video_id, "data/transcript.txt") 139 | hf.get_translation("data/transcript.txt", "data/translated_transcript.txt", language_code) 140 | hf.extract_audio("videos/Original_Video", "audios/sample.mp3") 141 | 142 | with open("data/translated_transcript.txt", "r") as file: 143 | vc.voiceOver(file.read(), "audios/VoiceOver.mp3") 144 | vc.delete_cloned_voice() 145 | 146 | hf.replace_audio("videos/Original_Video", "audios/VoiceOver.mp3", "videos/Final_Video.mp4") 147 | except Exception as e: 148 | return jsonify({"error": f"Error translating and creating video: {e}"}), 500 149 | 150 | # Read the final video and send it as a response 151 | with open("videos/Final_Video.mp4", "rb") as file: 152 | video_data = file.read() 153 | 154 | return video_data, 200, {'Content-Type': 'video/mp4'} 155 | 156 | 157 | 158 | @app.route('/translated_video_no_clone', methods=['POST']) 159 | def translate_video_no_clone(): 160 | """ An API route for the final, translated video without a cloned voice 161 | 162 | Returns: 163 | .mp4: A .mp4 file containing the translated and narrated video 164 | HTTPS code: Depending on the result 165 | """ 166 | data = request.get_json() 167 | video_url = data['video_url'] 168 | language_code = data['language_code'] 169 | 170 | try: 171 | yt = YouTube(video_url) 172 | except Exception as e: 173 | return jsonify({"error": f"Connection Error: {e}"}), 400 174 | 175 | try: 176 | yt.streams.filter(progressive=True, file_extension="mp4").first().download(output_path="videos", filename="Original_Video") 177 | video_id = yt.video_id 178 | 179 | hf.get_transcript(video_id, "data/transcript.txt") 180 | hf.get_translation("data/transcript.txt", "data/translated_transcript.txt", language_code) 181 | hf.extract_audio("videos/Original_Video", "audios/sample.mp3") 182 | 183 | with open("data/translated_transcript.txt", "r") as file: 184 | vc.voiceOverNoClone(file.read(), "audios/VoiceOver.mp3") 185 | vc.delete_cloned_voice() 186 | 187 | hf.replace_audio("videos/Original_Video", "audios/VoiceOver.mp3", "videos/Final_Video.mp4") 188 | except Exception as e: 189 | return jsonify({"error": f"Error translating and creating video: {e}"}), 500 190 | 191 | # Read the final video and send it as a response 192 | with open("videos/Final_Video.mp4", "rb") as file: 193 | video_data = file.read() 194 | 195 | return video_data, 200, {'Content-Type': 'video/mp4'} 196 | 197 | if __name__ == '__main__': 198 | app.run(debug=True) -------------------------------------------------------------------------------- /docs/LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------