Make the IPv4 NRB code's comments match the IPv6 NRB code's comments.
[metze/wireshark/wip.git] / wiretap / mpeg.c
index 1e15045cc0d34a84fcd4f0448f6c0fc53001bc7a..f572237ea297a98e6262d976b2a0615d52827e43 100644 (file)
@@ -4,8 +4,6 @@
  * Written by Shaun Jackman <sjackman@gmail.com>
  * Copyright 2007 Shaun Jackman
  *
- * $Id$
- *
  * Wiretap Library
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
-#ifdef HAVE_CONFIG_H
 #include "config.h"
-#endif
 
 #ifdef HAVE_SYS_TYPES_H
 #include <sys/types.h>
 #endif
 
 #include "mpeg.h"
-#include "mpeg-audio.h"
+#include "wsutil/mpeg-audio.h"
 
 #include "wtap-int.h"
-#include "buffer.h"
+#include <wsutil/buffer.h>
 #include "file_wrappers.h"
 #include <errno.h>
 #include <stdlib.h>
 #define PES_PREFIX 1
 #define PES_VALID(n) (((n) >> 8 & 0xffffff) == PES_PREFIX)
 
-static size_t 
-mpeg_resync(wtap *wth, int *err, gchar **err_info _U_)
+typedef struct {
+       nstime_t now;
+       time_t t0;
+} mpeg_t;
+
+static int
+mpeg_resync(FILE_T fh, int *err)
 {
-       gint64 offset = file_tell(wth->fh);
-       size_t count = 0;
-       int sync = file_getc(wth->fh);
-
-       while (sync != EOF) {
-               if (sync == 0xff && count > 0) {
-                       sync = file_getc(wth->fh);
-                       if (sync != EOF && (sync & 0xe0) == 0xe0)
+       gint64 offset = file_tell(fh);
+       int count = 0;
+       int byte = file_getc(fh);
+
+       while (byte != EOF) {
+               if (byte == 0xff && count > 0) {
+                       byte = file_getc(fh);
+                       if (byte != EOF && (byte & 0xe0) == 0xe0)
                                break;
                } else
-                       sync = file_getc(wth->fh);
+                       byte = file_getc(fh);
                count++;
        }
-       file_seek(wth->fh, offset, SEEK_SET, err);
+       if (file_seek(fh, offset, SEEK_SET, err) == -1)
+               return 0;
        return count;
 }
 
-static int 
-mpeg_read_header(wtap *wth, int *err, gchar **err_info _U_,
-               guint32 *n)
-{
-       int bytes_read;
-
-       errno = WTAP_ERR_CANT_READ;
-       bytes_read = file_read(n, 1, sizeof *n, wth->fh);
-       if (bytes_read != sizeof *n) {
-               *err = file_error(wth->fh);
-               if (*err == 0 && bytes_read != 0)
-                       *err = WTAP_ERR_SHORT_READ;
-               return -1;
-       }
-       *n = g_ntohl(*n);
-       if (file_seek(wth->fh, -(gint64)(sizeof *n), SEEK_CUR, err) == -1)
-               return -1;
-       return bytes_read;
-}
-
-static gboolean
-mpeg_read_rec_data(FILE_T fh, guchar *pd, int length, int *err)
-{
-       int     bytes_read;
-
-       errno = WTAP_ERR_CANT_READ;
-       bytes_read = file_read(pd, 1, length, fh);
-
-       if (bytes_read != length) {
-               *err = file_error(fh);
-               if (*err == 0)
-                       *err = WTAP_ERR_SHORT_READ;
-               return FALSE;
-       }
-       return TRUE;
-}
-
 #define SCRHZ 27000000
 
-static gboolean 
-mpeg_read(wtap *wth, int *err, gchar **err_info _U_,
-               gint64 *data_offset)
+static gboolean
+mpeg_read_packet(wtap *wth, FILE_T fh, struct wtap_pkthdr *phdr, Buffer *buf,
+    gboolean is_random, int *err, gchar **err_info)
 {
+       mpeg_t *mpeg = (mpeg_t *)wth->priv;
        guint32 n;
-       int bytes_read = mpeg_read_header(wth, err, err_info, &n);
-       unsigned packet_size;
-       struct wtap_nstime ts = wth->capture.mpeg->now;
-
-       if (bytes_read == -1)
+       unsigned int packet_size;
+       nstime_t ts = mpeg->now;
+
+       /*
+        * All packets have at least 4 bytes in them.  Read the first
+        * 4 bytes and determine whether it's a PES packet or not
+        * based on that.
+        *
+        * XXX - can an MPEG file contain a mixture of PES and non-PES
+        * packets?  If not, can we determine whether the packets will
+        * be PES packets or not based on the magic number (i.e., if the
+        * file begins with 0x00 0x00 0x01, it contains PES packets,
+        * otherwise it doesn't)?
+        */
+       if (!wtap_read_bytes_or_eof(fh, &n, sizeof n, err, err_info))
                return FALSE;
+       if (file_seek(fh, -(gint64)(sizeof n), SEEK_CUR, err) == -1)
+               return FALSE;
+       n = g_ntohl(n);
        if (PES_VALID(n)) {
-               gint64 offset = file_tell(wth->fh);
+               gint64 offset = file_tell(fh);
                guint8 stream;
-               int bytes_read;
 
-               if (offset == -1)
-                       return -1;
-               if (file_seek(wth->fh, 3, SEEK_CUR, err) == -1)
+               if (!file_skip(fh, 3, err))
                        return FALSE;
 
-               bytes_read = file_read(&stream, 1, sizeof stream, wth->fh);
-               if (bytes_read != sizeof stream) {
-                       *err = file_error(wth->fh);
+               if (!wtap_read_bytes(fh, &stream, sizeof stream, err, err_info))
                        return FALSE;
-               }
 
                if (stream == 0xba) {
                        guint32 pack1;
@@ -140,68 +113,50 @@ mpeg_read(wtap *wth, int *err, gchar **err_info _U_,
                        guint64 pack;
                        guint8 stuffing;
 
-                       bytes_read = file_read(&pack1, 1, sizeof pack1, wth->fh);
-                       if (bytes_read != sizeof pack1) {
-                               *err = file_error(wth->fh);
-                               if (*err == 0 && bytes_read != 0)
-                                       *err = WTAP_ERR_SHORT_READ;
+                       if (!wtap_read_bytes(fh, &pack1, sizeof pack1, err, err_info))
                                return FALSE;
-                       }
-                       bytes_read = file_read(&pack0, 1, sizeof pack0, wth->fh);
-                       if (bytes_read != sizeof pack0) {
-                               *err = file_error(wth->fh);
-                               if (*err == 0 && bytes_read != 0)
-                                       *err = WTAP_ERR_SHORT_READ;
+                       if (!wtap_read_bytes(fh, &pack0, sizeof pack0, err, err_info))
                                return FALSE;
-                       }
                        pack = (guint64)g_ntohl(pack1) << 32 | g_ntohl(pack0);
 
                        switch (pack >> 62) {
                                case 1:
-                                       if (file_seek(wth->fh, 1, SEEK_CUR, err) == -1)
+                                       if (!file_skip(fh, 1, err))
                                                return FALSE;
-                                       bytes_read = file_read(&stuffing,
-                                                       1, sizeof stuffing, wth->fh);
-                                       if (bytes_read != sizeof stuffing) {
-                                               *err = file_error(wth->fh);
+                                       if (!wtap_read_bytes(fh, &stuffing,
+                                           sizeof stuffing, err, err_info))
                                                return FALSE;
-                                       }
                                        stuffing &= 0x07;
                                        packet_size = 14 + stuffing;
 
-                                       {
+                                       if (!is_random) {
                                                guint64 bytes = pack >> 16;
-                                               guint64 ts =
+                                               guint64 ts_val =
                                                        (bytes >> 43 & 0x0007) << 30 |
                                                        (bytes >> 27 & 0x7fff) << 15 |
                                                        (bytes >> 11 & 0x7fff) << 0;
-                                               unsigned ext = (unsigned)((bytes >> 1) & 0x1ff);
-                                               guint64 cr = 300 * ts + ext;
-                                               unsigned rem = (unsigned)(cr % SCRHZ);
-                                               wth->capture.mpeg->now.secs
-                                                       = wth->capture.mpeg->t0 + (time_t)(cr / SCRHZ);
-                                               wth->capture.mpeg->now.nsecs
+                                               guint ext = (guint)((bytes >> 1) & 0x1ff);
+                                               guint64 cr = 300 * ts_val + ext;
+                                               guint rem = (guint)(cr % SCRHZ);
+                                               mpeg->now.secs
+                                                       = mpeg->t0 + (time_t)(cr / SCRHZ);
+                                               mpeg->now.nsecs
                                                        = (int)(G_GINT64_CONSTANT(1000000000) * rem / SCRHZ);
                                        }
-                                       ts = wth->capture.mpeg->now;
+                                       ts = mpeg->now;
                                        break;
                                default:
                                        packet_size = 12;
                        }
                } else {
                        guint16 length;
-                       bytes_read = file_read(&length, 1, sizeof length, wth->fh);
-                       if (bytes_read != sizeof length) {
-                               *err = file_error(wth->fh);
-                               if (*err == 0 && bytes_read != 0)
-                                       *err = WTAP_ERR_SHORT_READ;
+                       if (!wtap_read_bytes(fh, &length, sizeof length, err, err_info))
                                return FALSE;
-                       }
                        length = g_ntohs(length);
                        packet_size = 6 + length;
                }
 
-               if (file_seek(wth->fh, offset, SEEK_SET, err) == -1)
+               if (file_seek(fh, offset, SEEK_SET, err) == -1)
                        return FALSE;
        } else {
                struct mpa mpa;
@@ -209,44 +164,60 @@ mpeg_read(wtap *wth, int *err, gchar **err_info _U_,
                MPA_UNMARSHAL(&mpa, n);
                if (MPA_VALID(&mpa)) {
                        packet_size = MPA_BYTES(&mpa);
-                       wth->capture.mpeg->now.nsecs += MPA_DURATION_NS(&mpa);
-                       if (wth->capture.mpeg->now.nsecs >= 1000000000) {
-                               wth->capture.mpeg->now.secs++;
-                               wth->capture.mpeg->now.nsecs -= 1000000000;
+                       if (!is_random) {
+                               mpeg->now.nsecs += MPA_DURATION_NS(&mpa);
+                               if (mpeg->now.nsecs >= 1000000000) {
+                                       mpeg->now.secs++;
+                                       mpeg->now.nsecs -= 1000000000;
+                               }
                        }
                } else {
-                       packet_size = mpeg_resync(wth, err, err_info);
+                       packet_size = mpeg_resync(fh, err);
                        if (packet_size == 0)
                                return FALSE;
                }
        }
-       *data_offset = wth->data_offset;
 
-       buffer_assure_space(wth->frame_buffer, packet_size);
-       if (!mpeg_read_rec_data(wth->fh, buffer_start_ptr(wth->frame_buffer),
-                               packet_size, err))
+       if (!wtap_read_packet_bytes(fh, buf, packet_size, err, err_info))
                return FALSE;
-       wth->data_offset += packet_size;
-       wth->phdr.ts = ts;
-       wth->phdr.caplen = packet_size;
-       wth->phdr.len = packet_size;
+
+       phdr->rec_type = REC_TYPE_PACKET;
+
+       /* XXX - relative, not absolute, time stamps */
+       if (!is_random) {
+               phdr->presence_flags = WTAP_HAS_TS;
+               phdr->ts = ts;
+       }
+       phdr->caplen = packet_size;
+       phdr->len = packet_size;
+
        return TRUE;
 }
 
+static gboolean
+mpeg_read(wtap *wth, int *err, gchar **err_info, gint64 *data_offset)
+{
+       *data_offset = file_tell(wth->fh);
+
+       return mpeg_read_packet(wth, wth->fh, &wth->phdr, wth->frame_buffer,
+           FALSE, err, err_info);
+}
+
 static gboolean
 mpeg_seek_read(wtap *wth, gint64 seek_off,
-               union wtap_pseudo_header *pseudo_header _U_, guchar *pd, int length,
-               int *err, gchar **err_info _U_)
+               struct wtap_pkthdr *phdr, Buffer *buf,
+               int *err, gchar **err_info)
 {
        if (file_seek(wth->random_fh, seek_off, SEEK_SET, err) == -1)
                return FALSE;
-       return mpeg_read_rec_data(wth->random_fh, pd, length, err);
-}
 
-static void
-mpeg_close(wtap *wth)
-{
-       g_free(wth->capture.mpeg);
+       if (!mpeg_read_packet(wth, wth->random_fh, phdr, buf, TRUE, err,
+           err_info)) {
+               if (*err == 0)
+                       *err = WTAP_ERR_SHORT_READ;
+               return FALSE;
+       }
+       return TRUE;
 }
 
 struct _mpeg_magic {
@@ -256,50 +227,61 @@ struct _mpeg_magic {
        { 3, "TAG" }, /* ID3v1 */
        { 3, "ID3" }, /* ID3v2 */
        { 3, "\0\0\1" }, /* MPEG PES */
-       /* XXX MPEG audio is missing. */
+       { 2, "\xff\xfb" }, /* MP3, taken from http://en.wikipedia.org/wiki/MP3#File_structure */
        { 0, NULL }
 };
 
-int 
-mpeg_open(wtap *wth, int *err, gchar **err_info _U_)
+wtap_open_return_val
+mpeg_open(wtap *wth, int *err, gchar **err_info)
 {
-       int bytes_read;
        char magic_buf[16];
        struct _mpeg_magic* m;
-       
-       errno = WTAP_ERR_CANT_READ;
-       bytes_read = file_read(magic_buf, 1, sizeof magic_buf, wth->fh);
-       if (bytes_read != (int) sizeof magic_buf) {
-               *err = file_error(wth->fh);
-               if (*err != 0)
-                       return -1;
-               return 0;
+       mpeg_t *mpeg;
+
+       if (!wtap_read_bytes(wth->fh, magic_buf, sizeof magic_buf,
+           err, err_info)) {
+               if (*err != WTAP_ERR_SHORT_READ)
+                       return WTAP_OPEN_ERROR;
+               return WTAP_OPEN_NOT_MINE;
        }
 
-       for (m=magic;m->match;m++) {
-               if (memcmp(magic_buf,m->match,m->len) == 0)
+       for (m=magic; m->match; m++) {
+               if (memcmp(magic_buf, m->match, m->len) == 0)
                        goto good_magic;
        }
-       
-       return 0;
+
+       return WTAP_OPEN_NOT_MINE;
 
 good_magic:
        /* This appears to be a file with MPEG data. */
        if (file_seek(wth->fh, 0, SEEK_SET, err) == -1)
-               return -1;
+               return WTAP_OPEN_ERROR;
 
-       wth->file_type = WTAP_FILE_MPEG;
+       wth->file_type_subtype = WTAP_FILE_TYPE_SUBTYPE_MPEG;
        wth->file_encap = WTAP_ENCAP_MPEG;
-       wth->tsprecision = WTAP_FILE_TSPREC_NSEC;
+       wth->file_tsprec = WTAP_TSPREC_NSEC;
        wth->subtype_read = mpeg_read;
        wth->subtype_seek_read = mpeg_seek_read;
-       wth->subtype_close = mpeg_close;
        wth->snapshot_length = 0;
 
-       wth->capture.mpeg = g_malloc(sizeof(mpeg_t));
-       wth->capture.mpeg->now.secs = time(NULL);
-       wth->capture.mpeg->now.nsecs = 0;
-       wth->capture.mpeg->t0 = wth->capture.mpeg->now.secs;
+       mpeg = (mpeg_t *)g_malloc(sizeof(mpeg_t));
+       wth->priv = (void *)mpeg;
+       mpeg->now.secs = 0;
+       mpeg->now.nsecs = 0;
+       mpeg->t0 = mpeg->now.secs;
 
-       return 1;
+       return WTAP_OPEN_MINE;
 }
+
+/*
+ * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
+ *
+ * Local variables:
+ * c-basic-offset: 8
+ * tab-width: 8
+ * indent-tabs-mode: t
+ * End:
+ *
+ * vi: set shiftwidth=8 tabstop=8 noexpandtab:
+ * :indentSize=8:tabSize=8:noTabs=false:
+ */