dvd_reader.h File Reference

Go to the source code of this file.

Classes
struct	dvd_stat_t
	Public type that is used to provide statistics on a handle. More...
Typedefs
typedef struct dvd_reader_s	dvd_reader_t
	Opaque type that is used as a handle for one instance of an opened DVD.
typedef struct dvd_file_s	dvd_file_t
	Opaque type for a file read handle, much like a normal fd or FILE *.
Enumerations
enum	dvd_read_domain_t { DVD_READ_INFO_FILE, DVD_READ_INFO_BACKUP_FILE, DVD_READ_MENU_VOBS, DVD_READ_TITLE_VOBS }
Functions
dvd_reader_t *	DVDOpen (const char *)
	Opens a block device of a DVD-ROM file, or an image file, or a directory name for a mounted DVD or HD copy of a DVD.
void	DVDClose (dvd_reader_t *)
	Closes and cleans up the DVD reader object.
int	DVDFileStat (dvd_reader_t *, int, dvd_read_domain_t, dvd_stat_t *)
	Stats a file on the DVD given the title number and domain.
dvd_file_t *	DVDOpenFile (dvd_reader_t *, int, dvd_read_domain_t)
	Opens a file on the DVD given the title number and domain.
void	DVDCloseFile (dvd_file_t *)
	Closes a file and frees the associated structure.
ssize_t	DVDReadBlocks (dvd_file_t *, int, size_t, unsigned char *)
	Reads block_count number of blocks from the file at the given block offset.
int32_t	DVDFileSeek (dvd_file_t *, int32_t)
	Seek to the given position in the file.
ssize_t	DVDReadBytes (dvd_file_t *, void *, size_t)
	Reads the given number of bytes from the file.
ssize_t	DVDFileSize (dvd_file_t *)
	Returns the file size in blocks.
int	DVDDiscID (dvd_reader_t *, unsigned char *)
	Get a unique 128 bit disc ID.
int	DVDUDFVolumeInfo (dvd_reader_t *, char *, unsigned int, unsigned char *, unsigned int)
	Get the UDF VolumeIdentifier and VolumeSetIdentifier from the PrimaryVolumeDescriptor.
int	DVDFileSeekForce (dvd_file_t *, int offset, int force_size)
int	DVDISOVolumeInfo (dvd_reader_t *, char *, unsigned int, unsigned char *, unsigned int)
	Get the ISO9660 VolumeIdentifier and VolumeSetIdentifier.
int	DVDUDFCacheLevel (dvd_reader_t *, int)
	Sets the level of caching that is done when reading from a device.

---

Typedef Documentation

typedef struct dvd_reader_s dvd_reader_t

Opaque type that is used as a handle for one instance of an opened DVD.

Definition at line 65 of file dvd_reader.h.

typedef struct dvd_file_s dvd_file_t

Opaque type for a file read handle, much like a normal fd or FILE *.

Definition at line 70 of file dvd_reader.h.

---

Enumeration Type Documentation

enum dvd_read_domain_t

Enumerator:

DVD_READ_INFO_FILE	VIDEO_TS.IFO or VTS_XX_0.IFO (title).
DVD_READ_INFO_BACKUP_FILE	VIDEO_TS.BUP or VTS_XX_0.BUP (title).
DVD_READ_MENU_VOBS	VIDEO_TS.VOB or VTS_XX_0.VOB (title).
DVD_READ_TITLE_VOBS	VTS_XX_[1-9].VOB (title). All files in the title set are opened and read as a single file.

Definition at line 119 of file dvd_reader.h.

---

Function Documentation

dvd_reader_t* DVDOpen

(

const char *

)

Opens a block device of a DVD-ROM file, or an image file, or a directory name for a mounted DVD or HD copy of a DVD.

If the given file is a block device, or is the mountpoint for a block device, then that device is used for CSS authentication using libdvdcss. If no device is available, then no CSS authentication is performed, and we hope that the image is decrypted.

If the path given is a directory, then the files in that directory may be in any one of these formats:

path/VIDEO_TS/VTS_01_1.VOB path/video_ts/vts_01_1.vob path/VTS_01_1.VOB path/vts_01_1.vob

Parameters:

path

Specifies the the device, file or directory to be used.

Returns:

If successful a a read handle is returned. Otherwise 0 is returned.

dvd = DVDOpen(path);

Definition at line 339 of file dvd_reader.c.

Referenced by vm_reset().

void DVDClose

(

dvd_reader_t *

)

Closes and cleans up the DVD reader object.

You must close all open files before calling this function.

Parameters:

dvd

A read handle that should be closed.

DVDClose(dvd);

