├── .gitignore ├── .gitattributes ├── ABBYY FineReader - OCR Parameters.png ├── videosubocr ├── __init__.py ├── __main__.py ├── Subs.py ├── Helpers.py ├── Parse.py ├── VideoSubOCR.py └── OCREngine.py ├── VideoPreview.vpy ├── setup.py ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__/ 2 | *.egg-info/ 3 | build/ 4 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /ABBYY FineReader - OCR Parameters.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/moi15moi/VideoSubOCR/HEAD/ABBYY FineReader - OCR Parameters.png -------------------------------------------------------------------------------- /videosubocr/__init__.py: -------------------------------------------------------------------------------- 1 | from .Helpers import * 2 | from .OCREngine import * 3 | from .VideoSubOCR import * 4 | 5 | __version__ = "0.0.1" 6 | -------------------------------------------------------------------------------- /videosubocr/__main__.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from .Helpers import createSubsFromOCRResults 3 | from .Parse import parseArguments 4 | 5 | 6 | def main(): 7 | videoSubFinder, ocrEngine = parseArguments() 8 | 9 | videoSubFinder.generateImages() 10 | ocrText = ocrEngine.runOCR(videoSubFinder.txtImages) 11 | createSubsFromOCRResults(ocrText) 12 | 13 | 14 | if __name__ == "__main__": 15 | sys.exit(main()) 16 | -------------------------------------------------------------------------------- /videosubocr/Subs.py: -------------------------------------------------------------------------------- 1 | ASS_DEFAULT = """ 2 | [Script Info] 3 | ; Script generated by VideoSubOCR 4 | Title: Default Aegisub file 5 | ScriptType: v4.00+ 6 | WrapStyle: 0 7 | ScaledBorderAndShadow: yes 8 | YCbCr Matrix: None 9 | 10 | [V4+ Styles] 11 | Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, Encoding 12 | Style: Default,Verdana,35,&H00FFFFFF,&H000000FF,&H002C2C2C,&H00000000,-1,0,0,0,100,100,0,0,1,2.5,0,2,0,0,72,1 13 | 14 | [Events] 15 | Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text 16 | """ 17 | -------------------------------------------------------------------------------- /VideoPreview.vpy: -------------------------------------------------------------------------------- 1 | # This file is from: https://bitbucket.org/YuriZero/yolocr/src/master/YoloResize.vpy 2 | inputVideo=r'WRITE_THE_VIDEO_PATH_HERE' 3 | cropBoxDimension=[560,70] # Taille en largeur et hauteur de la CropBox délimitant les sous-titres à OCR. 4 | cropBoxHeight=6 # Hauteur de la CropBox délimitant les sous-titres à OCR. 5 | 6 | 7 | import vapoursynth as vs 8 | 9 | def Grayuv(x): 10 | return 128 11 | 12 | ClipSource=vs.core.ffms2.Source(source=inputVideo) 13 | CropBox=vs.core.std.CropAbs(clip=ClipSource,width=cropBoxDimension[0],height=cropBoxDimension[1],left=int((ClipSource.width-cropBoxDimension[0])/2),top=ClipSource.height-cropBoxHeight-cropBoxDimension[1]) 14 | ClipGray=vs.core.std.Lut(clip=ClipSource,planes=[1,2],function=Grayuv) 15 | 16 | ClipLeft=vs.core.std.Crop(clip=ClipGray,right=int((CropBox.width+ClipGray.width)/2)) 17 | ClipRight=vs.core.std.Crop(clip=ClipGray,left=ClipLeft.width+CropBox.width) 18 | Clip=vs.core.std.CropAbs(clip=ClipGray,width=CropBox.width,height=ClipGray.height,left=int((ClipGray.width-CropBox.width)/2)) 19 | ClipTop=vs.core.std.Crop(clip=Clip,bottom=int(cropBoxHeight)+CropBox.height) 20 | ClipBottom=vs.core.std.Crop(clip=Clip,top=ClipTop.height+CropBox.height) 21 | 22 | Bord=int(2) 23 | Crop=vs.core.std.Crop(clip=CropBox,left=Bord,right=Bord,top=Bord,bottom=Bord) 24 | Rect=vs.core.std.AddBorders(clip=Crop,left=Bord,right=Bord,top=Bord,bottom=Bord,color=[255,128,128]) 25 | Clip=vs.core.std.StackVertical([ClipTop,Rect,ClipBottom]) 26 | Clip=vs.core.std.StackHorizontal([ClipLeft,Clip,ClipRight]) 27 | Clip.set_output() -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import os 2 | import re 3 | import setuptools 4 | 5 | here = os.path.abspath(os.path.dirname(__file__)) 6 | 7 | 8 | def read(*parts): 9 | with open(os.path.join(here, *parts), "r") as fp: 10 | return fp.read() 11 | 12 | 13 | def find_version(*file_paths): 14 | version_file = read(*file_paths) 15 | version_match = re.search(r"^__version__ = [\'\"](.+)[\'\"]", version_file, re.M) 16 | if version_match: 17 | return version_match.group(1) 18 | raise RuntimeError("Unable to find version string.") 19 | 20 | 21 | setuptools.setup( 22 | name="VideoSubOCR", 23 | url="https://github.com/moi15moi/VideoSubOCR/", 24 | project_urls={ 25 | "Source": "https://github.com/moi15moi/VideoSubOCR/", 26 | "Tracker": "https://github.com/moi15moi/VideoSubOCR/issues/", 27 | }, 28 | author="moi15moi", 29 | author_email="moi15moismokerlolilol@gmail.com", 30 | description="VideoSubFinder automation.", 31 | long_description_content_type="text/markdown", 32 | version=find_version("videosubocr", "__init__.py"), 33 | python_requires=">=3.7", 34 | install_requires=[ 35 | "Pillow", 36 | "pysubs2", 37 | "pytesseract", 38 | "rich", 39 | ], 40 | entry_points={"console_scripts": ["VideoSubOCR=videosubocr.__main__:main"]}, 41 | classifiers=[ 42 | "Development Status :: 4 - Beta", 43 | "Intended Audience :: Other Audience", 44 | "Programming Language :: Python", 45 | "Programming Language :: Python :: 3", 46 | "Programming Language :: Python :: 3.7", 47 | "Programming Language :: Python :: 3.8", 48 | "Programming Language :: Python :: 3.9", 49 | "Programming Language :: Python :: 3.10", 50 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 51 | ], 52 | license="GNU LGPL 3.0 or later", 53 | ) 54 | -------------------------------------------------------------------------------- /videosubocr/Helpers.py: -------------------------------------------------------------------------------- 1 | import os 2 | import shutil 3 | import subprocess 4 | import sys 5 | import time 6 | from pathlib import Path 7 | from pysubs2 import SSAEvent, SSAFile 8 | from rich.console import Console 9 | from rich.progress import Progress 10 | from .Subs import ASS_DEFAULT 11 | from typing import Dict 12 | 13 | # Just to be safe, I floor 32767 https://learn.microsoft.com/en-us/windows/win32/api/processthreadsapi/nf-processthreadsapi-createprocessa or https://stackoverflow.com/a/2381726/15835974 14 | WINDOWS_CHARACTER_LIMIT = 32700 15 | 16 | 17 | def verifyIfFileExist(path: Path, canBeNone: bool = False) -> Path: 18 | """ 19 | Parameters: 20 | path (Path): File path. 21 | canBeNone (bool): If true and the path is None, it won't quit the program. 22 | Returns: 23 | If the file exist, it return the absolute path else, it quit the program. 24 | """ 25 | if canBeNone and path is None: 26 | return path 27 | elif path is None or not path.is_file(): 28 | sys.exit( 29 | Console().print(f'Error: the path "{path}" is not valid.', style="red1") 30 | ) 31 | else: 32 | if not os.path.isabs(path): 33 | return os.path.abspath(path) 34 | return path 35 | 36 | 37 | def parseDependency(dependencyName: str, possibleDependencyPath: Path = None): 38 | """ 39 | Parameters: 40 | dependencyName (str): The name of the dependency program. Ex: VideoSubFinder. 41 | possibleDependencyPath (Path): The possible location of the program. 42 | Returns: 43 | If the program is found, it return the program absolute path, else it quit the program. 44 | """ 45 | 46 | dependencyPath = "" 47 | 48 | if possibleDependencyPath is None: 49 | dependencyPath = shutil.which(dependencyName) 50 | if not dependencyPath: 51 | sys.exit( 52 | Console().print( 53 | f"Error: {dependencyName} in not in your environnements variable, add it or specify the path with --{dependencyName}.", 54 | style="red1", 55 | ) 56 | ) 57 | else: 58 | dependencyPath = verifyIfFileExist(possibleDependencyPath) 59 | 60 | return dependencyPath 61 | 62 | 63 | def createSubsFromOCRResults(ocrText: Dict[Path, str]): 64 | """ 65 | Parameters: 66 | ocrText (Dict[Path, str]): It is the ocr results from OCREngine.runOCR. 67 | """ 68 | from .VideoSubOCR import VideoSubFinder 69 | 70 | subs = SSAFile.from_string(ASS_DEFAULT) 71 | 72 | for imagePath, text in ocrText.items(): 73 | start, end = VideoSubFinder.getTimeFromTxtImagesPath(imagePath) 74 | line = SSAEvent(start=start, end=end) 75 | line.plaintext = text 76 | subs.events.append(line) 77 | 78 | subsPath = os.path.join(os.getcwd(), "Output.ass") 79 | subs.save(subsPath) 80 | Console().print(f"Subtitle saved at {subsPath}", style="bright_green") 81 | 82 | 83 | def runCommand(args: str, processName: str): 84 | """ 85 | Parameters: 86 | args (str): The command. 87 | processName (str): The name of the command that will be show in the cmd. 88 | """ 89 | 90 | process = subprocess.Popen(args) 91 | 92 | with Progress() as progress: 93 | 94 | task = progress.add_task(processName, total=None) 95 | 96 | while not progress.finished: 97 | progress.update(task) 98 | 99 | if process.poll() is not None: 100 | progress.update(task, completed=1, total=1, refresh=True) 101 | 102 | time.sleep(0.5) 103 | -------------------------------------------------------------------------------- /videosubocr/Parse.py: -------------------------------------------------------------------------------- 1 | import shutil 2 | import sys 3 | from argparse import ArgumentParser 4 | from .Helpers import verifyIfFileExist 5 | from .OCREngine import FineReader, OCREngine, Tesseract 6 | from pathlib import Path 7 | from rich.console import Console 8 | from typing import Tuple 9 | from .VideoSubOCR import CropBox, VideoSubFinder 10 | 11 | 12 | def parseArguments() -> Tuple[VideoSubFinder, OCREngine]: 13 | parser = ArgumentParser(prog="VideoSubOCR", description="Video OCR automation.") 14 | 15 | # VideoSubFinder arguments 16 | parser.add_argument( 17 | "--input", 18 | "-i", 19 | required=True, 20 | type=Path, 21 | help=""" 22 | Video file needed to be OCR. 23 | """, 24 | ) 25 | 26 | parser.add_argument( 27 | "--generalSettings", 28 | type=Path, 29 | help=""" 30 | Path to general settings (*.cfg file). By default, VideoSubFinder use the file settings/general.cfg 31 | """, 32 | ) 33 | 34 | parser.add_argument( 35 | "--cropBoxDimension", 36 | "-cpdh", 37 | type=float, 38 | nargs=2, 39 | metavar="Width_or_Height", 40 | help=""" 41 | CropBox dimension Width x Height. Ex: --cropBoxDimension 1920 1080 42 | """, 43 | ) 44 | 45 | parser.add_argument( 46 | "--cropBoxHeight", 47 | "-cph", 48 | type=float, 49 | metavar="Height", 50 | help=""" 51 | CropBox height. It is the height between the video bottom and the cropbox bottom. 52 | """, 53 | ) 54 | parser.add_argument( 55 | "--videosubfinderwxw", 56 | "-vsf", 57 | type=Path, 58 | help=""" 59 | Path to VideoSubFinderWXW.exe if not in variable environments. 60 | """, 61 | ) 62 | # End VideoSubFinder arguments 63 | 64 | parser.add_argument( 65 | "--tesseract", 66 | "-t", 67 | type=Path, 68 | nargs="?", 69 | const=shutil.which("tesseract"), 70 | help=""" 71 | If tesseract.exe is in your variable environments, simply use --tesseract. 72 | If not, path to FineCmd.exe 73 | 74 | """, 75 | ) 76 | 77 | parser.add_argument( 78 | "--finereader", 79 | "-f", 80 | type=Path, 81 | nargs="?", 82 | const=shutil.which("FineCmd"), 83 | help=""" 84 | If FineCmd.exe is in your variable environments, simply use --finereader. 85 | If not, path to FineCmd.exe 86 | """, 87 | ) 88 | 89 | parser.add_argument( 90 | "--lang", 91 | "-l", 92 | type=str, 93 | help=""" 94 | Language in which the hardsubbed subtitle is. 95 | It will be use by the ocr engine you choose. 96 | Warning, ABBYY FineReader and Tesseract doesn't have the exact same input for the same language. 97 | Tesseract support ISO 639-2 (t version): https://www.loc.gov/standards/iso639-2/php/code_list.php 98 | ABBYY FineReader support the fullname: https://help.abbyy.com/en-us/finereader/15/user_guide/commandline_lang/ 99 | """, 100 | ) 101 | 102 | args = parser.parse_args() 103 | cropBox = None 104 | 105 | if args.cropBoxDimension is not None and args.cropBoxHeight is not None: 106 | import vapoursynth as vs 107 | 108 | video = vs.core.ffms2.Source(verifyIfFileExist(args.input)) 109 | 110 | cropBox = CropBox.from_vsf_param( 111 | video.width, 112 | video.height, 113 | args.cropBoxDimension[0], 114 | args.cropBoxDimension[1], 115 | args.cropBoxHeight, 116 | ) 117 | 118 | ocrEngine = None 119 | if args.finereader is not None: 120 | ocrEngine = FineReader(args.finereader, args.lang) 121 | 122 | if args.tesseract is not None: 123 | ocrEngine = Tesseract(args.tesseract, args.lang) 124 | 125 | if ocrEngine is None: 126 | sys.exit( 127 | Console().print( 128 | f"Error: There is no OCR engine in your variable environments or you need to precize the OCR engine you wanna use (ABBYY FineReader or Tesseract)", 129 | style="red1", 130 | ) 131 | ) 132 | 133 | return ( 134 | VideoSubFinder( 135 | args.videosubfinderwxw, args.input, cropBox, args.generalSettings 136 | ), 137 | ocrEngine, 138 | ) 139 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # VideoSubOCR 2 | OCR automation for VideoSubFinder. 3 | 4 | ## Installation and Update 5 | ``` 6 | pip install git+https://github.com/moi15moi/VideoSubOCR.git 7 | ``` 8 | 9 | ## Dependencies 10 | - [Python 3.7 or more](https://www.python.org/downloads) 11 | - [ABBYY FineReader](https://pdf.abbyy.com) (or Tesseract) 12 | - [Tesseract](https://digi.bib.uni-mannheim.de/tesseract/?C=M;O=D) (or ABBYY FineReader) 13 | - [VapourSynth](https://github.com/vapoursynth/vapoursynth/releases/latest) (Optional, but required to use cropbox argument) 14 | - [VapourSynth-Editor](https://github.com/YomikoR/VapourSynth-Editor/releases/latest) (Optional, but required to use VideoPreview.vpy) 15 | 16 | ### Setup for [ABBYY FineReader](https://pdf.abbyy.com) 17 | You will need to have the same parameters has this image. 18 | To change your parameters, open **ABBYY FineReader** and go to ``Tools -> Options -> Format Settings -> TXT`` 19 | ![Alt text](https://github.com/moi15moi/VideoSubOCR/blob/main/ABBYY%20FineReader%20-%20OCR%20Parameters.png) 20 | 21 | ### Setup for [Tesseract](https://digi.bib.uni-mannheim.de/tesseract/?C=M;O=D) 22 | To be able to select the language you want, you need to download tesseract tessdata. 23 | 24 | - [tessdata](https://github.com/tesseract-ocr/tessdata) 25 | - [tessdata_best](https://github.com/tesseract-ocr/tessdata_best) 26 | - [tessdata_fast](https://github.com/tesseract-ocr/tessdata_fast) 27 | 28 | I recommand you to use **tessdata_best** traineddata. 29 | 30 | You will need to download the language you need and move it in the right folder. 31 | On Windows, it should be: ``C:\Users\YOUR_USERNAME\AppData\Local\Tesseract-OCR\tessdata`` 32 | 33 | ## Usage 34 | ```console 35 | usage: VideoSubOCR [-h] --input INPUT [--generalSettings GENERALSETTINGS] 36 | [--cropBoxDimension Width_or_Height Width_or_Height] [--cropBoxHeight Height] 37 | [--videosubfinderwxw VIDEOSUBFINDERWXW] [--tesseract [TESSERACT]] [--finereader [FINEREADER]] 38 | [--lang LANG] 39 | 40 | Video OCR automation. 41 | 42 | options: 43 | -h, --help show this help message and exit 44 | --input INPUT, -i INPUT 45 | Video file needed to be OCR. 46 | --generalSettings GENERALSETTINGS 47 | Path to general settings (*.cfg file). By default, VideoSubFinder use the file 48 | settings/general.cfg 49 | --cropBoxDimension Width_or_Height Width_or_Height, -cpdh Width_or_Height Width_or_Height 50 | CropBox dimension Width x Height. Ex: --cropBoxDimension 1920 1080 51 | --cropBoxHeight Height, -cph Height 52 | CropBox height. It is the height between the video bottom and the cropbox bottom. 53 | --videosubfinderwxw VIDEOSUBFINDERWXW, -vsf VIDEOSUBFINDERWXW 54 | Path to VideoSubFinderWXW.exe if not in variable environments. 55 | --tesseract [TESSERACT], -t [TESSERACT] 56 | If tesseract.exe is in your variable environments, simply use --tesseract. If not, path to 57 | FineCmd.exe 58 | --finereader [FINEREADER], -f [FINEREADER] 59 | If FineCmd.exe is in your variable environments, simply use --finereader. If not, path to 60 | FineCmd.exe 61 | --lang LANG, -l LANG Language in which the hardsubbed subtitle is. It will be use by the ocr engine you choose. 62 | Warning, ABBYY FineReader and Tesseract doesn't have the exact same input for the same 63 | language. Tesseract support ISO 639-2 (t version): 64 | https://www.loc.gov/standards/iso639-2/php/code_list.php ABBYY FineReader support the 65 | fullname: https://help.abbyy.com/en-us/finereader/15/user_guide/commandline_lang/ 66 | ``` 67 | 68 | ### VideoSubFinder General Settings 69 | I recommand you to always create a setting. 70 | This will allow to have a better ocr 71 | You can save the settings with ``File --> Save Settings As...`` 72 | 73 | For more information about VideoSubFinder, see their [website](https://sourceforge.net/projects/videosubfinder/) 74 | 75 | ### Alternative to VideoSubFinder General Settings 76 | 77 | If you don't want to create a setting, I recommand you to use the file named **VideoPreview.vpy**. To use it, you will need to install [VapourSynth](https://github.com/vapoursynth/vapoursynth/releases/latest) and [VapourSynth-Editor](https://github.com/YomikoR/VapourSynth-Editor/releases/latest). 78 | 79 | 1. Open VideoPreview.vpy with VapourSynth-Editor. 80 | 2. Change ``inputVideo``, ``cropBoxDimension``, ``cropBoxHeight`` to the value you think you need. 81 | 3. Press **F5** 82 | 4. See if the cropbox is good for you. If not, repeat the step 2 and 3. -------------------------------------------------------------------------------- /videosubocr/VideoSubOCR.py: -------------------------------------------------------------------------------- 1 | import os 2 | from .Helpers import parseDependency, runCommand, verifyIfFileExist 3 | from pathlib import Path 4 | from PIL import Image, UnidentifiedImageError 5 | from rich.console import Console 6 | from typing import Dict, Tuple 7 | 8 | 9 | class CropBox(object): 10 | def __init__(self, top: float, bottom: float, left: float, right: float): 11 | self.top = top 12 | self.bottom = bottom 13 | self.left = left 14 | self.right = right 15 | 16 | @classmethod 17 | def from_vsf_param( 18 | cls, 19 | videoWidth: int, 20 | videoHeight: int, 21 | cropBoxDimensionWidth: float, 22 | cropBoxDimensionHeight: float, 23 | cropBoxHeight: float, 24 | ): 25 | """ 26 | Parameters: 27 | videoWidth (int): The video width in pixel 28 | videoHeight (int): The video height in pixel 29 | cropBoxDimensionWidth (float): The cropbox width dimension in pixel 30 | cropBoxDimensionHeight (float): The cropbox height dimension in pixel 31 | cropBoxHeight (float): The cropbox height in pixel 32 | 33 | VideoWidth 34 | ----------------------------------------------------- 35 | | | 36 | | | 37 | | | V 38 | | | i 39 | | | d 40 | | | e 41 | | | o 42 | | | 43 | | | h 44 | | CropBoxDimensionWidth | e 45 | | ----------------- | i 46 | | | | CropBox | g 47 | | | | DimensionHeight | t 48 | | ----------------- | h 49 | | | | 50 | | | | 51 | | CropBoxHeight | | 52 | | | | 53 | | | | 54 | ----------------------------------------------------- 55 | Returns: 56 | An instance of CropBox. 57 | """ 58 | 59 | top = (cropBoxHeight + cropBoxDimensionHeight) / videoHeight 60 | bottom = cropBoxHeight / videoHeight 61 | left = (videoWidth - cropBoxDimensionWidth) / (2 * videoWidth) 62 | right = 1 - left 63 | 64 | return cls(top, bottom, left, right) 65 | 66 | 67 | class VideoSubFinder(object): 68 | 69 | name = "VideoSubFinder" 70 | 71 | def __init__( 72 | self, 73 | videoSubFinderPath: Path, 74 | videoPath: Path, 75 | cropBox: CropBox = None, 76 | generalSettings: Path = None, 77 | ): 78 | self.videoSubFinderPath = videoSubFinderPath 79 | self.videoPath = videoPath 80 | self.cropBox = cropBox 81 | self.generalSettings = generalSettings 82 | 83 | @property 84 | def videoSubFinderPath(self): 85 | return self._videoSubFinderPath 86 | 87 | @videoSubFinderPath.setter 88 | def videoSubFinderPath(self, value): 89 | self._videoSubFinderPath = parseDependency(self.name, value) 90 | 91 | @property 92 | def txtImages(self) -> Dict[Path, Image.Image]: 93 | filesList = {} 94 | imagesDirectory = os.path.join( 95 | os.path.dirname(self.videoSubFinderPath), "TXTImages" 96 | ) 97 | 98 | for filename in os.listdir(imagesDirectory): 99 | filePath = os.path.join(imagesDirectory, filename) 100 | try: 101 | image = Image.open(filePath) 102 | except UnidentifiedImageError: 103 | continue 104 | else: 105 | filesList[filePath] = image 106 | 107 | return filesList 108 | 109 | @property 110 | def videoPath(self): 111 | return self._videoPath 112 | 113 | @videoPath.setter 114 | def videoPath(self, value): 115 | self._videoPath = verifyIfFileExist(value) 116 | 117 | @property 118 | def generalSettings(self): 119 | return self._generalSettings 120 | 121 | @generalSettings.setter 122 | def generalSettings(self, value): 123 | self._generalSettings = verifyIfFileExist(value, True) 124 | 125 | @staticmethod 126 | def getTimeFromTxtImagesPath(txtImage: Path) -> Tuple[int, int]: 127 | """ 128 | Parameters: 129 | txtImage (Path): An image path from the VideoSubFinder's TxtImages folder. 130 | Ex: "C:\..\0_00_04_713__0_00_08_882_0039400035005700048000640.jpeg" 131 | Returns: 132 | The start time and the end time in milliseconds. 133 | """ 134 | 135 | imageFilename = os.path.basename(txtImage) 136 | 137 | try: 138 | startHour = int(imageFilename[0]) 139 | startMin = int(imageFilename[2:4]) 140 | startSec = int(imageFilename[5:7]) 141 | startMsec = int(imageFilename[8:11]) 142 | 143 | endHour = int(imageFilename[13]) 144 | endMin = int(imageFilename[15:17]) 145 | endSec = int(imageFilename[18:20]) 146 | endMsec = int(imageFilename[21:24]) 147 | except ValueError: 148 | Console().print( 149 | f'Error: the file "{imageFilename}" is not conform to this naming convention H_M_S_MS__H_M_S_MS.', 150 | style="red1", 151 | ) 152 | 153 | startMs = startHour * 3600000 + startMin * 60000 + startSec * 1000 + startMsec 154 | endMs = endHour * 3600000 + endMin * 60000 + endSec * 1000 + endMsec 155 | 156 | return startMs, endMs 157 | 158 | def generateImages(self): 159 | """ 160 | Run VideoSubFinder to generate the images that will be used to OCR. 161 | """ 162 | args = [] 163 | 164 | args.append(f'"{self.videoSubFinderPath}"') 165 | args.append("--clear_dirs") 166 | args.append("--run_search") 167 | args.append("--create_cleared_text_images") 168 | 169 | if self.cropBox is not None: 170 | args.append(f"--top_video_image_percent_end={self.cropBox.top}") 171 | args.append(f"--bottom_video_image_percent_end={self.cropBox.bottom}") 172 | args.append(f"--left_video_image_percent_end={self.cropBox.left}") 173 | args.append(f"--right_video_image_percent_end={self.cropBox.right}") 174 | if self.generalSettings is not None: 175 | args.append(f'--general_settings="{self.generalSettings}"') 176 | 177 | args.append(f'--input_video="{self.videoPath}"') 178 | 179 | runCommand(" ".join(args), f"{self.name}...") 180 | 181 | Console().print( 182 | f"{self.name}: Successfully created images", style="bright_green" 183 | ) 184 | -------------------------------------------------------------------------------- /videosubocr/OCREngine.py: -------------------------------------------------------------------------------- 1 | import pytesseract 2 | import os 3 | import sys 4 | from abc import ABC, abstractmethod 5 | from .Helpers import parseDependency, runCommand, WINDOWS_CHARACTER_LIMIT 6 | from pathlib import Path 7 | from PIL.Image import Image 8 | from rich.console import Console 9 | from rich.progress import track 10 | from typing import List, Dict 11 | 12 | 13 | class OCREngine(ABC): 14 | @property 15 | @abstractmethod 16 | def engineName(self): 17 | pass 18 | 19 | @property 20 | @abstractmethod 21 | def enginePath(self): 22 | pass 23 | 24 | @property 25 | @abstractmethod 26 | def lang(self): 27 | pass 28 | 29 | @abstractmethod 30 | def runOCR(self, images: Dict[Path, Image]) -> Dict[Path, str]: 31 | """ 32 | Parameters: 33 | images (Dict[Path, Image]): The Dictionnary to be splitted. 34 | Returns: 35 | The OCR results. The path is the image path AND the str is the ocr result. 36 | """ 37 | pass 38 | 39 | 40 | class Tesseract(OCREngine): 41 | 42 | engineName = "Tesseract" 43 | lang: str 44 | 45 | def __init__(self, tesseractPath: Path, lang: str): 46 | self.enginePath = parseDependency(self.engineName, tesseractPath) 47 | pytesseract.pytesseract.tesseract_cmd = self.enginePath 48 | self.lang = lang 49 | 50 | @property 51 | def enginePath(self): 52 | return self._enginePath 53 | 54 | @enginePath.setter 55 | def enginePath(self, value): 56 | self._enginePath = parseDependency(self.engineName, value) 57 | 58 | @property 59 | def lang(self): 60 | return self._lang 61 | 62 | @lang.setter 63 | def lang(self, value): 64 | languagesList = pytesseract.get_languages() 65 | if value in languagesList: 66 | self._lang = value 67 | else: 68 | sys.exit( 69 | Console().print( 70 | f"Error: You can't select the language: {value}.\nHere is all the available language: " 71 | + ", ".join(languagesList), 72 | style="red1", 73 | ) 74 | ) 75 | 76 | def runOCR(self, images: Dict[Path, Image]) -> Dict[Path, str]: 77 | ocrText = {} 78 | 79 | for key in track(images, description=f"{self.engineName}..."): 80 | ocrText[key] = pytesseract.image_to_string( 81 | images[key], lang=self.lang 82 | ).strip() 83 | 84 | Console().print( 85 | f"{self.engineName}: Successfully OCR the images", style="bright_green" 86 | ) 87 | 88 | return ocrText 89 | 90 | 91 | class FineReader(OCREngine): 92 | 93 | engineName = "ABBYY FineReader" 94 | lang: str 95 | outputPath = os.path.join(os.getcwd(), f"{engineName} - Output.txt") 96 | 97 | def __init__(self, fineReaderPath: Path, lang: str): 98 | if sys.platform != "win32": 99 | raise OSError( 100 | f"Sorry, {self.engineName} implementation only works on Windows." 101 | ) 102 | 103 | self.enginePath = parseDependency(self.engineName, fineReaderPath) 104 | self.lang = lang 105 | 106 | @property 107 | def enginePath(self): 108 | return self._enginePath 109 | 110 | @enginePath.setter 111 | def enginePath(self, value): 112 | self._enginePath = parseDependency(self.engineName, value) 113 | 114 | @property 115 | def lang(self): 116 | return self._lang 117 | 118 | @lang.setter 119 | def lang(self, value): 120 | # There is no proper way to verify if FineReader support X language: https://help.abbyy.com/en-us/finereader/15/user_guide/commandline_lang/ 121 | self._lang = value 122 | 123 | @property 124 | def formattedFinereaderPath(self): 125 | return f'"{self.enginePath}"' 126 | 127 | @property 128 | def formattedLang(self): 129 | lang = None 130 | if self.lang is not None: 131 | lang = f"/lang {self.lang}" 132 | return lang 133 | 134 | @property 135 | def formattedOutputPath(self): 136 | return f'/out "{self.outputPath}"' 137 | 138 | @property 139 | def basicCommandLength(self): 140 | """ 141 | Command length without the images. 142 | Ex: 143 | Command: 144 | "VideoSubFinderWXW.exe" /lang English /output "output.txt" 145 | 146 | Command's argument: 147 | "VideoSubFinderWXW.exe" => 23 characters 148 | /lang English => 13 characters 149 | /output "output.txt" => 20 characters 150 | But, we also count the space between these arguments => 2 characters 151 | Finally, we count the space for the future images arguments => 1 characters 152 | 153 | Return: 154 | 23 + 13 + 20 + 2 + 1 155 | """ 156 | # Set all the command parameter except the images list 157 | fineReaderPath = self.formattedFinereaderPath 158 | lang = self.formattedLang 159 | outputPathStr = self.formattedOutputPath 160 | 161 | # + 3 because we will join these elements with space 162 | basicCommandLength = ( 163 | len(fineReaderPath) 164 | + (0 if lang is None else len(lang)) 165 | + len(outputPathStr) 166 | + 3 167 | ) 168 | 169 | return basicCommandLength 170 | 171 | def __parseOutputFile(self, file: Path) -> List[str]: 172 | """ 173 | Parameters: 174 | file (Path): The output text file generated by ABBYY FineReader. 175 | Returns: 176 | A list containing each lines of the OCR results. 177 | """ 178 | 179 | lines = [] 180 | with open(file, encoding="utf-8") as file: 181 | lines = file.readlines() 182 | lines = "".join(lines) 183 | # https://unicode-table.com/en/000C/ 184 | # We need it to conserve the \N 185 | lines = lines.split("\x0c") 186 | 187 | return lines 188 | 189 | def __splitImages(self, imagesToSplit: Dict[Path, Image]) -> List[Dict[Path, Image]]: 190 | """ 191 | Windows cmd API has a characters limit. 192 | Because of that, we need to split the one possible command into multiple command to always have a command less than Helpers.WINDOWS_CHARACTER_LIMIT. 193 | 194 | Parameters: 195 | imagesToSplit (Dict[Path, Image]): The Dictionnary to be splitted. 196 | Returns: 197 | A list containing Dict. 198 | """ 199 | 200 | untouchedRemainingStrLength = WINDOWS_CHARACTER_LIMIT - self.basicCommandLength 201 | 202 | currentImages = {} 203 | images = [] 204 | remainingStrLength = untouchedRemainingStrLength 205 | for i, key in enumerate(list(imagesToSplit)): 206 | # + 2 because __runOCR will add quotation mark 207 | imageStrLength = len(str(key)) + 2 208 | 209 | # (len(imagesToSplit) - 1) because we will add space between each element 210 | possibleRemainingCharacter = ( 211 | remainingStrLength - imageStrLength - (len(imagesToSplit) - 1) 212 | ) 213 | 214 | if possibleRemainingCharacter >= 0: 215 | remainingStrLength -= imageStrLength 216 | currentImages[key] = imagesToSplit[key] 217 | 218 | if i == len(imagesToSplit) - 1: 219 | images.append(currentImages) 220 | 221 | else: 222 | images.append(currentImages) 223 | 224 | # This is almost impossible, but it can happen. 225 | if i == len(imagesToSplit) - 1: 226 | images.append({key: imagesToSplit[key]}) 227 | else: 228 | # Reset variable 229 | remainingStrLength = untouchedRemainingStrLength 230 | currentImages = {key: imagesToSplit[key]} 231 | 232 | return images 233 | 234 | def runOCR(self, images: Dict[Path, Image]) -> Dict[Path, str]: 235 | 236 | images = self.__splitImages(images) 237 | ocrText = {} 238 | 239 | for i, dictImages in enumerate(images): 240 | args = [] 241 | 242 | # Args items 243 | args.append(self.formattedFinereaderPath) 244 | args.append(" ".join(['"{}"'.format(image) for image in dictImages])) 245 | if self.formattedLang is not None: 246 | args.append(self.formattedLang) 247 | args.append(self.formattedOutputPath) 248 | 249 | runCommand(" ".join(args), f"{self.engineName} ({i + 1}/{len(images)})...") 250 | 251 | # Get text 252 | for (imagePath, text) in zip( 253 | dictImages, self.__parseOutputFile(self.outputPath) 254 | ): 255 | ocrText[imagePath] = text.strip() 256 | 257 | if os.path.exists(self.outputPath): 258 | os.remove(self.outputPath) 259 | 260 | Console().print( 261 | f"{self.engineName}: Successfully OCR the images", style="bright_green" 262 | ) 263 | 264 | return ocrText 265 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------