├── src ├── app │ ├── @types │ │ ├── preferences.d.ts │ │ └── preload.d.ts │ ├── index.tsx │ └── app.tsx ├── renderer.ts ├── assets │ ├── icon.ico │ ├── icon.png │ └── fonts │ │ ├── DSEG7Modern-Bold.ttf │ │ ├── DSEG7Modern-Bold.woff │ │ └── DSEG7Modern-Bold.woff2 ├── index.html ├── preload.ts ├── utils.ts ├── index.css ├── osc.ts ├── index.ts └── settings.ts ├── .eslintrc.json ├── webpack.renderer.config.ts ├── tsconfig.json ├── webpack.main.config.ts ├── webpack.plugins.ts ├── .github └── workflows │ └── release.yml ├── webpack.rules.ts ├── .gitignore ├── package.json ├── README.md ├── forge.config.ts └── LICENSE /src/app/@types/preferences.d.ts: -------------------------------------------------------------------------------- 1 | declare module 'electron-preferences'; -------------------------------------------------------------------------------- /src/renderer.ts: -------------------------------------------------------------------------------- 1 | import './index.css'; 2 | import './app/index'; 3 | 4 | 5 | -------------------------------------------------------------------------------- /src/assets/icon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jcalado/cgtimer/HEAD/src/assets/icon.ico -------------------------------------------------------------------------------- /src/assets/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jcalado/cgtimer/HEAD/src/assets/icon.png -------------------------------------------------------------------------------- /src/assets/fonts/DSEG7Modern-Bold.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jcalado/cgtimer/HEAD/src/assets/fonts/DSEG7Modern-Bold.ttf -------------------------------------------------------------------------------- /src/assets/fonts/DSEG7Modern-Bold.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jcalado/cgtimer/HEAD/src/assets/fonts/DSEG7Modern-Bold.woff -------------------------------------------------------------------------------- /src/assets/fonts/DSEG7Modern-Bold.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jcalado/cgtimer/HEAD/src/assets/fonts/DSEG7Modern-Bold.woff2 -------------------------------------------------------------------------------- /src/app/@types/preload.d.ts: -------------------------------------------------------------------------------- 1 | import { api } from '../../preload'; 2 | 3 | declare global { 4 | interface Window { api: typeof api;} 5 | } -------------------------------------------------------------------------------- /src/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | CG Timer 6 | 7 | 8 | 9 |
10 | 11 | 12 | -------------------------------------------------------------------------------- /src/app/index.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import { createRoot } from 'react-dom/client'; 3 | import App from './app'; // Import the 'App' component 4 | 5 | const element = document.getElementById('app') as HTMLElement; 6 | const root = createRoot(element); 7 | root.render(); -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "env": { 3 | "browser": true, 4 | "es6": true, 5 | "node": true 6 | }, 7 | "extends": [ 8 | "eslint:recommended", 9 | "plugin:@typescript-eslint/eslint-recommended", 10 | "plugin:@typescript-eslint/recommended", 11 | "plugin:import/recommended", 12 | "plugin:import/electron", 13 | "plugin:import/typescript" 14 | ], 15 | "parser": "@typescript-eslint/parser" 16 | } 17 | -------------------------------------------------------------------------------- /webpack.renderer.config.ts: -------------------------------------------------------------------------------- 1 | import type { Configuration } from 'webpack'; 2 | 3 | import { rules } from './webpack.rules'; 4 | import { plugins } from './webpack.plugins'; 5 | 6 | rules.push({ 7 | test: /\.css$/, 8 | use: [{ loader: 'style-loader' }, { loader: 'css-loader' }], 9 | }); 10 | 11 | export const rendererConfig: Configuration = { 12 | module: { 13 | rules, 14 | }, 15 | plugins, 16 | resolve: { 17 | extensions: ['.js', '.ts', '.jsx', '.tsx', '.css'], 18 | }, 19 | }; 20 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "ES6", 4 | "allowJs": true, 5 | "module": "commonjs", 6 | "skipLibCheck": true, 7 | "esModuleInterop": true, 8 | "jsx": "react-jsx", 9 | "noImplicitAny": true, 10 | "sourceMap": true, 11 | "baseUrl": ".", 12 | "outDir": "dist", 13 | "moduleResolution": "node", 14 | "resolveJsonModule": true, 15 | "paths": { 16 | "*": ["node_modules/*"] 17 | } 18 | }, 19 | "include": ["src/**/*"] 20 | } 21 | -------------------------------------------------------------------------------- /webpack.main.config.ts: -------------------------------------------------------------------------------- 1 | import type { Configuration } from 'webpack'; 2 | 3 | import { rules } from './webpack.rules'; 4 | import { plugins } from './webpack.plugins'; 5 | 6 | export const mainConfig: Configuration = { 7 | /** 8 | * This is the main entry point for your application, it's the first file 9 | * that runs in the main process. 10 | */ 11 | entry: './src/index.ts', 12 | // Put your normal webpack config below here 13 | module: { 14 | rules, 15 | }, 16 | plugins, 17 | resolve: { 18 | extensions: ['.js', '.ts', '.jsx', '.tsx', '.css', '.json'], 19 | }, 20 | }; 21 | -------------------------------------------------------------------------------- /webpack.plugins.ts: -------------------------------------------------------------------------------- 1 | import type IForkTsCheckerWebpackPlugin from 'fork-ts-checker-webpack-plugin'; 2 | // eslint-disable-next-line @typescript-eslint/no-var-requires 3 | const CopyPlugin = require("copy-webpack-plugin"); 4 | 5 | // eslint-disable-next-line @typescript-eslint/no-var-requires 6 | const ForkTsCheckerWebpackPlugin: typeof IForkTsCheckerWebpackPlugin = require('fork-ts-checker-webpack-plugin'); 7 | 8 | export const plugins = [ 9 | new ForkTsCheckerWebpackPlugin({ 10 | logger: 'webpack-infrastructure', 11 | }), 12 | new CopyPlugin({ 13 | patterns: [ 14 | { from: "node_modules/electron-preferences/build", to: "./native_modules" } 15 | ] 16 | }) 17 | ]; 18 | -------------------------------------------------------------------------------- /src/preload.ts: -------------------------------------------------------------------------------- 1 | // See the Electron documentation for details on how to use preload scripts: 2 | // https://www.electronjs.org/docs/latest/tutorial/process-model#preload-scripts 3 | 4 | import { contextBridge, ipcRenderer } from "electron"; 5 | 6 | export const api = { 7 | send: (channel: any, data: any) => { 8 | ipcRenderer.send(channel, data); 9 | }, 10 | receive: (channel: any, handler: any) => { 11 | ipcRenderer.on(channel, (...args) => handler(...args)); 12 | }, 13 | removeListener: (channel: any, handler: any) => { 14 | ipcRenderer.removeListener(channel, (...args) => handler(...args)); 15 | 16 | } 17 | }; 18 | 19 | contextBridge.exposeInMainWorld("api", api); -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release app 2 | on: 3 | workflow_dispatch: 4 | jobs: 5 | build: 6 | strategy: 7 | matrix: 8 | os: 9 | [ 10 | { name: 'windows', image: 'windows-latest' }, 11 | { name: 'macos', image: 'macos-latest' }, 12 | { name: 'linux', image: 'ubuntu-latest' } 13 | ] 14 | runs-on: ${{ matrix.os.image }} 15 | steps: 16 | - name: Github checkout 17 | uses: actions/checkout@v4 18 | - name: Use Node.js 19 | uses: actions/setup-node@v4 20 | with: 21 | node-version: 20 22 | - run: npm install 23 | - name: Publish app 24 | env: 25 | GITHUB_TOKEN: ${{ secrets.GH_TOKEN }} 26 | run: npm run publish -------------------------------------------------------------------------------- /webpack.rules.ts: -------------------------------------------------------------------------------- 1 | import type { ModuleOptions } from 'webpack'; 2 | 3 | export const rules: Required['rules'] = [ 4 | // Add support for native node modules 5 | { 6 | // We're specifying native_modules in the test because the asset relocator loader generates a 7 | // "fake" .node file which is really a cjs file. 8 | test: /native_modules[/\\].+\.node$/, 9 | use: 'node-loader', 10 | }, 11 | { 12 | test: /[/\\]node_modules[/\\].+\.(m?js|node)$/, 13 | parser: { amd: false }, 14 | use: { 15 | loader: '@vercel/webpack-asset-relocator-loader', 16 | options: { 17 | outputAssetBase: 'native_modules', 18 | }, 19 | }, 20 | }, 21 | { 22 | test: /\.tsx?$/, 23 | exclude: /(node_modules|\.webpack)/, 24 | use: { 25 | loader: 'ts-loader', 26 | options: { 27 | transpileOnly: true, 28 | }, 29 | }, 30 | }, 31 | ]; 32 | -------------------------------------------------------------------------------- /src/utils.ts: -------------------------------------------------------------------------------- 1 | export class Utils { 2 | /** 3 | * Converts milliseconds from midnight to HH:mm:ss format 4 | * @param ms Number of milliseconds from midnight 5 | * @returns Formatted time string in HH:mm:ss format 6 | * @example 7 | * Utils.msToTime(3661000) // returns "01:01:01" 8 | * Utils.msToTime(-3661000) // returns "-01:01:01" 9 | */ 10 | public static msToTime(ms: number): string { 11 | const isNegative = ms < 0; 12 | ms = Math.abs(ms); 13 | 14 | const totalSeconds = Math.floor(ms / 1000); 15 | const hours = Math.floor(totalSeconds / 3600); 16 | const minutes = Math.floor((totalSeconds % 3600) / 60); 17 | const seconds = totalSeconds % 60; 18 | 19 | const timeString = `${hours.toString().padStart(2, '0')}:${minutes.toString().padStart(2, '0')}:${seconds.toString().padStart(2, '0')}`; 20 | 21 | return isNegative ? `-${timeString}` : timeString; 22 | } 23 | 24 | // You can add other utility methods here 25 | } -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | .DS_Store 18 | 19 | # Directory for instrumented libs generated by jscoverage/JSCover 20 | lib-cov 21 | 22 | # Coverage directory used by tools like istanbul 23 | coverage 24 | *.lcov 25 | 26 | # nyc test coverage 27 | .nyc_output 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # TypeScript cache 43 | *.tsbuildinfo 44 | 45 | # Optional npm cache directory 46 | .npm 47 | 48 | # Optional eslint cache 49 | .eslintcache 50 | 51 | # Optional REPL history 52 | .node_repl_history 53 | 54 | # Output of 'npm pack' 55 | *.tgz 56 | 57 | # Yarn Integrity file 58 | .yarn-integrity 59 | 60 | # dotenv environment variables file 61 | .env 62 | .env.test 63 | 64 | # parcel-bundler cache (https://parceljs.org/) 65 | .cache 66 | 67 | # next.js build output 68 | .next 69 | 70 | # nuxt.js build output 71 | .nuxt 72 | 73 | # vuepress build output 74 | .vuepress/dist 75 | 76 | # Serverless directories 77 | .serverless/ 78 | 79 | # FuseBox cache 80 | .fusebox/ 81 | 82 | # DynamoDB Local files 83 | .dynamodb/ 84 | 85 | # Webpack 86 | .webpack/ 87 | 88 | # Vite 89 | .vite/ 90 | 91 | # Electron-Forge 92 | out/ 93 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "cgtimer", 3 | "productName": "cgtimer", 4 | "version": "2.1.0", 5 | "description": "Media playback production clocks for CasparCG", 6 | "main": ".webpack/main", 7 | "repository": "https://github.com/jcalado/cgtimer", 8 | "scripts": { 9 | "start": "electron-forge start", 10 | "package": "electron-forge package", 11 | "make": "electron-forge make", 12 | "publish": "electron-forge publish", 13 | "lint": "eslint --ext .ts,.tsx ." 14 | }, 15 | "devDependencies": { 16 | "@electron-forge/cli": "^7.4.0", 17 | "@electron-forge/maker-deb": "^7.4.0", 18 | "@electron-forge/maker-rpm": "^7.4.0", 19 | "@electron-forge/maker-squirrel": "^7.4.0", 20 | "@electron-forge/maker-zip": "^7.4.0", 21 | "@electron-forge/plugin-auto-unpack-natives": "^7.4.0", 22 | "@electron-forge/plugin-fuses": "^7.4.0", 23 | "@electron-forge/plugin-webpack": "^7.4.0", 24 | "@electron-forge/publisher-github": "^7.4.0", 25 | "@electron/fuses": "^1.8.0", 26 | "@types/react": "^18.2.79", 27 | "@types/react-dom": "^18.2.25", 28 | "@typescript-eslint/eslint-plugin": "^5.0.0", 29 | "@typescript-eslint/parser": "^5.0.0", 30 | "@vercel/webpack-asset-relocator-loader": "1.7.3", 31 | "copy-webpack-plugin": "^12.0.2", 32 | "css-loader": "^6.0.0", 33 | "electron": "30.0.1", 34 | "eslint": "^8.0.1", 35 | "eslint-plugin-import": "^2.25.0", 36 | "fork-ts-checker-webpack-plugin": "^7.2.13", 37 | "node-loader": "^2.0.0", 38 | "style-loader": "^3.0.0", 39 | "ts-loader": "^9.2.2", 40 | "ts-node": "^10.0.0", 41 | "typescript": "~4.5.4" 42 | }, 43 | "keywords": [], 44 | "author": { 45 | "name": "Joel Calado", 46 | "email": "joelcalado@gmail.com" 47 | }, 48 | "license": "GPL-3.0-only", 49 | "dependencies": { 50 | "date-fns": "^3.6.0", 51 | "electron-preferences": "^2.8.2", 52 | "electron-squirrel-startup": "^1.0.0", 53 | "osc": "^2.4.4", 54 | "react": "^18.2.0", 55 | "react-dom": "^18.2.0", 56 | "update-electron-app": "^3.0.0" 57 | } 58 | } 59 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # CGTimer 2 | Production clocks for CasparCG servers. 3 | Show current time, elapsed and remaining active media time. 4 | 5 | If you are using CGTimer share some pictures and I'll open a gallery here on the wiki. 6 | You may use [code@jcalado.com](mailto:code@jcalado.com) 7 | 8 | # Features 9 | 10 | - Set what casparCG channel to target 11 | - Displays elapsed time 12 | - Displays remaining time 13 | - Split the live clock into two clocks: the regular live clock and a production time clock. 14 | - Set production start time, and duration, and get a countdown to production start and end. 15 | - Remaining time turns read at less than 10 seconds to clip end. 16 | - Warns about the video being looped, via a "Loop" bug on the elapsed time panel 17 | - When CasparCG is issued a `STOP` command to the ffmpeg producer, everything is reset 18 | - 🆕 Connects with ontime for production time management. 19 | 20 | # Screenshots 21 | 22 | 23 | # Configuration 24 | 25 | ## Client 26 | 27 | Press `alt` key and the menu should popup. Go to preferences, setup the CasparCG OSC port and channel information. 28 | 29 | ## Server 30 | CGTimer expects a CasparCG server configured to output OSC data. 31 | You can do this in you caspar.config: 32 | 33 | ``` 34 | 35 | ... 36 | 37 | 38 |
127.0.0.1
39 | 6251 40 |
41 |
42 |
43 | ``` 44 | 45 | Replace 127.0.0.1 with the IP address of the machine running CGTimer. 46 | 47 | 48 | ## 🆕 ontime integration 49 | 50 | You can show the remaining time of your active ontime event timer: 51 | 52 | On ontime `Integrations` go to `OSC settings`. Set the `OSC Output` to on, set the `OSC target IP` to the IP of the machine running `CGTimer`. Set the `OSC target port` to the same port you're using for the casparCG OSC port, eg: `6251`. 53 | 54 | Add an `OSC Integration` below, setting it to cycle `Every second`, address: `/from-ontime/current`, and arguments to `{{timer.current}}` 55 | 56 | # UI 57 | The design is heavily inspired on the looks of https://github.com/dimitry-ishenko-casparcg/timer. 58 | -------------------------------------------------------------------------------- /forge.config.ts: -------------------------------------------------------------------------------- 1 | import type { ForgeConfig } from "@electron-forge/shared-types"; 2 | import { MakerSquirrel } from "@electron-forge/maker-squirrel"; 3 | import { MakerZIP } from "@electron-forge/maker-zip"; 4 | import { MakerDeb } from "@electron-forge/maker-deb"; 5 | import { MakerRpm } from "@electron-forge/maker-rpm"; 6 | import { AutoUnpackNativesPlugin } from "@electron-forge/plugin-auto-unpack-natives"; 7 | import { WebpackPlugin } from "@electron-forge/plugin-webpack"; 8 | import { FusesPlugin } from "@electron-forge/plugin-fuses"; 9 | import { FuseV1Options, FuseVersion } from "@electron/fuses"; 10 | 11 | import { mainConfig } from "./webpack.main.config"; 12 | import { rendererConfig } from "./webpack.renderer.config"; 13 | 14 | const config: ForgeConfig = { 15 | packagerConfig: { 16 | asar: true, 17 | icon: "./src/assets/icon", 18 | }, 19 | rebuildConfig: {}, 20 | makers: [ 21 | new MakerSquirrel({}), 22 | new MakerZIP({}), 23 | new MakerDeb({}, ["linux"]), 24 | ], 25 | publishers: [ 26 | { 27 | name: "@electron-forge/publisher-github", 28 | config: { 29 | repository: { 30 | owner: "jcalado", 31 | name: "cgtimer", 32 | }, 33 | prerelease: false, 34 | draft: true, 35 | generateReleaseNotes: true, 36 | }, 37 | }, 38 | ], 39 | plugins: [ 40 | new AutoUnpackNativesPlugin({}), 41 | new WebpackPlugin({ 42 | mainConfig, 43 | renderer: { 44 | config: rendererConfig, 45 | entryPoints: [ 46 | { 47 | html: "./src/index.html", 48 | js: "./src/renderer.ts", 49 | name: "main_window", 50 | preload: { 51 | js: "./src/preload.ts", 52 | }, 53 | }, 54 | ], 55 | }, 56 | }), 57 | // Fuses are used to enable/disable various Electron functionality 58 | // at package time, before code signing the application 59 | new FusesPlugin({ 60 | version: FuseVersion.V1, 61 | [FuseV1Options.RunAsNode]: false, 62 | [FuseV1Options.EnableCookieEncryption]: true, 63 | [FuseV1Options.EnableNodeOptionsEnvironmentVariable]: false, 64 | [FuseV1Options.EnableNodeCliInspectArguments]: false, 65 | [FuseV1Options.EnableEmbeddedAsarIntegrityValidation]: true, 66 | [FuseV1Options.OnlyLoadAppFromAsar]: true, 67 | }), 68 | ], 69 | }; 70 | 71 | export default config; 72 | -------------------------------------------------------------------------------- /src/index.css: -------------------------------------------------------------------------------- 1 | html { 2 | width: 100%; 3 | height: 100%; 4 | overflow: hidden; 5 | background-color: #1e1e1e; 6 | } 7 | 8 | body { 9 | font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, 10 | Arial, sans-serif; 11 | margin: auto; 12 | display: flex; 13 | align-items: center; 14 | flex-direction: column; 15 | height: 100%; 16 | width: 100%; 17 | } 18 | 19 | .app { 20 | display: flex; 21 | flex-direction: column; 22 | justify-content: space-around; 23 | align-items: center; 24 | height: 100vh; 25 | gap: 10px; 26 | box-sizing: border-box; 27 | padding: 10px 0; 28 | user-select: none; 29 | } 30 | 31 | .monitor { 32 | flex: 1; 33 | background-color: #242424; 34 | height: 100%; 35 | box-shadow: 0px 4px 5px rgb(22, 22, 22); 36 | position: relative; 37 | padding: 0px 40px; 38 | display: flex; 39 | flex-direction: column; 40 | justify-content: center; 41 | } 42 | 43 | .monitor.ending div { 44 | animation: blink-red 1s linear infinite; 45 | color: red; 46 | } 47 | 48 | .monitor.ending h1 + div { 49 | color: #ff0000; 50 | } 51 | 52 | div > h1 + div { 53 | font-size: clamp(1vh, 15vw, 20vh); 54 | font-weight: bold; 55 | text-align: center; 56 | margin: 0; 57 | font-family: "led"; 58 | color: white; 59 | } 60 | 61 | div > h1 { 62 | font-size: 1.5vw; 63 | text-align: center; 64 | font-weight: bolder; 65 | color: rgb(170, 170, 170); 66 | text-transform: uppercase; 67 | margin: 0; 68 | margin-bottom: 20px; 69 | } 70 | 71 | @font-face { 72 | font-family: led; 73 | src: url(../src/assets//fonts/DSEG7Modern-Bold.ttf); 74 | font-weight: bold; 75 | } 76 | 77 | #loop { 78 | position: absolute; 79 | top: 10px; 80 | right: 10px; 81 | margin: 0; 82 | color: #959595; 83 | text-align: center; 84 | font-size: 1em; 85 | } 86 | 87 | .blink { 88 | animation: blink-animation 2s cubic-bezier(0.075, 0.82, 0.165, 1) infinite; 89 | } 90 | 91 | @keyframes blink-animation { 92 | 50% { 93 | opacity: 0; 94 | } 95 | } 96 | 97 | .blinkred { 98 | animation: blink-animation 1s linear infinite; 99 | color: red; 100 | } 101 | 102 | .columns { 103 | display: flex; 104 | flex-direction: row; 105 | gap: 10px; 106 | } 107 | 108 | .columns div > h1 + div { 109 | font-size: clamp(1vh, 8vw, 20vh); 110 | } 111 | 112 | .flexi { 113 | flex: 1; 114 | } 115 | -------------------------------------------------------------------------------- /src/osc.ts: -------------------------------------------------------------------------------- 1 | // @ts-ignore 2 | import osc from "osc"; 3 | import { ElectronPreferences } from "electron-preferences"; 4 | import { Utils } from './utils'; 5 | 6 | class oscListener { 7 | port: number; 8 | currentTime: number; 9 | remainingTime: number; 10 | totalTime: number; 11 | ontimeCurrent: number; 12 | loop: boolean; 13 | stopped: boolean; 14 | udpPort: osc.UDPPort | undefined; 15 | preferences: typeof ElectronPreferences; 16 | 17 | constructor(preferences: typeof ElectronPreferences) { 18 | this.currentTime = 0; 19 | this.remainingTime = 0; 20 | this.totalTime = 0; 21 | this.ontimeCurrent = 0; 22 | this.loop = false; 23 | this.stopped = false; 24 | this.udpPort = undefined; 25 | this.preferences = preferences(); 26 | 27 | this.start(); 28 | this.preferences.on("save", this.restart); 29 | } 30 | 31 | public start = () => { 32 | this.udpPort = new osc.UDPPort({ 33 | localAddress: "0.0.0.0", 34 | localPort: this.preferences.value("server.port"), 35 | metadata: true, 36 | }); 37 | 38 | 39 | 40 | this.udpPort.on("message", (message: any, timetag: any, info: any) => { 41 | // If the message startes with /channel/ then it is a CCG message 42 | if (message["address"].startsWith("/channel/")) { 43 | this.parseCCGMessage(message); 44 | } 45 | 46 | if (message["address"].startsWith("/from-ontime/")) { 47 | this.parseOntimeMessage(message); 48 | } 49 | 50 | }); 51 | 52 | this.udpPort.open(); 53 | }; 54 | 55 | private parseCCGMessage = (message: any) => { 56 | const channel = this.preferences.value("server.channel"); 57 | const address = message["address"]; 58 | const args = message["args"]; 59 | const isFromActiveChannel = new RegExp(`/channel/${channel}`).test( 60 | address 61 | ); 62 | const isTimeMessage = new RegExp(`/foreground/file/time`).test(address); 63 | const isLoopMessage = new RegExp(`/foreground/loop`).test(address); 64 | 65 | if (!isFromActiveChannel) { 66 | return; 67 | } 68 | 69 | // Packet contains playing file time 70 | if (isTimeMessage) { 71 | this.stopped = false; 72 | this.currentTime = Math.round(args[0]["value"]); 73 | this.totalTime = Math.round(args[1]["value"]); 74 | this.remainingTime = this.totalTime - this.currentTime; 75 | if (this.remainingTime < 0) { 76 | this.remainingTime = 0; 77 | } 78 | } 79 | 80 | if (isLoopMessage) { 81 | this.loop = args[0]["value"]; 82 | } 83 | } 84 | 85 | private parseOntimeMessage = (message: any) => { 86 | const args = message["args"]; 87 | 88 | if (message["address"].startsWith("/from-ontime/current")) { 89 | if (args[0]["value"] == "null") { 90 | this.ontimeCurrent = 0; 91 | } else { 92 | this.ontimeCurrent = args[0]["value"]; 93 | } 94 | } 95 | 96 | // if (message["address"].startsWith("/from-ontime/expectedFinish")) { 97 | // console.log(Utils.msToTime(args[0]["value"])); 98 | // } 99 | } 100 | 101 | public stop = () => { 102 | if (this.udpPort) { 103 | this.udpPort.close(); 104 | } 105 | }; 106 | 107 | /** 108 | * Resets the timer to its initial state. 109 | */ 110 | private reset = () => { 111 | this.currentTime = 0; 112 | this.remainingTime = 0; 113 | this.loop = false; 114 | this.stopped = true; 115 | this.totalTime = 0; 116 | }; 117 | 118 | /** 119 | * Restarts the timer by stopping, resetting, and then starting it again. 120 | */ 121 | public restart = () => { 122 | this.stop(); 123 | this.reset(); 124 | this.start(); 125 | }; 126 | } 127 | 128 | export default oscListener; 129 | -------------------------------------------------------------------------------- /src/app/app.tsx: -------------------------------------------------------------------------------- 1 | import React, { useEffect } from "react"; 2 | import { Utils } from "../utils"; 3 | 4 | function toTime(seconds: number) { 5 | return new Date(seconds * 1000).toISOString().substr(11, 8); 6 | } 7 | 8 | function clockTime() { 9 | const date = new Date(); 10 | const timeZoneOffset = date.getTimezoneOffset() * 60 * 1000; 11 | const timeZoneDate = new Date(date.getTime() - timeZoneOffset); 12 | return timeZoneDate.toISOString().substr(11, 8); 13 | } 14 | 15 | function App() { 16 | const [state, setState] = React.useState({ 17 | currentTime: 0, 18 | totalTime: 0, 19 | remainingTime: 0, 20 | loop: false, 21 | stopped: false, 22 | enableProductionClock: false, 23 | enableOntime: false, 24 | ontimeCurrent: 0, 25 | elapsedColor: "", 26 | remainingColor: "", 27 | clockColor: "", 28 | productionColor: "", 29 | startTime: 0, 30 | runtime: 0, 31 | 32 | }); 33 | 34 | useEffect(() => { 35 | const displayResetListener = () => { 36 | setState({ 37 | currentTime: 0, 38 | totalTime: 0, 39 | remainingTime: 0, 40 | loop: false, 41 | stopped: false, 42 | startTime: 0, 43 | runtime: 0, 44 | enableProductionClock: false, 45 | enableOntime: false, 46 | ontimeCurrent: 0, 47 | elapsedColor: "", 48 | remainingColor: "", 49 | clockColor: "", 50 | productionColor: "", 51 | }); 52 | } 53 | 54 | const timersListener = (event: any, arg: any) => { 55 | setState({ 56 | ...state, 57 | ...arg, 58 | }); 59 | } 60 | 61 | window.api.receive('display:reset', displayResetListener); 62 | window.api.receive('timers:update', timersListener); 63 | 64 | 65 | return ()=>{ 66 | window.api.removeListener('display:reset', displayResetListener); 67 | window.api.removeListener('timers:update', timersListener); 68 | } 69 | }, []); 70 | 71 | // Status enum 72 | const Status = { 73 | RUNNING: 0, 74 | HALFWAY: 1, 75 | ENDING: 2, 76 | ENDED: 3, 77 | }; 78 | 79 | const status = () => { 80 | if (state.remainingTime <= 0) { 81 | return Status.ENDED; 82 | } 83 | 84 | if (state.remainingTime <= state.totalTime / 4) { 85 | return Status.ENDING; 86 | } 87 | 88 | if (state.remainingTime <= state.totalTime / 2) { 89 | return Status.HALFWAY; 90 | } 91 | 92 | return Status.RUNNING; 93 | 94 | } 95 | 96 | const remainingClassName = () => { 97 | switch (status()) { 98 | case Status.RUNNING: 99 | return "monitor"; 100 | case Status.HALFWAY: 101 | return "monitor halfway"; 102 | case Status.ENDING: 103 | return "monitor ending"; 104 | case Status.ENDED: 105 | return "monitor ended"; 106 | } 107 | } 108 | 109 | const remainingTimeColor = () => { 110 | switch (status()) { 111 | case Status.RUNNING: 112 | return state.remainingColor; 113 | case Status.HALFWAY: 114 | return "orange"; 115 | case Status.ENDING: 116 | return "red"; 117 | case Status.ENDED: 118 | return "red"; 119 | } 120 | } 121 | 122 | return ( 123 |
124 |
125 |
126 |

Clock

127 |
{clockTime()}
128 | 129 |
130 | {state.enableProductionClock ? ( 131 |
132 |

Production

133 |
{state.enableOntime ? Utils.msToTime(state.ontimeCurrent) : state.runtime}
134 |
135 | ) : null} 136 | 137 |
138 | 139 |
140 |

{state.loop ? "LOOP" : null}

141 |

Elapsed

142 |
{toTime(state.currentTime)}
143 |
144 |
145 |

Remaining

146 |
{toTime(state.remainingTime)}
147 |
148 |
149 | ); 150 | } 151 | 152 | export default App; 153 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | import { app, BrowserWindow, ipcMain, Menu, screen } from "electron"; 2 | import { updateElectronApp } from "update-electron-app"; 3 | import settings from './settings'; 4 | import oscListener from "./osc"; 5 | 6 | import { 7 | add, 8 | differenceInMilliseconds, 9 | isPast, 10 | parse, 11 | } from "date-fns"; 12 | 13 | // This allows TypeScript to pick up the magic constants that's auto-generated by Forge's Webpack 14 | // plugin that tells the Electron app where to look for the Webpack-bundled app code (depending on 15 | // whether you're running in development or production). 16 | declare const MAIN_WINDOW_WEBPACK_ENTRY: string; 17 | declare const MAIN_WINDOW_PRELOAD_WEBPACK_ENTRY: string; 18 | 19 | // Handle creating/removing shortcuts on Windows when installing/uninstalling. 20 | if (require("electron-squirrel-startup")) { 21 | app.quit(); 22 | } 23 | 24 | const isMac = process.platform === "darwin"; 25 | const isDebug = process.env.NODE_ENV === "development"; 26 | let timer: NodeJS.Timeout; 27 | 28 | const createWindow = (): void => { 29 | const appSettings = new settings(); 30 | const prefs = appSettings.prefs(); 31 | const targetScreen = screen 32 | .getAllDisplays() 33 | .find( 34 | (display) => 35 | display.id.toString() === 36 | prefs.value("application.display") 37 | ); 38 | 39 | const osc = new oscListener(appSettings.prefs); 40 | 41 | // Create the browser window. 42 | const mainWindow = new BrowserWindow({ 43 | x: targetScreen?.nativeOrigin?.x || 0, 44 | y: targetScreen?.nativeOrigin?.y || 0, 45 | fullscreen: prefs.value("application.fullscreen") || false, 46 | height: 600, 47 | width: 800, 48 | webPreferences: { 49 | preload: MAIN_WINDOW_PRELOAD_WEBPACK_ENTRY, 50 | }, 51 | autoHideMenuBar: true, 52 | }); 53 | 54 | ipcMain.on("display:reset", () => { 55 | mainWindow.webContents.send("display:reset"); 56 | }); 57 | 58 | // and load the index.html of the app. 59 | mainWindow.loadURL(MAIN_WINDOW_WEBPACK_ENTRY); 60 | 61 | mainWindow.on("closed", () => { 62 | clearInterval(timer); 63 | timer = null; 64 | }); 65 | 66 | // Open the DevTools. 67 | if (isDebug) { 68 | mainWindow.webContents.openDevTools(); 69 | } 70 | 71 | const menu = Menu.buildFromTemplate([ 72 | { 73 | label: "File", 74 | submenu: [ 75 | { 76 | label: "Preferences", 77 | click: () => { 78 | appSettings.show(); 79 | }, 80 | }, 81 | isMac ? { role: "close" } : { role: "quit" }, 82 | ], 83 | }, 84 | { 85 | label: "View", 86 | submenu: [ 87 | { role: "reload" }, 88 | { role: "forceReload" }, 89 | { role: "toggleDevTools" }, 90 | { type: "separator" }, 91 | { role: "resetZoom" }, 92 | { role: "zoomIn" }, 93 | { role: "zoomOut" }, 94 | { type: "separator" }, 95 | { role: "togglefullscreen" }, 96 | ], 97 | }, 98 | ]); 99 | 100 | Menu.setApplicationMenu(menu); 101 | 102 | timer = setInterval(() => { 103 | mainWindow.webContents.send("timers:update", { 104 | currentTime: osc.currentTime, 105 | totalTime: osc.totalTime, 106 | remainingTime: osc.remainingTime, 107 | loop: osc.loop, 108 | stopped: osc.stopped, 109 | enableProductionClock: prefs.value("production.enable"), 110 | enableOntime: prefs.value("production.ontime"), 111 | ontimeCurrent: osc.ontimeCurrent, 112 | elapsedColor: prefs.value("colors.elapsed"), 113 | remainingColor: prefs.value("colors.remaining"), 114 | clockColor: prefs.value("colors.clock"), 115 | productionColor: prefs.value("colors.production"), 116 | startTime: prefs.value("production.start"), 117 | runtime: runtimeClock( 118 | prefs.value("production.start"), 119 | prefs.value("production.runtime") 120 | ), 121 | }); 122 | }, 200); 123 | }; 124 | 125 | const runtimeClock = (startTime: string, runtime: string) => { 126 | 127 | if (!startTime || !runtime) { 128 | return "00:00:00"; 129 | } 130 | 131 | const timeFormat = /^(\d{2}:\d{2}:\d{2})$/; 132 | 133 | if (!timeFormat.test(startTime) || !timeFormat.test(runtime)) { 134 | return "00:00:00"; 135 | } 136 | 137 | const runtimeDate = parse(runtime, "HH:mm:ss", new Date()); 138 | const startDate = parse(startTime, "HH:mm:ss", new Date()); 139 | const endDate = add(startDate, { 140 | hours: runtimeDate.getHours(), 141 | minutes: runtimeDate.getMinutes(), 142 | seconds: runtimeDate.getSeconds(), 143 | }); 144 | 145 | if (isPast(startDate)) { 146 | const diff = differenceInMilliseconds(endDate, new Date()); 147 | return new Date(diff).toISOString().substr(11, 8); 148 | } else { 149 | const diff = differenceInMilliseconds(startDate, new Date()); 150 | 151 | return new Date(diff).toISOString().substr(11, 8); 152 | } 153 | }; 154 | 155 | updateElectronApp(); 156 | 157 | // This method will be called when Electron has finished 158 | // initialization and is ready to create browser windows. 159 | // Some APIs can only be used after this event occurs. 160 | app.on("ready", createWindow); 161 | 162 | // Quit when all windows are closed, except on macOS. There, it's common 163 | // for applications and their menu bar to stay active until the user quits 164 | // explicitly with Cmd + Q. 165 | app.on("window-all-closed", () => { 166 | if (process.platform !== "darwin") { 167 | app.quit(); 168 | } 169 | }); 170 | 171 | app.on("activate", () => { 172 | // On OS X it's common to re-create a window in the app when the 173 | // dock icon is clicked and there are no other windows open. 174 | if (BrowserWindow.getAllWindows().length === 0) { 175 | createWindow(); 176 | } 177 | }); 178 | 179 | // In this file you can include the rest of your app's specific main process 180 | // code. You can also put them in separate files and import them here. 181 | -------------------------------------------------------------------------------- /src/settings.ts: -------------------------------------------------------------------------------- 1 | import { app, Menu, screen } from "electron"; 2 | import path from "path"; 3 | import ElectronPreferences from "electron-preferences"; 4 | 5 | const displays = () => { 6 | return screen.getAllDisplays().map((display, index) => { 7 | return { 8 | label: `Display ${display.id} - ${display.label}`, 9 | value: display.id, 10 | }; 11 | }); 12 | }; 13 | 14 | class Settings { 15 | prefs: typeof ElectronPreferences; 16 | constructor() { 17 | this.prefs = this.preferences; 18 | } 19 | 20 | public show = () => { 21 | this.prefs().show(); 22 | }; 23 | 24 | private preferences = (): typeof ElectronPreferences => { 25 | return new ElectronPreferences({ 26 | // Preference default values 27 | defaults: { 28 | server: { 29 | port: 6251, 30 | channel: 1, 31 | }, 32 | production: { 33 | enable: false, 34 | start: "00:10:00", 35 | runtime: "00:20:00", 36 | }, 37 | colors: { 38 | clock: "#960000", 39 | production: "#960000", 40 | elapsed: "#00FF00", 41 | remaining: "#FF0000", 42 | } 43 | }, 44 | 45 | dataStore: path.resolve(app.getPath("userData"), "preferences.json"), 46 | 47 | browserWindowOpts: { 48 | title: "My custom preferences title", 49 | width: 900, 50 | maxWidth: 1000, 51 | height: 700, 52 | maxHeight: 1000, 53 | resizable: true, 54 | maximizable: false, 55 | //... 56 | }, 57 | 58 | menu: Menu.buildFromTemplate([ 59 | { 60 | label: "Window", 61 | role: "window", 62 | submenu: [ 63 | { 64 | label: "Close", 65 | accelerator: "CmdOrCtrl+W", 66 | role: "close", 67 | }, 68 | ], 69 | }, 70 | ]), 71 | 72 | // Preference sections visible to the UI 73 | sections: [ 74 | { 75 | id: "server", 76 | label: "Server", 77 | icon: "single-01", // See the list of available icons below 78 | form: { 79 | groups: [ 80 | { 81 | label: "Server connection", // optional 82 | fields: [ 83 | { 84 | label: "Port", 85 | key: "port", 86 | type: "number", 87 | help: "CasparCG OSC Port", 88 | }, 89 | { 90 | label: "Channel", 91 | key: "channel", 92 | type: "number", 93 | help: "CasparCG channel", 94 | }, 95 | // ... 96 | ], 97 | }, 98 | // ... 99 | ], 100 | }, 101 | }, 102 | { 103 | id: "application", 104 | label: "Application", 105 | icon: "settings-gear-63", 106 | form: { 107 | groups: [ 108 | { 109 | label: "Display", 110 | fields: [ 111 | { 112 | label: "Display", 113 | key: "display", 114 | type: "dropdown", 115 | options: displays(), 116 | help: "You might want to set this to an external display.", 117 | }, 118 | { 119 | label: "Fullscreen", 120 | key: "fullscreen", 121 | type: "radio", 122 | options: [ 123 | { label: "No", value: false }, 124 | { label: "Yes", value: true }, 125 | ], 126 | help: "Start in fullscreen mode", 127 | }, 128 | ], 129 | }, 130 | ], 131 | }, 132 | }, 133 | { 134 | id: "production", 135 | label: "Production", 136 | icon: "settings-gear-63", 137 | form: { 138 | groups: [ 139 | { 140 | label: "Production", 141 | fields: [ 142 | { 143 | label: "Enable production clock", 144 | key: "enable", 145 | type: "radio", 146 | options: [ 147 | { label: "No", value: false }, 148 | { label: "Yes", value: true }, 149 | ], 150 | help: "Splits clock in two clocks. A live clock and a production clock", 151 | }, 152 | { 153 | label: "Start time", 154 | key: "start", 155 | type: "text", 156 | help: "The time the production starts", 157 | hideFunction: (preferences: typeof ElectronPreferences) => { return (!preferences.production.enable && !preferences.production.ontime) } 158 | }, 159 | { 160 | label: "Runtime", 161 | key: "runtime", 162 | type: "text", 163 | help: "Approximate runtime of the production", 164 | hideFunction: (preferences: typeof ElectronPreferences) => { return !preferences.production.enable && !preferences.production.ontime} 165 | }, 166 | { 167 | label: "ontime", 168 | key: "ontime", 169 | type: "radio", 170 | options: [ 171 | { label: "No", value: false }, 172 | { label: "Yes", value: true }, 173 | ], 174 | help: "Use ontime for production clock start time and remaining time", 175 | } 176 | ], 177 | }, 178 | ], 179 | }, 180 | }, 181 | { 182 | id: "colors", 183 | label: "Colors", 184 | icon: "image", 185 | form: { 186 | groups: [ 187 | { 188 | label: "Clocks", 189 | fields: [ 190 | { 191 | label: "Clock", 192 | key: "clock", 193 | type: "color", 194 | format: "hex", 195 | }, 196 | { 197 | label: "Production", 198 | key: "production", 199 | type: "color", 200 | format: "hex", 201 | }, 202 | ], 203 | }, 204 | { 205 | label: "Playout clocks", 206 | fields: [ 207 | { 208 | label: "Elapsed", 209 | key: "elapsed", 210 | type: "color", 211 | format: "hex", 212 | }, 213 | { 214 | label: "Remaining", 215 | key: "remaining", 216 | type: "color", 217 | format: "hex", 218 | }, 219 | ], 220 | }, 221 | ], 222 | } 223 | } 224 | ], 225 | }); 226 | }; 227 | } 228 | 229 | export default Settings; 230 | -------------------------------------------------------------------------------- /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 | . --------------------------------------------------------------------------------