ADC Home > Reference Library > Reference > Audio > Carbon > Disc Recording Framework Reference
|
DRCoreTrack.h |
Includes: | <CoreServices/CoreServices.h> <DiscRecording/DRCoreDevice.h> <DiscRecording/DRCoreObject.h> <AvailabilityMacros.h> |
Track object interfaces for Disc Recording.
DRTrackCreate |
Creates a new track object.
extern DRTrackRef DRTrackCreate( CFDictionaryRef properties, DRTrackCallbackProc callback) ;
properties
callback
A reference to the new DRTrack object.
DRTrackEstimateLength |
Asks the track producer for a block size estimate.
extern UInt64 DRTrackEstimateLength( DRTrackRef track) ;
track
The size of the track in blocks.
This function calls the track producer to ask it to estimate the block size
needed for its data. This call is passed through to the DRTrackCallbackProc
track production callback as kDRTrackMessageEstimateLength .
For some types of tracks, this call may be very expensive. For example,
a file system track (DRFilesystemTrack ) may need to iterate through folders
on disk to provide an accurate estimate. If a large number of files and folders
are involved, this call may take 30 seconds or more. Since your
main thread should not block for this long, you may wish to call this
function on a separate thread.
The return value is the size in blocks that is specified in the
track's properties dictionary.
DRTrackGetProperties |
Returns the properties of the track.
extern CFDictionaryRef DRTrackGetProperties( DRTrackRef track) ;
track
A CFMutableDictionary object containing the track properties.
DRTrackGetTypeID |
Returns the Core Foundation type identifier of all DRTrack instances.
extern CFTypeID DRTrackGetTypeID( void) ;
DRTrackSetProperties |
Sets the properties of the track.
extern void DRTrackSetProperties( DRTrackRef track, CFDictionaryRef properties) ;
track
properties
DRTrackSpeedTest |
Tests the speed at which data can be produced.
extern float DRTrackSpeedTest( DRTrackRef track, UInt32 howManyMilliseconds, UInt32 howManyBytes) ;
track
howManyMilliseconds
howManyBytes
The maximum throughput obtained during the test cycle.
Runs a test track-production cycle, calling the produceData callback for the specified
number of milliseconds or until the specified number of bytes have been
produced, whichever comes first.
Use this function to verify that the produceData callback can produce data fast
enough to satisfy the data throughput requirements of the burn.
This function will automatically set a value for the kDRMaxBurnSpeedKey key in the track's
properties dictionary, with a value equal to the return result.
kDRAudioFourChannelKey |
extern const CFStringRef kDRAudioFourChannelKey;
Optional key. For CD-DA audio tracks only. This track property key corresponds to a CFBoolean
value indicating whether the track data has four channels, as opposed to the
two channels of normal stereo. If this key is not present, the engine
will use a default value of false and standard two-channel stereo
is assumed.
Four-channel audio is supported in the Red Book standard but never
caught on. It is probably being replaced by SACD, so you probably shouldn't
attempt to use it.
On the disc, this key corresponds to bit 3 of the control field in
sub-channel Q.
kDRAudioPreEmphasisKey |
extern const CFStringRef kDRAudioPreEmphasisKey;
Optional key. For CD-DA audio tracks only. This track property key corresponds to a CFBoolean value indicating whether the track includes pre-emphasis of 50/15 microseconds. If this key is not present, the engine will use a default value of false. On the disc, this key corresponds to bit 0 of the control field in sub-channel Q.
kDRBlockSizeKey |
extern const CFStringRef kDRBlockSizeKey;
Required key. This key corresponds to a CFNumber object containing the size of each block of the track. Common values are defined in the Block Sizes enumeration.
kDRBlockTypeKey |
extern const CFStringRef kDRBlockTypeKey;
Required key. This key corresponds to a CFNumber object containing the type of each block of the track. Common values are defined in the Block Types enumeration.
kDRBufferZone1DataKey |
extern const CFStringRef kDRBufferZone1DataKey;
Optional key. This track property key corresponds to a CFData object containing the data to write to Buffer Zone 1 on drives which support it, such as the Pioneer DVR-S201. This data will be sent directly to the drive. If this key is not present, no Buffer Zone 1 data will be sent.
kDRBurnKey |
extern const CFStringRef kDRBurnKey;
This key corresponds to the DRBurn object for which the PreBurn message applies.
kDRDataFormKey |
extern const CFStringRef kDRDataFormKey;
Required key. This key corresponds to a CFNumber object containing the data format of each block of the track. Common values are defined in the Data Forms enumeration.
kDRDVDCopyrightInfoKey |
extern const CFStringRef kDRDVDCopyrightInfoKey;
Optional key. This track property key corresponds to a CFData object containing Multi-Media Command (MMC) copyright data. This data will be sent directly to the drive. If this key is not present, no copyright information will be sent.
kDRDVDTimestampKey |
extern const CFStringRef kDRDVDTimestampKey;
Optional key. This track property key corresponds to a CFData object containing Multi-Media Command (MMC) timestamp data. This data will be sent directly to the drive. If this key is not present, no timestamp will be sent.
kDRFreeBlocksKey |
extern const CFStringRef kDRFreeBlocksKey;
This key corresponds to a CFNumber object containing the length, in blocks, which is still available in a writable track.
kDRIndexPointsKey |
extern const CFStringRef kDRIndexPointsKey;
Optional key. For CD tracks only. This track property key corresponds to a CFArray object
containing CFNumber objects describing index points within the track. Each
index point is specified as a number of blocks, equivalent to frames, relative
to the start of the track. There are 75 blocks in one second of CD audio. No
more than 98 index points may be specified for a track.
Not all drives can write index points, and not all consumer CD players report or
use them. If this key is present in any track and the drive cannot write index
points, the burn will fail with a return value of kDRDeviceCantWriteIndexPointsErr .
kDRMaxBurnSpeedKey |
extern const CFStringRef kDRMaxBurnSpeedKey;
Optional key. This track property key corresponds to a CFNumber object containing
the maximum sustained rate at which your application will request data from the
track callback, in units of kilobytes per second where 1 kilobyte = 1,000 bytes.
The value for kDRMaxBurnSpeedKey must be greater than the drive's minimum burn
speed. It is usually safe to specify the appropriate flavor of 1x
(kDRDeviceBurnSpeedCD1x or kDRDeviceBurnSpeedDVD1x ), but some drives cannot slow
all the way down to 1x.
Given the capabilities of the drive, the bus, and the recordable disc, the burn speed used
when writing a layout will generally be the highest data rate possible that is less
than or equal to the value of kDRMaxBurnSpeedKey for every track, as well as less
than or equal to the value of the kDRBurnRequestedSpeedKey key for the burn object.
When this key is not present, the requested maximum sustained data rate defaults
to a value of infinity. In this case, the Disc Recording engine assumes that your
track callback can produce data at any rate requested.
kDRNextWritableAddressKey |
extern const CFStringRef kDRNextWritableAddressKey;
This key corresponds to a CFNumber object containing the Logical Block Address (LBA) of the next writable address in the track. This key is not present in closed tracks.
kDRPreGapIsRequiredKey |
extern const CFStringRef kDRPreGapIsRequiredKey;
Optional key. This track property key corresponds to a CFBoolean object indicating whether
the pregap listed for the track is required. If this key is not present,
the track will behave as though the key were false.
If this key's value is set to true and the device does
not support the exact pregap length, the burn
will fail with a return value of .
If this key's value is set to false and the device does
not support the suggested pregap length, the engine
will choose an alternate pregap length.
kDRPreGapLengthKey |
extern const CFStringRef kDRPreGapLengthKey;
Optional key. This track property key corresponds to a CFNumber object containing the length in blocks of empty space, or pregap, to be recorded before the track. If this key is not present the Disc Recording engine will assume a 2 second, or 150 block, pregap.
kDRSCMSCopyrightFree |
extern const CFStringRef kDRSCMSCopyrightFree;
One value for the kDRSerialCopyManagementStateKey dictionary key. This value indicates that the track has no copying restrictions. Copies of this track should also be copyright free.
kDRSCMSCopyrightProtectedCopy |
extern const CFStringRef kDRSCMSCopyrightProtectedCopy;
One value for the kDRSerialCopyManagementStateKey dictionary key. This value indicates that the track is a first-generation copy of an original that was subject to copy protection. No further digital copying should be allowed.
kDRSCMSCopyrightProtectedOriginal |
extern const CFStringRef kDRSCMSCopyrightProtectedOriginal;
One value for the kDRSerialCopyManagementStateKey dictionary key. This value indicates that the track is an original subject to copyright protection. Digital copying of this track should be allowed, but copies should be marked with appropriate Serial Copy Management System (SCMS) data.
kDRSerialCopyManagementStateKey |
extern const CFStringRef kDRSerialCopyManagementStateKey;
Optional key. For CD tracks only. This track property key corresponds to a CFString value
indicating the Serial Copy Management System (SCMS) state of the track. If
this key is not present, no SCMS data is written.
Not all drives are capable of writing SCMS data. If this key is present in any
track and the drive cannot write SCMS, the burn will fail with a return value
of kDRDeviceCantWriteSCMSErr .
kDRSessionFormatKey |
extern const CFStringRef kDRSessionFormatKey;
Required key. This key corresponds to a CFNumber object containing the session format of the track. Common values are defined in the Session Mode enumeration.
kDRSessionNumberKey |
extern const CFStringRef kDRSessionNumberKey;
This key corresponds to a CFNumber object containing the physical session number of a track.
kDRSubchannelDataFormKey |
extern const CFStringRef kDRSubchannelDataFormKey;
The property whose value is the data mode of the subchannel data sent to the drive.
If this key is not present, the track will default to a value of DRSubchannelDataFormNone
and no subchannel information will be requested from the producer.
Subchannel data is returned from the producer in the same production method that produces normal user data.
Normally a producer returns user data in chunks of DRBlockSizeKey size. When subchannel
data is also produced, the producer is expected to return user data of DRBlockSizeKey in length with an additonal
96 bytes of subchannel data. Depending on the data form specified in this key, the format of this 96 bytes is
either in raw or pack format. When subchannel data is requested from the producer, the DRFlagSubchannelDataRequested flag is set in the flags parameter of
producePreGapForTrack:intoBuffer:length:atAddress:blockSize:ioFlags:
or produceDataForTrack:intoBuffer:length:atAddress:blockSize:ioFlags: and blockSize is increased by 96 bytes.
kDRSubchannelDataFormNone |
extern const CFStringRef kDRSubchannelDataFormNone;
A value for DRSubchannelDataFormKey indicating that the subchannel data will not be provided by the producer.
kDRSubchannelDataFormPack |
extern const CFStringRef kDRSubchannelDataFormPack;
A value for DRSubchannelDataFormKey indicating that the producer will be asked to provide pack format subchannel data for the track. If this form is selected, the drive will perform P and Q parity calculations on each pack and interleave the packs before writing them to disc. This corresponds to a subchannel data form of 0xC0.
kDRSubchannelDataFormRaw |
extern const CFStringRef kDRSubchannelDataFormRaw;
A value for DRSubchannelDataFormKey indicating that the producer will be asked to provide raw format subchannel data for the track. If this form is selected, the producer must have performed P and Q parity calculations for each pack and done proper interleaving of the subchannel data. The drive will fill in the P-Q subchannel information and write the R-W subchannel data as is to the disc. This corresponds to a subchannel data form of 0x40.
kDRTrackIsEmptyKey |
extern const CFStringRef kDRTrackIsEmptyKey;
This key corresponds to a CFBoolean object and indicates whether the track is empty.
kDRTrackISRCKey |
extern const CFStringRef kDRTrackISRCKey;
Optional key. For CD-DA audio tracks only. This track property key corresponds to a CFData
object containing exactly 12 bytes, which will be written to the disc as the
International Standard Recording Code (ISRC). If this key is not present,
no ISRC data is written.
The use of this value should conform to the specifications of the IFPI. See
http://www.ifpi.org/isrc for details on the ISRC standard.
Not all drives can write ISRC data. If this key is present in any track and
the drive cannot write ISRC data, the burn will fail with a return value of
kDRDeviceCantWriteISRCErr .
kDRTrackLengthKey |
extern const CFStringRef kDRTrackLengthKey;
Required Key. This key corresponds to a CFNumber object containing the length of the track data in blocks.
kDRTrackModeKey |
extern const CFStringRef kDRTrackModeKey;
Required key. This key corresponds to a CFNumber object containing the track mode of the track. Common values are defined in the Track Modes enumeration.
kDRTrackNumberKey |
extern const CFStringRef kDRTrackNumberKey;
This key corresponds to a CFNumber object containing the physical track number of a track.
kDRTrackPacketSizeKey |
extern const CFStringRef kDRTrackPacketSizeKey;
This key corresponds to a CFNumber object that contains the number of blocks per packet for the disc. It will only be present if the disc contains fixed packets. This key will contain '16' for DVD media, and typically contains either '16' or '32' for CD media.
kDRTrackPacketTypeFixed |
extern const CFStringRef kDRTrackPacketTypeFixed;
One value for the kDRTrackPacketTypeKey dictionary key. This value indicates the disc is writen with fixed sized packets. When this value is present the kDRPacketSizeKey dictionary key will also be present.
kDRTrackPacketTypeKey |
extern const CFStringRef kDRTrackPacketTypeKey;
This key corresponds to a CFString value indicating the kind of packets being written.
kDRTrackPacketTypeVariable |
extern const CFStringRef kDRTrackPacketTypeVariable;
One value for the kDRTrackPacketTypeKey dictionary key. This value indicates the disc is written with sequential, variable-sized packets. When this key is present, the kDRPacketSizeKey dictionary key will not be.
kDRTrackStartAddressKey |
extern const CFStringRef kDRTrackStartAddressKey;
This key corresponds to a CFNumber object containing the Logical Block Address (LBA) of the start address for the track.
kDRTrackTypeClosed |
extern const CFStringRef kDRTrackTypeClosed;
One value for the kDRTrackTypeKey dictionary key. This value indicates the track has been written and is closed.
kDRTrackTypeIncomplete |
extern const CFStringRef kDRTrackTypeIncomplete;
One value for the kDRTrackTypeKey dictionary key. This value indicates the track is not invisible or reserved and is available for writing.
kDRTrackTypeInvisible |
extern const CFStringRef kDRTrackTypeInvisible;
One value for the kDRTrackTypeKey dictionary key. This value indicates the track is invisible and available for writing. If it is packet written and not closed, the kDRTrackPacketType key will be present along with the kDRTrackPacketSize keys.
kDRTrackTypeKey |
extern const CFStringRef kDRTrackTypeKey;
This key corresponds to a CFString object indicating the type of track. Possible values are kDRTrackTypeInvisible , kDRTrackTypeIncomplete , kDRTrackTypeReserved , or kDRTrackTypeClosed .
kDRTrackTypeReserved |
extern const CFStringRef kDRTrackTypeReserved;
One value for the kDRTrackTypeKey dictionary key. This value indicates the track is reserved for writing.
kDRVerificationTypeChecksum |
extern const CFStringRef kDRVerificationTypeChecksum;
One value for the kDRVerificationTypeKey dictionary key. This value indicates the engine will verify the track data with an internally calculated checksum.
kDRVerificationTypeKey |
extern const CFStringRef kDRVerificationTypeKey;
Optional key. This track property key corresponds to a CFString object indicating the kind of verification that should be performed. If the key is not present, no verification will take place.
kDRVerificationTypeNone |
extern const CFStringRef kDRVerificationTypeNone;
One value for the kDRVerificationTypeKey dictionary key. This value indicates the engine will not do any sort of verification on the track data.
kDRVerificationTypeProduceAgain |
extern const CFStringRef kDRVerificationTypeProduceAgain;
One value for the kDRVerificationTypeKey dictionary key. This value indicates
the engine will start another production cycle and the client
simply produces data again from the start.
Note that this verification mode currently only works with data CDs and DVDs.
kDRVerificationTypeReceiveData |
extern const CFStringRef kDRVerificationTypeReceiveData;
One value for the kDRVerificationTypeKey dictionary key. This value indicates the engine will read data from the disc and send it to the client through a series of calls to the callback.
DRTrackCallbackProc |
Callback defined in the client to produce track data for recording.
typedef OSStatus ( *DRTrackCallbackProc)( DRTrackRef track, DRTrackMessage message, void *ioParam);
track
- The track with this callback is associated.
message
- Indicates the type of data requested as one of the constants in the Track Messages enumeration.
ioParam
- Parameters are message-specific.
Error code. Your client application should return a value of kDRFunctionNotSupportedErr when a message is received that you don't respond to, and a value of noErr when the message is handled successfully. Any other error will cause the burn to immediately fail with the value you return as the error code.
If your callback does not support a given function, it should return a value of kDRFunctionNotSupportedErr .
DRTrackMessage |
Messages sent to the DRTrackCallbackProc callback.
typedef UInt32 DRTrackMessage;
DRTrackRef |
typedef struct __DRTrack* DRTrackRef;
A reference to a DRTrack object.
DRTrackProductionInfo |
Parmeter block used for data production.
struct DRTrackProductionInfo { void *buffer; UInt32 reqCount; UInt32 actCount; UInt32 flags; UInt32 blockSize; UInt64 requestedAddress; };
buffer
- In - The buffer to produce into. This buffer is passed into the track production callback and only the contents should be modified.
reqCount
- In - The number of bytes requested by the engine.
actCount
- Out - The number of bytes actually produced (between 0 and reqCount).
flags
- InOut - Miscellaneous flags. Flags are passed into the track production callback callback from the Disc Recording engine and the callback can set flags to be passed back to the engine.
blockSize
- In - The block size the engine is expecting. For best results, return multiples of this size.
requestedAddress
- In - The byte address that the burn engine is requesting from the object (0-based). This increments when you send data, as one would expect.
Block Sizes |
enum { kDRBlockSizeAudio = 2352, kDRBlockSizeMode1Data = 2048, kDRBlockSizeMode2Data = 2332, kDRBlockSizeMode2Form1Data = 2048, kDRBlockSizeMode2Form2Data = 2324, kDRBlockSizeDVDData = 2048 };
kDRBlockSizeAudio
- Audio data.
kDRBlockSizeMode1Data
- Mode 1 data.
kDRBlockSizeMode2Data
- Mode 2 data. Photo CD and CD-i use this.
kDRBlockSizeMode2Form1Data
- Mode 2 Form 1 data.
kDRBlockSizeMode2Form2Data
- Mode 2 Form 2 data.
kDRBlockSizeDVDData
- DVD data.
Common block sizes for different types of track data.
Block Types |
enum { kDRBlockTypeAudio = 0, kDRBlockTypeMode1Data = 8, kDRBlockTypeMode2Data = 13, kDRBlockTypeMode2Form1Data = 10, kDRBlockTypeMode2Form2Data = 12, kDRBlockTypeDVDData = 8 };
kDRBlockTypeAudio
- Audio data.
kDRBlockTypeMode1Data
- Mode 1 data.
kDRBlockTypeMode2Data
- Mode 2 data. Photo CD and CD-i use this.
kDRBlockTypeMode2Form1Data
- Mode 2 Form 1 data.
kDRBlockTypeMode2Form2Data
- Mode 2 Form 2 data.
kDRBlockTypeDVDData
- DVD data.
Common block type values for types of track data.
Data Forms |
enum { kDRDataFormAudio = 0, kDRDataFormMode1Data = 16, kDRDataFormMode2Data = 32, kDRDataFormMode2Form1Data = 32, kDRDataFormMode2Form2Data = 32, kDRDataFormDVDData = 16 };
kDRDataFormAudio
- Audio data.
kDRDataFormMode1Data
- Mode 1 data.
kDRDataFormMode2Data
- Mode 2 data. Photo CD and CD-i use this.
kDRDataFormMode2Form1Data
- Mode 2 Form 1 data.
kDRDataFormMode2Form2Data
- Mode 2 Form 2 data.
kDRDataFormDVDData
- DVD data.
Common data form values for types of track data.
Session Format |
enum { kDRSessionFormatAudio = 0, kDRSessionFormatMode1Data = 0, kDRSessionFormatCDI = 0x10, kDRSessionFormatCDXA = 0x20, kDRSessionFormatDVDData = 0 };
kDRSessionFormatAudio
- Audio data.
kDRSessionFormatMode1Data
- Mode 1 data.
kDRSessionFormatCDI
- CD-I disc.
kDRSessionFormatCDXA
- CD-ROM XA disc.
kDRSessionFormatDVDData
- DVD data.
Common session format values for types of track data.
Track Flags |
enum { #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5 kDRFlagSubchannelDataRequested = ( 1 << 1), #endif kDRFlagNoMoreData = ( 1 << 0) };
kDRFlagNoMoreData
- Indicates the end of variable length data.
kDRFlagSubchannelDataRequested
- Indicates that the blockSize passed in includes room for subchannel data. Data producers should check this flag and perform subchannel data production in addition to user data production. Each block requested from the producer in this case will be formatted as
[user data (as specified in track properties)][subchannel data(96 bytes)].
For example an audio producer callback should produce 2352 bytes of audio data into bytes 0-2351 of the block and an additional 96 bytes of subchannel data into bytes 2352-2447.
These flags are options in the DRTrackProductionInfo structure.
Track Messages |
enum { kDRTrackMessagePreBurn = 'pre ', kDRTrackMessageProduceData = 'prod', kDRTrackMessageVerificationStarting = 'vstr', kDRTrackMessageVerifyData = 'vrfy', kDRTrackMessageVerificationDone = 'vdon', kDRTrackMessagePostBurn = 'post', kDRTrackMessageEstimateLength = 'esti', /* added in 10.3 */ kDRTrackMessageProducePreGap = 'prpr', /* added in 10.3 */ kDRTrackMessageVerifyPreGap = 'vrpr' /* added in 10.4 */ };
kDRTrackMessagePreBurn
- Message sent to the track production callback indicating a burn is about to begin. Clients should open any files needed to produce data and get ready to start sending data.
The ioParam parameter contains a CFDictionary object with information about the burn. It currently holds kDRBurnKey and kDRDeviceMediaInfoKey dictionary keys, but may be extended to hold other properties in the future.kDRTrackMessageProduceData
- Message sent to the track production callback requesting that the client produce the next chunk of data for the track.
The ioParam parameter is a pointer to a DRTrackProductionInfo structure.kDRTrackMessageVerificationStarting
- Message sent to the callback proc indicating that verification is about to begin.
ioParam is not used and is NULL.kDRTrackMessageVerifyData
- Message sent to the track production callback when the client has chosen the kDRVerificationTypeReceiveData option.
The ioParam parameter is a pointer to a DRTrackProductionInfo structure describing the data passed to the callback.kDRTrackMessageVerificationDone
- Message sent to the track production callback when verification is complete.
The ioParam parameter is not used and is NULL.kDRTrackMessagePostBurn
- Message sent to the track production callback indicating a burn has completed.
The ioParam parameter is not used and is NULL.kDRTrackMessageEstimateLength
- Message sent to the track production callback asking it to estimate the length of the track. This message is sent outside of a burn cycle, when the DRTrackEstimateLength function is called.
The ioParam parameter is a pointer to a UInt64 value, which the callback fills in with an estimated number of blocks for the track. The estimate should be reasonably accurate and no smaller than the actual size that will be needed.kDRTrackMessageProducePreGap
- Message sent to the track production callback requesting that the client produce the next chunk of the pregap.
The ioParam parameter is a pointer to a DRTrackProductionInfo structure.kDRTrackMessageVerifyPreGap
- Message sent to the track production callback when the client has chosen the kDRVerificationTypeReceiveData option. The data produced by the client for the kDRTrackMessageProducePreGap should be verified.
The ioParam parameter is a pointer to a DRTrackProductionInfo structure describing the data passed to the callback.
Messages sent to the DRTrackCallbackProc callback during a burn.
Track Modes |
enum { kDRTrackModeAudio = 0, kDRTrackMode1Data = 4, kDRTrackMode2Data = 4, kDRTrackMode2Form1Data = 4, kDRTrackMode2Form2Data = 4, kDRTrackModeDVDData = 5 };
kDRTrackModeAudio
- Audio data.
kDRTrackMode1Data
- Mode 1 data.
kDRTrackMode2Data
- Mode 2 data. Photo CD and CD-i use this.
kDRTrackMode2Form1Data
- Mode 2 Form 1 data.
kDRTrackMode2Form2Data
- Mode 2 Form 2 data.
kDRTrackModeDVDData
- DVD data.
Common track mode values for types of track data.
|