bagel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d6d4b6c3ea3546c110bb0c0f47c44a66e3f01a0c1b3b4cca7c131766c5dbc0fd
+  data.tar.gz: 81877528261e49c263ace7d4024e10235ca383272c60b17ee9373dea39b80f67
+SHA512:
+  metadata.gz: e52838783e9b7e56898882d6a26d7180763a61d00b21118ac6c5b4de1713b44497412dc5f9c069f96a504ca0245e0305eb3fba3f19b3645a572dada14c831377
+  data.tar.gz: a62bf13d31fed60a02df6c7cc7420a79a704fb3b2f58bd54340b2a3341917416d590ccdfb7c5ff555a86d47d060c1b11d1cc53deb0afb570a1bc9eb6bae8c34c

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.prettierignore

@@ -0,0 +1,2 @@
+*.yml
+*.yaml

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-07-21
+
+- Initial release

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Brent Chuang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,187 @@
+# Bagel
+
+## Table of Contents
+- [Introduction](#introduction)
+- [Features](#features)
+- [Dependencies](#dependencies)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Example YAML File](#example-yaml-file)
+  - [Configure and Start](#configure-and-start)
+- [Sample Output](#sample-output)
+- [Testing](#testing)
+- [License](#license)
+- [What Did I Use to Record My Videos?](#what-did-i-use-to-record-my-videos)
+- [TODOs](#todos)
+
+## Introduction
+Bagel is a tennis video editor/annotator.
+
+## Features
+
+- Trim and concatenate videos
+- Generate and overlay scoreboard/stat graphics
+
+## Dependencies
+
+- [FFmpeg][ffmpeg]
+- [ImageMagick][imagemagick]
+
+## Installation
+
+Install native dependencies using [Homebrew][homebrew]:
+```
+$ brew install ffmpeg pkg-config imagemagick
+```
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'bagel'
+```
+And then execute:
+```
+$ bundle install
+```
+Or install it yourself as:
+```ruby
+$ gem install bagel
+```
+
+## Usage
+
+1. Make sure your source video is a single file. If your camera splits the recorded video into smaller chunks like mine does, concatenate them first:
+
+```ruby
+require 'bagel'
+
+Bagel::Video.::FFMPEG.concat(
+  source: 'path/to/chunks',
+  destination: 'path/to/output.mp4',
+  transcode: false
+)
+```
+
+2. Chart the match and build the "clips file" using YAML. This file will be used to build the final video.
+
+Every clip must specify:
+- `type`
+  - has to be either `intro`, `point`, or `stats`
+- `start` and `finish` timestamps
+  - which part of the source video to trim (e.g. `'01:23'`)
+
+`intro` clips must also specify:
+- `title` and `description`
+  - e.g. the location and date/time of when the match was played
+
+`point` clips must also specify:
+- `server`
+  - the player who served the point (`1` or `2`)
+- `score`
+  - a nested array representing the current score AT THE TIME OF SERVE
+  - e.g. 6-4, 2-0, 40-15 is represented as [[[6, 4], [2, 0]], [3, 1]])
+- `faults`
+  - number of faults during serve
+- `winner`
+  - the player who won the point (`1` or`2`)
+- `reason`
+  - the circumstance under which the point was won
+  - has to be either `W` for winner, `UE` for unforced error, or `FE` for forced error
+- `shot`
+  - the type of shot that ended the point
+  - has to be either `S` for serve, `FH` for forehand, `BH` for backhand, or `OH` for overhead.
+- `net` (optional)
+  - an array containing details about whether the point was a net point for either player and the subsequent outcome
+  - `true` = won the net point, `false` = lost the net point, `null` = player did not play a net point
+  - e.g. [ true, null ] = player 1 won a net point, player 2 was not at the net
+  - e.g. [ null, false ] = player 1 was not at the net, player 2 lost a net point (volley error etc.)
+
+`stats` clips must also specify:
+- `score`
+  - a nested array representing the current score AT THE END OF THE SET
+  - e.g. 6-4, 2-6 is represented as [[[6, 4], [2, 6]]]
+
+### Example YAML File
+
+```yaml
+# Intro
+- { type: intro, start: '00:00', finish: '00:08', title: 'My Tennis Club', description: 'May 16, 2021' }
+
+# Set 1 points
+- { type: point, server: 1, score: [[[0, 0]], [0, 0]], start: '02:02', faults: 1, finish: '02:07', winner: 1, reason: UE, shot: BH }
+# ...
+- { type: point, server: 2, score: [[[5, 4]], [3, 2]], start: '37:53', faults: 1, finish: '38:03', winner: 1, reason: W, shot: FH, net: [ true, false ] }
+
+# Set 1 stats
+- { type: stats, start: '38:35', finish: '38:47', score: [[[6, 4]]] }
+
+# Set 2 points
+- { type: point, server: 1, score: [[[6, 4], [0, 0]], [0, 0]], start: '40:41', faults: 1, finish: '40:55', winner: 1, reason: W, shot: BH, net: [ true, false ] }
+# ...
+- { type: point, server: 2, score: [[[6, 4], [2, 5]], [1, 3]], start: '1:14:05', faults: 0, finish: '1:14:11', winner: 2, reason: UE, shot: FH }
+
+# Set 2 stats
+- { type: stats, start: '1:14:24', finish: '1:14:36', score: [[[6, 4], [2, 6]]] }
+```
+
+### Configure and Start
+
+```ruby
+require 'bagel'
+
+Bagel.configure do |config|
+  config.name = '2021-05-16' # this will be used to namespace the temp clip/graphic files
+  config.source_video = 'path/to/source/video.mp4'
+  config.clip_data = 'path/to/data/file.yml'
+  config.destination_video = 'path/to/destination/video.mp4'
+  config.names = %w(Alice Bob)
+end
+
+Bagel.make_video
+```
+
+## Sample Output
+
+![intro]
+![point-1]
+![point-2]
+![stats]
+
+## Testing
+
+```
+$ rspec
+```
+Tested on
+- Ruby 3.0.1
+- ffmpeg 4.4
+- ImageMagick 7.0.11-12
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Useful Links
+- https://stackoverflow.com/questions/57045900/how-to-find-a-safe-point-for-ss-using-ffmpeg-to-avoid-breaking-a-v-sync
+- https://stackoverflow.com/questions/42943805/ffmpeg-is-it-possible-to-overlay-multiple-images-over-a-video-at-specified-inte
+- https://trac.ffmpeg.org/wiki/Seeking#Seekingwhiledoingacodeccopy
+- https://itectec.com/superuser/video-cut-with-missing-frames-in-ffmpeg/
+- http://www.markbuckler.com/post/cutting-ffmpeg/
+
+## What Did I Use to Record My Videos?
+- [QM-1 Portable Camera Mount][qm-1]
+- Sony Action Cam HDR-AS200V
+
+# TODOs
+- customizable audio/video quality
+- customizable stats
+- customizable scoreboards
+- themed scoreboards (AO, RG, Wimbledon, USO, etc.)
+- more details (deuce #, breakpoint #, etc.)
+
+[ffmpeg]: https://www.ffmpeg.org
+[imagemagick]: https://imagemagick.org
+[homebrew]: https://brew.sh
+[intro]: https://www.dropbox.com/s/64xc8xw15fxdton/intro.jpg?raw=1 "intro"
+[point-1]: https://www.dropbox.com/s/ny6h5ja5d5doheg/point-1.jpg?raw=1 "point"
+[point-2]: https://www.dropbox.com/s/gyvfkxx389y8pac/point-2.jpg?raw=1 "point"
+[stats]: https://www.dropbox.com/s/gjm6bhshuchfwi9/stats.jpg?raw=1 "stats"
+[qm-1]: https://mytennistools.com/play-smarter-with-the-qm-1

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bagel.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/bagel/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bagel"
+  spec.version       = Bagel::VERSION
+  spec.authors       = ["Brent Chuang"]
+  spec.email         = ["burennto@gmail.com"]
+
+  spec.summary       = "Bagel is a tennis video editor/annotator."
+  spec.homepage      = "https://github.com/burennto/bagel"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rmagick", "~> 4.2", ">= 4.2.2"
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.7"
+  spec.add_development_dependency "factory_bot", "~> 6.2"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bagel"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bagel/colors.rb

@@ -0,0 +1,8 @@
+COLOR_TRANSPARENT = 'transparent'
+COLOR_WHITE = '#E0E0E0'
+COLOR_BLACK = '#000000'
+COLOR_GREY = '#303030'
+COLOR_GREY_DARK = '#303030'
+COLOR_GREY_LIGHT = '#404040'
+COLOR_BLUE = '#3498DB'
+COLOR_ORANGE = '#F39C12'

data/lib/bagel/fonts.rb

@@ -0,0 +1,3 @@
+FONT_FAMILY = 'Helvetica'
+FONT_WEIGHT = BoldWeight
+FONT_SIZE = 32

data/lib/bagel/graphic/comment.rb

@@ -0,0 +1,49 @@
+module Bagel::Graphic
+  class Comment
+    HEIGHT = 40
+    PADDING = 10
+
+    FILENAME_PREFIX = 'comment-'
+
+    def initialize(text)
+      @text = text
+    end
+
+    def save
+      text = Image.new(1920, 1080) { self.background_color = COLOR_WHITE }
+
+      draw = Magick::Draw.new do |d|
+        d.font_family = FONT_FAMILY
+        d.font_weight = FONT_WEIGHT
+        d.pointsize = 24
+        d.gravity = CenterGravity
+        d.fill = COLOR_BLACK
+      end
+
+      draw.annotate(text, 0, 0, 0, 0, @text)
+      text.trim!
+
+      canvas = Image.new(text.columns + PADDING * 2, HEIGHT) { self.background_color = COLOR_WHITE }
+      canvas.composite!(text, CenterGravity, 0, 0, OverCompositeOp)
+
+      canvas.write(path)
+
+      path
+    end
+
+    private
+
+    def filename
+      name = @text.downcase
+        .gsub(/[^\w\s_-]+/, '')
+        .gsub(/(^|\b\s)\s+($|\s?\b)/, '\\1\\2')
+        .gsub(/\s+/, '-')
+
+        FILENAME_PREFIX + name + FILENAME_EXTENSION
+    end
+
+    def path
+      File.join(Bagel.config.graphic_dir, filename)
+    end
+  end
+end

data/lib/bagel/graphic/intro.rb

@@ -0,0 +1,49 @@
+module Bagel::Graphic
+  class Intro
+    FILENAME = '00-intro.png'
+    MARGIN_X = 0
+    MARGIN_Y = 20
+
+    def initialize(title='', description='')
+      @title = title
+      @description = description
+    end
+
+    def save
+      top = Image.new(1920, 1080) { self.background_color = COLOR_TRANSPARENT }
+      draw.font_weight = BoldWeight
+      draw.pointsize = 64
+      draw.annotate(top, 0, 0, 0, 0, @title.upcase)
+      top.trim!
+
+      bottom = Image.new(1920, 1080) { self.background_color = COLOR_TRANSPARENT }
+      draw.font_weight = NormalWeight
+      draw.pointsize = 48
+      draw.annotate(bottom, 0, 0, 0, 0, @description)
+      bottom.trim!
+
+      height = top.rows + bottom.rows + MARGIN_Y
+      canvas = Image.new(1920, height) { self.background_color = COLOR_TRANSPARENT }
+      canvas.composite!(top, NorthWestGravity, MARGIN_X, 0, OverCompositeOp)
+      canvas.composite!(bottom, SouthWestGravity, MARGIN_X, 0, OverCompositeOp)
+      canvas.trim!
+      canvas.write(path)
+
+      path
+    end
+
+    private
+
+    def draw
+      @draw ||= Magick::Draw.new do |d|
+        d.font_family = FONT_FAMILY
+        d.gravity = WestGravity
+        d.fill = COLOR_WHITE
+      end
+    end
+
+    def path
+      File.join(Bagel.config.graphic_dir, FILENAME)
+    end
+  end
+end