1 /*
2 * Licensed to The Apereo Foundation under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work for additional
4 * information regarding copyright ownership.
5 *
6 *
7 * The Apereo Foundation licenses this file to you under the Educational
8 * Community License, Version 2.0 (the "License"); you may not use this file
9 * except in compliance with the License. You may obtain a copy of the License
10 * at:
11 *
12 * http://opensource.org/licenses/ecl2.txt
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 * License for the specific language governing permissions and limitations under
18 * the License.
19 *
20 */
21
22 package org.opencastproject.sox.api;
23
24 import org.opencastproject.job.api.Job;
25 import org.opencastproject.mediapackage.MediaPackageException;
26 import org.opencastproject.mediapackage.Track;
27
28 /**
29 * Provides sound processing services with SoX
30 */
31 public interface SoxService {
32
33 String JOB_TYPE = "org.opencastproject.sox";
34
35 /**
36 * Get audio statistics, using that track's audio streams.
37 *
38 * @param sourceAudioTrack
39 * The source audio track
40 * @return The receipt for this audio processing job.
41 * @throws MediaPackageException
42 * if the mediapackage is invalid
43 * @throws SoxException
44 * if audio processing fails
45 */
46 Job analyze(Track sourceAudioTrack) throws MediaPackageException, SoxException;
47
48 /**
49 * Normalize the audio stream of that track.
50 *
51 * @param sourceAudioTrack
52 * The source audio track
53 * @param targetRmsLevDb
54 * The target RMS Lev dB
55 * @return The receipt for this audio processing job
56 * @throws MediaPackageException
57 * if the mediapackage is invalid
58 * @throws SoxException
59 * if audio processing fails
60 */
61 Job normalize(Track sourceAudioTrack, Float targetRmsLevDb) throws MediaPackageException, SoxException;
62
63 }