Add:FFProbe api endpoint

client/components/modals/AudioFileDataModal.vue

@@ -1,84 +1,99 @@
 <template>
   <modals-modal v-model="show" name="audiofile-data-modal" :width="700" :height="'unset'">
     <div v-if="audioFile" ref="container" class="w-full rounded-lg bg-bg box-shadow-md overflow-y-auto overflow-x-hidden p-6" style="max-height: 80vh">
-      <p class="text-base text-gray-200">{{ metadata.filename }}</p>
-
-      <div class="w-full h-px bg-white bg-opacity-10 my-4" />
-
-      <ui-text-input-with-label :value="metadata.path" readonly :label="$strings.LabelPath" class="mb-4 text-sm" />
-
-      <div class="flex flex-col sm:flex-row text-sm">
-        <div class="w-full sm:w-1/2">
-          <div class="flex mb-1">
-            <p class="w-32 text-black-50">
-              {{ $strings.LabelSize }}
-            </p>
-            <p>{{ $bytesPretty(metadata.size) }}</p>
-          </div>
-          <div class="flex mb-1">
-            <p class="w-32 text-black-50">
-              {{ $strings.LabelDuration }}
-            </p>
-            <p>{{ $secondsToTimestamp(audioFile.duration) }}</p>
-          </div>
-          <div class="flex mb-1">
-            <p class="w-32 text-black-50">{{ $strings.LabelFormat }}</p>
-            <p>{{ audioFile.format }}</p>
-          </div>
-          <div class="flex mb-1">
-            <p class="w-32 text-black-50">
-              {{ $strings.LabelChapters }}
-            </p>
-            <p>{{ audioFile.chapters?.length || 0 }}</p>
-          </div>
-          <div v-if="audioFile.embeddedCoverArt" class="flex mb-1">
-            <p class="w-32 text-black-50">
-              {{ $strings.LabelEmbeddedCover }}
-            </p>
-            <p>{{ audioFile.embeddedCoverArt || '' }}</p>
-          </div>
-        </div>
-        <div class="w-full sm:w-1/2">
-          <div class="flex mb-1">
-            <p class="w-32 text-black-50">
-              {{ $strings.LabelCodec }}
-            </p>
-            <p>{{ audioFile.codec }}</p>
-          </div>
-          <div class="flex mb-1">
-            <p class="w-32 text-black-50">
-              {{ $strings.LabelChannels }}
-            </p>
-            <p>{{ audioFile.channels }} ({{ audioFile.channelLayout }})</p>
-          </div>
-          <div class="flex mb-1">
-            <p class="w-32 text-black-50">
-              {{ $strings.LabelBitrate }}
-            </p>
-            <p>{{ $bytesPretty(audioFile.bitRate || 0, 0) }}</p>
-          </div>
-          <div class="flex mb-1">
-            <p class="w-32 text-black-50">{{ $strings.LabelTimeBase }}</p>
-            <p>{{ audioFile.timeBase }}</p>
-          </div>
-          <div v-if="audioFile.language" class="flex mb-1">
-            <p class="w-32 text-black-50">
-              {{ $strings.LabelLanguage }}
-            </p>
-            <p>{{ audioFile.language || '' }}</p>
-          </div>
-        </div>
+      <div class="flex items-center justify-between">
+        <p class="text-base text-gray-200 truncate">{{ metadata.filename }}</p>
+        <ui-btn v-if="ffprobeData" small class="ml-2" @click="ffprobeData = null">{{ $strings.ButtonReset }}</ui-btn>
+        <ui-btn v-else-if="userIsAdminOrUp" small :loading="probingFile" class="ml-2" @click="getFFProbeData">Probe Audio File</ui-btn>
       </div>
 
       <div class="w-full h-px bg-white bg-opacity-10 my-4" />
 
-      <p class="font-bold mb-2">{{ $strings.LabelMetaTags }}</p>
+      <template v-if="!ffprobeData">
+        <ui-text-input-with-label :value="metadata.path" readonly :label="$strings.LabelPath" class="mb-4 text-sm" />
 
