Miles Sound System SDK 7.2a

AIL_enumerate_MP3_frames

The function AIL_enumerate_MP3_frames obtains information about successive frames from an MPEG-1 Layer 3 audio file.

S32 AIL_enumerate_MP3_frames(
  MP3_INFO *inspection_state
);

Out Parameters

inspection_state: points to an instance of an MP3_INFO structure owned by the application and previously initialized by a call to AIL_inspect_MP3.

Returns

1 if the frame-data portion of the MP3_INFO structure represents a valid frame; 0 if no (further) valid frames exist in the file image.

Discussion

This function returns information about all of the valid MP3 frames in the file image, beginning with the first, by filling in the appropriate MP3_INFO structure fields.

You can inspect all of the frames in an MP3 file image with the following code:


   MP3_INFO info;
   AIL_inspect_MP3(&info,
                   my_MP3_file_image,
                   size_in_bytes_of_my_MP3_file_image);
   printf("Valid MP3 data, if any, begins at %X\n",info.start_MP3_data);
   while (AIL_enumerate_MP3_frames(&info))
      {
      printf("Valid frame found at byte offset %d from info.start_MP3_data\n",info.byte_offset);
      }

ID3v2 tags appearing in the middle of the file will not be reported by this function; they will be skipped. An ID3v2 tag at the beginning of the file, if any, will be logged by the initial call to AIL_inspect_MP3.

See the MP3_INFO structure description for details about the information retrieved by this function.

Group: Utility Services
Related Functions: AIL_inspect_MP3
Related Basic Types: S32
Related Structures: MP3_INFO