-
Notifications
You must be signed in to change notification settings - Fork 27
/
EncodingWithCdnOutput.java
406 lines (364 loc) · 17.3 KB
/
EncodingWithCdnOutput.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
import com.bitmovin.api.sdk.BitmovinApi;
import com.bitmovin.api.sdk.common.BitmovinException;
import com.bitmovin.api.sdk.model.AacAudioConfiguration;
import com.bitmovin.api.sdk.model.AudioConfiguration;
import com.bitmovin.api.sdk.model.CdnOutput;
import com.bitmovin.api.sdk.model.CloudRegion;
import com.bitmovin.api.sdk.model.CodecConfiguration;
import com.bitmovin.api.sdk.model.DashManifest;
import com.bitmovin.api.sdk.model.DashManifestDefault;
import com.bitmovin.api.sdk.model.DashManifestDefaultVersion;
import com.bitmovin.api.sdk.model.Encoding;
import com.bitmovin.api.sdk.model.EncodingOutput;
import com.bitmovin.api.sdk.model.EncodingOutputPaths;
import com.bitmovin.api.sdk.model.EncodingOutputPathsDashManifest;
import com.bitmovin.api.sdk.model.EncodingOutputPathsHlsManifest;
import com.bitmovin.api.sdk.model.Fmp4Muxing;
import com.bitmovin.api.sdk.model.H264VideoConfiguration;
import com.bitmovin.api.sdk.model.HlsManifest;
import com.bitmovin.api.sdk.model.HlsManifestDefault;
import com.bitmovin.api.sdk.model.HlsManifestDefaultVersion;
import com.bitmovin.api.sdk.model.HttpInput;
import com.bitmovin.api.sdk.model.Input;
import com.bitmovin.api.sdk.model.Manifest;
import com.bitmovin.api.sdk.model.ManifestGenerator;
import com.bitmovin.api.sdk.model.ManifestResource;
import com.bitmovin.api.sdk.model.MessageType;
import com.bitmovin.api.sdk.model.MuxingStream;
import com.bitmovin.api.sdk.model.Output;
import com.bitmovin.api.sdk.model.PresetConfiguration;
import com.bitmovin.api.sdk.model.StartEncodingRequest;
import com.bitmovin.api.sdk.model.Status;
import com.bitmovin.api.sdk.model.Stream;
import com.bitmovin.api.sdk.model.StreamInput;
import com.bitmovin.api.sdk.model.StreamSelectionMode;
import com.bitmovin.api.sdk.model.Task;
import com.bitmovin.api.sdk.model.VideoConfiguration;
import common.ConfigProvider;
import feign.slf4j.Slf4jLogger;
import java.util.Arrays;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* This example demonstrates how to execute an encoding using the Bitmovin Content Delivery Network
* as output storage.
*
* <p>The following configuration parameters are expected:
*
* <ul>
* <li>BITMOVIN_API_KEY - Your API key for the Bitmovin API
* <li>BITMOVIN_TENANT_ORG_ID - (optional) The ID of the Organisation in which you want to perform
* the encoding.
* <li>HTTP_INPUT_HOST - The Hostname or IP address of the HTTP server hosting your input files,
* e.g.: my-storage.biz
* <li>HTTP_INPUT_FILE_PATH - The path to your input file on the provided HTTP server Example:
* videos/1080p_Sintel.mp4
* </ul>
*
* <p>Configuration parameters will be retrieved from these sources in the listed order: * *
*
* <ol>
* <li>command line arguments (eg BITMOVIN_API_KEY=xyz)
* <li>properties file located in the root folder of the JAVA examples at ./examples.properties
* (see examples.properties.template as reference)
* <li>environment variables
* <li>properties file located in the home folder at ~/.bitmovin/examples.properties (see
* examples.properties.template as reference)
* </ol>
*/
public class EncodingWithCdnOutput {
private static final Logger logger = LoggerFactory.getLogger(EncodingWithCdnOutput.class);
private static ConfigProvider configProvider;
private static BitmovinApi bitmovinApi;
public static void main(String[] args) throws Exception {
configProvider = new ConfigProvider(args);
bitmovinApi =
BitmovinApi.builder()
.withApiKey(configProvider.getBitmovinApiKey())
// uncomment the following line if you are working with a multi-tenant account
// .withTenantOrgId(configProvider.getBitmovinTenantOrgId())
.withLogger(
new Slf4jLogger(),
feign.Logger.Level.BASIC) // set the logger and log level for the API client
.build();
Encoding encoding =
createEncoding("Encoding with CDN Output", "First encoding with CDN output");
String inputFilePath = configProvider.getHttpInputFilePath();
Input input = createHttpInput(configProvider.getHttpInputHost());
final CdnOutput cdnOutput = getCdnOutput();
// ABR Ladder - H264
List<H264VideoConfiguration> videoConfigurations =
Arrays.asList(
createH264VideoConfig(1280, 720, 3_000_000),
createH264VideoConfig(1280, 720, 4_608_000),
createH264VideoConfig(1920, 1080, 6_144_000),
createH264VideoConfig(1920, 1080, 7_987_200));
// Create video streams and muxings
for (VideoConfiguration videoConfig : videoConfigurations) {
Stream videoStream =
createStream(encoding, input, inputFilePath, videoConfig);
createFmp4Muxing(encoding, cdnOutput, "video/" + videoConfig.getBitrate(), videoStream);
}
// Audio - AAC
List<AacAudioConfiguration> audioConfigurations =
Arrays.asList(createAacAudioConfig(192_000), createAacAudioConfig(64_000));
// create audio streams and muxings
for (AudioConfiguration audioConfig : audioConfigurations) {
Stream audioStream =
createStream(encoding, input, inputFilePath, audioConfig);
createFmp4Muxing(encoding, cdnOutput, "audio/" + audioConfig.getBitrate(), audioStream);
}
DashManifest dashManifest = createDefaultDashManifest(encoding, cdnOutput, "/");
HlsManifest hlsManifest = createDefaultHlsManifest(encoding, cdnOutput, "/");
StartEncodingRequest startEncodingRequest = new StartEncodingRequest();
startEncodingRequest.setManifestGenerator(ManifestGenerator.V2);
startEncodingRequest.addVodDashManifestsItem(buildManifestResource(dashManifest));
startEncodingRequest.addVodHlsManifestsItem(buildManifestResource(hlsManifest));
executeEncoding(encoding, startEncodingRequest);
for (EncodingOutputPaths encodingOutputPath : bitmovinApi.encoding.encodings.outputPaths.get(encoding.getId())) {
for (EncodingOutputPathsDashManifest dm : encodingOutputPath.getPaths().getDashManifests()) {
logger.info("Dash Manifest: https://{}/{}", cdnOutput.getDomainName(), dm.getPath());
}
for (EncodingOutputPathsHlsManifest hm : encodingOutputPath.getPaths().getHlsManifests()) {
logger.info("HLS Manifest: https://{}/{}", cdnOutput.getDomainName(), hm.getPath());
}
}
}
/**
* Creates an Encoding object. This is the base object to configure your encoding.
*
* <p>API endpoint:
* https://bitmovin.com/docs/encoding/api-reference/sections/encodings#/Encoding/PostEncodingEncodings
*
* @param name This is the name of the encoding
* @param description This is the description of the encoding
*/
private static Encoding createEncoding(String name, String description) {
Encoding encoding = new Encoding();
encoding.setName(name);
encoding.setDescription(description);
encoding.setCloudRegion(CloudRegion.AWS_EU_WEST_1);
return bitmovinApi.encoding.encodings.create(encoding);
}
/**
* Creates a resource representing an HTTP server providing the input files. For alternative input
* methods see <a
* href="https://bitmovin.com/docs/encoding/articles/supported-input-output-storages">list of
* supported input and output storages</a>
*
* <p>For reasons of simplicity, a new input resource is created on each execution of this
* example. In production use, this method should be replaced by a <a
* href="https://bitmovin.com/docs/encoding/api-reference/sections/inputs#/Encoding/GetEncodingInputsHttpByInputId">get
* call</a> to retrieve an existing resource.
*
* <p>API endpoint:
* https://bitmovin.com/docs/encoding/api-reference/sections/inputs#/Encoding/PostEncodingInputsHttp
*
* @param host The hostname or IP address of the HTTP server e.g.: my-storage.biz
*/
private static HttpInput createHttpInput(String host) {
HttpInput httpInput = new HttpInput();
httpInput.setHost(host);
return bitmovinApi.encoding.inputs.http.create(httpInput);
}
/**
* Retrieves the singleton CdnOutput resource that exists for every organization
*
* <p>API endpoint:
* https://bitmovin.com/docs/encoding/api-reference/all#/Encoding/GetEncodingOutputsCdn
*/
private static CdnOutput getCdnOutput() {
List<CdnOutput> cdnOutputs = bitmovinApi.encoding.outputs.cdn.list().getItems();
return cdnOutputs.get(0);
}
/**
* Creates a configuration for the AAC audio codec to be applied to audio streams.
*
* <p>API endpoint:
* https://bitmovin.com/docs/encoding/api-reference/sections/configurations#/Encoding/PostEncodingConfigurationsAudioAac
*
* @param bitrate The target bitrate for the encoded audio
*/
private static AacAudioConfiguration createAacAudioConfig(long bitrate) throws BitmovinException {
AacAudioConfiguration config = new AacAudioConfiguration();
config.setName(String.format("AAC Audio @ %d Kbps", Math.round(bitrate / 1000d)));
config.setBitrate(bitrate);
return bitmovinApi.encoding.configurations.audio.aac.create(config);
}
/**
* Creates a fragmented MP4 muxing. This will generate segments with a given segment length for
* adaptive streaming.
*
* <p>API endpoint:
* https://bitmovin.com/docs/encoding/api-reference/all#/Encoding/PostEncodingEncodingsMuxingsFmp4ByEncodingId
*
* @param encoding The encoding where to add the muxing to
* @param output The output that should be used for the muxing to write the segments to
* @param outputPath The output path where the fragmented segments will be written to
* @param stream The stream to be muxed
*/
private static Fmp4Muxing createFmp4Muxing(
Encoding encoding, Output output, String outputPath, Stream stream) throws BitmovinException {
MuxingStream muxingStream = new MuxingStream();
muxingStream.setStreamId(stream.getId());
Fmp4Muxing muxing = new Fmp4Muxing();
muxing.addOutputsItem(buildEncodingOutput(output, outputPath));
muxing.addStreamsItem(muxingStream);
muxing.setSegmentLength(4.0);
return bitmovinApi.encoding.encodings.muxings.fmp4.create(encoding.getId(), muxing);
}
/**
* Create a stream which binds an input file to a codec configuration. The stream is used later
* for muxings.
*
* <p>API endpoint:
* https://bitmovin.com/docs/encoding/api-reference/sections/encodings#/Encoding/PostEncodingEncodingsStreamsByEncodingId
*
* @param encoding The encoding where to add the stream to
* @param input The input where the input file is located
* @param inputPath The path to the input file
* @param codecConfiguration The codec configuration to be applied to the stream
*/
private static Stream createStream(
Encoding encoding, Input input, String inputPath, CodecConfiguration codecConfiguration)
throws BitmovinException {
StreamInput streamInput = new StreamInput();
streamInput.setInputId(input.getId());
streamInput.setInputPath(inputPath);
streamInput.setSelectionMode(StreamSelectionMode.AUTO);
Stream stream = new Stream();
stream.addInputStreamsItem(streamInput);
stream.setCodecConfigId(codecConfiguration.getId());
return bitmovinApi.encoding.encodings.streams.create(encoding.getId(), stream);
}
/**
* Creates a DASH default manifest that automatically includes all representations configured in
* the encoding.
*
* <p>API endpoint:
* https://bitmovin.com/docs/encoding/api-reference/sections/manifests#/Encoding/PostEncodingManifestsDashDefault
*
* @param encoding The encoding for which the manifest should be generated
* @param output The output to which the manifest should be written
* @param outputPath The path to which the manifest should be written
*/
private static DashManifest createDefaultDashManifest(
Encoding encoding, Output output, String outputPath) {
DashManifestDefault dashManifestDefault = new DashManifestDefault();
dashManifestDefault.setEncodingId(encoding.getId());
dashManifestDefault.setManifestName("stream.mpd");
dashManifestDefault.setVersion(DashManifestDefaultVersion.V1);
dashManifestDefault.addOutputsItem(buildEncodingOutput(output, outputPath));
return bitmovinApi.encoding.manifests.dash.defaultapi.create(dashManifestDefault);
}
/**
* Creates an HLS default manifest that automatically includes all representations configured in
* the encoding.
*
* <p>API endpoint:
* https://bitmovin.com/docs/encoding/api-reference/sections/manifests#/Encoding/PostEncodingManifestsHlsDefault
*
* @param encoding The encoding for which the manifest should be generated
* @param output The output to which the manifest should be written
* @param outputPath The path to which the manifest should be written
*/
private static HlsManifest createDefaultHlsManifest(
Encoding encoding, Output output, String outputPath) {
HlsManifestDefault hlsManifestDefault = new HlsManifestDefault();
hlsManifestDefault.setEncodingId(encoding.getId());
hlsManifestDefault.addOutputsItem(buildEncodingOutput(output, outputPath));
hlsManifestDefault.setName("index.m3u8");
hlsManifestDefault.setVersion(HlsManifestDefaultVersion.V1);
return bitmovinApi.encoding.manifests.hls.defaultapi.create(hlsManifestDefault);
}
/**
* Wraps a manifest ID into a ManifestResource object, so it can be referenced in one of the
* StartEncodingRequest manifest lists.
*
* @param manifest The manifest to be generated at the end of the encoding process
*/
private static ManifestResource buildManifestResource(Manifest manifest) {
ManifestResource manifestResource = new ManifestResource();
manifestResource.setManifestId(manifest.getId());
return manifestResource;
}
/**
* Creates a configuration for the H.264 video codec to be applied to video streams.
*
* <p>The output resolution is defined by setting the height to 1080 pixels. Width will be
* determined automatically to maintain the aspect ratio of your input video.
*
* <p>To keep things simple, we use a quality-optimized VoD preset configuration, which will apply
* proven settings for the codec. See <a
* href="https://bitmovin.com/docs/encoding/tutorials/how-to-optimize-your-h264-codec-configuration-for-different-use-cases">How
* to optimize your H264 codec configuration for different use-cases</a> for alternative presets.
*
* <p>API endpoint:
* https://bitmovin.com/docs/encoding/api-reference/sections/configurations#/Encoding/PostEncodingConfigurationsVideoH264
*
* @param width The width of the output video
* @param height The height of the output video
* @param bitrate The target bitrate of the output video
*/
private static H264VideoConfiguration createH264VideoConfig(int width, int height, long bitrate)
throws BitmovinException {
H264VideoConfiguration config = new H264VideoConfiguration();
config.setName(String.format("H.264 %d %d Kbit/s", height, Math.round(bitrate / 1000d)));
config.setPresetConfiguration(PresetConfiguration.VOD_STANDARD);
config.setHeight(height);
config.setWidth(width);
config.setBitrate(bitrate);
return bitmovinApi.encoding.configurations.video.h264.create(config);
}
/**
* Builds an EncodingOutput object which defines where the output content (e.g. of a muxing) will
* be written to.
*
* @param output The output resource to be used by the EncodingOutput
* @param outputPath The path where the content will be written to
*/
private static EncodingOutput buildEncodingOutput(Output output, String outputPath) {
EncodingOutput encodingOutput = new EncodingOutput();
encodingOutput.setOutputPath(outputPath);
encodingOutput.setOutputId(output.getId());
return encodingOutput;
}
/**
* Starts the actual encoding process and periodically polls its status until it reaches a final
* state
*
* <p>API endpoints:
* https://bitmovin.com/docs/encoding/api-reference/all#/Encoding/PostEncodingEncodingsStartByEncodingId
* https://bitmovin.com/docs/encoding/api-reference/sections/encodings#/Encoding/GetEncodingEncodingsStatusByEncodingId
*
* <p>Please note that you can also use our webhooks API instead of polling the status. For more
* information consult the API spec:
* https://bitmovin.com/docs/encoding/api-reference/sections/notifications-webhooks
*
* @param encoding The encoding to be started
* @param startEncodingRequest The request object to be sent with the start call
*/
private static void executeEncoding(Encoding encoding, StartEncodingRequest startEncodingRequest)
throws InterruptedException, BitmovinException {
bitmovinApi.encoding.encodings.start(encoding.getId(), startEncodingRequest);
Task task;
do {
Thread.sleep(5000);
task = bitmovinApi.encoding.encodings.status(encoding.getId());
logger.info("Encoding status is {} (progress: {} %)", task.getStatus(), task.getProgress());
} while (task.getStatus() != Status.FINISHED
&& task.getStatus() != Status.ERROR
&& task.getStatus() != Status.CANCELED);
if (task.getStatus() == Status.ERROR) {
logTaskErrors(task);
throw new RuntimeException("Encoding failed");
}
logger.info("Encoding finished successfully");
}
private static void logTaskErrors(Task task) {
task.getMessages().stream()
.filter(msg -> msg.getType() == MessageType.ERROR)
.forEach(msg -> logger.error(msg.getText()));
}
}