Updated version info to v0.2.0

.woodpecker.yml

@@ -1,8 +1,13 @@
 pipeline:
+  test:
+    image: maven:3-jdk-11
+    commands:
+      - mvn test
+
   build:
     image: maven:3-jdk-11
     commands:
-      - mvn clean package
+      - mvn clean compile assembly:single
 
   gitea_release:
     image: plugins/gitea-release

README.md

@@ -1,3 +1,42 @@
-# dragoon
+# Dragoon
 
-Bit Goblin video transcoder
+The Bit Goblin video transcoder.
+
+## Building
+
+Currently this project is targeting Java 11 LTS and uses Maven to manage the software lifecycle. Thus, you must have a Java 11 JDK and Maven installed to build this project.
+
+*NOTE:* The targeted Java version will likely change to 17 LTS soon.
+
+### Ubuntu
+
+`sudo apt install openjdk-11-jdk maven`
+
+### Red Hat/Almalinux
+
+`sudo dnf install java-11-openjdk-devel maven`
+
+### Actually Building
+
+Now that the needed tools are installed, you should be able to build this project. To build a JAR file with it's dependencies included:
+
+`mvn clean compile assembly:single`
+
+Then you can run the transcoder:
+
+`java -jar target/Dragon-VERSION-jar-with-dependencies.jar`
+
+## Configuration
+
+If you were paying attention to Dragoon's output, you would have noticed that it failed with a complaint about not finding a configuration file. The location might move in the future or even be configurable, but for now you need to have a TOML file located at `~/.config/dragoon.toml` with at minimum the following contents:
+
+```toml
+# This example transcodes footage to DNxHD 1080p60 for use in video editors like DaVinci Resolve.
+[transcoder]
+repo_path = '~/videos' # location of the videos to transcode
+video_format = 'mov' # video container format
+video_codec = 'dnxhd' # video codec to use
+video_parameters = 'scale=1920x1080,fps=60,format=yuv422p' # video extra format parameters flag - this will be broken later into separate attributes
+video_profile = 'dnxhr_hq' # DNxHD has multiple presets for various video qualities
+audio_codec = 'pcm_s16le' # audio codec to use
+```

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>tech.bitgoblin</groupId>
     <artifactId>Dragoon</artifactId>
-  <version>0.1.0</version>
+    <version>0.2.0</version>
 
     <name>Dragoon</name>
     <url>https://www.bitgoblin.tech</url>
@@ -18,6 +18,11 @@
     </properties>
 
     <dependencies>
+        <dependency>
+            <groupId>org.tomlj</groupId>
+            <artifactId>tomlj</artifactId>
+            <version>1.0.0</version>
+        </dependency>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
@@ -63,6 +68,27 @@
                         </archive>
                     </configuration>
                 </plugin>
+                <plugin>
+                    <artifactId>maven-assembly-plugin</artifactId>
+                    <executions>
+                        <execution>
+                            <phase>package</phase>
+                            <goals>
+                                <goal>single</goal>
+                            </goals>
+                        </execution>
+                    </executions>
+                    <configuration>
+                        <archive>
+                            <manifest>
+                                <mainClass>tech.bitgoblin.App</mainClass>
+                            </manifest>
+                        </archive>
+                        <descriptorRefs>
+                            <descriptorRef>jar-with-dependencies</descriptorRef>
+                        </descriptorRefs>
+                    </configuration>
+                </plugin>
                 <plugin>
                     <artifactId>maven-install-plugin</artifactId>
                     <version>2.5.2</version>

src/main/java/tech/bitgoblin/App.java

@@ -1,6 +1,10 @@
 package tech.bitgoblin;
 
-import tech.bitgoblin.video.Transcoder;
+import tech.bitgoblin.config.Config;
+import tech.bitgoblin.transcoder.RunTranscoderTask;
+import tech.bitgoblin.transcoder.Transcoder;
+
+import java.util.Timer;
 
 /**
  * The Bit Goblin video transcoder service.
@@ -8,10 +12,15 @@ import tech.bitgoblin.video.Transcoder;
  */
 public class App {
 
+  private static final String configFile = "~/.config/dragoon.toml";
+
   public static void main(String[] args) {
+    // read our config file
+    Config c = new Config(configFile);
     // create new Transcoder object and start the service
-    Transcoder t = new Transcoder("~/dragoon");
-    t.transcode();
+    Transcoder t = new Transcoder(c);
+    Timer timer = new Timer();
+    timer.scheduleAtFixedRate(new RunTranscoderTask(t), 2500, 120 * 1000);
   }
 
 }