-      <div v-for="(value, key) in metaTags" :key="key" class="flex mb-1 text-sm">
-        <p class="w-32 min-w-32 text-black-50 mb-1">
-          {{ key.replace('tag', '') }}
-        </p>
-        <p>{{ value }}</p>
+        <div class="flex flex-col sm:flex-row text-sm">
+          <div class="w-full sm:w-1/2">
+            <div class="flex mb-1">
+              <p class="w-32 text-black-50">
+                {{ $strings.LabelSize }}
+              </p>
+              <p>{{ $bytesPretty(metadata.size) }}</p>
+            </div>
+            <div class="flex mb-1">
+              <p class="w-32 text-black-50">
+                {{ $strings.LabelDuration }}
+              </p>
+              <p>{{ $secondsToTimestamp(audioFile.duration) }}</p>
+            </div>
+            <div class="flex mb-1">
+              <p class="w-32 text-black-50">{{ $strings.LabelFormat }}</p>
+              <p>{{ audioFile.format }}</p>
+            </div>
+            <div class="flex mb-1">
+              <p class="w-32 text-black-50">
+                {{ $strings.LabelChapters }}
+              </p>
+              <p>{{ audioFile.chapters?.length || 0 }}</p>
+            </div>
+            <div v-if="audioFile.embeddedCoverArt" class="flex mb-1">
+              <p class="w-32 text-black-50">
+                {{ $strings.LabelEmbeddedCover }}
+              </p>
+              <p>{{ audioFile.embeddedCoverArt || '' }}</p>
+            </div>
+          </div>
+          <div class="w-full sm:w-1/2">
+            <div class="flex mb-1">
+              <p class="w-32 text-black-50">
+                {{ $strings.LabelCodec }}
+              </p>
+              <p>{{ audioFile.codec }}</p>
+            </div>
+            <div class="flex mb-1">
+              <p class="w-32 text-black-50">
+                {{ $strings.LabelChannels }}
+              </p>
+              <p>{{ audioFile.channels }} ({{ audioFile.channelLayout }})</p>
+            </div>
+            <div class="flex mb-1">
+              <p class="w-32 text-black-50">
+                {{ $strings.LabelBitrate }}
+              </p>
+              <p>{{ $bytesPretty(audioFile.bitRate || 0, 0) }}</p>
+            </div>
+            <div class="flex mb-1">
+              <p class="w-32 text-black-50">{{ $strings.LabelTimeBase }}</p>
+              <p>{{ audioFile.timeBase }}</p>
+            </div>
+            <div v-if="audioFile.language" class="flex mb-1">
+              <p class="w-32 text-black-50">
+                {{ $strings.LabelLanguage }}
+              </p>
+              <p>{{ audioFile.language || '' }}</p>
+            </div>
+          </div>
+        </div>
+
+        <div class="w-full h-px bg-white bg-opacity-10 my-4" />
+
+        <p class="font-bold mb-2">{{ $strings.LabelMetaTags }}</p>
+
+        <div v-for="(value, key) in metaTags" :key="key" class="flex mb-1 text-sm">
+          <p class="w-32 min-w-32 text-black-50 mb-1">
+            {{ key.replace('tag', '') }}
+          </p>
+          <p>{{ value }}</p>
+        </div>
+      </template>
+      <div v-else class="w-full">
+        <div class="relative">
+          <ui-textarea-with-label :value="prettyFfprobeData" readonly :rows="30" class="text-xs" />
+
+          <button class="absolute top-4 right-4" :class="copiedToClipboard ? 'text-success' : 'text-white/50 hover:text-white/80'" @click.stop="copyFfprobeData">
+            <span class="material-icons">{{ copiedToClipboard ? 'check' : 'content_copy' }}</span>
+          </button>
+        </div>
       </div>
     </div>
   </modals-modal>
@@ -91,10 +106,24 @@ export default {
     audioFile: {
       type: Object,
       default: () => {}
-    }
+    },
+    libraryItemId: String
   },
   data() {
-    return {}
+    return {
+      probingFile: false,
+      ffprobeData: null,
+      copiedToClipboard: false
+    }
+  },
+  watch: {
+    show(newVal) {
+      if (newVal) {
+        this.ffprobeData = null
+        this.copiedToClipboard = false
+        this.probingFile = false
+      }
+    }
   },
   computed: {
     show: {
@@ -110,9 +139,36 @@ export default {
     },
     metaTags() {
       return this.audioFile?.metaTags || {}
+    },
+    userIsAdminOrUp() {
+      return this.$store.getters['user/getIsAdminOrUp']
+    },
+    prettyFfprobeData() {
+      if (!this.ffprobeData) return ''
+      return JSON.stringify(this.ffprobeData, null, 2)
+    }
+  },
+  methods: {
+    getFFProbeData() {
+      this.probingFile = true
+      this.$axios
+        .$get(`/api/items/${this.libraryItemId}/ffprobe/${this.audioFile.ino}`)
+        .then((data) => {
+          console.log('Got ffprobe data', data)
+          this.ffprobeData = data
+        })
+        .catch((error) => {
+          console.error('Failed to get ffprobe data', error)
+          this.$toast.error('FFProbe failed')
+        })
+        .finally(() => {
+          this.probingFile = false
+        })
+    },
+    async copyFfprobeData() {
+      this.copiedToClipboard = await this.$copyToClipboard(this.prettyFfprobeData)
     }
   },
-  methods: {},
   mounted() {}
 }
 </script>

