libvo/vo_pnm.c

   1 /*
   2  * PPM/PGM/PGMYUV video output driver
   3  *
   4  * copyright (C) 2004, 2005 Ivo van Poorten
   5  *
   6  * This file is part of MPlayer.
   7  *
   8  * MPlayer is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * MPlayer is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with MPlayer; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 /* ------------------------------------------------------------------------- */
  24
  25 /* Global Includes */
  26
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #include <errno.h>
  31 #include <sys/stat.h>
  32
  33 /* ------------------------------------------------------------------------- */
  34
  35 /* Local Includes */
  36
  37 #include "config.h"
  38 #include "subopt-helper.h"
  39 #include "mp_msg.h"
  40 #include "video_out.h"
  41 #include "video_out_internal.h"
  42 #include "mplayer.h"                    /* for exit_player() */
  43 #include "help_mp.h"
  44
  45 /* ------------------------------------------------------------------------- */
  46
  47 /* Defines */
  48
  49 /* Used for temporary buffers to store file- and pathnames */
  50 #define BUFLENGTH 512
  51
  52 #define PNM_ASCII_MODE 0
  53 #define PNM_RAW_MODE 1
  54 #define PNM_TYPE_PPM 0
  55 #define PNM_TYPE_PGM 1
  56 #define PNM_TYPE_PGMYUV 2
  57
  58 #define PNM_LINE_OF_ASCII "%03d %03d %03d %03d %03d %03d %03d %03d %03d %03d %03d %03d %03d %03d %03d\n"
  59 #define PNM_LINE15(a,b) a[b], a[b+1], a[b+2], a[b+3], a[b+4], a[b+5], a[b+6], \
  60                         a[b+7], a[b+8], a[b+9], a[b+10], a[b+11], a[b+12], \
  61                         a[b+13], a[b+14]
  62
  63 /* ------------------------------------------------------------------------- */
  64
  65 /* Info */
  66
  67 static const vo_info_t info=
  68 {
  69         "PPM/PGM/PGMYUV file",
  70         "pnm",
  71         "Ivo van Poorten (ivop@euronet.nl)",
  72         ""
  73 };
  74
  75 const LIBVO_EXTERN (pnm)
  76
  77 /* ------------------------------------------------------------------------- */
  78
  79 /* Global Variables */
  80
  81 int pnm_type = PNM_TYPE_PPM;
  82 int pnm_mode = PNM_RAW_MODE;
  83
  84 char *pnm_outdir = NULL;
  85 char *pnm_subdirs = NULL;
  86 int pnm_maxfiles = 1000;
  87 char *pnm_file_extension = NULL;
  88
  89 /* ------------------------------------------------------------------------- */
  90
  91 /** \brief An error occured while writing to a file.
  92  *
  93  * The program failed to write data to a file.
  94  * It displays a message and exits the player.
  95  *
  96  * \return nothing It does not return.
  97  */
  98
  99 static void pnm_write_error(void) {
 100     mp_msg(MSGT_VO, MSGL_ERR, MSGTR_ErrorWritingFile, info.short_name);
 101     exit_player(MSGTR_Exit_error);
 102 }
 103
 104 /* ------------------------------------------------------------------------- */
 105
 106 /** \brief Pre-initialisation.
 107  *
 108  * This function is called before initialising the video output driver. It
 109  * parses all suboptions and sets variables accordingly. If an error occurs
 110  * (like an option being out of range, not having any value or an unknown
 111  * option is stumbled upon) the player will exit.
 112  *
 113  * \param arg   A string containing all the suboptions passed to the video
 114  *              output driver.
 115  *
 116  * \return 0    All went well.
 117  */
 118
 119 static int preinit(const char *arg)
 120 {
 121     int ppm_type = 0, pgm_type = 0, pgmyuv_type = 0,
 122         raw_mode = 0, ascii_mode = 0;
 123     const opt_t subopts[] = {
 124         {"ppm",         OPT_ARG_BOOL,   &ppm_type,      NULL},
 125         {"pgm",         OPT_ARG_BOOL,   &pgm_type,      NULL},
 126         {"pgmyuv",      OPT_ARG_BOOL,   &pgmyuv_type,   NULL},
 127         {"raw",         OPT_ARG_BOOL,   &raw_mode,      NULL},
 128         {"ascii",       OPT_ARG_BOOL,   &ascii_mode,    NULL},
 129         {"outdir",      OPT_ARG_MSTRZ,  &pnm_outdir,    NULL},
 130         {"subdirs",     OPT_ARG_MSTRZ,  &pnm_subdirs,   NULL},
 131         {"maxfiles",    OPT_ARG_INT,    &pnm_maxfiles,  (opt_test_f)int_pos},
 132         {NULL, 0, NULL, NULL}
 133     };
 134     const char *info_message = NULL;
 135
 136     mp_msg(MSGT_VO, MSGL_INFO, "%s: %s\n", info.short_name,
 137                                             MSGTR_VO_ParsingSuboptions);
 138
 139     pnm_maxfiles = 1000;
 140     pnm_outdir = strdup(".");
 141     pnm_subdirs = NULL;
 142
 143     if (subopt_parse(arg, subopts) != 0) {
 144         return -1;
 145     }
 146
 147     pnm_type     = PNM_TYPE_PPM;
 148     pnm_mode     = PNM_RAW_MODE;
 149
 150     if (pgmyuv_type) pnm_type     = PNM_TYPE_PGMYUV;
 151     if (pgm_type)    pnm_type     = PNM_TYPE_PGM;
 152     if (ppm_type)    pnm_type     = PNM_TYPE_PPM;
 153     if (ascii_mode)  pnm_mode     = PNM_ASCII_MODE;
 154     if (raw_mode)    pnm_mode     = PNM_RAW_MODE;
 155
 156     switch (pnm_mode) {
 157         case PNM_ASCII_MODE:
 158             info_message = MSGTR_VO_PNM_ASCIIMode;
 159             break;
 160         case PNM_RAW_MODE:
 161             info_message = MSGTR_VO_PNM_RawMode;
 162             break;
 163     }
 164     mp_msg(MSGT_VO, MSGL_INFO, "%s: %s\n", info.short_name, info_message);
 165
 166     switch (pnm_type) {
 167         case PNM_TYPE_PPM:
 168             info_message = MSGTR_VO_PNM_PPMType;
 169             break;
 170         case PNM_TYPE_PGM:
 171             info_message = MSGTR_VO_PNM_PGMType;
 172             break;
 173         case PNM_TYPE_PGMYUV:
 174             info_message = MSGTR_VO_PNM_PGMYUVType;
 175             break;
 176     }
 177     mp_msg(MSGT_VO, MSGL_INFO, "%s: %s\n", info.short_name, info_message);
 178
 179     mp_msg(MSGT_VO, MSGL_INFO, "%s: %s\n", info.short_name,
 180                                             MSGTR_VO_SuboptionsParsedOK);
 181     return 0;
 182 }
 183
 184 /* ------------------------------------------------------------------------- */
 185
 186 /** \brief Create a directory.
 187  *
 188  *  This function creates a directory. If it already exists, it tests if
 189  *  it's a directory and not something else, and if it is, it tests whether
 190  *  the directory is writable or not.
 191  *
 192  * \param buf       Pointer to directory name.
 193  * \param verbose   Verbose on success. If verbose is non-zero, it will print
 194  *                  a message if it was successful in creating the directory.
 195  *
 196  * \return nothing  In case anything fails, the player will exit. If it
 197  *                  returns, everything went well.
 198  */
 199
 200 static void pnm_mkdir(char *buf, int verbose) {
 201     struct stat stat_p;
 202
 203 /* Silly MING32 bug workaround */
 204 #ifndef __MINGW32__
 205     if ( mkdir(buf, 0755) < 0 ) {
 206 #else
 207     if ( mkdir(buf) < 0 ) {
 208 #endif
 209         switch (errno) { /* use switch in case other errors need to be caught
 210                             and handled in the future */
 211             case EEXIST:
 212                 if ( stat(buf, &stat_p ) < 0 ) {
 213                     mp_msg(MSGT_VO, MSGL_ERR, "%s: %s: %s\n", info.short_name,
 214                             MSGTR_VO_GenericError, strerror(errno) );
 215                     mp_msg(MSGT_VO, MSGL_ERR, "%s: %s %s\n", info.short_name,
 216                             MSGTR_VO_UnableToAccess,buf);
 217                     exit_player(MSGTR_Exit_error);
 218                 }
 219                 if ( !S_ISDIR(stat_p.st_mode) ) {
 220                     mp_msg(MSGT_VO, MSGL_ERR, "%s: %s %s\n", info.short_name,
 221                             buf, MSGTR_VO_ExistsButNoDirectory);
 222                     exit_player(MSGTR_Exit_error);
 223                 }
 224                 if ( !(stat_p.st_mode & S_IWUSR) ) {
 225                     mp_msg(MSGT_VO, MSGL_ERR, "%s: %s - %s\n", info.short_name,
 226                             buf, MSGTR_VO_DirExistsButNotWritable);
 227                     exit_player(MSGTR_Exit_error);
 228                 }
 229
 230                 if (strcmp(buf, ".") != 0) {
 231                 mp_msg(MSGT_VO, MSGL_INFO, "%s: %s - %s\n", info.short_name,
 232                         buf, MSGTR_VO_DirExistsAndIsWritable);
 233                 }
 234                 break;
 235
 236             default:
 237                 mp_msg(MSGT_VO, MSGL_ERR, "%s: %s: %s\n", info.short_name,
 238                         MSGTR_VO_GenericError, strerror(errno) );
 239                 mp_msg(MSGT_VO, MSGL_ERR, "%s: %s - %s\n", info.short_name,
 240                         buf, MSGTR_VO_CantCreateDirectory);
 241                 exit_player(MSGTR_Exit_error);
 242         } /* end switch */
 243     } else if ( verbose ) {
 244         mp_msg(MSGT_VO, MSGL_INFO, "%s: %s - %s\n", info.short_name,
 245                 buf, MSGTR_VO_DirectoryCreateSuccess);
 246     } /* end if */
 247 }
 248
 249 /* ------------------------------------------------------------------------- */
 250
 251 /** \brief Configure the video output driver.
 252  *
 253  * This functions configures the video output driver. It determines the
 254  * width and height of the image(s) and creates the output directory.
 255  *
 256  *  \return 0             All went well.
 257  */
 258
 259 static int config(uint32_t width, uint32_t height, uint32_t d_width,
 260                        uint32_t d_height, uint32_t flags, char *title,
 261                        uint32_t format)
 262 {
 263     char buf[BUFLENGTH];
 264
 265     if (vo_config_count > 0 ) { /* Already configured */
 266         return 0;
 267     }
 268
 269     /* Create outdir. */
 270
 271     snprintf(buf, BUFLENGTH, "%s", pnm_outdir);
 272     pnm_mkdir(buf, 1); /* This function only returns if creation was
 273                            successful. If not, the player will exit. */
 274
 275     if (pnm_type == PNM_TYPE_PPM) {
 276         pnm_file_extension = strdup("ppm");
 277     } else if (pnm_type == PNM_TYPE_PGM) {
 278         pnm_file_extension = strdup("pgm");
 279     } else if (pnm_type == PNM_TYPE_PGMYUV) {
 280         pnm_file_extension = strdup("pgmyuv");
 281     }
 282
 283     return 0;
 284 }
 285
 286 /* ------------------------------------------------------------------------- */
 287
 288 /** \brief Write PNM file to output file
 289  *
 290  * This function writes PPM, PGM or PGMYUV data to an output file, depending
 291  * on which type was selected on the commandline. pnm_type and pnm_mode are
 292  * global variables. Depending on which mode was selected, it will write
 293  * a RAW or an ASCII file.
 294  *
 295  * \param outfile       Filedescriptor of output file.
 296  * \param mpi           The image to write.
 297  *
 298  * \return none         The player will exit if anything goes wrong.
 299  */
 300
 301 static void pnm_write_pnm(FILE *outfile, mp_image_t *mpi)
 302 {
 303     uint32_t w = mpi->w;
 304     uint32_t h = mpi->h;
 305     uint8_t *rgbimage = mpi->planes[0];
 306     uint8_t *planeY = mpi->planes[0];
 307     uint8_t *planeU = mpi->planes[1];
 308     uint8_t *planeV = mpi->planes[2];
 309     uint8_t *curline;
 310     uint32_t strideY = mpi->stride[0];
 311     uint32_t strideU = mpi->stride[1];
 312     uint32_t strideV = mpi->stride[2];
 313
 314     unsigned int i, j;
 315
 316     if (pnm_mode == PNM_RAW_MODE) {
 317
 318         if (pnm_type == PNM_TYPE_PPM) {
 319             if ( fprintf(outfile, "P6\n%d %d\n255\n", w, h) < 0 )
 320                 pnm_write_error();
 321             if ( fwrite(rgbimage, w * 3, h, outfile) < h ) pnm_write_error();
 322         } else if (pnm_type == PNM_TYPE_PGM) {
 323             if ( fprintf(outfile, "P5\n%d %d\n255\n", w, h) < 0 )
 324                 pnm_write_error();
 325             for (i=0; i<h; i++) {
 326                 if ( fwrite(planeY + i * strideY, w, 1, outfile) < 1 )
 327                     pnm_write_error();
 328             }
 329         } else if (pnm_type == PNM_TYPE_PGMYUV) {
 330             if ( fprintf(outfile, "P5\n%d %d\n255\n", w, h*3/2) < 0 )
 331                 pnm_write_error();
 332             for (i=0; i<h; i++) {
 333                 if ( fwrite(planeY + i * strideY, w, 1, outfile) < 1 )
 334                     pnm_write_error();
 335             }
 336             w = w / 2;
 337             h = h / 2;
 338             for (i=0; i<h; i++) {
 339                 if ( fwrite(planeU + i * strideU, w, 1, outfile) < 1 )
 340                     pnm_write_error();
 341                 if ( fwrite(planeV + i * strideV, w, 1, outfile) < 1 )
 342                     pnm_write_error();
 343             }
 344         } /* end if pnm_type */
 345
 346     } else if (pnm_mode == PNM_ASCII_MODE) {
 347
 348         if (pnm_type == PNM_TYPE_PPM) {
 349             if ( fprintf(outfile, "P3\n%d %d\n255\n", w, h) < 0 )
 350                 pnm_write_error();
 351             for (i=0; i <= w * h * 3 - 16 ; i += 15) {
 352                 if ( fprintf(outfile, PNM_LINE_OF_ASCII,
 353                     PNM_LINE15(rgbimage,i) ) < 0 )  pnm_write_error();
 354             }
 355             while (i < (w * h * 3) ) {
 356                 if ( fprintf(outfile, "%03d ", rgbimage[i]) < 0 )
 357                     pnm_write_error();
 358                 i++;
 359             }
 360             if ( fputc('\n', outfile) < 0 ) pnm_write_error();
 361         } else if ( (pnm_type == PNM_TYPE_PGM) ||
 362                                             (pnm_type == PNM_TYPE_PGMYUV) ) {
 363
 364             /* different header for pgm and pgmyuv. pgmyuv is 'higher' */
 365             if (pnm_type == PNM_TYPE_PGM) {
 366                 if ( fprintf(outfile, "P2\n%d %d\n255\n", w, h) < 0 )
 367                     pnm_write_error();
 368             } else { /* PNM_TYPE_PGMYUV */
 369                 if ( fprintf(outfile, "P2\n%d %d\n255\n", w, h*3/2) < 0 )
 370                     pnm_write_error();
 371             }
 372
 373             /* output Y plane for both PGM and PGMYUV */
 374             for (j=0; j<h; j++) {
 375                 curline = planeY + strideY * j;
 376                 for (i=0; i <= w - 16; i+=15) {
 377                     if ( fprintf(outfile, PNM_LINE_OF_ASCII,
 378                         PNM_LINE15(curline,i) ) < 0 ) pnm_write_error();
 379                 }
 380                 while (i < w ) {
 381                     if ( fprintf(outfile, "%03d ", curline[i]) < 0 )
 382                         pnm_write_error();
 383                     i++;
 384                 }
 385                 if ( fputc('\n', outfile) < 0 ) pnm_write_error();
 386             }
 387
 388             /* also output U and V planes fpr PGMYUV */
 389             if (pnm_type == PNM_TYPE_PGMYUV) {
 390                 w = w / 2;
 391                 h = h / 2;
 392                 for (j=0; j<h; j++) {
 393                     curline = planeU + strideU * j;
 394                     for (i=0; i<= w-16; i+=15) {
 395                         if ( fprintf(outfile, PNM_LINE_OF_ASCII,
 396                             PNM_LINE15(curline,i) ) < 0 ) pnm_write_error();
 397                     }
 398                     while (i < w ) {
 399                         if ( fprintf(outfile, "%03d ", curline[i]) < 0 )
 400                             pnm_write_error();
 401                         i++;
 402                     }
 403                     if ( fputc('\n', outfile) < 0 ) pnm_write_error();
 404
 405                     curline = planeV + strideV * j;
 406                     for (i=0; i<= w-16; i+=15) {
 407                         if ( fprintf(outfile, PNM_LINE_OF_ASCII,
 408                             PNM_LINE15(curline,i) ) < 0 ) pnm_write_error();
 409                     }
 410                     while (i < w ) {
 411                         if ( fprintf(outfile, "%03d ", curline[i]) < 0 )
 412                             pnm_write_error();
 413                         i++;
 414                     }
 415                     if ( fputc('\n', outfile) < 0 ) pnm_write_error();
 416                 }
 417             }
 418
 419         } /* end if pnm_type */
 420     } /* end if pnm_mode */
 421 }
 422
 423 /* ------------------------------------------------------------------------- */
 424
 425 /** \brief Write a PNM image.
 426  *
 427  * This function gets called first if a PNM image has to be written to disk.
 428  * It contains the subdirectory framework and it calls pnm_write_pnm() to
 429  * actually write the image to disk.
 430  *
 431  * \param mpi       The image to write.
 432  *
 433  * \return none     The player will exit if anything goes wrong.
 434  */
 435
 436 static void pnm_write_image(mp_image_t *mpi)
 437 {
 438     static int framenum = 0, framecounter = 0, subdircounter = 0;
 439     char buf[BUFLENGTH];
 440     static char subdirname[BUFLENGTH] = "";
 441     FILE *outfile;
 442
 443     if (!mpi) {
 444         mp_msg(MSGT_VO, MSGL_ERR, "%s: No image data suplied to video output driver\n", info.short_name );
 445         exit_player(MSGTR_Exit_error);
 446     }
 447
 448     /* Start writing to new subdirectory after a certain amount of frames */
 449     if ( framecounter == pnm_maxfiles ) {
 450         framecounter = 0;
 451     }
 452
 453     /* If framecounter is zero (or reset to zero), increment subdirectory
 454      * number and create the subdirectory.
 455      * If pnm_subdirs is not set, do nothing. */
 456     if ( !framecounter && pnm_subdirs ) {
 457         subdircounter++;
 458         snprintf(subdirname, BUFLENGTH, "%s%08d", pnm_subdirs, subdircounter);
 459         snprintf(buf, BUFLENGTH, "%s/%s", pnm_outdir, subdirname);
 460         pnm_mkdir(buf, 0); /* This function only returns if creation was
 461                                successful. If not, the player will exit. */
 462     }
 463
 464     framenum++;
 465     framecounter++;
 466
 467     /* snprintf the full pathname of the outputfile */
 468     snprintf(buf, BUFLENGTH, "%s/%s/%08d.%s", pnm_outdir, subdirname,
 469                                             framenum, pnm_file_extension);
 470
 471     if ( (outfile = fopen(buf, "wb") ) == NULL ) {
 472         mp_msg(MSGT_VO, MSGL_ERR, "\n%s: %s\n", info.short_name,
 473                 MSGTR_VO_CantCreateFile);
 474         mp_msg(MSGT_VO, MSGL_ERR, "%s: %s: %s\n",
 475                 info.short_name, MSGTR_VO_GenericError,
 476                 strerror(errno) );
 477         exit_player(MSGTR_Exit_error);
 478     }
 479
 480     pnm_write_pnm(outfile, mpi);
 481
 482     fclose(outfile);
 483 }
 484
 485 /* ------------------------------------------------------------------------- */
 486
 487 static uint32_t draw_image(mp_image_t *mpi)
 488 {
 489     if (mpi->flags & MP_IMGFLAG_PLANAR) { /* Planar */
 490         if (mpi->flags & MP_IMGFLAG_YUV) { /* Planar YUV */
 491             pnm_write_image(mpi);
 492             return VO_TRUE;
 493         } else { /* Planar RGB */
 494             return VO_FALSE;
 495         }
 496     } else { /* Packed */
 497         if (mpi->flags & MP_IMGFLAG_YUV) { /* Packed YUV */
 498             return VO_FALSE;
 499         } else { /* Packed RGB */
 500             pnm_write_image(mpi);
 501             return VO_TRUE;
 502         }
 503     }
 504
 505     return VO_FALSE;
 506 }
 507
 508 /* ------------------------------------------------------------------------- */
 509
 510 static int draw_frame(uint8_t *src[])
 511 {
 512     mp_msg(MSGT_VO, MSGL_V, "%s: draw_frame() is called!\n", info.short_name);
 513     return -1;
 514 }
 515
 516 /* ------------------------------------------------------------------------- */
 517
 518 static int draw_slice(uint8_t *src[], int stride[], int w, int h,
 519                            int x, int y)
 520 {
 521     return 0;
 522 }
 523
 524 /* ------------------------------------------------------------------------- */
 525
 526 static int query_format(uint32_t format)
 527 {
 528     /* Ensure that for PPM we get Packed RGB and for PGM(YUV) we get
 529      * Planar YUV */
 530     if (pnm_type == PNM_TYPE_PPM) {
 531         if (format == IMGFMT_RGB24) {
 532             return VFCAP_CSP_SUPPORTED|VFCAP_CSP_SUPPORTED_BY_HW;
 533         }
 534     } else if ( (pnm_type == PNM_TYPE_PGM) || (pnm_type == PNM_TYPE_PGMYUV) ) {
 535         if (format == IMGFMT_YV12) {
 536             return VFCAP_CSP_SUPPORTED|VFCAP_CSP_SUPPORTED_BY_HW;
 537         }
 538     }
 539
 540     return 0;
 541 }
 542
 543 /* ------------------------------------------------------------------------- */
 544
 545 static int control(uint32_t request, void *data, ...)
 546 {
 547     switch (request) {
 548         case VOCTRL_QUERY_FORMAT:
 549             return query_format(*((uint32_t*)data));
 550         case VOCTRL_DRAW_IMAGE:
 551             return draw_image(data);
 552     }
 553     return VO_NOTIMPL;
 554 }
 555
 556 /* ------------------------------------------------------------------------- */
 557
 558 static void uninit(void)
 559 {
 560     if (pnm_subdirs) {
 561         free(pnm_subdirs);
 562         pnm_subdirs = NULL;
 563     }
 564     if (pnm_outdir) {
 565         free(pnm_outdir);
 566         pnm_outdir = NULL;
 567     }
 568 }
 569
 570 /* ------------------------------------------------------------------------- */
 571
 572 static void check_events(void)
 573 {
 574 }
 575
 576 /* ------------------------------------------------------------------------- */
 577
 578 static void draw_osd(void)
 579 {
 580 }
 581
 582 /* ------------------------------------------------------------------------- */
 583
 584 static void flip_page (void)
 585 {
 586 }
 587
 588 /* ------------------------------------------------------------------------- */
 589
 590 #undef BUFLENGTH
 591 #undef PNM_RAW_MODE
 592 #undef PNM_ASCII_MODE
 593 #undef PNM_TYPE_PPM
 594 #undef PNM_TYPE_PGM
 595 #undef PNM_TYPE_PGMYUV
 596
 597 /* ------------------------------------------------------------------------- */
 598