[xine-cvs] CVS: xine-vcdnav/vcdimager-0.7.12-rocky/libvcd vcdinfo.h,1.28,1.29

[Rocky B. <ro...@us...>]

Update of /cvsroot/xine/xine-vcdnav/vcdimager-0.7.12-rocky/libvcd
In directory sc8-pr-cvs1:/tmp/cvs-serv13730

Modified Files:
	vcdinfo.h 
Log Message:
Improve up interface comments for vcdinfo_get_seg_sector_count() and
vcdinfo_get_seg_size() based on info from HvR.


Index: vcdinfo.h
===================================================================
RCS file: /cvsroot/xine/xine-vcdnav/vcdimager-0.7.12-rocky/libvcd/vcdinfo.h,v
retrieving revision 1.28
retrieving revision 1.29
diff -u -r1.28 -r1.29
--- vcdinfo.h	4 Jan 2003 23:54:40 -0000	1.28
+++ vcdinfo.h	6 Jan 2003 14:28:35 -0000	1.29
@@ -439,13 +439,17 @@
 vcdinfo_get_seg_msf(const vcdinfo_obj_t *obj, const unsigned int seg_num);
 
 /*!  Return the size in bytes for segment for entry_num n obj ASSUMING
-  THERE THE SIZE OF A SECTOR IS ISO_BLOCKSIZE.  NULL is returned if
-  there is no entry.
+  THE SIZE OF A SECTOR IS ISO_BLOCKSIZE. This could be the case (but
+  doesn't have to be) if you mount a CD, have the OS list sizes and
+  its blocksize is ISO_BLOCKSIZE.
 
-  NOTE: if you are looking for the actual number of bytes used on a
-  portion of a CD or a disk image, this is not the routine to
-  use. Instead multiply vcdinfo_get_seg_sector_count() by the number
-  of bytes per secto.
+  In contrast, if you are issuing mode2/format2 reads which give 2324
+  bytes per sector and want to know how many of these to read to get
+  the entire segment, this is probably not the way to do do
+  that. Instead, multiply vcdinfo_get_seg_sector_count() by the number
+  of bytes per sector.
+
+  NULL is returned if there is no entry.
 */
 uint32_t
 vcdinfo_get_seg_size(const vcdinfo_obj_t *obj, const unsigned int seg_num);