Changeset 390 for libmpc/trunk/libmpcdec/mpc_demux.c

Timestamp:

04/05/08 20:09:57 (17 years ago)

Author:

r2d

Message:

libmpcdec API cleanup and documentation

File:

• libmpc/trunk/libmpcdec/mpc_demux.c (modified) (5 diffs)

libmpc/trunk/libmpcdec/mpc_demux.c

@@ -50 +50 @@
 void  streaminfo_gain(mpc_streaminfo* si, const mpc_bits_reader * r_in);
 
+// mpc_decoder.c
+void mpc_decoder_reset_scf(mpc_decoder * d, int value);
 
 enum {
@@ -137 +139 @@
 
 /**
- * return the current position in the stream (in bits)
+ * return the current position in the stream (in bits) from the beginning
+ * of the file
  * @param d demuxer context
  * @return current stream position in bits
@@ -330 +333 @@
                 }
         }
-        
+
         d->bits_reader.buff -= size;
 }
 
+/**
+ * Gets the number of chapters in the stream
+ * @param d pointer to a musepack demuxer
+ * @return the number of chapters found in the stream
+ */
 mpc_int_t mpc_demux_chap_nb(mpc_demux * d)
 {
@@ -341 +349 @@
 }
 
+/**
+ * Gets datas associated to a given chapter
+ * You can pass 0 for tag and tag_size if you don't needs the tag information
+ * The chapter tag is an APEv2 tag without the preamble
+ * @param d pointer to a musepack demuxer
+ * @param chap_nb chapter number you want datas (from 0 to mpc_demux_chap_nb(d) - 1)
+ * @param tag will return a pointer to the chapter tag datas
+ * @param tag_size will be filed with the tag data size (0 if no tag for this chapter)
+ * @return the sample where the chapter starts
+ */
 mpc_uint64_t mpc_demux_chap(mpc_demux * d, int chap_nb, char ** tag, mpc_uint_t * tag_size)
 {
@@ -353 +371 @@
         return d->chap[chap_nb].sample;
 }
-                
+
 static mpc_status mpc_demux_header(mpc_demux * d)
 {