src/main/java/tech/bitgoblin/config/Config.java

@@ -0,0 +1,48 @@
+package tech.bitgoblin.config;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.Objects;
+
+import org.tomlj.Toml;
+import org.tomlj.TomlParseResult;
+import tech.bitgoblin.io.IOUtils;
+
+public class Config {
+
+  private final String configPath;
+  private TomlParseResult result;
+
+  public Config(String path) {
+    this.configPath = IOUtils.resolveTilda(path);
+    // parse config file
+    try {
+      this.parseConfig();
+    } catch (IOException e) {
+      System.out.println("Unable to read config file; please check that " + this.configPath + " is available.");
+      System.exit(1);
+    }
+  }
+
+  public String getString(String key) {
+    return this.result.getString(key);
+  }
+
+  public int getInt(String key) {
+    return Objects.requireNonNull(this.result.getDouble(key)).intValue();
+  }
+
+  public boolean contains(String key) {
+    return this.result.contains(key);
+  }
+
+  private void parseConfig() throws IOException {
+    // parse config file
+    Path source = Paths.get(this.configPath);
+    this.result = Toml.parse(source);
+    this.result.errors().forEach(error -> System.err.println(error.toString()));
+  }
+
+}

src/main/java/tech/bitgoblin/io/IOUtils.java

