├── .github ├── dependabot.yml └── workflows │ └── test.yml ├── .gitignore ├── Makefile ├── Eask ├── README.md ├── ffmpeg-player.el └── LICENSE /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: github-actions 4 | directory: / 5 | schedule: 6 | interval: daily 7 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # ignore these directories 2 | /.git 3 | /recipes 4 | /_test 5 | 6 | # ignore generated files 7 | *.elc 8 | 9 | # eask packages 10 | .eask/ 11 | dist/ 12 | 13 | # packaging 14 | *-autoloads.el 15 | *-pkg.el 16 | 17 | # OS generated 18 | .DS_Store 19 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | EMACS ?= emacs 2 | EASK ?= eask 3 | 4 | .PHONY: clean checkdoc lint package install compile test 5 | 6 | ci: clean package install compile 7 | 8 | package: 9 | @echo "Packaging..." 10 | $(EASK) package 11 | 12 | install: 13 | @echo "Installing..." 14 | $(EASK) install 15 | 16 | compile: 17 | @echo "Compiling..." 18 | $(EASK) compile 19 | 20 | test: 21 | @echo "Testing..." 22 | $(EASK) test ert ./test/*.el 23 | 24 | checkdoc: 25 | @echo "Run checkdoc..." 26 | $(EASK) lint checkdoc 27 | 28 | lint: 29 | @echo "Run package-lint..." 30 | $(EASK) lint package 31 | 32 | clean: 33 | $(EASK) clean all 34 | -------------------------------------------------------------------------------- /Eask: -------------------------------------------------------------------------------- 1 | ;; -*- mode: eask; lexical-binding: t -*- 2 | 3 | (package "ffmpeg-player" 4 | "0.2.1" 5 | "Play video using ffmpeg") 6 | 7 | (website-url "https://github.com/jcs-elpa/ffmpeg-player") 8 | (keywords "multimedia" "video" "ffmpeg" "buffering" "images") 9 | 10 | (package-file "ffmpeg-player.el") 11 | 12 | (script "test" "echo \"Error: no test specified\" && exit 1") 13 | 14 | (source "melpa") 15 | 16 | (depends-on "emacs" "24.4") 17 | (depends-on "s") 18 | (depends-on "f") 19 | 20 | (setq network-security-level 'low) ; see https://github.com/jcs090218/setup-emacs-windows/issues/156#issuecomment-932956432 21 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | pull_request: 8 | workflow_dispatch: 9 | 10 | concurrency: 11 | group: ${{ github.workflow }}-${{ github.ref }} 12 | cancel-in-progress: true 13 | 14 | jobs: 15 | test: 16 | runs-on: ${{ matrix.os }} 17 | continue-on-error: ${{ matrix.experimental }} 18 | strategy: 19 | fail-fast: false 20 | matrix: 21 | os: [ubuntu-latest, macos-latest, windows-latest] 22 | emacs-version: 23 | - 26.3 24 | - 27.2 25 | - 28.2 26 | - 29.4 27 | - 30.2 28 | experimental: [false] 29 | include: 30 | - os: ubuntu-latest 31 | emacs-version: snapshot 32 | experimental: true 33 | - os: macos-latest 34 | emacs-version: snapshot 35 | experimental: true 36 | - os: windows-latest 37 | emacs-version: snapshot 38 | experimental: true 39 | exclude: 40 | - os: macos-latest 41 | emacs-version: 26.3 42 | - os: macos-latest 43 | emacs-version: 27.2 44 | 45 | steps: 46 | - uses: actions/checkout@v5 47 | 48 | - uses: jcs090218/setup-emacs@master 49 | with: 50 | version: ${{ matrix.emacs-version }} 51 | 52 | - uses: emacs-eask/setup-eask@master 53 | with: 54 | version: 'snapshot' 55 | 56 | - name: Run tests 57 | run: 58 | make ci 59 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) 2 | [![MELPA](https://melpa.org/packages/ffmpeg-player-badge.svg)](https://melpa.org/#/ffmpeg-player) 3 | [![MELPA Stable](https://stable.melpa.org/packages/ffmpeg-player-badge.svg)](https://stable.melpa.org/#/ffmpeg-player) 4 | 5 | # ffmpeg-player 6 | > Play video using ffmpeg. 7 | 8 | [![CI](https://github.com/jcs-elpa/ffmpeg-player/actions/workflows/test.yml/badge.svg)](https://github.com/jcs-elpa/ffmpeg-player/actions/workflows/test.yml) 9 | 10 | ## 📝 Acknowledge 11 | 12 | This package will output video into images (in frame). This might causes 13 | many I/O times and disk space (Even though these frames will eventually get 14 | cleaned up). I would like to mention you all the information and consequences 15 | before you use this package. 16 | 17 | *See [melpa/6560](https://github.com/melpa/melpa/pull/6560) for more information.* 18 | 19 | ## External Program 20 | 21 | This package uses these following programs, make sure these program are added 22 | to your path. 23 | 24 | * [ffmpeg](https://www.ffmpeg.org/) 25 | * [ffplay](https://www.ffmpeg.org/) - Bundle with `ffmpeg`. 26 | 27 | ## 🔌 Capability 28 | 29 | Base on `ffplay`'s website. 30 | 31 | > ffplay is a very simple and portable media player using the FFmpeg libraries 32 | and the SDL library. It is mostly used as a testbed for the various FFmpeg APIs. 33 | 34 | Hence, I have encounter some issues synchronize video and audio. Try move the 35 | timeline by pressing `` or `` key multiple times could resolve 36 | such an issue. 37 | 38 | ## 🔧 Usage 39 | 40 | You can play the video by calling function `ffmpeg-player-video`. 41 | 42 | ```el 43 | (ffmpeg-player-video (expand-file-name "./test/1.avi")) 44 | ``` 45 | 46 | And here is the control of the media. 47 | 48 | * space - Pause/Unpause. 49 | * up - Increase volume by 5. 50 | * down - Decrease volume by 5. 51 | * left - Backward timeline 10 seconds. 52 | * right - Forward timeline 10 seconds. 53 | * m - Mute/Unmute. 54 | * r - Replay. 55 | 56 | ## 📝 Todo List 57 | 58 | - [ ] Play youtube video through url. 59 | 60 | ## 🛠️ Contribute 61 | 62 | [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com) 63 | [![Elisp styleguide](https://img.shields.io/badge/elisp-style%20guide-purple?logo=gnuemacs&logoColor=white)](https://github.com/bbatsov/emacs-lisp-style-guide) 64 | [![Donate on paypal](https://img.shields.io/badge/paypal-donate-1?logo=paypal&color=blue)](https://www.paypal.me/jcs090218) 65 | [![Become a patron](https://img.shields.io/badge/patreon-become%20a%20patron-orange.svg?logo=patreon)](https://www.patreon.com/jcs090218) 66 | 67 | If you would like to contribute to this project, you may either 68 | clone and make pull requests to this repository. Or you can 69 | clone the project and establish your own branch of this tool. 70 | Any methods are welcome! 71 | 72 | ### 🔬 Development 73 | 74 | To run the test locally, you will need the following tools: 75 | 76 | - [Eask](https://emacs-eask.github.io/) 77 | - [Make](https://www.gnu.org/software/make/) (optional) 78 | 79 | Install all dependencies and development dependencies: 80 | 81 | ```sh 82 | eask install-deps --dev 83 | ``` 84 | 85 | To test the package's installation: 86 | 87 | ```sh 88 | eask package 89 | eask install 90 | ``` 91 | 92 | To test compilation: 93 | 94 | ```sh 95 | eask compile 96 | ``` 97 | 98 | **🪧 The following steps are optional, but we recommend you follow these lint results!** 99 | 100 | The built-in `checkdoc` linter: 101 | 102 | ```sh 103 | eask lint checkdoc 104 | ``` 105 | 106 | The standard `package` linter: 107 | 108 | ```sh 109 | eask lint package 110 | ``` 111 | 112 | *📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.* 113 | 114 | ## ⚜️ License 115 | 116 | This program is free software; you can redistribute it and/or modify 117 | it under the terms of the GNU General Public License as published by 118 | the Free Software Foundation, either version 3 of the License, or 119 | (at your option) any later version. 120 | 121 | This program is distributed in the hope that it will be useful, 122 | but WITHOUT ANY WARRANTY; without even the implied warranty of 123 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 124 | GNU General Public License for more details. 125 | 126 | You should have received a copy of the GNU General Public License 127 | along with this program. If not, see . 128 | 129 | See [`LICENSE`](./LICENSE.txt) for details. 130 | -------------------------------------------------------------------------------- /ffmpeg-player.el: -------------------------------------------------------------------------------- 1 | ;;; ffmpeg-player.el --- Play video using ffmpeg -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2019-2025 Shen, Jen-Chieh 4 | ;; Created date 2019-11-20 13:28:20 5 | 6 | ;; Author: Shen, Jen-Chieh 7 | ;; URL: https://github.com/jcs-elpa/ffmpeg-player 8 | ;; Version: 0.2.1 9 | ;; Package-Requires: ((emacs "24.4") (s "1.12.0") (f "0.20.0")) 10 | ;; Keywords: multimedia video ffmpeg buffering images 11 | 12 | ;; This file is NOT part of GNU Emacs. 13 | 14 | ;; This program is free software; you can redistribute it and/or modify 15 | ;; it under the terms of the GNU General Public License as published by 16 | ;; the Free Software Foundation, either version 3 of the License, or 17 | ;; (at your option) any later version. 18 | 19 | ;; This program is distributed in the hope that it will be useful, 20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 | ;; GNU General Public License for more details. 23 | 24 | ;; You should have received a copy of the GNU General Public License 25 | ;; along with this program. If not, see . 26 | 27 | ;;; Commentary: 28 | ;; 29 | ;; Play video using ffmpeg. 30 | ;; 31 | 32 | ;;; Code: 33 | 34 | (require 'f) 35 | (require 's) 36 | (require 'subr-x) 37 | 38 | (defgroup ffmpeg-player nil 39 | "Play video using ffmpeg." 40 | :prefix "ffmpeg-player-" 41 | :group 'tool 42 | :link '(url-link :tag "Github" "https://github.com/jcs-elpa/ffmpeg-player")) 43 | 44 | (defcustom ffmpeg-player-buffer-name "*ffmpeg-player*: %s" 45 | "Buffer name of the video player." 46 | :type 'string 47 | :group 'ffmpeg-player) 48 | 49 | (defcustom ffmpeg-player-display-width 864 50 | "Display width." 51 | :type 'integer 52 | :group 'ffmpeg-player) 53 | 54 | (defcustom ffmpeg-player-display-height 486 55 | "Display height." 56 | :type 'integer 57 | :group 'ffmpeg-player) 58 | 59 | (defcustom ffmpeg-player-loop t 60 | "Loop when the video end." 61 | :type 'boolean 62 | :group 'ffmpeg-player) 63 | 64 | (defcustom ffmpeg-player-image-prefix "snap" 65 | "Prefix when output images." 66 | :type 'string 67 | :group 'ffmpeg-player) 68 | 69 | (defcustom ffmpeg-player-image-extension "jpg" 70 | "Image extension when output from ffmpeg." 71 | :type 'string 72 | :group 'ffmpeg-player) 73 | 74 | (defcustom ffmpeg-player-fixed-id "%09d" 75 | "Fixed id for the images." 76 | :type 'string 77 | :group 'ffmpeg-player) 78 | 79 | (defcustom ffmpeg-player-mode-hook nil 80 | "Hook called by `ffmpeg-player-mode'." 81 | :type 'hook 82 | :group 'ffmpeg-player) 83 | 84 | (defcustom ffmpeg-player-no-message nil 85 | "No message print out when using video buffer." 86 | :type 'boolean 87 | :group 'ffmpeg-player) 88 | 89 | (defcustom ffmpeg-player-before-insert-image-hook nil 90 | "Hook called before inserting image." 91 | :type 'hook 92 | :group 'ffmpeg-player) 93 | 94 | (defcustom ffmpeg-player-after-insert-image-hook nil 95 | "Hook called after inserting image." 96 | :type 'hook 97 | :group 'ffmpeg-player) 98 | 99 | (defcustom ffmpeg-player-before-insert-string-hook nil 100 | "Hook called before inserting string." 101 | :type 'hook 102 | :group 'ffmpeg-player) 103 | 104 | (defcustom ffmpeg-player-after-insert-string-hook nil 105 | "Hook called after inserting string." 106 | :type 'hook 107 | :group 'ffmpeg-player) 108 | 109 | (defconst ffmpeg-player--command-video-to-images 110 | "ffmpeg -i %s %s \"%s%s%s.%s\"" 111 | "Command that convert video to image source.") 112 | 113 | (defconst ffmpeg-player--command-play-audio 114 | "ffplay %s %s" 115 | "Command that convert video to audio source.") 116 | 117 | (defconst ffmpeg-player--as-video-buffer-name "*Async Shell Command*: Video" 118 | "Name of the async shell buffer for video output.") 119 | 120 | (defconst ffmpeg-player--as-audio-buffer-name "*Async Shell Command*: Audio" 121 | "Name of the async shell buffer for audio output.") 122 | 123 | (defvar ffmpeg-player--img-dir "" 124 | "Current image directory.") 125 | 126 | (defvar ffmpeg-player--img-dir-index 0 127 | "Current image directory index to point to `ffmpeg-player--img-dir-lst'.") 128 | 129 | (defvar ffmpeg-player--img-dir-lst 130 | (list (expand-file-name (format "%s%s" user-emacs-directory "ffmpeg-player/images-0/")) 131 | (expand-file-name (format "%s%s" user-emacs-directory "ffmpeg-player/images-1/")) 132 | (expand-file-name (format "%s%s" user-emacs-directory "ffmpeg-player/images-2/")) 133 | (expand-file-name (format "%s%s" user-emacs-directory "ffmpeg-player/images-3/")) 134 | (expand-file-name (format "%s%s" user-emacs-directory "ffmpeg-player/images-4/")) 135 | (expand-file-name (format "%s%s" user-emacs-directory "ffmpeg-player/images-5/")) 136 | (expand-file-name (format "%s%s" user-emacs-directory "ffmpeg-player/images-6/"))) 137 | "List of image directories so we can split the delete directory processes.") 138 | 139 | (defvar ffmpeg-player--current-path "" 140 | "Record of the current video path.") 141 | 142 | (defvar ffmpeg-player--pause nil 143 | "Flag for pausing video.") 144 | 145 | (defvar ffmpeg-player--frame-regexp nil 146 | "Frame regular expression for matching length.") 147 | 148 | (defvar ffmpeg-player--current-duration 0.0 "Current video length/duration.") 149 | 150 | (defvar ffmpeg-player--current-fps 0.0 "Current FPS that are being used.") 151 | (defvar ffmpeg-player--first-frame-time 0.2 "Time to check if the first frame exists.") 152 | (defvar ffmpeg-player--buffer-time 0.0 "Time to update buffer frame, calculate with FPS.") 153 | 154 | (defvar ffmpeg-player--video-timer 0.0 "Time to record delta time.") 155 | 156 | (defvar ffmpeg-player--last-time 0.0 157 | "Record last time for each frame, used for calculate delta time.") 158 | (defvar ffmpeg-player--delta-time 0.0 159 | "Record delta time for each frame.") 160 | 161 | (defvar ffmpeg-player--frame-index 0 "Current frame index/counter.") 162 | 163 | (defvar ffmpeg-player--first-frame-timer nil "Timer that find out the first frame.") 164 | 165 | (defvar ffmpeg-player--buffer nil "Buffer that displays video.") 166 | (defvar ffmpeg-player--buffer-timer nil "Timer that will update the image buffer.") 167 | 168 | (defvar ffmpeg-player--resolve-clip-info-timer nil "Timer that tries to resolve FPS.") 169 | (defvar ffmpeg-player--resolve-clip-info-time 0.2 "Time to check if fps could be resolved.") 170 | 171 | (defvar ffmpeg-player--mute nil "Flag to check if nil.") 172 | (defvar ffmpeg-player--volume 75 "Current audio volume.") 173 | 174 | ;;; Command 175 | 176 | (defun ffmpeg-player--form-command-list (lst) 177 | "Form the command by LST." 178 | (let ((output "")) 179 | (dolist (cmd lst) 180 | (setq output (concat output cmd " "))) 181 | output)) 182 | 183 | (defun ffmpeg-player--form-command-video (path source) 184 | "From the command for video by needed parameters. 185 | PATH is the input video file. SOURCE is the output image directory." 186 | (format ffmpeg-player--command-video-to-images 187 | (shell-quote-argument path) 188 | (ffmpeg-player--form-command-list 189 | (list (format "-filter:v \"scale=w=%s:h=%s\"" ; Width & Height 190 | (ceiling ffmpeg-player-display-width) 191 | (ceiling ffmpeg-player-display-height)))) 192 | source 193 | ffmpeg-player-image-prefix 194 | ffmpeg-player-fixed-id 195 | ffmpeg-player-image-extension)) 196 | 197 | (defun ffmpeg-player--form-command-audio (path time volume) 198 | "From the command for audio by needed parameters. 199 | PATH is the input audio/video file. TIME is the start time. 200 | VOLUME of the sound from 0 ~ 100." 201 | (format ffmpeg-player--command-play-audio 202 | (shell-quote-argument path) 203 | (ffmpeg-player--form-command-list 204 | (list "-nodisp" ; Don't display 205 | (format "-ss %s" time) 206 | (format "-volume %s" volume))))) 207 | 208 | ;;; Util 209 | 210 | (defun ffmpeg-player--message (fmt &rest args) 211 | "Message FMT and ARGS." 212 | (unless ffmpeg-player-no-message 213 | (apply #'message fmt args))) 214 | 215 | (defun ffmpeg-player--inhibit-sentinel-messages (fun &rest args) 216 | "Inhibit messages in all sentinels started by FUN with ARGS." 217 | (cl-letf* ((old-set-process-sentinel (symbol-function 'set-process-sentinel)) 218 | ((symbol-function 'set-process-sentinel) 219 | (lambda (process sentinel) 220 | (funcall 221 | old-set-process-sentinel 222 | process 223 | `(lambda (&rest args) 224 | (cl-letf (((symbol-function 'message) #'ignore)) 225 | (apply (quote ,sentinel) args))))))) 226 | (apply fun args))) 227 | 228 | (defun ffmpeg-player--round-to-digit (val digit) 229 | "Round VAL to DIGIT." 230 | (let ((ten-digit (expt 10.0 digit))) 231 | (/ (ceiling (* val ten-digit)) ten-digit))) 232 | 233 | (defun ffmpeg-player--count-windows () 234 | "Total window count." 235 | (let ((count 0)) 236 | (dolist (fn (frame-list)) 237 | (setq count (+ (length (window-list fn)) count))) 238 | count)) 239 | 240 | (defun ffmpeg-player--walk-through-all-windows-once (fnc) 241 | "Walk through all the windows once and execute callback FNC." 242 | (save-selected-window 243 | (let ((cur-frame (selected-frame)) (index 0)) 244 | (while (< index (ffmpeg-player--count-windows)) 245 | (when fnc (funcall fnc)) 246 | (other-window 1 t) 247 | (setq index (+ index 1))) 248 | (select-frame-set-input-focus cur-frame)))) 249 | 250 | (defun ffmpeg-player--bury-buffer (buf-name) 251 | "Bury BUF-NAME by walking through all the windows." 252 | ;; NOTE: Regular `walk-windows' function wouldn't work. 253 | ;; TBH, I don't know why. 254 | (ffmpeg-player--walk-through-all-windows-once 255 | (lambda () 256 | (when (string= (buffer-name) buf-name) 257 | (bury-buffer))))) 258 | 259 | (defun ffmpeg-player--safe-path (path) 260 | "Check if safe PATH." 261 | (unless (file-exists-p path) (setq path (expand-file-name path))) 262 | (if (file-exists-p path) path nil)) 263 | 264 | (defun ffmpeg-player--ensure-video-directory-exists () 265 | "Ensure the video directory exists so we can put our image files." 266 | (unless (file-directory-p ffmpeg-player--img-dir) 267 | (make-directory ffmpeg-player--img-dir t))) 268 | 269 | (defun ffmpeg-player--async-delete-directory (path) 270 | "Async delete directory by PATH." 271 | (let ((command (car command-line-args))) 272 | (start-process "ffmpeg-player--async-delete-directory" 273 | nil command "-Q" "--batch" "--eval" 274 | (format "(delete-directory %s t)" (shell-quote-argument path))))) 275 | 276 | (defun ffmpeg-player--clean-video-images () 277 | "Clean up current video images." 278 | (unless (string-empty-p ffmpeg-player--img-dir) 279 | (ffmpeg-player--async-delete-directory ffmpeg-player--img-dir))) 280 | 281 | ;;; Buffer 282 | 283 | (defun ffmpeg-player--buffer-name (path) 284 | "Return current ffmpeg play buffer name by PATH." 285 | (format ffmpeg-player-buffer-name (f-filename path))) 286 | 287 | (defun ffmpeg-player--create-video-buffer (path) 288 | "Create a new video buffer with PATH." 289 | (let* ((name (ffmpeg-player--buffer-name path)) 290 | (buf (if (get-buffer name) (get-buffer name) (generate-new-buffer name)))) 291 | (setq ffmpeg-player--buffer buf) 292 | (with-current-buffer buf (ffmpeg-player-mode)) 293 | (ffmpeg-player--update-frame-by-string "[Nothing to display yet...]") 294 | buf)) 295 | 296 | (defun ffmpeg-player--buffer-alive-p () 297 | "Check if the video buffer alive." 298 | (buffer-name (get-buffer ffmpeg-player--buffer))) 299 | 300 | ;;; Delta Time 301 | 302 | (defun ffmpeg-player--calc-delta-time () 303 | "Calculate the delta time." 304 | (if ffmpeg-player--pause 305 | (setq ffmpeg-player--delta-time 0.0) 306 | (setq ffmpeg-player--delta-time (- (float-time) ffmpeg-player--last-time))) 307 | (setq ffmpeg-player--last-time (float-time))) 308 | 309 | ;;; Clip Info 310 | 311 | (defun ffmpeg-player--set-resolve-clip-info-timer () 312 | "Set the resolve clip information timer task." 313 | (ffmpeg-player--kill-resolve-clip-info-timer) 314 | (setq ffmpeg-player--resolve-clip-info-timer 315 | (run-with-timer ffmpeg-player--resolve-clip-info-time nil #'ffmpeg-player--check-resolve-clip-info))) 316 | 317 | (defun ffmpeg-player--kill-resolve-clip-info-timer () 318 | "Kill the resolve clip information timer." 319 | (when (timerp ffmpeg-player--resolve-clip-info-timer) 320 | (cancel-timer ffmpeg-player--resolve-clip-info-timer) 321 | (setq ffmpeg-player--resolve-clip-info-timer nil))) 322 | 323 | (defun ffmpeg-player--video-shell-output-p () 324 | "Check if output available." 325 | (save-window-excursion 326 | (switch-to-buffer (get-buffer ffmpeg-player--as-video-buffer-name)) 327 | (not (string-empty-p (buffer-string))))) 328 | 329 | (defun ffmpeg-player--get-fps () 330 | "Get the FPS from async shell command output buffer." 331 | (with-current-buffer (get-buffer ffmpeg-player--as-video-buffer-name) 332 | (goto-char (point-min)) 333 | (let ((end-pt -1)) 334 | (search-forward "fps,") 335 | (search-backward " ") 336 | (setq end-pt (1- (point))) 337 | (search-backward " ") 338 | (substring (buffer-string) (point) end-pt)))) 339 | 340 | (defun ffmpeg-player--get-duration () 341 | "Get the duration from async shell command output buffer." 342 | (with-current-buffer (get-buffer ffmpeg-player--as-video-buffer-name) 343 | (goto-char (point-min)) 344 | (search-forward "Duration: ") 345 | (let ((start-pt (1- (point)))) 346 | (search-forward ",") 347 | (substring (buffer-string) start-pt (- (point) 2))))) 348 | 349 | (defun ffmpeg-player--string-to-number-time (str-time) 350 | "Convert STR-TIME to number time." 351 | (let* ((split-time (split-string str-time ":")) 352 | (time-arg (1- (length split-time))) 353 | (float-time 0.0)) 354 | (dolist (st split-time) 355 | (setq st (string-to-number st)) 356 | (setq float-time (+ float-time (* st (expt 60 time-arg)))) 357 | (setq time-arg (1- time-arg))) 358 | float-time)) 359 | 360 | (defun ffmpeg-player--number-to-string-time (time) 361 | "Convert TIME to string time." 362 | (let* ((hr 0.0) (min 0.0) (sec 0.0) (ms 0.0) 363 | (time-arg 2) (unit-time 0.0) (unit-product 0)) 364 | (while (not (= -2 time-arg)) 365 | (setq unit-time (expt 60 time-arg)) 366 | (cond ((= time-arg 2) 367 | (setq hr (floor (/ time unit-time))) 368 | (setq unit-product hr)) 369 | ((= time-arg 1) 370 | (setq min (floor (/ time unit-time))) 371 | (setq unit-product min)) 372 | ((= time-arg 0) 373 | (setq sec (floor (/ time unit-time))) 374 | (setq unit-product sec)) 375 | ((= time-arg -1) 376 | (setq ms (floor (* time 100))))) 377 | (setq time (- time (* unit-time unit-product))) 378 | (setq time-arg (1- time-arg))) 379 | (format "%02d:%02d:%02d.%02d" hr min sec ms))) 380 | 381 | (defun ffmpeg-player--resolve-clip-info () 382 | "Resolve clip's information." 383 | (setq ffmpeg-player--current-duration 384 | (ffmpeg-player--string-to-number-time (ffmpeg-player--get-duration))) 385 | (setq ffmpeg-player--current-fps (ffmpeg-player--get-fps)) 386 | (setq ffmpeg-player--current-fps (string-to-number ffmpeg-player--current-fps)) 387 | (setq ffmpeg-player--buffer-time (/ 1.0 ffmpeg-player--current-fps))) 388 | 389 | (defun ffmpeg-player--check-resolve-clip-info () 390 | "Check if resolved clip information." 391 | (if (not (ffmpeg-player--video-shell-output-p)) 392 | (progn 393 | (message "[INFO] Waiting to resolve clip information") 394 | (ffmpeg-player--set-resolve-clip-info-timer)) 395 | (ffmpeg-player--resolve-clip-info) 396 | (ffmpeg-player--check-first-frame))) 397 | 398 | ;;; First frame 399 | 400 | (defun ffmpeg-player--set-first-frame-timer () 401 | "Set the first frame timer task." 402 | (ffmpeg-player--kill-first-frame-timer) 403 | (setq ffmpeg-player--first-frame-timer 404 | (run-with-timer ffmpeg-player--first-frame-time nil 'ffmpeg-player--check-first-frame))) 405 | 406 | (defun ffmpeg-player--kill-first-frame-timer () 407 | "Kill the first frame timer. 408 | Information about first frame timer please see variable `ffmpeg-player--first-frame-timer'." 409 | (when (timerp ffmpeg-player--first-frame-timer) 410 | (cancel-timer ffmpeg-player--first-frame-timer) 411 | (setq ffmpeg-player--first-frame-timer nil))) 412 | 413 | (defun ffmpeg-player--form-file-extension-regexp () 414 | "Form regular expression for search image file." 415 | (format "\\.%s$" ffmpeg-player-image-extension)) 416 | 417 | (defun ffmpeg-player--check-first-frame () 418 | "Core function to check first frame image is ready." 419 | (if (f-empty? ffmpeg-player--img-dir) 420 | (ffmpeg-player--set-first-frame-timer) 421 | (let ((images (directory-files ffmpeg-player--img-dir nil (ffmpeg-player--form-file-extension-regexp))) 422 | (first-frame nil)) 423 | (setq first-frame (nth 0 images)) 424 | (setq first-frame (s-replace ffmpeg-player-image-prefix "" first-frame)) 425 | (setq first-frame (s-replace-regexp (ffmpeg-player--form-file-extension-regexp) "" first-frame)) 426 | (setq ffmpeg-player--frame-regexp (format "%s%sd" "%0" (length first-frame))) 427 | (setq ffmpeg-player--last-time (float-time)) ; Update the first frame time. 428 | (ffmpeg-player--play-sound-at-current-time) ; Start the audio 429 | (ffmpeg-player--update-frame)))) 430 | 431 | ;;; Frame 432 | 433 | (defun ffmpeg-player--set-buffer-timer () 434 | "Set the buffer timer task." 435 | (ffmpeg-player--kill-buffer-timer) 436 | (setq ffmpeg-player--buffer-timer 437 | (run-with-timer ffmpeg-player--buffer-time nil #'ffmpeg-player--update-frame))) 438 | 439 | (defun ffmpeg-player--kill-buffer-timer () 440 | "Kill the buffer timer." 441 | (when (timerp ffmpeg-player--buffer-timer) 442 | (cancel-timer ffmpeg-player--buffer-timer) 443 | (setq ffmpeg-player--buffer-timer nil))) 444 | 445 | (defun ffmpeg-player--form-frame-filename () 446 | "Form the frame filename." 447 | (format "%s%s.%s" 448 | ffmpeg-player-image-prefix 449 | (format ffmpeg-player--frame-regexp ffmpeg-player--frame-index) 450 | ffmpeg-player-image-extension)) 451 | 452 | (defun ffmpeg-player--update-frame-by-image-path (path) 453 | "Update the frame by image PATH." 454 | (if (not (ffmpeg-player--buffer-alive-p)) 455 | (ffmpeg-player--clean-up) 456 | (with-current-buffer ffmpeg-player--buffer 457 | (erase-buffer) 458 | (run-hooks 'ffmpeg-player-before-insert-image-hook) 459 | (insert-image-file path) 460 | (run-hooks 'ffmpeg-player-after-insert-image-hook)))) 461 | 462 | (defun ffmpeg-player--update-frame-by-string (str) 463 | "Update the frame by STR." 464 | (if (not (ffmpeg-player--buffer-alive-p)) 465 | (ffmpeg-player--clean-up) 466 | (with-current-buffer ffmpeg-player--buffer 467 | (erase-buffer) 468 | (run-hooks 'ffmpeg-player-before-insert-string-hook) 469 | (insert str) 470 | (run-hooks 'ffmpeg-player-after-insert-string-hook)))) 471 | 472 | (defun ffmpeg-player--update-frame-index () 473 | "Calculate then update the frame index by time." 474 | ;; Calculate the time passed. 475 | (setq ffmpeg-player--video-timer (+ ffmpeg-player--video-timer ffmpeg-player--delta-time)) 476 | ;; Calculate the frame index. 477 | (setq ffmpeg-player--frame-index (ceiling (* ffmpeg-player--current-fps ffmpeg-player--video-timer)))) 478 | 479 | (defun ffmpeg-player--update-frame-info () 480 | "Update display image and audio by timeline." 481 | (if (ffmpeg-player--done-playing-p) 482 | (if (not ffmpeg-player-loop) 483 | (ffmpeg-player--update-frame-by-string "[INFO] Done display...") 484 | ;; Do loop. 485 | (ffmpeg-player-replay) 486 | (ffmpeg-player--set-buffer-timer)) 487 | (let ((frame-file (concat ffmpeg-player--img-dir (ffmpeg-player--form-frame-filename)))) 488 | (if (not (file-exists-p frame-file)) 489 | (ffmpeg-player--update-frame-by-string "[INFO] Frame not ready") 490 | (ffmpeg-player--update-frame-by-image-path frame-file)) 491 | (ffmpeg-player--set-buffer-timer)))) 492 | 493 | (defun ffmpeg-player--update-frame () 494 | "Core logic to update frame." 495 | (if (not (ffmpeg-player--buffer-alive-p)) 496 | (progn 497 | (ffmpeg-player--kill-sound-process) 498 | (user-error "[WARNING] Display buffer no longer live")) 499 | (ffmpeg-player--calc-delta-time) 500 | (ffmpeg-player--update-frame-index) 501 | (ffmpeg-player--update-frame-info))) 502 | 503 | ;;; Core 504 | 505 | (defun ffmpeg-player--kill-async-shell-buffer () 506 | "Kill all async shell buffers." 507 | (when (get-buffer ffmpeg-player--as-video-buffer-name) 508 | (kill-buffer (get-buffer ffmpeg-player--as-video-buffer-name))) 509 | (ffmpeg-player--kill-sound-process)) 510 | 511 | (defun ffmpeg-player--bury-async-shell-buffer () 512 | "Bury all the async shell buffers." 513 | ;; NOTE: Regular `bury-buffer' wouldn't work. 514 | (ffmpeg-player--bury-buffer ffmpeg-player--as-video-buffer-name) 515 | (ffmpeg-player--bury-buffer ffmpeg-player--as-audio-buffer-name)) 516 | 517 | (defun ffmpeg-player--rename-async-shell (new-name) 518 | "Rename the async shell output buffer to NEW-NAME." 519 | (with-current-buffer (get-buffer "*Async Shell Command*") 520 | (rename-buffer new-name)) 521 | (ffmpeg-player--bury-async-shell-buffer)) 522 | 523 | (defun ffmpeg-player--done-playing-p () 524 | "Check if done playing the clip." 525 | (<= ffmpeg-player--current-duration 526 | (ffmpeg-player--round-to-digit ffmpeg-player--video-timer 2))) 527 | 528 | (defun ffmpeg-player--kill-display-buffer () 529 | "Clean up display buffer." 530 | (when ffmpeg-player--buffer 531 | (kill-buffer ffmpeg-player--buffer) 532 | (setq ffmpeg-player--buffer nil))) 533 | 534 | (defun ffmpeg-player--clean-up () 535 | "Reset/Clean up some variable before we play a new video." 536 | (progn ; Change to new image directory. 537 | (setq ffmpeg-player--img-dir-index (1+ ffmpeg-player--img-dir-index)) 538 | (setq ffmpeg-player--img-dir-index 539 | (% ffmpeg-player--img-dir-index (length ffmpeg-player--img-dir-lst))) 540 | (setq ffmpeg-player--img-dir 541 | (nth ffmpeg-player--img-dir-index ffmpeg-player--img-dir-lst))) 542 | (ffmpeg-player--kill-first-frame-timer) 543 | (ffmpeg-player--kill-resolve-clip-info-timer) 544 | (ffmpeg-player--kill-buffer-timer) 545 | (setq ffmpeg-player--current-path "") 546 | (ffmpeg-player--kill-display-buffer) 547 | (progn ; Clean delta time 548 | (setq ffmpeg-player--last-time 0.0) 549 | (setq ffmpeg-player--delta-time 0.0)) 550 | (setq ffmpeg-player--video-timer 0.0) 551 | (setq ffmpeg-player--current-duration 0.0) 552 | (setq ffmpeg-player--current-fps 0.0) 553 | (setq ffmpeg-player--frame-index 0) 554 | (setq ffmpeg-player--frame-regexp nil) 555 | (progn ; User settings 556 | (setq ffmpeg-player--pause nil)) 557 | (ffmpeg-player--kill-async-shell-buffer)) 558 | 559 | ;;;###autoload 560 | (defun ffmpeg-player-clean () 561 | "Clean all the data, like images cache." 562 | (interactive) 563 | (dolist (cache-dir ffmpeg-player--img-dir-lst) 564 | (unless (string-empty-p cache-dir) 565 | (ffmpeg-player--async-delete-directory cache-dir)))) 566 | 567 | ;;;###autoload 568 | (defun ffmpeg-player-video (path) 569 | "Play the video with PATH." 570 | (setq path (ffmpeg-player--safe-path path)) 571 | (if (not path) 572 | (user-error "[ERROR] Input video file doesn't exists: %s" path) 573 | (ffmpeg-player--clean-video-images) 574 | (ffmpeg-player--clean-up) 575 | (ffmpeg-player--ensure-video-directory-exists) 576 | (setq ffmpeg-player--current-path path) 577 | (progn ; Extract video 578 | (ffmpeg-player--inhibit-sentinel-messages 579 | #'async-shell-command 580 | (ffmpeg-player--form-command-video path ffmpeg-player--img-dir)) 581 | (ffmpeg-player--rename-async-shell ffmpeg-player--as-video-buffer-name) 582 | (ffmpeg-player--create-video-buffer path)) 583 | (switch-to-buffer-other-window ffmpeg-player--buffer) 584 | (ffmpeg-player--check-resolve-clip-info))) 585 | 586 | ;;; Sound 587 | 588 | (defun ffmpeg-player--kill-sound-process () 589 | "Kill the current sound process if available." 590 | (when (get-buffer ffmpeg-player--as-audio-buffer-name) 591 | (kill-buffer (get-buffer ffmpeg-player--as-audio-buffer-name)))) 592 | 593 | (defun ffmpeg-player--play-sound (&optional time) 594 | "Play the sound at the TIME." 595 | (cond ((not time) (setq time "00:00:00.0")) ; Default to 00:00:00.0 596 | ((or (floatp time) (integerp time)) 597 | (setq time (ffmpeg-player--number-to-string-time time)))) 598 | (if (string-empty-p ffmpeg-player--current-path) 599 | (user-error "[ERROR] Can't play with this path: %s" ffmpeg-player--current-path) 600 | (ffmpeg-player--kill-sound-process) 601 | (ffmpeg-player--inhibit-sentinel-messages 602 | #'async-shell-command 603 | (ffmpeg-player--form-command-audio ffmpeg-player--current-path 604 | time 605 | ffmpeg-player--volume)) 606 | (ffmpeg-player--rename-async-shell ffmpeg-player--as-audio-buffer-name))) 607 | 608 | (defun ffmpeg-player--play-sound-at-current-time () 609 | "Play the sound at current timeline." 610 | (when (and (not ffmpeg-player--pause) (not ffmpeg-player--mute)) 611 | (ffmpeg-player--play-sound ffmpeg-player--video-timer))) 612 | 613 | (defun ffmpeg-player-mute-or-unmute () 614 | "Mute/Unmute the sound." 615 | (interactive) 616 | (if ffmpeg-player--mute (ffmpeg-player-unmute) (ffmpeg-player-mute))) 617 | 618 | (defun ffmpeg-player-unmute () 619 | "Unmute the sound." 620 | (interactive) 621 | (setq ffmpeg-player--mute nil) 622 | (ffmpeg-player--play-sound-at-current-time) 623 | (ffmpeg-player--message "[INFO] Unmute audio")) 624 | 625 | (defun ffmpeg-player-mute () 626 | "Mute the sound." 627 | (interactive) 628 | (setq ffmpeg-player--mute t) 629 | (ffmpeg-player--kill-sound-process) 630 | (ffmpeg-player--message "[INFO] Mute audio")) 631 | 632 | (defun ffmpeg-player--move-volume (n) 633 | "Move audio volume by N value." 634 | (setq ffmpeg-player--volume (+ ffmpeg-player--volume n)) 635 | (cond ((< ffmpeg-player--volume 0) 636 | (setq ffmpeg-player--volume 0)) 637 | ((> ffmpeg-player--volume 100) 638 | (setq ffmpeg-player--volume 100))) 639 | (ffmpeg-player--play-sound-at-current-time) 640 | (ffmpeg-player--message "[INFO] Current audio: %s" ffmpeg-player--volume)) 641 | 642 | (defun ffmpeg-player-volume-dec-5 () 643 | "Decrease volume by 5." 644 | (interactive) 645 | (ffmpeg-player--move-volume -5)) 646 | 647 | (defun ffmpeg-player-volume-inc-5 () 648 | "Increase volume by 5." 649 | (interactive) 650 | (ffmpeg-player--move-volume 5)) 651 | 652 | ;;; Mode 653 | 654 | (defun ffmpeg-player-replay () 655 | "Play video from the start." 656 | (interactive) 657 | (setq ffmpeg-player--video-timer 0.0) 658 | (ffmpeg-player-unpause) 659 | (ffmpeg-player--message "[INFO] Replaying '%s'" ffmpeg-player--current-path)) 660 | 661 | (defun ffmpeg-player-unpause () 662 | "Unpause the video." 663 | (interactive) 664 | (setq ffmpeg-player--pause nil) 665 | (ffmpeg-player--play-sound-at-current-time) 666 | (ffmpeg-player--message "[INFO] Unpause video")) 667 | 668 | (defun ffmpeg-player-pause () 669 | "Pause the video." 670 | (interactive) 671 | (setq ffmpeg-player--pause t) 672 | (ffmpeg-player--kill-sound-process) 673 | (ffmpeg-player--message "[INFO] Pause video")) 674 | 675 | (defun ffmpeg-player-pause-or-unpause () 676 | "Pause or unpause video." 677 | (interactive) 678 | (if ffmpeg-player--pause (ffmpeg-player-unpause) (ffmpeg-player-pause))) 679 | 680 | (defun ffmpeg-player--move-timeline (n) 681 | "Move video timeline by N seconds." 682 | (setq ffmpeg-player--video-timer (+ ffmpeg-player--video-timer n)) 683 | (cond ((< ffmpeg-player--video-timer 0.0) 684 | (setq ffmpeg-player--video-timer 0.0)) 685 | ((> ffmpeg-player--video-timer ffmpeg-player--current-duration) 686 | (setq ffmpeg-player--video-timer ffmpeg-player--current-duration))) 687 | (ffmpeg-player--play-sound-at-current-time) 688 | (ffmpeg-player--message "[INFO] Current time: %s" ffmpeg-player--video-timer)) 689 | 690 | (defun ffmpeg-player-backward-10 () 691 | "Backward time 10 seconds." 692 | (interactive) 693 | (ffmpeg-player--move-timeline -10.0)) 694 | 695 | (defun ffmpeg-player-forward-10 () 696 | "Forward time 10 seconds." 697 | (interactive) 698 | (ffmpeg-player--move-timeline 10.0)) 699 | 700 | (defvar ffmpeg-player-mode-map 701 | (let ((map (make-sparse-keymap))) 702 | (define-key map (kbd "SPC") #'ffmpeg-player-pause-or-unpause) 703 | (define-key map (kbd "") #'ffmpeg-player-volume-inc-5) 704 | (define-key map (kbd "") #'ffmpeg-player-volume-dec-5) 705 | (define-key map (kbd "") #'ffmpeg-player-backward-10) 706 | (define-key map (kbd "") #'ffmpeg-player-forward-10) 707 | (define-key map (kbd "m") #'ffmpeg-player-mute-or-unmute) 708 | (define-key map (kbd "r") #'ffmpeg-player-replay) 709 | map) 710 | "Keymap used in `ffmpeg-player-mode'.") 711 | 712 | (define-derived-mode ffmpeg-player-mode fundamental-mode "ffmpeg-player" 713 | "Major mode for play ffmpeg video." 714 | :group 'ffmpeg-player 715 | (buffer-disable-undo) 716 | (use-local-map ffmpeg-player-mode-map)) 717 | 718 | (provide 'ffmpeg-player) 719 | ;;; ffmpeg-player.el ends here 720 | -------------------------------------------------------------------------------- /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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | --------------------------------------------------------------------------------