com.ibm.watson.developer_cloud.android.library.audio

Class AudioFileWriter

java.lang.Object

com.ibm.watson.developer_cloud.android.library.audio.AudioFileWriter

Direct Known Subclasses:

OpusWriter

public abstract class AudioFileWriter
extends Object

Abstract Class that defines an Audio File Writer.

Constructor Summary

Constructors

Constructor and Description
AudioFileWriter()

Method Summary

Modifier and Type	Method and Description
static byte[]	buildOggPageHeader(int headerType, long granulepos, int streamSerialNumber, int pageCount, int packetCount, byte[] packetSizes) Builds and returns an Ogg Page Header.
static byte[]	buildOpusComment(String comment) Builds and returns a Opus Comment.
static byte[]	buildOpusHeader(int sampleRate) Builds a Opus Header.
abstract void	close() Closes the output file.
abstract void	open(File file) Open the output file.
abstract void	open(String filename) Open the output file.
abstract void	writeHeader(String comment) Writes the header pages that start the Ogg Opus file.
static void	writeInt(byte[] data, int offset, int v) Writes a Little-endian int.
static void	writeInt(DataOutput out, int v) Writes a Little-endian int.
static void	writeInt(OutputStream os, int v) Writes a Little-endian int.
static void	writeLong(byte[] data, int offset, long v) Writes a Little-endian long.
static void	writeLong(OutputStream os, long v) Writes a Little-endian long.
static int	writeOggPageHeader(byte[] buf, int offset, int headerType, long granulepos, int streamSerialNumber, int pageCount, int packetCount, byte[] packetSizes) Writes an Ogg Page Header to the given byte array.
static void	writeOpusComment(byte[] buf, int offset, String comment) Writes a Opus Comment to the given byte array.
static void	writeOpusHeader(byte[] buf, int offset, int sampleRate) Write Opus header.
abstract void	writePacket(byte[] data, int offset, int len) Writes a packet of audio.
static void	writeShort(byte[] data, int offset, int v) Writes a Little-endian short.
static void	writeShort(DataOutput out, short v) Writes a Little-endian short.
static void	writeShort(OutputStream os, short v) Writes a Little-endian short.
static void	writeString(byte[] data, int offset, String v) Writes a String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AudioFileWriter

public AudioFileWriter()

Method Detail

writeOggPageHeader

public static int writeOggPageHeader(byte[] buf,
                                     int offset,
                                     int headerType,
                                     long granulepos,
                                     int streamSerialNumber,
                                     int pageCount,
                                     int packetCount,
                                     byte[] packetSizes)

Writes an Ogg Page Header to the given byte array.

Parameters:

buf - the buffer to write to.

offset - the from which to start writing.

headerType - the header type flag (0=normal, 2=bos: beginning of stream, 4=eos: end of stream).

granulepos - the absolute granule position.

streamSerialNumber - the stream serial number

pageCount - the page count

packetCount - the packet count

packetSizes - the packet sizes

Returns:

the amount of data written to the buffer.

buildOggPageHeader

public static byte[] buildOggPageHeader(int headerType,
                                        long granulepos,
                                        int streamSerialNumber,
                                        int pageCount,
                                        int packetCount,
                                        byte[] packetSizes)

Builds and returns an Ogg Page Header.

Parameters:

headerType - the header type flag (0=normal, 2=bos: beginning of stream, 4=eos: end of stream).

granulepos - the absolute granule position.

streamSerialNumber - the stream serial number

pageCount - the page count

packetCount - the packet count

packetSizes - the packet sizes

Returns:

an Ogg Page Header.

buildOpusHeader

public static byte[] buildOpusHeader(int sampleRate)

Builds a Opus Header.

Parameters:

sampleRate - the sample rate

Returns:

Opus Header data

writeOpusHeader

public static void writeOpusHeader(byte[] buf,
                                   int offset,
                                   int sampleRate)

Write Opus header. See more info on Opus decoding.

Parameters:

buf - the buf

offset - the offset

sampleRate - the sample rate

writeOpusComment

public static void writeOpusComment(byte[] buf,
                                    int offset,
                                    String comment)

Writes a Opus Comment to the given byte array.

Parameters:

buf - the buffer to write to.

offset - the from which to start writing.

comment - the comment.

buildOpusComment

public static byte[] buildOpusComment(String comment)

Builds and returns a Opus Comment.

Parameters:

comment - the comment.

Returns:

a Opus Comment.

writeShort

public static void writeShort(DataOutput out,
                              short v)
                       throws IOException

Writes a Little-endian short.

Parameters:

out - the data output to write to.

v - value to write.

Throws:

IOException - Signals that an I/O exception has occurred.

writeInt

public static void writeInt(DataOutput out,
                            int v)
                     throws IOException

Writes a Little-endian int.

Parameters:

out - the data output to write to.

v - value to write.

Throws:

IOException - Signals that an I/O exception has occurred.

writeShort

public static void writeShort(OutputStream os,
                              short v)
                       throws IOException

Writes a Little-endian short.

Parameters:

os - - the output stream to write to.

v - - the value to write.

Throws:

IOException - Signals that an I/O exception has occurred.

writeInt

public static void writeInt(OutputStream os,
                            int v)
                     throws IOException

Writes a Little-endian int.

Parameters:

os - - the output stream to write to.

v - - the value to write.

Throws:

IOException - Signals that an I/O exception has occurred.

writeLong

public static void writeLong(OutputStream os,
                             long v)
                      throws IOException

Writes a Little-endian long.

Parameters:

os - - the output stream to write to.

v - - the value to write.

Throws:

IOException - Signals that an I/O exception has occurred.

writeShort

public static void writeShort(byte[] data,
                              int offset,
                              int v)

Writes a Little-endian short.

Parameters:

data - the array into which the data should be written.

offset - the offset from which to start writing in the array.

v - the value to write.

writeInt

public static void writeInt(byte[] data,
                            int offset,
                            int v)

Writes a Little-endian int.

Parameters:

data - the array into which the data should be written.

offset - the offset from which to start writing in the array.

v - the value to write.

writeLong

public static void writeLong(byte[] data,
                             int offset,
                             long v)

Writes a Little-endian long.

Parameters:

data - the array into which the data should be written.

offset - the offset from which to start writing in the array.

v - the value to write.

writeString

public static void writeString(byte[] data,
                               int offset,
                               String v)

Writes a String.

Parameters:

data - the array into which the data should be written.

offset - the offset from which to start writing in the array.

v - the value to write.

close

public abstract void close()
                    throws IOException

Closes the output file.

Throws:

IOException - if there was an exception closing the Audio Writer.

open

public abstract void open(File file)
                   throws IOException

Open the output file.

Parameters:

file - - file to open.

Throws:

IOException - if there was an exception opening the Audio Writer.

open

public abstract void open(String filename)
                   throws IOException

Open the output file.

Parameters:

filename - - file to open.

Throws:

IOException - if there was an exception opening the Audio Writer.

writeHeader

public abstract void writeHeader(String comment)
                          throws IOException

Writes the header pages that start the Ogg Opus file. Prepares file for data to be written.

Parameters:

comment - description to be included in the header.

Throws:

IOException - Signals that an I/O exception has occurred.

writePacket

public abstract void writePacket(byte[] data,
                                 int offset,
                                 int len)
                          throws IOException

Writes a packet of audio.

Parameters:

data - audio data

offset - the offset from which to start reading the data.

len - the length of data to read.

Throws:

IOException - Signals that an I/O exception has occurred.