@@ -14,9 +14,9 @@ public class IOUtils {
   }
 
   public static String resolveTilda(String path) {
-    if (path.startsWith("~" + File.separator)) {
+    if (path.startsWith("~" + File.separator) || path.equals("~")) {
       path = System.getProperty("user.home") + path.substring(1);
-    } else if (path.startsWith("~")) {
+    } else if ((!path.equals("~")) && path.startsWith("~")) {
       // here you can implement reading homedir of other users if you care
       throw new UnsupportedOperationException("Home dir expansion not implemented for explicit usernames");
     }

src/main/java/tech/bitgoblin/transcoder/RunTranscoderTask.java

@@ -0,0 +1,23 @@
+package tech.bitgoblin.transcoder;
+
+import java.util.TimerTask;
+
+public class RunTranscoderTask extends TimerTask {
+
+  private Transcoder transcoder;
+
+  public RunTranscoderTask(Transcoder t) {
+    this.transcoder = t;
+  }
+
+  @Override
+  public void run() {
+    // archive the files
+    transcoder.archive();
+    // run the transcoder
+    transcoder.transcode();
+    // clean up ingest
+    transcoder.cleanup();
+  }
+
+}

src/main/java/tech/bitgoblin/transcoder/Transcoder.java

@@ -1,34 +1,38 @@
-package tech.bitgoblin.video;
+package tech.bitgoblin.transcoder;
 
-import java.io.BufferedReader;
 import java.io.File;
-import java.io.InputStream;
-import java.io.InputStreamReader;
 import java.io.IOException;
 import java.lang.InterruptedException;
 import java.lang.Process;
+import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
-import java.util.function.Consumer;
-import java.util.concurrent.Executors;
+import java.nio.file.StandardCopyOption;
+import java.util.Timer;
 
+import tech.bitgoblin.config.Config;
 import tech.bitgoblin.io.IOUtils;
 
 public class Transcoder {
 
   private String repo_dir;
+  private Config config;
   private String ffmpeg_path = "/usr/bin/ffmpeg";
 
   // only define the working directory; use default FFMPEG path
-  public Transcoder(String repo_dir) {
-    this.repo_dir = IOUtils.resolveTilda(repo_dir);
+  public Transcoder(Config config) {
+    this.config = config;
+    this.repo_dir = IOUtils.resolveTilda(this.config.getString("transcoder.repo_path"));
+    if (this.config.contains("transcoder.ffmpeg_path")) {
+      this.ffmpeg_path = this.config.getString("transcoder.ffmpeg_path");
+    }
     this.initDirectory();
   }
-  // define a custom FFMPEG binary path
-  public Transcoder(String repo_dir, String ffmpeg_path) {
-    this.repo_dir = IOUtils.resolveTilda(repo_dir);
-    this.ffmpeg_path = ffmpeg_path;
-    this.initDirectory();
+
+  // create a periodic timer task and start it
+  public void start() {
+    Timer timer = new Timer();
+    timer.scheduleAtFixedRate(new RunTranscoderTask(this), 10000, this.config.getInt("transcoder.interval") * 60 * 1000);
   }
 
   // transcode files in the working directory
@@ -38,6 +42,11 @@ public class Transcoder {
     File repo = new File(Paths.get(this.repo_dir, "ingest").toString());
     File[] sourceFiles = repo.listFiles();
 
+    if (sourceFiles.length == 0) {
+      System.out.println("There is nothing to transcode in " + this.repo_dir + "/ingest.");
+      return;
+    }
+
     // transcode
     System.out.println("Transcoding files in " + this.repo_dir + "/ingest...");
     for (File f : sourceFiles) {
@@ -48,11 +57,11 @@ public class Transcoder {
       String cmd = String.format("%s -i %s -y -f %s -c:v %s -vf %s -profile:v %s -c:a %s %s",
         this.ffmpeg_path, // FFMPEG binary path
         f.toString(), // input file
-        "mov",
-        "dnxhd", // video codec
-        "scale=1920x1080,fps=60,format=yuv422p", // video format
-        "dnxhr_hq", // video profile
-        "pcm_s16le", // audio codec
+        this.config.getString("transcoder.video_format"), // video container format
+        this.config.getString("transcoder.video_codec"), // video codec
+        this.config.getString("transcoder.video_parameters"), // video format
+        this.config.getString("transcoder.video_profile"), // video profile
+        this.config.getString("transcoder.audio_codec"), // audio codec
         outputPath // output file path
       );
 
@@ -74,6 +83,34 @@ public class Transcoder {
     System.out.println();
   }
 
+  // copies sources files to the archive directory
+  public void archive() {
+    File repo = new File(Paths.get(this.repo_dir, "ingest").toString());
+    File[] sourceFiles = repo.listFiles();
+
+    for (File f : sourceFiles) {
+      Path filePath = Path.of(f.toString());
+      String filename = filePath.getFileName().toString();
+      String archivePath = Paths.get(this.repo_dir, "archive", filename).toString();
+
+      try {
+        Files.copy(filePath, Paths.get(archivePath), StandardCopyOption.COPY_ATTRIBUTES, StandardCopyOption.REPLACE_EXISTING);
+      } catch (IOException e) {
+        throw new RuntimeException(e);
+      }
+    }
+  }
+
+  // clean up the ingest directory once we're done
+  public void cleanup() {
+    File repo = new File(Paths.get(this.repo_dir, "ingest").toString());
+    File[] sourceFiles = repo.listFiles();
+
+    for (File f : sourceFiles) {
+      f.delete();
+    }
+  }
+
   // ensures the transcoder's working directory is available
   private void initDirectory() {
     // create transcoder directory

src/test/java/tech/bitgoblin/io/IOUtilsTest.java

@@ -0,0 +1,36 @@
+package tech.bitgoblin.io;
+
+import static org.junit.Assert.assertTrue;
+
+import org.junit.AfterClass;
+import org.junit.Test;
+
+import java.io.File;
+
+public class IOUtilsTest {
+
+  private static String testDir = "test-temp";
+
+  @Test
+  public void shouldCreateDirectory() {
+    IOUtils.createDirectory(testDir);
+    assertTrue(new File(testDir).exists());
+  }
+
+  @Test
+  public void shouldExpandTilda() {
+    String homeExpanded = IOUtils.resolveTilda("~");
+    assertTrue(!homeExpanded.equals("~"));
+  }
+
+  @Test(expected=UnsupportedOperationException.class)
+  public void shouldFailExpandExplicitTilda() {
+    IOUtils.resolveTilda("~test");
+  }
+
+  @AfterClass
+  public static void cleanup() {
+    new File(testDir).delete();
+  }
+
+}