client/components/tables/LibraryFilesTable.vue

@@ -27,7 +27,7 @@
       </div>
     </transition>
 
-    <modals-audio-file-data-modal v-model="showAudioFileDataModal" :audio-file="selectedAudioFile" />
+    <modals-audio-file-data-modal v-model="showAudioFileDataModal" :library-item-id="libraryItemId" :audio-file="selectedAudioFile" />
   </div>
 </template>
 

client/components/tables/TracksTable.vue

@@ -33,7 +33,7 @@
       </div>
     </transition>
 
-    <modals-audio-file-data-modal v-model="showAudioFileDataModal" :audio-file="selectedAudioFile" />
+    <modals-audio-file-data-modal v-model="showAudioFileDataModal" :library-item-id="libraryItemId" :audio-file="selectedAudioFile" />
   </div>
 </template>
 

client/components/ui/TextareaWithLabel.vue

@@ -1,7 +1,7 @@
 <template>
   <div class="w-full">
     <p class="px-1 text-sm font-semibold" :class="disabled ? 'text-gray-400' : ''">{{ label }}</p>
-    <ui-textarea-input ref="input" v-model="inputValue" :disabled="disabled" :rows="rows" class="w-full" />
+    <ui-textarea-input ref="input" v-model="inputValue" :disabled="disabled" :readonly="readonly" :rows="rows" class="w-full" />
   </div>
 </template>
 
