Skip to content

Commit

Permalink
Set version 0.0.26
Browse files Browse the repository at this point in the history
  • Loading branch information
hdsdi3g committed Dec 30, 2023
1 parent b6b14dd commit a703458
Show file tree
Hide file tree
Showing 5 changed files with 64 additions and 31 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,19 +83,19 @@ cd mediadeepa
mvn install -DskipTests
```

Build jar will be founded on `target` directory as `mediadeepa-0.0.25.jar`
Build jar will be founded on `target` directory as `mediadeepa-0.0.26.jar`

And simply run the application with

```bash
java -jar mediadeepa-0.0.25.jar
java -jar mediadeepa-0.0.26.jar
```

Mediadeepa contain embedded help, displayed with the `-h` parameter.

You can set the command line parameters with `java -jar mediadeepa-0.0.25.jar [parameters]`.
You can set the command line parameters with `java -jar mediadeepa-0.0.26.jar [parameters]`.

> Example: `java -jar mediadeepa-0.0.25.jar -h`
> Example: `java -jar mediadeepa-0.0.26.jar -h`
<h2 id="examples">🛫 Examples</h2>

Expand Down
18 changes: 6 additions & 12 deletions THIRD-PARTY.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

Lists of 119 third-party dependencies.
Lists of 113 third-party dependencies.
(Eclipse Public License - v 1.0) (GNU Lesser General Public License) Logback Classic Module (ch.qos.logback:logback-classic:1.4.8 - http://logback.qos.ch/logback-classic)
(Eclipse Public License - v 1.0) (GNU Lesser General Public License) Logback Core Module (ch.qos.logback:logback-core:1.4.8 - http://logback.qos.ch/logback-core)
(Apache License, Version 2.0) ClassMate (com.fasterxml:classmate:1.5.1 - https://github.com/FasterXML/java-classmate)
Expand Down Expand Up @@ -32,8 +32,6 @@ Lists of 119 third-party dependencies.
(Apache License 2.0) Jakarta Bean Validation API (jakarta.validation:jakarta.validation-api:3.0.2 - https://beanvalidation.org)
(Eclipse Distribution License - v 1.0) Jakarta XML Binding API (jakarta.xml.bind:jakarta.xml.bind-api:4.0.0 - https://github.com/eclipse-ee4j/jaxb-api/jakarta.xml.bind-api)
(CDDL/GPLv2+CE) JavaBeans Activation Framework API jar (javax.activation:javax.activation-api:1.2.0 - http://java.net/all/javax.activation-api/)
(CDDL + GPLv2 with classpath exception) javax.annotation API (javax.annotation:javax.annotation-api:1.2 - http://jcp.org/en/jsr/detail?id=250)
(Apache License, Version 2.0) CDI APIs (javax.enterprise:cdi-api:1.2 - http://cdi-spec.org)
(CDDL 1.1) (GPL2 w/ CPE) jaxb-api (javax.xml.bind:jaxb-api:2.3.1 - https://github.com/javaee/jaxb-spec/jaxb-api)
(Apache License, Version 2.0) Byte Buddy (without dependencies) (net.bytebuddy:byte-buddy:1.14.5 - https://bytebuddy.net/byte-buddy)
(Apache License, Version 2.0) Byte Buddy agent (net.bytebuddy:byte-buddy-agent:1.14.5 - https://bytebuddy.net/byte-buddy-agent)
Expand All @@ -48,11 +46,11 @@ Lists of 119 third-party dependencies.
(Apache License, Version 2.0) Apache Commons Text (org.apache.commons:commons-text:1.10.0 - https://commons.apache.org/proper/commons-text)
(Apache License, Version 2.0) Apache Log4j API (org.apache.logging.log4j:log4j-api:2.20.0 - https://logging.apache.org/log4j/2.x/log4j-api/)
(Apache License, Version 2.0) Apache Log4j to SLF4J Adapter (org.apache.logging.log4j:log4j-to-slf4j:2.20.0 - https://logging.apache.org/log4j/2.x/log4j-to-slf4j/)
(Apache-2.0) Maven 4 API :: Meta annotations (org.apache.maven:maven-api-meta:4.0.0-alpha-9 - https://maven.apache.org/ref/4.0.0-alpha-9/api/maven-api-meta/)
(Apache-2.0) Maven 4 API :: Model (org.apache.maven:maven-api-model:4.0.0-alpha-9 - https://maven.apache.org/ref/4.0.0-alpha-9/api/maven-api-model/)
(Apache-2.0) Maven 4 API :: XML (org.apache.maven:maven-api-xml:4.0.0-alpha-9 - https://maven.apache.org/ref/4.0.0-alpha-9/api/maven-api-xml/)
(Apache-2.0) Maven Model (org.apache.maven:maven-model:4.0.0-alpha-9 - https://maven.apache.org/ref/4.0.0-alpha-9/maven-model/)
(Apache-2.0) Implementation of Maven API XML (org.apache.maven:maven-xml-impl:4.0.0-alpha-9 - https://maven.apache.org/ref/4.0.0-alpha-9/maven-xml-impl/)
(Apache-2.0) Maven 4 API :: Meta annotations (org.apache.maven:maven-api-meta:4.0.0-alpha-10 - https://maven.apache.org/ref/4.0.0-alpha-10/api/maven-api-meta/)
(Apache-2.0) Maven 4 API :: Model (org.apache.maven:maven-api-model:4.0.0-alpha-10 - https://maven.apache.org/ref/4.0.0-alpha-10/api/maven-api-model/)
(Apache-2.0) Maven 4 API :: XML (org.apache.maven:maven-api-xml:4.0.0-alpha-10 - https://maven.apache.org/ref/4.0.0-alpha-10/api/maven-api-xml/)
(Apache-2.0) Maven Model (org.apache.maven:maven-model:4.0.0-alpha-10 - https://maven.apache.org/ref/4.0.0-alpha-10/maven-model/)
(Apache-2.0) Implementation of Maven API XML (org.apache.maven:maven-xml-impl:4.0.0-alpha-10 - https://maven.apache.org/ref/4.0.0-alpha-10/maven-xml-impl/)
(Apache License, Version 2.0) Apache Maven Invoker (org.apache.maven.shared:maven-invoker:3.2.0 - https://maven.apache.org/shared/maven-invoker/)
(Apache License, Version 2.0) Apache Maven Shared Utils (org.apache.maven.shared:maven-shared-utils:3.3.4 - https://maven.apache.org/shared/maven-shared-utils/)
(Apache License, Version 2.0) Apache POI - Common (org.apache.poi:poi:5.2.3 - https://poi.apache.org/)
Expand All @@ -62,14 +60,10 @@ Lists of 119 third-party dependencies.
(The Apache Software License, Version 2.0) XmlBeans (org.apache.xmlbeans:xmlbeans:5.1.1 - https://xmlbeans.apache.org/)
(The Apache License, Version 2.0) org.apiguardian:apiguardian-api (org.apiguardian:apiguardian-api:1.1.2 - https://github.com/apiguardian-team/apiguardian)
(Apache License, Version 2.0) AssertJ Core (org.assertj:assertj-core:3.24.2 - https://assertj.github.io/doc/#assertj-core)
(Apache License, Version 2.0) Plexus Classworlds (org.codehaus.plexus:plexus-classworlds:2.6.0 - http://codehaus-plexus.github.io/plexus-classworlds/)
(Apache License, Version 2.0) Plexus :: Component Annotations (org.codehaus.plexus:plexus-component-annotations:2.1.0 - http://codehaus-plexus.github.io/plexus-containers/plexus-component-annotations/)
(Apache License, Version 2.0) Plexus XML Utilities (org.codehaus.plexus:plexus-xml:4.0.1 - https://codehaus-plexus.github.io/plexus-xml/)
(The BSD License) Stax2 API (org.codehaus.woodstox:stax2-api:4.2.1 - http://github.com/FasterXML/stax2-api)
(BSD 2-Clause License) commonmark-java core (org.commonmark:commonmark:0.21.0 - https://github.com/commonmark/commonmark-java/commonmark)
(Eclipse Public License - v 2.0) Java Development Tools Core (org.eclipse.jdt:org.eclipse.jdt.core:3.32.0 - https://projects.eclipse.org/projects/eclipse.jdt)
(Eclipse Public License, Version 1.0) org.eclipse.sisu.inject (org.eclipse.sisu:org.eclipse.sisu.inject:0.9.0.M2 - http://www.eclipse.org/sisu/org.eclipse.sisu.inject/)
(Eclipse Public License, Version 1.0) org.eclipse.sisu.plexus (org.eclipse.sisu:org.eclipse.sisu.plexus:0.9.0.M2 - http://www.eclipse.org/sisu/org.eclipse.sisu.plexus/)
(Eclipse Distribution License - v 1.0) JAXB Runtime (org.glassfish.jaxb:jaxb-runtime:2.3.8 - https://eclipse-ee4j.github.io/jaxb-ri/)
(Eclipse Distribution License - v 1.0) TXW2 Runtime (org.glassfish.jaxb:txw2:4.0.3 - https://eclipse-ee4j.github.io/jaxb-ri/)
(BSD License 3) Hamcrest (org.hamcrest:hamcrest:2.2 - http://hamcrest.org/JavaHamcrest/)
Expand Down
35 changes: 25 additions & 10 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<!DOCTYPE html>
<html lang="en"><head><title>Mediadeepa project documentation page</title><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta data-http-equiv="Content-Type" content="text/html; charset=UTF-8"><link media="all" rel="stylesheet" href="style.css"></head><body><header><nav><a href="#aboutmediadeepa">About Mediadeepa</a><a href="#features">Features</a><a href="#gettingstarted">Getting started</a><a href="#examples">Examples</a><a href="#commandlineoptions">Command line options</a><a href="#documentationcontributingandsupport">Documentation, contributing and support</a><a href="#acknowledgments">Acknowledgments</a></nav></header><main><section id="aboutmediadeepa"><h1>About Mediadeepa</h1><p>Audio/video medias and streams deep analyzer in Java with FFmpeg as back-end: extract/process technical information from audio/videos files/streams.</p>
<p><strong>This application is currently in alpha version, and should not be ready for production</strong></p>
<p><em>This document contain the full documentation for Mediadeepa version 0.0.25.</em></p>
<p><em>This document contain the full documentation for Mediadeepa version 0.0.26.</em></p>
<p>This application will run FFmpeg on a source video/audio file to apply some filters, and generate analysis raw data (mostly high verbosely text/XML streams). They are parsed and reduced/converted/drawn/summarized them to some output formats by Mediadeepa.</p>
<blockquote>
<p>Mediadeepa is a command line standalone application (no GUI, no specific setup).</p>
Expand Down Expand Up @@ -90,14 +90,14 @@ <h2>Current available export formats</h2>
cd mediadeepa
mvn install -DskipTests
</code></pre>
<p>Build jar will be founded on <code>target</code> directory as <code>mediadeepa-0.0.25.jar</code></p>
<p>Build jar will be founded on <code>target</code> directory as <code>mediadeepa-0.0.26.jar</code></p>
<p>And simply run the application with</p>
<pre><code class="language-bash">java -jar mediadeepa-0.0.25.jar
<pre><code class="language-bash">java -jar mediadeepa-0.0.26.jar
</code></pre>
<p>Mediadeepa contain embedded help, displayed with the <code>-h</code> parameter.</p>
<p>You can set the command line parameters with <code>java -jar mediadeepa-0.0.25.jar [parameters]</code>.</p>
<p>You can set the command line parameters with <code>java -jar mediadeepa-0.0.26.jar [parameters]</code>.</p>
<blockquote>
<p>Example: <code>java -jar mediadeepa-0.0.25.jar -h</code></p>
<p>Example: <code>java -jar mediadeepa-0.0.26.jar -h</code></p>
</blockquote></section><section id="examples"><h1>Examples</h1><h2>Process to export</h2>
<p>Export to the current directory the analysis report for the file <code>videofile.mov</code>:</p>
<pre><code>mediadeepa -i videofile.mov -f report -e .
Expand Down Expand Up @@ -231,7 +231,9 @@ <h3>Directly on command line</h3>
</code></pre>
<h3>Available options</h3>
<p>You can refer to this full list:</p>
<pre><code>mediadeepa.ffprobexml-file-name=ffprobe.xml # String
<pre><code>mediadeepa.ffmpeg-exec-name=ffmpeg # String
mediadeepa.ffprobe-exec-name=ffprobe # String
mediadeepa.ffprobexml-file-name=ffprobe.xml # String
mediadeepa.graphic-config.a-bitrate-graphic-filename=audio-bitrate.png # String
mediadeepa.graphic-config.a-phase-graphic-filename=audio-phase.png # String
mediadeepa.graphic-config.block-graphic-filename=video-block.png # String
Expand Down Expand Up @@ -279,6 +281,19 @@ <h3>Logging</h3>
<p>To inject a new logback configuration file, add in application command line:</p>
<pre><code>-Dlogging.config=&quot;path/to/new/logback.xml&quot;
</code></pre>
<h2>Search path binaries</h2>
<p>Mediadeepa can search on several paths to found <code>ffmpeg</code>/<code>ffmpeg.exe</code> and <code>ffprobe</code>/<code>ffprobe.exe</code> (sorted by search order):</p>
<ul>
<li>directly declared on command line by <code>-Dexecfinder.searchdir=c:\path1;c:\path2\subpath</code> on Windows or <code>-Dexecfinder.searchdir=/path1:/path2/subpath</code> on Posix</li>
<li>on <code>$HOME</code> directory</li>
<li>on <code>$HOME/bin</code> directory, if exists</li>
<li>on <code>$HOME/App/bin</code> directory, if exists</li>
<li>on any classpath directory declared, if exists</li>
<li>on the global <code>PATH</code> environment variable</li>
</ul>
<p>Either on Linux/Posix and Windows.</p>
<p>You can inject other binary names (other than <code>ffmpeg</code>/<code>ffprobe</code>) with: <code>mediadeepa.ffmpegExecName</code> and <code>mediadeepa.ffprobeExecName</code> configuration keys. <code>.exe</code> on Windows will be added/removed as needed by the application.</p>
<p>In summary, if FFmpeg/FFprobe is runnable from anywhere on your host (<code>PATH</code>), you'll have nothing to do.</p>
<h2>Application return</h2>
<p>The application can produce several files, but return mostly processing status and log messages.</p>
<h3>Return codes</h3>
Expand Down Expand Up @@ -315,20 +330,20 @@ <h2>Road-map</h2>
<h2>Auto-generated documentation</h2>
<h3>Bash-completion</h3>
<p>The application provide a dynamic bash-completion script generated by:</p>
<pre><code class="language-bash">java -jar target/mediadeepa-0.0.25.jar --autocomplete
<pre><code class="language-bash">java -jar target/mediadeepa-0.0.26.jar --autocomplete
</code></pre>
<h3>Man page</h3>
<p>An auto-generated <strong>man</strong> page can be produced by an internal option:</p>
<pre><code class="language-bash">java -Dexportdocumentation.manpage=&quot;/full/path/to/file.man&quot; -jar target/mediadeepa-0.0.25.jar
<pre><code class="language-bash">java -Dexportdocumentation.manpage=&quot;/full/path/to/file.man&quot; -jar target/mediadeepa-0.0.26.jar
</code></pre>
<h3>README page</h3>
<p>Auto-generated by Mediadeepa, like the man page, and can be produced by the internal option:</p>
<pre><code class="language-bash">java -Dexportdocumentation.readme=&quot;README.md&quot; -jar target/mediadeepa-0.0.25.jar
<pre><code class="language-bash">java -Dexportdocumentation.readme=&quot;README.md&quot; -jar target/mediadeepa-0.0.26.jar
</code></pre>
<p>All source text for documentation is either auto-generated by the internal application options and static markdown files in the <code>src/main/resources/doc/en</code> directory.</p>
<h3>Project web page</h3>
<p>Auto-generated by Mediadeepa, like the man and README pages, and can be produced by the internal option:</p>
<pre><code class="language-bash">java -Dexportdocumentation.website=&quot;docs/index.html&quot; -jar target/mediadeepa-0.0.25.jar
<pre><code class="language-bash">java -Dexportdocumentation.website=&quot;docs/index.html&quot; -jar target/mediadeepa-0.0.26.jar
</code></pre>
<p>Same method to generate this file, like README/man files does.</p></section><section id="acknowledgments"><h1>Acknowledgments</h1><p>Mediadeepa would never have been possible without the help of these magnificent and amazing OSS projects:</p>
<ul>
Expand Down
32 changes: 28 additions & 4 deletions docs/mediadeepa-1.man
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
.\" Title: mediadeepa
.\" Author: Media ex Machina / hdsdi3g
.\" Generator: mediadeepa
.\" Date: 12/18/2023
.\" Source: mediadeepa 0.0.25
.\" Date: 12/31/2023
.\" Source: mediadeepa 0.0.26
.\" Language: English
.TH "MEDIADEEPA" "1" "12/18/2023" "mediadeepa 0\&.0\&.25" ""
.TH "MEDIADEEPA" "1" "12/31/2023" "mediadeepa 0\&.0\&.26" ""
.\" -----------------------------------------------------------------
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
Expand Down Expand Up @@ -504,6 +504,30 @@ To inject a new logback configuration file, add in application command line:
.RE
.PP

Search path binaries
Mediadeepa can search on several paths to found \fBffmpeg\fR/\fBffmpeg\&.exe\fR and \fBffprobe\fR/\fBffprobe\&.exe\fR (sorted by search order):
.PP
.RS 4
\- directly declared on command line by \fB\-Dexecfinder\&.searchdir=c:\\path1;c:\\path2\\subpath\fR on Windows or \fB\-Dexecfinder\&.searchdir=/path1:/path2/subpath\fR on Posix
.PP
\- on \fB$HOME\fR directory
.PP
\- on \fB$HOME/bin\fR directory, if exists
.PP
\- on \fB$HOME/App/bin\fR directory, if exists
.PP
\- on any classpath directory declared, if exists
.PP
\- on the global \fBPATH\fR environment variable
.PP
.RE
Either on Linux/Posix and Windows\&.
.PP
You can inject other binary names (other than \fBffmpeg\fR/\fBffprobe\fR) with: \fBmediadeepa\&.ffmpegExecName\fR and \fBmediadeepa\&.ffprobeExecName\fR configuration keys\&. \fB\&.exe\fR on Windows will be added/removed as needed by the application\&.
.PP
In summary, if FFmpeg/FFprobe is runnable from anywhere on your host (\fBPATH\fR), you'll have nothing to do\&.
.PP

.SH "EXIT STATUS"
0
.RS 4
Expand Down Expand Up @@ -543,7 +567,7 @@ Send bug reports on GitHub project page \fIhttps://github\&.com/mediaexmachina/m
If you have any questions, feel free to reach out via any contact method listed on https://mexm\&.media \fIhttps://mexm\&.media\fR\&.
.PP

Mediadeepa 0\&.0\&.25
Mediadeepa 0\&.0\&.26
.PP
Copyright (C) 2022\-2023 Media ex Machina, under the GNU General Public License\&.
.PP
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<groupId>media.mexm</groupId>
<artifactId>mediadeepa</artifactId>
<packaging>jar</packaging>
<version>0.0.26-SNAPSHOT</version>
<version>0.0.26</version>

<name>MediaDeepA</name>
<url>https://github.com/mediaexmachina/mediadeepa</url>
Expand Down

0 comments on commit a703458

Please sign in to comment.