Definition at line 589 of file dvd_reader.c.

Referenced by vm_stop().

int DVDFileStat	(	dvd_reader_t *	,
		int	,
		dvd_read_domain_t	,
		dvd_stat_t *
	)

Stats a file on the DVD given the title number and domain.

The information about the file is stored in a dvd_stat_t which contains information about the size of the file and the number of parts in case of a multipart file and the respective sizes of the parts. A multipart file is for instance VTS_02_1.VOB, VTS_02_2.VOB, VTS_02_3.VOB The size of VTS_02_1.VOB will be stored in stat->parts_size[0], VTS_02_2.VOB in stat->parts_size[1], ... The total size (sum of all parts) is stored in stat->size and stat->nr_parts will hold the number of parts. Only DVD_READ_TITLE_VOBS (VTS_??_[1-9].VOB) can be multipart files.

This function is only of use if you want to get the size of each file in the filesystem. These sizes are not needed to use any other functions in libdvdread.

Parameters:

	dvd	A dvd read handle.
	titlenum	Which Video Title Set should be used, VIDEO_TS is 0.
	domain	Which domain.
	stat	Pointer to where the result is stored.

Returns:

If successful 0, otherwise -1.

int DVDFileStat(dvd, titlenum, domain, stat);

Definition at line 1035 of file dvd_reader.c.

dvd_file_t* DVDOpenFile	(	dvd_reader_t *	,
		int	,
		dvd_read_domain_t
	)

Opens a file on the DVD given the title number and domain.

If the title number is 0, the video manager information is opened (VIDEO_TS.[IFO,BUP,VOB]). Returns a file structure which may be used for reads, or 0 if the file was not found.

Parameters:

	dvd	A dvd read handle.
	titlenum	Which Video Title Set should be used, VIDEO_TS is 0.
	domain	Which domain.

Returns:

If successful a a file read handle is returned, otherwise 0.

dvd_file = DVDOpenFile(dvd, titlenum, domain);

Definition at line 866 of file dvd_reader.c.

Referenced by DVDDiscID(), dvdnav_get_next_cache_block(), dvdnav_open(), ifoOpen(), ifoOpenVMGI(), and ifoOpenVTSI().

void DVDCloseFile

(

dvd_file_t *

)

Closes a file and frees the associated structure.

Parameters:

dvd_file

The file read handle to be closed.

DVDCloseFile(dvd_file);

Definition at line 917 of file dvd_reader.c.

Referenced by DVDDiscID(), dvdnav_clear(), dvdnav_close(), dvdnav_get_next_cache_block(), and ifoClose().

ssize_t DVDReadBlocks	(	dvd_file_t *	,
		int	,
		size_t	,
		unsigned char *
	)

Reads block_count number of blocks from the file at the given block offset.

Returns number of blocks read on success, -1 on error. This call is only for reading VOB data, and should not be used when reading the IFO files. When reading from an encrypted drive, blocks are decrypted using libdvdcss where required.

Parameters:

	dvd_file	A file read handle.
	offset	Block offset from the start of the file to start reading at.
	block_count	Number of block to read.
	data	Pointer to a buffer to write the data into.

Returns:

Returns number of blocks read on success, -1 on error.

blocks_read = DVDReadBlocks(dvd_file, offset, block_count, data);

Definition at line 1221 of file dvd_reader.c.

Referenced by dvdnav_read_cache_block().

int32_t DVDFileSeek	(	dvd_file_t *	,
		int32_t
	)

Seek to the given position in the file.

Returns the resulting position in bytes from the beginning of the file. The seek position is only used for byte reads from the file, the block read call always reads from the given offset.

Parameters:

	dvd_file	A file read handle.
	seek_offset	Byte offset from the start of the file to seek to.

Returns:

The resulting position in bytes from the beginning of the file.

offset_set = DVDFileSeek(dvd_file, seek_offset);

Definition at line 1253 of file dvd_reader.c.

Referenced by DVDFileSeek_().

ssize_t DVDReadBytes	(	dvd_file_t *	,
		void *	,
		size_t
	)

Reads the given number of bytes from the file.

This call can only be used on the information files, and may not be used for reading from a VOB. This reads from and increments the currrent seek position for the file.

Parameters:

	dvd_file	A file read handle.
	data	Pointer to a buffer to write the data into.
	bytes	Number of bytes to read.

Returns:

Returns number of bytes read on success, -1 on error.

bytes_read = DVDReadBytes(dvd_file, data, bytes);

Definition at line 1288 of file dvd_reader.c.

