-
Notifications
You must be signed in to change notification settings - Fork 27
/
StreamMappingMonoInputTracks.ts
528 lines (472 loc) · 18.6 KB
/
StreamMappingMonoInputTracks.ts
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
import ConfigProvider from '../../common/ConfigProvider';
import {join} from 'path';
import BitmovinApi, {
AacAudioConfiguration,
AclEntry,
AclPermission,
AudioMixChannelType,
AudioMixInputChannelLayout,
AudioMixInputStream,
AudioMixInputStreamChannel,
AudioMixInputStreamSourceChannel,
AudioMixSourceChannelType,
CodecConfiguration,
ConsoleLogger,
DolbyDigitalAudioConfiguration,
DolbyDigitalChannelLayout,
Encoding,
EncodingOutput,
H264VideoConfiguration,
HttpInput,
IngestInputStream,
Input,
InputStream,
MessageType,
Mp4Muxing,
MuxingStream,
Output,
PresetConfiguration,
S3Output,
Status,
Stream,
StreamInput,
StreamSelectionMode,
Task,
} from '@bitmovin/api-sdk';
/**
* This example demonstrates one mechanism to create a stereo and surround audio track in the output
* from multiple mono input tracks, using multiple IngestInputStreams (by position in the source),
* and mapping them to output channels (by type).
*
* <p>This example illustrates one of the use cases in the [tutorial on audio manipulations]
* (https://bitmovin.com/docs/encoding/tutorials/separating-and-combining-audio-streams)
*
* <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_MULTIPLE_MONO_AUDIO_TRACKS - the path to a file containing a video
* with multiple mono audio tracks
* <li>S3_OUTPUT_BUCKET_NAME - The name of your S3 output bucket. Example: my-bucket-name
* <li>S3_OUTPUT_ACCESS_KEY - The access key of your S3 output bucket
* <li>S3_OUTPUT_SECRET_KEY - The secret key of your S3 output bucket
* <li>S3_OUTPUT_BASE_PATH - The base path on your S3 output bucket where content will be written.
* Example: /outputs
* </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>
*/
const exampleName = 'StreamMappingMonoInputTracks';
const configProvider: ConfigProvider = new ConfigProvider();
const bitmovinApi: BitmovinApi = new BitmovinApi({
apiKey: configProvider.getBitmovinApiKey(),
// uncomment the following line if you are working with a multi-tenant account
// tenantOrgId: configProvider.getBitmovinTenantOrgId(),
logger: new ConsoleLogger(),
});
/** Helper classes representing the mapping from source channels to output channels */
class ChannelMappingConfig {
outputChannelType: AudioMixChannelType;
sourceChannelNumber: number;
constructor(outputChannelType: AudioMixChannelType, sourceChannelNumber: number) {
this.outputChannelType = outputChannelType;
this.sourceChannelNumber = sourceChannelNumber;
}
}
async function main() {
const encoding = await createEncoding(
'Audio Mapping - Stream Mapping - Multiple Mono Tracks',
'Input with multiple mono tracks -> Output with stereo and surround tracks'
);
const input = await createHttpInput(configProvider.getHttpInputHost());
const output = await createS3Output(
configProvider.getS3OutputBucketName(),
configProvider.getS3OutputAccessKey(),
configProvider.getS3OutputSecretKey()
);
const h264Config = await createH264VideoConfig();
const aacConfig = await createAacStereoAudioConfig();
const ddConfig = await createDdSurroundAudioConfig();
const inputFilePath = configProvider.getHttpInputFilePathWithMultipleMonoAudioTracks();
const videoIngestInputStream = await createIngestInputStream(encoding, input, inputFilePath);
const stereoMap = [
new ChannelMappingConfig(AudioMixChannelType.FRONT_LEFT, 0),
new ChannelMappingConfig(AudioMixChannelType.FRONT_RIGHT, 1),
];
const surroundMap = [
new ChannelMappingConfig(AudioMixChannelType.FRONT_LEFT, 2),
new ChannelMappingConfig(AudioMixChannelType.FRONT_RIGHT, 3),
new ChannelMappingConfig(AudioMixChannelType.BACK_LEFT, 4),
new ChannelMappingConfig(AudioMixChannelType.BACK_RIGHT, 5),
new ChannelMappingConfig(AudioMixChannelType.CENTER, 6),
new ChannelMappingConfig(AudioMixChannelType.LOW_FREQUENCY, 7),
];
const stereoMixInputStream = await createAudioMixInputStream(
encoding,
input,
inputFilePath,
AudioMixInputChannelLayout.CL_STEREO,
stereoMap
);
const surroundMixInputStream = await createAudioMixInputStream(
encoding,
input,
inputFilePath,
AudioMixInputChannelLayout.CL_5_1_BACK,
surroundMap
);
const videoStream = await createStream(encoding, videoIngestInputStream, h264Config);
const audioStream1 = await createStream(encoding, stereoMixInputStream, aacConfig);
const audioStream2 = await createStream(encoding, surroundMixInputStream, ddConfig);
await createMp4Muxing(
encoding,
output,
'/',
[videoStream, audioStream1, audioStream2],
'stereo-and-surround-tracks-mapped.mp4'
);
await executeEncoding(encoding);
}
/**
* 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 A name that will help you identify the encoding in our dashboard (required)
* @param description A description of the encoding (optional)
*/
function createEncoding(name: string, description: string): Promise<Encoding> {
const encoding = new Encoding({
name: name,
description: description,
});
return bitmovinApi.encoding.encodings.create(encoding);
}
/**
* Creates an IngestInputStream and adds it to an encoding
*
* <p>The IngestInputStream is used to define where a file to read a stream from is located
*
* <p>API endpoint:
* https://bitmovin.com/docs/encoding/api-reference/sections/encodings#/Encoding/PostEncodingEncodingsInputStreamsIngestByEncodingId
*
* @param encoding The encoding to which the stream will be added
* @param input The input resource providing the input file
* @param inputPath The path to the input file
*/
function createIngestInputStream(encoding: Encoding, input: Input, inputPath: string): Promise<IngestInputStream> {
const ingestInputStream = new IngestInputStream({
inputId: input.id,
inputPath: inputPath,
selectionMode: StreamSelectionMode.AUTO,
});
return bitmovinApi.encoding.encodings.inputStreams.ingest.create(encoding.id!, ingestInputStream);
}
/**
* Creates an IngestInputStream to select a specific audio strack in the input, and adds it to an
* encoding
*
* <p>The IngestInputStream is used to define where a file to read a stream from is located
*
* <p>API endpoint:
* https://bitmovin.com/docs/encoding/api-reference/sections/encodings#/Encoding/PostEncodingEncodingsInputStreamsIngestByEncodingId
*
* @param encoding The encoding to which the stream will be added
* @param input The input resource providing the input file
* @param inputPath The path to the input file
* @param position The relative position of the audio track to select in the input file
*/
function createIngestInputStreamForAudioTrack(
encoding: Encoding,
input: Input,
inputPath: string,
position: number
): Promise<IngestInputStream> {
const ingestInputStream = new IngestInputStream({
inputId: input.id,
inputPath: inputPath,
selectionMode: StreamSelectionMode.AUDIO_RELATIVE,
position: position,
});
return bitmovinApi.encoding.encodings.inputStreams.ingest.create(encoding.id!, ingestInputStream);
}
/**
* Adds an audio stream to an encoding, by remixing multiple channels from a source input stream
*
* <p>API endpoint:
* https://bitmovin.com/docs/encoding/api-reference/sections/encodings#/Encoding/PostEncodingEncodingsInputStreamsAudioMixByEncodingId
*
* @param encoding The encoding to which the stream will be added
* @param input The input resource providing the input file
* @param inputFilePath The path to the input file
* @param mappingConfigs The configuration of the mapping of source channels to output channels
*/
async function createAudioMixInputStream(
encoding: Encoding,
input: Input,
inputFilePath: string,
channelLayout: AudioMixInputChannelLayout,
mappingConfigs: ChannelMappingConfig[]
): Promise<AudioMixInputStream> {
const audioMixInputStream = new AudioMixInputStream({channelLayout: channelLayout});
for (const mappingConfig of mappingConfigs) {
const audioIngestInputStream = await createIngestInputStreamForAudioTrack(
encoding,
input,
inputFilePath,
mappingConfig.sourceChannelNumber
);
const outputChannel = new AudioMixInputStreamChannel({
inputStreamId: audioIngestInputStream.id,
outputChannelType: mappingConfig.outputChannelType,
});
const sourceChannel = new AudioMixInputStreamSourceChannel({
type: AudioMixSourceChannelType.CHANNEL_NUMBER,
channelNumber: 0,
});
outputChannel.sourceChannels?.push(sourceChannel);
audioMixInputStream.audioMixChannels?.push(outputChannel);
}
return bitmovinApi.encoding.encodings.inputStreams.audioMix.create(encoding.id!, audioMixInputStream);
}
/**
* Adds a video or audio stream to an encoding
*
* <p>API endpoint:
* https://bitmovin.com/docs/encoding/api-reference/sections/encodings#/Encoding/PostEncodingEncodingsStreamsByEncodingId
*
* @param encoding The encoding to which the stream will be added
* @param inputStream The inputStream resource providing the input file
* @param codecConfiguration The codec configuration to be applied to the stream
*/
function createStream(
encoding: Encoding,
inputStream: InputStream,
codecConfiguration: CodecConfiguration
): Promise<Stream> {
const streamInput = new StreamInput({
inputStreamId: inputStream.id,
});
const stream = new Stream({
inputStreams: [streamInput],
codecConfigId: codecConfiguration.id,
});
return bitmovinApi.encoding.encodings.streams.create(encoding.id!, stream);
}
/**
* Creates a resource representing an AWS S3 cloud storage bucket to which generated content will
* be transferred. For alternative output methods see <a
* href="https://bitmovin.com/docs/encoding/articles/supported-input-output-storages">list of
* supported input and output storages</a>
*
* <p>The provided credentials need to allow <i>read</i>, <i>write</i> and <i>list</i> operations.
* <i>delete</i> should also be granted to allow overwriting of existings files. See <a
* href="https://bitmovin.com/docs/encoding/faqs/how-do-i-create-a-aws-s3-bucket-which-can-be-used-as-output-location">creating
* an S3 bucket and setting permissions</a> for further information
*
* <p>For reasons of simplicity, a new output 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/outputs#/Encoding/GetEncodingOutputsS3">get
* call</a> retrieving an existing resource.
*
* <p>API endpoint:
* https://bitmovin.com/docs/encoding/api-reference/sections/outputs#/Encoding/PostEncodingOutputsS3
*
* @param bucketName The name of the S3 bucket
* @param accessKey The access key of your S3 account
* @param secretKey The secret key of your S3 account
*/
function createS3Output(bucketName: string, accessKey: string, secretKey: string): Promise<S3Output> {
const s3Output = new S3Output({
bucketName: bucketName,
accessKey: accessKey,
secretKey: secretKey,
});
return bitmovinApi.encoding.outputs.s3.create(s3Output);
}
/**
* 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
*/
function createHttpInput(host: string): Promise<HttpInput> {
const input = new HttpInput({
host: host,
});
return bitmovinApi.encoding.inputs.http.create(input);
}
/**
* 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
*/
function createH264VideoConfig(): Promise<H264VideoConfiguration> {
const config = new H264VideoConfiguration({
name: 'H.264 1080p 1.5 Mbit/s',
presetConfiguration: PresetConfiguration.VOD_STANDARD,
height: 1080,
bitrate: 1500000,
});
return bitmovinApi.encoding.configurations.video.h264.create(config);
}
/**
* 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
*/
function createAacStereoAudioConfig(): Promise<AacAudioConfiguration> {
const config = new AacAudioConfiguration({
name: 'AAC 128 kbit/s',
bitrate: 128000,
});
return bitmovinApi.encoding.configurations.audio.aac.create(config);
}
/**
* Creates a Dolby Digital audio configuration.
*
* <p>API endpoint:
* https://bitmovin.com/docs/encoding/api-reference/sections/configurations#/Encoding/PostEncodingConfigurationsAudioDD
*/
function createDdSurroundAudioConfig(): Promise<DolbyDigitalAudioConfiguration> {
const config = new DolbyDigitalAudioConfiguration({
name: 'Dolby Digital Channel Layout 5.1',
bitrate: 256000,
channelLayout: DolbyDigitalChannelLayout.CL_5_1,
});
return bitmovinApi.encoding.configurations.audio.dolbyDigital.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 streams A list of streams to be added to the muxing
* @param fileName The name of the file that will be written to the output
*/
function createMp4Muxing(
encoding: Encoding,
output: Output,
outputPath: string,
streams: Stream[],
fileName: string
): Promise<Mp4Muxing> {
const muxing = new Mp4Muxing({
outputs: [buildEncodingOutput(output, outputPath)],
filename: fileName,
});
for (const stream of streams) {
const muxingStream = new MuxingStream({
streamId: stream.id,
});
muxing.streams?.push(muxingStream);
}
return bitmovinApi.encoding.encodings.muxings.mp4.create(encoding.id!, muxing);
}
/**
* Builds an EncodingOutput object which defines where the output content (e.g. of a muxing) will
* be written to. Public read permissions will be set for the files written, so they can be
* accessed easily via HTTP.
*
* @param output The output resource to be used by the EncodingOutput
* @param outputPath The path where the content will be written to
*/
function buildEncodingOutput(output: Output, outputPath: string): EncodingOutput {
const aclEntry = new AclEntry({
permission: AclPermission.PUBLIC_READ,
});
return new EncodingOutput({
outputPath: buildAbsolutePath(outputPath),
outputId: output.id,
acl: [aclEntry],
});
}
/**
* Builds an absolute path by concatenating the S3_OUTPUT_BASE_PATH configuration parameter, the
* name of this example and the given relative path
*
* <p>e.g.: /s3/base/path/exampleName/relative/path
*
* @param relativePath The relative path that is concatenated
* @return The absolute path
*/
function buildAbsolutePath(relativePath: string): string {
return join(configProvider.getS3OutputBasePath(), exampleName, relativePath);
}
/**
* 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
*/
async function executeEncoding(encoding: Encoding): Promise<void> {
await bitmovinApi.encoding.encodings.start(encoding.id!);
let task: Task;
do {
await timeout(5000);
task = await bitmovinApi.encoding.encodings.status(encoding.id!);
console.log(`Encoding status is ${task.status} (progress: ${task.progress} %)`);
} while (task.status !== Status.FINISHED && task.status !== Status.ERROR);
if (task.status === Status.ERROR) {
logTaskErrors(task);
throw new Error('Encoding failed');
}
console.log('Encoding finished successfully');
}
function logTaskErrors(task: Task): void {
if (task.messages == undefined) {
return;
}
task.messages!.filter((msg) => msg.type === MessageType.ERROR).forEach((msg) => console.error(msg.text));
}
function timeout(ms: number): Promise<void> {
return new Promise((resolve) => setTimeout(resolve, ms));
}
main();