@@ -11,6 +11,7 @@ export default {
     value: [String, Number],
     label: String,
     disabled: Boolean,
+    readonly: Boolean,
     rows: {
       type: Number,
       default: 2

client/plugins/init.client.js

@@ -24,20 +24,20 @@ Vue.prototype.$formatJsDate = (jsdate, fnsFormat = 'MM/dd/yyyy HH:mm') => {
   return format(jsdate, fnsFormat)
 }
 Vue.prototype.$formatTime = (unixms, fnsFormat = 'HH:mm') => {
-    if (!unixms) return ''
-    return format(unixms, fnsFormat)
+  if (!unixms) return ''
+  return format(unixms, fnsFormat)
 }
 Vue.prototype.$formatJsTime = (jsdate, fnsFormat = 'HH:mm') => {
-    if (!jsdate || !isDate(jsdate)) return ''
-    return format(jsdate, fnsFormat)
+  if (!jsdate || !isDate(jsdate)) return ''
+  return format(jsdate, fnsFormat)
 }
 Vue.prototype.$formatDatetime = (unixms, fnsDateFormart = 'MM/dd/yyyy', fnsTimeFormat = 'HH:mm') => {
-    if (!unixms) return ''
-    return format(unixms, `${fnsDateFormart} ${fnsTimeFormat}`)
+  if (!unixms) return ''
+  return format(unixms, `${fnsDateFormart} ${fnsTimeFormat}`)
 }
 Vue.prototype.$formatJsDatetime = (jsdate, fnsDateFormart = 'MM/dd/yyyy', fnsTimeFormat = 'HH:mm') => {
-    if (!jsdate || !isDate(jsdate)) return ''
-    return format(jsdate, `${fnsDateFormart} ${fnsTimeFormat}`)
+  if (!jsdate || !isDate(jsdate)) return ''
+  return format(jsdate, `${fnsDateFormart} ${fnsTimeFormat}`)
 }
 Vue.prototype.$addDaysToToday = (daysToAdd) => {
   var date = addDays(new Date(), daysToAdd)
@@ -132,8 +132,10 @@ Vue.prototype.$copyToClipboard = (str, ctx) => {
     if (navigator.clipboard) {
       navigator.clipboard.writeText(str).then(() => {
         if (ctx) ctx.$toast.success('Copied to clipboard')
+        resolve(true)
       }, (err) => {
         console.error('Clipboard copy failed', str, err)
+        resolve(false)
       })
     } else {
       const el = document.createElement('textarea')
@@ -147,6 +149,7 @@ Vue.prototype.$copyToClipboard = (str, ctx) => {
       document.body.removeChild(el)
 
       if (ctx) ctx.$toast.success('Copied to clipboard')
+      resolve(true)
     }
   })
 }

server/controllers/LibraryItemController.js

@@ -472,7 +472,7 @@ class LibraryItemController {
 
   getToneMetadataObject(req, res) {
     if (!req.user.isAdminOrUp) {
-      Logger.error(`[LibraryItemController] Non-root user attempted to get tone metadata object`, req.user)
+      Logger.error(`[LibraryItemController] Non-admin user attempted to get tone metadata object`, req.user)
       return res.sendStatus(403)
     }
 
@@ -514,20 +514,31 @@ class LibraryItemController {
     })
   }
 
-  async toneScan(req, res) {
-    if (!req.libraryItem.media.audioFiles.length) {
-      return res.sendStatus(404)
+  /**
+   * GET api/items/:id/ffprobe/:fileid
+   * FFProbe JSON result from audio file
+   * 
+   * @param {express.Request} req
+   * @param {express.Response} res 
+   */
+  async getFFprobeData(req, res) {
+    if (!req.user.isAdminOrUp) {
+      Logger.error(`[LibraryItemController] Non-admin user attempted to get ffprobe data`, req.user)
+      return res.sendStatus(403)
+    }
+    if (req.libraryFile.fileType !== 'audio') {
+      Logger.error(`[LibraryItemController] Invalid filetype "${req.libraryFile.fileType}" for fileid "${req.params.fileid}". Expected audio file`)
+      return res.sendStatus(400)
     }
 
-    const audioFileIndex = isNullOrNaN(req.params.index) ? 1 : Number(req.params.index)
-    const audioFile = req.libraryItem.media.audioFiles.find(af => af.index === audioFileIndex)
+    const audioFile = req.libraryItem.media.findFileWithInode(req.params.fileid)
     if (!audioFile) {
-      Logger.error(`[LibraryItemController] toneScan: Audio file not found with index ${audioFileIndex}`)
+      Logger.error(`[LibraryItemController] Audio file not found with inode value ${req.params.fileid}`)
       return res.sendStatus(404)
     }
 
-    const toneData = await this.scanner.probeAudioFileWithTone(audioFile)
-    res.json(toneData)
+    const ffprobeData = await this.scanner.probeAudioFile(audioFile)
+    res.json(ffprobeData)
   }
 
   /**

server/objects/mediaTypes/Book.js

@@ -198,6 +198,7 @@ class Book {
     this.coverPath = coverPath
     return true
   }
+
   removeFileWithInode(inode) {
     if (this.audioFiles.some(af => af.ino === inode)) {
       this.audioFiles = this.audioFiles.filter(af => af.ino !== inode)
@@ -210,8 +211,13 @@ class Book {
     return false
   }
 
+  /**
+   * Get audio file or ebook file from inode
+   * @param {string} inode 
+   * @returns {(AudioFile|EBookFile|null)}
+   */
   findFileWithInode(inode) {
-    var audioFile = this.audioFiles.find(af => af.ino === inode)
+    const audioFile = this.audioFiles.find(af => af.ino === inode)
     if (audioFile) return audioFile
     if (this.ebookFile && this.ebookFile.ino === inode) return this.ebookFile
     return null

server/objects/settings/ServerSettings.js

@@ -15,7 +15,6 @@ class ServerSettings {
     this.scannerPreferMatchedMetadata = false
     this.scannerDisableWatcher = false
     this.scannerPreferOverdriveMediaMarker = false
-    this.scannerUseTone = false
 
     // Metadata - choose to store inside users library item folder
     this.storeCoverWithItem = false
@@ -72,7 +71,6 @@ class ServerSettings {
     this.scannerPreferMatchedMetadata = !!settings.scannerPreferMatchedMetadata
     this.scannerDisableWatcher = !!settings.scannerDisableWatcher
     this.scannerPreferOverdriveMediaMarker = !!settings.scannerPreferOverdriveMediaMarker
-    this.scannerUseTone = !!settings.scannerUseTone
 
     this.storeCoverWithItem = !!settings.storeCoverWithItem
     this.storeMetadataWithItem = !!settings.storeMetadataWithItem
@@ -139,7 +137,6 @@ class ServerSettings {
       scannerPreferMatchedMetadata: this.scannerPreferMatchedMetadata,
       scannerDisableWatcher: this.scannerDisableWatcher,
       scannerPreferOverdriveMediaMarker: this.scannerPreferOverdriveMediaMarker,
-      scannerUseTone: this.scannerUseTone,
       storeCoverWithItem: this.storeCoverWithItem,
       storeMetadataWithItem: this.storeMetadataWithItem,
       metadataFileFormat: this.metadataFileFormat,

server/routers/ApiRouter.js

@@ -121,7 +121,7 @@ class ApiRouter {
     this.router.post('/items/:id/scan', LibraryItemController.middleware.bind(this), LibraryItemController.scan.bind(this))
     this.router.get('/items/:id/tone-object', LibraryItemController.middleware.bind(this), LibraryItemController.getToneMetadataObject.bind(this))
     this.router.post('/items/:id/chapters', LibraryItemController.middleware.bind(this), LibraryItemController.updateMediaChapters.bind(this))
-    this.router.post('/items/:id/tone-scan/:index?', LibraryItemController.middleware.bind(this), LibraryItemController.toneScan.bind(this))
+    this.router.get('/items/:id/ffprobe/:fileid', LibraryItemController.middleware.bind(this), LibraryItemController.getFFprobeData.bind(this))
     this.router.get('/items/:id/file/:fileid', LibraryItemController.middleware.bind(this), LibraryItemController.getLibraryFile.bind(this))
     this.router.delete('/items/:id/file/:fileid', LibraryItemController.middleware.bind(this), LibraryItemController.deleteLibraryFile.bind(this))
     this.router.get('/items/:id/file/:fileid/download', LibraryItemController.middleware.bind(this), LibraryItemController.downloadLibraryFile.bind(this))

server/scanner/MediaFileScanner.js

@@ -59,14 +59,7 @@ class MediaFileScanner {
   async scan(mediaType, libraryFile, mediaMetadataFromScan, verbose = false) {
     const probeStart = Date.now()
 
-    let probeData = null
-    // TODO: Temp not using tone for probing until more testing can be done
-    // if (global.ServerSettings.scannerUseTone) {
-    //   Logger.debug(`[MediaFileScanner] using tone to probe audio file "${libraryFile.metadata.path}"`)
-    //   probeData = await toneProber.probe(libraryFile.metadata.path, true)
-    // } else {
-    probeData = await prober.probe(libraryFile.metadata.path, verbose)
-    // }
+    const probeData = await prober.probe(libraryFile.metadata.path, verbose)
 
     if (probeData.error) {
       Logger.error(`[MediaFileScanner] ${probeData.error} : "${libraryFile.metadata.path}"`)
@@ -332,9 +325,9 @@ class MediaFileScanner {
     return hasUpdated
   }
 
-  probeAudioFileWithTone(audioFile) {
-    Logger.debug(`[MediaFileScanner] using tone to probe audio file "${audioFile.metadata.path}"`)
-    return toneProber.rawProbe(audioFile.metadata.path)
+  probeAudioFile(audioFile) {
+    Logger.debug(`[MediaFileScanner] Running ffprobe for audio file at "${audioFile.metadata.path}"`)
+    return prober.rawProbe(audioFile.metadata.path)
   }
 }
 module.exports = new MediaFileScanner()

server/scanner/Scanner.js

@@ -1034,8 +1034,8 @@ class Scanner {
     SocketAuthority.emitter('scan_complete', libraryScan.getScanEmitData)
   }
 
-  probeAudioFileWithTone(audioFile) {
-    return MediaFileScanner.probeAudioFileWithTone(audioFile)
+  probeAudioFile(audioFile) {
+    return MediaFileScanner.probeAudioFile(audioFile)
   }
 }
 module.exports = Scanner

server/utils/prober.js

@@ -309,3 +309,23 @@ function probe(filepath, verbose = false) {
     })
 }
 module.exports.probe = probe
+
+/**
+ * Ffprobe for audio file path
+ * 
+ * @param {string} filepath
+ * @returns {Object} ffprobe json output
+ */
+function rawProbe(filepath) {
+  if (process.env.FFPROBE_PATH) {
+    ffprobe.FFPROBE_PATH = process.env.FFPROBE_PATH
+  }
+
+  return ffprobe(filepath)
+    .catch((err) => {
+      return {
+        error: err
+      }
+    })
+}
+module.exports.rawProbe = rawProbe