Referenced by DVDDiscID(), ifoRead_C_ADT_internal(), ifoRead_CELL_PLAYBACK_TBL(), ifoRead_CELL_POSITION_TBL(), ifoRead_PGC(), ifoRead_PGC_COMMAND_TBL(), ifoRead_PGC_PROGRAM_MAP(), ifoRead_PGCI_UT(), ifoRead_PGCIT_internal(), ifoRead_PTL_MAIT(), ifoRead_TT_SRPT(), ifoRead_TXTDT_MGI(), ifoRead_VMG(), ifoRead_VOBU_ADMAP_internal(), ifoRead_VTS(), ifoRead_VTS_ATRT(), ifoRead_VTS_ATTRIBUTES(), ifoRead_VTS_PTT_SRPT(), and ifoRead_VTS_TMAPT().

ssize_t DVDFileSize

(

dvd_file_t *

)

Returns the file size in blocks.

Parameters:

dvd_file

A file read handle.

Returns:

The size of the file in blocks, -1 on error.

blocks = DVDFileSize(dvd_file);

Definition at line 1332 of file dvd_reader.c.

int DVDDiscID	(	dvd_reader_t *	,
		unsigned char *
	)

Get a unique 128 bit disc ID.

This is the MD5 sum of VIDEO_TS.IFO and the VTS_0?_0.IFO files in title order (those that exist). If you need a 'text' representation of the id, print it as a hexadecimal number, using lowercase letters, discid[0] first. I.e. the same format as the command-line 'md5sum' program uses.

Parameters:

	dvd	A read handle to get the disc ID from
	discid	The buffer to put the disc ID into. The buffer must have room for 128 bits (16 chars).

Returns:

0 on success, -1 on error.

Definition at line 1341 of file dvd_reader.c.

int DVDUDFVolumeInfo	(	dvd_reader_t *	,
		char *	,
		unsigned	int,
		unsigned char *	,
		unsigned	int
	)

Get the UDF VolumeIdentifier and VolumeSetIdentifier from the PrimaryVolumeDescriptor.

Parameters:

	dvd	A read handle to get the disc ID from
	volid	The buffer to put the VolumeIdentifier into. The VolumeIdentifier is latin-1 encoded (8bit unicode) null terminated and max 32 bytes (including '')
	volid_size	No more than volid_size bytes will be copied to volid. If the VolumeIdentifier is truncated because of this it will still be null terminated.
	volsetid	The buffer to put the VolumeSetIdentifier into. The VolumeIdentifier is 128 bytes as stored in the UDF PrimaryVolumeDescriptor. Note that this is not a null terminated string.
	volsetid_size	At most volsetid_size bytes will be copied to volsetid.

Returns:

0 on success, -1 on error.

Definition at line 1453 of file dvd_reader.c.

int DVDFileSeekForce	(	dvd_file_t *	,
		int	offset,
		int	force_size
	)

Definition at line 1266 of file dvd_reader.c.

Referenced by DVDFileSeekForce_(), and DVDReadBytes().

int DVDISOVolumeInfo	(	dvd_reader_t *	,
		char *	,
		unsigned	int,
		unsigned char *	,
		unsigned	int
	)

Get the ISO9660 VolumeIdentifier and VolumeSetIdentifier.

* Only use this function as fallback if DVDUDFVolumeInfo returns 0 * * this will happen on a disc mastered only with a iso9660 filesystem * * All video DVD discs have UDF filesystem *

Parameters:

	dvd	A read handle to get the disc ID from
	volid	The buffer to put the VolumeIdentifier into. The VolumeIdentifier is coded with '0-9','A-Z','_' null terminated and max 33 bytes (including '')
	volid_size	No more than volid_size bytes will be copied to volid. If the VolumeIdentifier is truncated because of this it will still be null terminated.
	volsetid	The buffer to put the VolumeSetIdentifier into. The VolumeIdentifier is 128 bytes as stored in the ISO9660 PrimaryVolumeDescriptor. Note that this is not a null terminated string.
	volsetid_size	At most volsetid_size bytes will be copied to volsetid.

Returns:

0 on success, -1 on error.

Definition at line 1393 of file dvd_reader.c.

int DVDUDFCacheLevel	(	dvd_reader_t *	device,
		int	level
	)

Sets the level of caching that is done when reading from a device.

Parameters:

	dvd	A read handle to get the disc ID from
	level	The level of caching wanted. -1 - returns the current setting. 0 - UDF Cache turned off. 1 - (default level) Pointers to IFO files and some data from PrimaryVolumeDescriptor are cached.

Returns:

The level of caching.

Definition at line 126 of file dvd_reader.c.

Referenced by GetUDFCache(), SetUDFCache(), and UDFScanDir().