Integrate transcription in PeerTube

server/core/controllers/api/config.ts

@@ -1,10 +1,16 @@
+import { About, ActorImageType, ActorImageType_Type, CustomConfig, HttpStatusCode, UserRight } from '@peertube/peertube-models'
+import { createReqFiles } from '@server/helpers/express-utils.js'
+import { MIMETYPES } from '@server/initializers/constants.js'
+import { deleteLocalActorImageFile, updateLocalActorImageFiles } from '@server/lib/local-actor.js'
+import { ServerConfigManager } from '@server/lib/server-config-manager.js'
+import { ActorImageModel } from '@server/models/actor/actor-image.js'
+import { getServerActor } from '@server/models/application/application.js'
+import { ModelCache } from '@server/models/shared/model-cache.js'
 import express from 'express'
 import { remove, writeJSON } from 'fs-extra/esm'
 import snakeCase from 'lodash-es/snakeCase.js'
 import validator from 'validator'
-import { ServerConfigManager } from '@server/lib/server-config-manager.js'
-import { About, ActorImageType, ActorImageType_Type, CustomConfig, HttpStatusCode, UserRight } from '@peertube/peertube-models'
-import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger.js'
+import { CustomConfigAuditView, auditLoggerFactory, getAuditIdFromRes } from '../../helpers/audit-logger.js'
 import { objectConverter } from '../../helpers/core-utils.js'
 import { CONFIG, reloadConfig } from '../../initializers/config.js'
 import { ClientHtml } from '../../lib/html/client-html.js'
@@ -18,12 +24,6 @@ import {
   updateBannerValidator
 } from '../../middlewares/index.js'
 import { customConfigUpdateValidator, ensureConfigIsEditable } from '../../middlewares/validators/config.js'
-import { createReqFiles } from '@server/helpers/express-utils.js'
-import { MIMETYPES } from '@server/initializers/constants.js'
-import { deleteLocalActorImageFile, updateLocalActorImageFiles } from '@server/lib/local-actor.js'
-import { getServerActor } from '@server/models/application/application.js'
-import { ActorImageModel } from '@server/models/actor/actor-image.js'
-import { ModelCache } from '@server/models/shared/model-cache.js'
 
 const configRouter = express.Router()
 
@@ -385,6 +385,12 @@ function customConfig (): CustomConfig {
         enabled: CONFIG.VIDEO_STUDIO.REMOTE_RUNNERS.ENABLED
       }
     },
+    videoTranscription: {
+      enabled: CONFIG.VIDEO_TRANSCRIPTION.ENABLED,
+      remoteRunners: {
+        enabled: CONFIG.VIDEO_TRANSCRIPTION.REMOTE_RUNNERS.ENABLED
+      }
+    },
     videoFile: {
       update: {
         enabled: CONFIG.VIDEO_FILE.UPDATE.ENABLED

server/core/controllers/api/runners/jobs.ts

@@ -1,4 +1,25 @@
-import express, { UploadFiles } from 'express'
+import {
+  AbortRunnerJobBody,
+  AcceptRunnerJobResult,
+  ErrorRunnerJobBody,
+  HttpStatusCode,
+  ListRunnerJobsQuery,
+  LiveRTMPHLSTranscodingUpdatePayload,
+  RequestRunnerJobResult,
+  RunnerJobState,
+  RunnerJobSuccessBody,
+  RunnerJobSuccessPayload,
+  RunnerJobType,
+  RunnerJobUpdateBody,
+  RunnerJobUpdatePayload,
+  ServerErrorCode,
+  TranscriptionSuccess,
+  UserRight,
+  VODAudioMergeTranscodingSuccess,
+  VODHLSTranscodingSuccess,
+  VODWebVideoTranscodingSuccess,
+  VideoStudioTranscodingSuccess
+} from '@peertube/peertube-models'
 import { retryTransactionWrapper } from '@server/helpers/database-utils.js'
 import { createReqFiles } from '@server/helpers/express-utils.js'
 import { logger, loggerTagsFactory } from '@server/helpers/logger.js'
@@ -28,33 +49,13 @@ import {
   successRunnerJobValidator,
   updateRunnerJobValidator
 } from '@server/middlewares/validators/runners/index.js'
-import { RunnerModel } from '@server/models/runner/runner.js'
 import { RunnerJobModel } from '@server/models/runner/runner-job.js'
-import {
-  AbortRunnerJobBody,
-  AcceptRunnerJobResult,
-  ErrorRunnerJobBody,
-  HttpStatusCode,
-  ListRunnerJobsQuery,
-  LiveRTMPHLSTranscodingUpdatePayload,
-  RequestRunnerJobResult,
-  RunnerJobState,
-  RunnerJobSuccessBody,
-  RunnerJobSuccessPayload,
-  RunnerJobType,
-  RunnerJobUpdateBody,
-  RunnerJobUpdatePayload,
-  ServerErrorCode,
-  UserRight,
-  VideoStudioTranscodingSuccess,
-  VODAudioMergeTranscodingSuccess,
-  VODHLSTranscodingSuccess,
-  VODWebVideoTranscodingSuccess
-} from '@peertube/peertube-models'
+import { RunnerModel } from '@server/models/runner/runner.js'
+import express, { UploadFiles } from 'express'
 
 const postRunnerJobSuccessVideoFiles = createReqFiles(
-  [ 'payload[videoFile]', 'payload[resolutionPlaylistFile]' ],
-  { ...MIMETYPES.VIDEO.MIMETYPE_EXT, ...MIMETYPES.M3U8.MIMETYPE_EXT }
+  [ 'payload[videoFile]', 'payload[resolutionPlaylistFile]', 'payload[vttFile]' ],
+  { ...MIMETYPES.VIDEO.MIMETYPE_EXT, ...MIMETYPES.M3U8.MIMETYPE_EXT, ...MIMETYPES.VIDEO_CAPTIONS.MIMETYPE_EXT }
 )
 
 const runnerJobUpdateVideoFiles = createReqFiles(
@@ -345,7 +346,15 @@ const jobSuccessPayloadBuilders: {
     }
   },
 
-  'live-rtmp-hls-transcoding': () => ({})
+  'live-rtmp-hls-transcoding': () => ({}),
+
+  'video-transcription': (payload: TranscriptionSuccess, files) => {
+    return {
+      ...payload,
+
+      vttFile: files['payload[vttFile]'][0].path
+    }
+  }
 }
 
 async function postRunnerJobSuccess (req: express.Request, res: express.Response) {

server/core/controllers/api/users/my-notifications.ts

@@ -76,6 +76,7 @@ async function updateNotificationSettings (req: express.Request, res: express.Re
     abuseStateChange: body.abuseStateChange,
     newPeerTubeVersion: body.newPeerTubeVersion,
     newPluginVersion: body.newPluginVersion,
+    myVideoTranscriptionGenerated: body.myVideoTranscriptionGenerated,
     myVideoStudioEditionFinished: body.myVideoStudioEditionFinished
   }
 

server/core/controllers/api/videos/captions.ts

@@ -1,31 +1,47 @@
-import express from 'express'
-import { HttpStatusCode } from '@peertube/peertube-models'
+import { HttpStatusCode, VideoCaptionGenerate } from '@peertube/peertube-models'
 import { Hooks } from '@server/lib/plugins/hooks.js'
+import { createLocalCaption, createTranscriptionTaskIfNeeded } from '@server/lib/video-captions.js'
+import { VideoJobInfoModel } from '@server/models/video/video-job-info.js'
+import express from 'express'
 import { createReqFiles } from '../../../helpers/express-utils.js'
-import { logger } from '../../../helpers/logger.js'
+import { logger, loggerTagsFactory } from '../../../helpers/logger.js'
 import { getFormattedObjects } from '../../../helpers/utils.js'
 import { MIMETYPES } from '../../../initializers/constants.js'
 import { sequelizeTypescript } from '../../../initializers/database.js'
 import { federateVideoIfNeeded } from '../../../lib/activitypub/videos/index.js'
 import { asyncMiddleware, asyncRetryTransactionMiddleware, authenticate } from '../../../middlewares/index.js'
-import { addVideoCaptionValidator, deleteVideoCaptionValidator, listVideoCaptionsValidator } from '../../../middlewares/validators/index.js'
+import {
+  addVideoCaptionValidator,
+  deleteVideoCaptionValidator,
+  generateVideoCaptionValidator,
+  listVideoCaptionsValidator
+} from '../../../middlewares/validators/index.js'
 import { VideoCaptionModel } from '../../../models/video/video-caption.js'
-import { createLocalCaption } from '@server/lib/video-captions.js'
+
+const lTags = loggerTagsFactory('api', 'video-caption')
 
 const reqVideoCaptionAdd = createReqFiles([ 'captionfile' ], MIMETYPES.VIDEO_CAPTIONS.MIMETYPE_EXT)
 
 const videoCaptionsRouter = express.Router()
 
+videoCaptionsRouter.post('/:videoId/captions/generate',
+  authenticate,
+  asyncMiddleware(generateVideoCaptionValidator),
+  asyncMiddleware(createGenerateVideoCaption)
+)
+
 videoCaptionsRouter.get('/:videoId/captions',
   asyncMiddleware(listVideoCaptionsValidator),
   asyncMiddleware(listVideoCaptions)
 )
+
 videoCaptionsRouter.put('/:videoId/captions/:captionLanguage',
   authenticate,
   reqVideoCaptionAdd,
   asyncMiddleware(addVideoCaptionValidator),
   asyncRetryTransactionMiddleware(createVideoCaption)
 )
+
 videoCaptionsRouter.delete('/:videoId/captions/:captionLanguage',
   authenticate,
   asyncMiddleware(deleteVideoCaptionValidator),
@@ -40,6 +56,19 @@ export {
 
 // ---------------------------------------------------------------------------
 
+async function createGenerateVideoCaption (req: express.Request, res: express.Response) {
+  const video = res.locals.videoAll
+
+  const body = req.body as VideoCaptionGenerate
+  if (body.forceTranscription === true) {
+    await VideoJobInfoModel.abortAllTasks(video.uuid, 'pendingTranscription')
+  }
+
+  await createTranscriptionTaskIfNeeded(video)
+
+  return res.sendStatus(HttpStatusCode.NO_CONTENT_204)
+}
+
 async function listVideoCaptions (req: express.Request, res: express.Response) {
   const data = await VideoCaptionModel.listVideoCaptions(res.locals.onlyVideo.id)
 
@@ -74,7 +103,7 @@ async function deleteVideoCaption (req: express.Request, res: express.Response)
     await federateVideoIfNeeded(video, false, t)
   })
 
-  logger.info('Video caption %s of video %s deleted.', videoCaption.language, video.uuid)
+  logger.info('Video caption %s of video %s deleted.', videoCaption.language, video.uuid, lTags(video.uuid))
 
   Hooks.runAction('action:api.video-caption.deleted', { caption: videoCaption, req, res })
 

server/core/controllers/api/videos/import.ts

@@ -142,7 +142,8 @@ async function handleTorrentImport (req: express.Request, res: express.Response,
       ? 'torrent-file'
       : 'magnet-uri',
     videoImportId: videoImport.id,
-    preventException: false
+    preventException: false,
+    generateTranscription: body.generateTranscription
   }
   await JobQueue.Instance.createJob({ type: 'video-import', payload })